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)
54 const LIMIT_BIG1
= 500; // Fast query, std user limit
55 const LIMIT_BIG2
= 5000; // Fast query, bot/sysop limit
56 const LIMIT_SML1
= 50; // Slow query, std user limit
57 const LIMIT_SML2
= 500; // Slow query, bot/sysop limit
59 private $mMainModule, $mModuleName, $mModulePrefix;
63 * @param $mainModule ApiMain object
64 * @param $moduleName string Name of this module
65 * @param $modulePrefix string Prefix to use for parameter names
67 public function __construct( $mainModule, $moduleName, $modulePrefix = '' ) {
68 $this->mMainModule
= $mainModule;
69 $this->mModuleName
= $moduleName;
70 $this->mModulePrefix
= $modulePrefix;
73 /*****************************************************************************
75 *****************************************************************************/
78 * Evaluates the parameters, performs the requested query, and sets up
79 * the result. Concrete implementations of ApiBase must override this
80 * method to provide whatever functionality their module offers.
81 * Implementations must not produce any output on their own and are not
82 * expected to handle any errors.
84 * The execute() method will be invoked directly by ApiMain immediately
85 * before the result of the module is output. Aside from the
86 * constructor, implementations should assume that no other methods
87 * will be called externally on the module before the result is
90 * The result data should be stored in the ApiResult object available
91 * through getResult().
93 public abstract function execute();
96 * Returns a string that identifies the version of the extending class.
97 * Typically includes the class name, the svn revision, timestamp, and
98 * last author. Usually done with SVN's Id keyword
101 public abstract function getVersion();
104 * Get the name of the module being executed by this instance
107 public function getModuleName() {
108 return $this->mModuleName
;
112 * Get parameter prefix (usually two letters or an empty string).
115 public function getModulePrefix() {
116 return $this->mModulePrefix
;
120 * Get the name of the module as shown in the profiler log
123 public function getModuleProfileName( $db = false ) {
125 return 'API:' . $this->mModuleName
. '-DB';
127 return 'API:' . $this->mModuleName
;
132 * Get the main module
133 * @return ApiMain object
135 public function getMain() {
136 return $this->mMainModule
;
140 * Returns true if this module is the main module ($this === $this->mMainModule),
144 public function isMain() {
145 return $this === $this->mMainModule
;
149 * Get the result object
152 public function getResult() {
153 // Main module has getResult() method overriden
154 // Safety - avoid infinite loop:
155 if ( $this->isMain() ) {
156 ApiBase
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
158 return $this->getMain()->getResult();
162 * Get the result data array (read-only)
165 public function getResultData() {
166 return $this->getResult()->getData();
170 * Set warning section for this module. Users should monitor this
171 * section to notice any changes in API. Multiple calls to this
172 * function will result in the warning messages being separated by
174 * @param $warning string Warning message
176 public function setWarning( $warning ) {
177 $data = $this->getResult()->getData();
178 if ( isset( $data['warnings'][$this->getModuleName()] ) ) {
179 // Don't add duplicate warnings
180 $warn_regex = preg_quote( $warning, '/' );
181 if ( preg_match( "/{$warn_regex}(\\n|$)/", $data['warnings'][$this->getModuleName()]['*'] ) )
185 $oldwarning = $data['warnings'][$this->getModuleName()]['*'];
186 // If there is a warning already, append it to the existing one
187 $warning = "$oldwarning\n$warning";
188 $this->getResult()->unsetValue( 'warnings', $this->getModuleName() );
191 ApiResult
::setContent( $msg, $warning );
192 $this->getResult()->disableSizeCheck();
193 $this->getResult()->addValue( 'warnings', $this->getModuleName(), $msg );
194 $this->getResult()->enableSizeCheck();
198 * If the module may only be used with a certain format module,
199 * it should override this method to return an instance of that formatter.
200 * A value of null means the default format will be used.
201 * @return mixed instance of a derived class of ApiFormatBase, or null
203 public function getCustomPrinter() {
208 * Generates help message for this module, or false if there is no description
209 * @return mixed string or false
211 public function makeHelpMsg() {
212 static $lnPrfx = "\n ";
214 $msg = $this->getDescription();
216 if ( $msg !== false ) {
218 if ( !is_array( $msg ) ) {
223 $msg = $lnPrfx . implode( $lnPrfx, $msg ) . "\n";
225 if ( $this->isReadMode() ) {
226 $msg .= "\nThis module requires read rights";
228 if ( $this->isWriteMode() ) {
229 $msg .= "\nThis module requires write rights";
231 if ( $this->mustBePosted() ) {
232 $msg .= "\nThis module only accepts POST requests";
234 if ( $this->isReadMode() ||
$this->isWriteMode() ||
235 $this->mustBePosted() )
241 $paramsMsg = $this->makeHelpMsgParameters();
242 if ( $paramsMsg !== false ) {
243 $msg .= "Parameters:\n$paramsMsg";
247 $examples = $this->getExamples();
248 if ( $examples !== false ) {
249 if ( !is_array( $examples ) ) {
254 $msg .= 'Example' . ( count( $examples ) > 1 ?
's' : '' ) . ":\n ";
255 $msg .= implode( $lnPrfx, $examples ) . "\n";
258 if ( $this->getMain()->getShowVersions() ) {
259 $versions = $this->getVersion();
260 $pattern = '/(\$.*) ([0-9a-z_]+\.php) (.*\$)/i';
261 $callback = array( $this, 'makeHelpMsg_callback' );
263 if ( is_array( $versions ) ) {
264 foreach ( $versions as &$v ) {
265 $v = preg_replace_callback( $pattern, $callback, $v );
267 $versions = implode( "\n ", $versions );
269 $versions = preg_replace_callback( $pattern, $callback, $versions );
272 $msg .= "Version:\n $versions\n";
280 * Generates the parameter descriptions for this module, to be displayed in the
284 public function makeHelpMsgParameters() {
285 $params = $this->getFinalParams();
288 $paramsDescription = $this->getFinalParamDescription();
290 $paramPrefix = "\n" . str_repeat( ' ', 19 );
291 foreach ( $params as $paramName => $paramSettings ) {
292 $desc = isset( $paramsDescription[$paramName] ) ?
$paramsDescription[$paramName] : '';
293 if ( is_array( $desc ) ) {
294 $desc = implode( $paramPrefix, $desc );
297 if ( !is_array( $paramSettings ) ) {
298 $paramSettings = array(
299 self
::PARAM_DFLT
=> $paramSettings,
303 $deprecated = isset( $paramSettings[self
::PARAM_DEPRECATED
] ) ?
304 $paramSettings[self
::PARAM_DEPRECATED
] : false;
306 $desc = "DEPRECATED! $desc";
309 $type = isset( $paramSettings[self
::PARAM_TYPE
] ) ?
$paramSettings[self
::PARAM_TYPE
] : null;
310 if ( isset( $type ) ) {
311 if ( isset( $paramSettings[self
::PARAM_ISMULTI
] ) ) {
312 $prompt = 'Values (separate with \'|\'): ';
314 $prompt = 'One value: ';
317 if ( is_array( $type ) ) {
319 $nothingPrompt = false;
320 foreach ( $type as $t ) {
322 $nothingPrompt = 'Can be empty, or ';
327 $desc .= $paramPrefix . $nothingPrompt . $prompt . implode( ', ', $choices );
331 // Special handling because namespaces are type-limited, yet they are not given
332 $desc .= $paramPrefix . $prompt . implode( ', ', MWNamespace
::getValidNamespaces() );
335 $desc .= $paramPrefix . "No more than {$paramSettings[self :: PARAM_MAX]} ({$paramSettings[self::PARAM_MAX2]} for bots) allowed";
338 $hasMin = isset( $paramSettings[self
::PARAM_MIN
] );
339 $hasMax = isset( $paramSettings[self
::PARAM_MAX
] );
340 if ( $hasMin ||
$hasMax ) {
342 $intRangeStr = "The value must be no less than {$paramSettings[self::PARAM_MIN]}";
343 } elseif ( !$hasMin ) {
344 $intRangeStr = "The value must be no more than {$paramSettings[self::PARAM_MAX]}";
346 $intRangeStr = "The value must be between {$paramSettings[self::PARAM_MIN]} and {$paramSettings[self::PARAM_MAX]}";
349 $desc .= $paramPrefix . $intRangeStr;
356 $default = is_array( $paramSettings ) ?
( isset( $paramSettings[self
::PARAM_DFLT
] ) ?
$paramSettings[self
::PARAM_DFLT
] : null ) : $paramSettings;
357 if ( !is_null( $default ) && $default !== false ) {
358 $desc .= $paramPrefix . "Default: $default";
361 $msg .= sprintf( " %-14s - %s\n", $this->encodeParamName( $paramName ), $desc );
371 * Callback for preg_replace_callback() call in makeHelpMsg().
372 * Replaces a source file name with a link to ViewVC
374 public function makeHelpMsg_callback( $matches ) {
375 global $wgAutoloadClasses, $wgAutoloadLocalClasses;
376 if ( isset( $wgAutoloadLocalClasses[get_class( $this )] ) ) {
377 $file = $wgAutoloadLocalClasses[get_class( $this )];
378 } elseif ( isset( $wgAutoloadClasses[get_class( $this )] ) ) {
379 $file = $wgAutoloadClasses[get_class( $this )];
382 // Do some guesswork here
383 $path = strstr( $file, 'includes/api/' );
384 if ( $path === false ) {
385 $path = strstr( $file, 'extensions/' );
387 $path = 'phase3/' . $path;
390 // Get the filename from $matches[2] instead of $file
391 // If they're not the same file, they're assumed to be in the
393 // This is necessary to make stuff like ApiMain::getVersion()
394 // returning the version string for ApiBase work
396 return "{$matches[0]}\n http://svn.wikimedia.org/" .
397 "viewvc/mediawiki/trunk/" . dirname( $path ) .
404 * Returns the description string for this module
405 * @return mixed string or array of strings
407 protected function getDescription() {
412 * Returns usage examples for this module. Return null if no examples are available.
413 * @return mixed string or array of strings
415 protected function getExamples() {
420 * Returns an array of allowed parameters (parameter name) => (default
421 * value) or (parameter name) => (array with PARAM_* constants as keys)
422 * Don't call this function directly: use getFinalParams() to allow
423 * hooks to modify parameters as needed.
426 protected function getAllowedParams() {
431 * Returns an array of parameter descriptions.
432 * Don't call this functon directly: use getFinalParamDescription() to
433 * allow hooks to modify descriptions as needed.
436 protected function getParamDescription() {
441 * Get final list of parameters, after hooks have had a chance to
442 * tweak it as needed.
445 public function getFinalParams() {
446 $params = $this->getAllowedParams();
447 wfRunHooks( 'APIGetAllowedParams', array( &$this, &$params ) );
452 * Get final description, after hooks have had a chance to tweak it as
456 public function getFinalParamDescription() {
457 $desc = $this->getParamDescription();
458 wfRunHooks( 'APIGetParamDescription', array( &$this, &$desc ) );
463 * This method mangles parameter name based on the prefix supplied to the constructor.
464 * Override this method to change parameter name during runtime
465 * @param $paramName string Parameter name
466 * @return string Prefixed parameter name
468 public function encodeParamName( $paramName ) {
469 return $this->mModulePrefix
. $paramName;
473 * Using getAllowedParams(), this function makes an array of the values
474 * provided by the user, with key being the name of the variable, and
475 * value - validated value from user or default. limits will not be
476 * parsed if $parseLimit is set to false; use this when the max
477 * limit is not definitive yet, e.g. when getting revisions.
478 * @param $parseLimit Boolean: true by default
481 public function extractRequestParams( $parseLimit = true ) {
482 $params = $this->getFinalParams();
485 if ( $params ) { // getFinalParams() can return false
486 foreach ( $params as $paramName => $paramSettings ) {
487 $results[$paramName] = $this->getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
495 * Get a value for the given parameter
496 * @param $paramName string Parameter name
497 * @param $parseLimit bool see extractRequestParams()
498 * @return mixed Parameter value
500 protected function getParameter( $paramName, $parseLimit = true ) {
501 $params = $this->getFinalParams();
502 $paramSettings = $params[$paramName];
503 return $this->getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
507 * Die if none or more than one of a certain set of parameters is set and not false.
508 * @param $params array of parameter names
510 public function requireOnlyOneParameter( $params ) {
511 $required = func_get_args();
512 array_shift( $required );
514 $intersection = array_intersect( array_keys( array_filter( $params,
515 create_function( '$x', 'return !is_null($x) && $x !== false;' )
517 if ( count( $intersection ) > 1 ) {
518 $this->dieUsage( 'The parameters ' . implode( ', ', $intersection ) . ' can not be used together', 'invalidparammix' );
519 } elseif ( count( $intersection ) == 0 ) {
520 $this->dieUsage( 'One of the parameters ' . implode( ', ', $required ) . ' is required', 'missingparam' );
525 * @deprecated use MWNamespace::getValidNamespaces()
527 public static function getValidNamespaces() {
528 return MWNamespace
::getValidNamespaces();
532 * Return true if we're to watch the page, false if not, null if no change.
533 * @param $watchlist String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
534 * @param $titleObj Title the page under consideration
535 * @param $userOption The user option to consider when $watchlist=preferences.
536 * If not set will magically default to either watchdefault or watchcreations
539 protected function getWatchlistValue ( $watchlist, $titleObj, $userOption = null ) {
540 switch ( $watchlist ) {
549 # If the user is already watching, don't bother checking
550 if ( $titleObj->userIsWatching() ) {
553 # If no user option was passed, use watchdefault or watchcreation
554 if ( is_null( $userOption ) ) {
555 $userOption = $titleObj->exists()
556 ?
'watchdefault' : 'watchcreations';
558 # If the corresponding user option is true, watch, else no change
559 return $wgUser->getOption( $userOption ) ?
true : null;
570 * Set a watch (or unwatch) based the based on a watchlist parameter.
571 * @param $watch String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
572 * @param $titleObj Title the article's title to change
573 * @param $userOption The user option to consider when $watch=preferences
575 protected function setWatch ( $watch, $titleObj, $userOption = null ) {
576 $value = $this->getWatchlistValue( $watch, $titleObj, $userOption );
577 if ( $value === null ) {
581 $articleObj = new Article( $titleObj );
583 $articleObj->doWatch();
585 $articleObj->doUnwatch();
590 * Using the settings determine the value for the given parameter
592 * @param $paramName String: parameter name
593 * @param $paramSettings Mixed: default value or an array of settings
594 * using PARAM_* constants.
595 * @param $parseLimit Boolean: parse limit?
596 * @return mixed Parameter value
598 protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
599 // Some classes may decide to change parameter names
600 $encParamName = $this->encodeParamName( $paramName );
602 if ( !is_array( $paramSettings ) ) {
603 $default = $paramSettings;
605 $type = gettype( $paramSettings );
609 $default = isset( $paramSettings[self
::PARAM_DFLT
] ) ?
$paramSettings[self
::PARAM_DFLT
] : null;
610 $multi = isset( $paramSettings[self
::PARAM_ISMULTI
] ) ?
$paramSettings[self
::PARAM_ISMULTI
] : false;
611 $type = isset( $paramSettings[self
::PARAM_TYPE
] ) ?
$paramSettings[self
::PARAM_TYPE
] : null;
612 $dupes = isset( $paramSettings[self
::PARAM_ALLOW_DUPLICATES
] ) ?
$paramSettings[self
::PARAM_ALLOW_DUPLICATES
] : false;
613 $deprecated = isset( $paramSettings[self
::PARAM_DEPRECATED
] ) ?
$paramSettings[self
::PARAM_DEPRECATED
] : false;
615 // When type is not given, and no choices, the type is the same as $default
616 if ( !isset( $type ) ) {
617 if ( isset( $default ) ) {
618 $type = gettype( $default );
620 $type = 'NULL'; // allow everything
625 if ( $type == 'boolean' ) {
626 if ( isset( $default ) && $default !== false ) {
627 // Having a default value of anything other than 'false' is pointless
628 ApiBase
::dieDebug( __METHOD__
, "Boolean param $encParamName's default is set to '$default'" );
631 $value = $this->getMain()->getRequest()->getCheck( $encParamName );
633 $value = $this->getMain()->getRequest()->getVal( $encParamName, $default );
635 if ( isset( $value ) && $type == 'namespace' ) {
636 $type = MWNamespace
::getValidNamespaces();
640 if ( isset( $value ) && ( $multi ||
is_array( $type ) ) ) {
641 $value = $this->parseMultiValue( $encParamName, $value, $multi, is_array( $type ) ?
$type : null );
644 // More validation only when choices were not given
645 // choices were validated in parseMultiValue()
646 if ( isset( $value ) ) {
647 if ( !is_array( $type ) ) {
649 case 'NULL': // nothing to do
651 case 'string': // nothing to do
653 case 'integer': // Force everything using intval() and optionally validate limits
655 $value = is_array( $value ) ?
array_map( 'intval', $value ) : intval( $value );
656 $min = isset ( $paramSettings[self
::PARAM_MIN
] ) ?
$paramSettings[self
::PARAM_MIN
] : null;
657 $max = isset ( $paramSettings[self
::PARAM_MAX
] ) ?
$paramSettings[self
::PARAM_MAX
] : null;
659 if ( !is_null( $min ) ||
!is_null( $max ) ) {
660 $values = is_array( $value ) ?
$value : array( $value );
661 foreach ( $values as &$v ) {
662 $this->validateLimit( $paramName, $v, $min, $max );
667 if ( !$parseLimit ) {
668 // Don't do any validation whatsoever
671 if ( !isset( $paramSettings[self
::PARAM_MAX
] ) ||
!isset( $paramSettings[self
::PARAM_MAX2
] ) ) {
672 ApiBase
::dieDebug( __METHOD__
, "MAX1 or MAX2 are not defined for the limit $encParamName" );
675 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
677 $min = isset( $paramSettings[self
::PARAM_MIN
] ) ?
$paramSettings[self
::PARAM_MIN
] : 0;
678 if ( $value == 'max' ) {
679 $value = $this->getMain()->canApiHighLimits() ?
$paramSettings[self
::PARAM_MAX2
] : $paramSettings[self
::PARAM_MAX
];
680 $this->getResult()->addValue( 'limits', $this->getModuleName(), $value );
682 $value = intval( $value );
683 $this->validateLimit( $paramName, $value, $min, $paramSettings[self
::PARAM_MAX
], $paramSettings[self
::PARAM_MAX2
] );
688 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
693 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
695 $value = wfTimestamp( TS_UNIX
, $value );
696 if ( $value === 0 ) {
697 $this->dieUsage( "Invalid value '$value' for timestamp parameter $encParamName", "badtimestamp_{$encParamName}" );
699 $value = wfTimestamp( TS_MW
, $value );
702 if ( !is_array( $value ) ) {
703 $value = array( $value );
706 foreach ( $value as $key => $val ) {
707 $title = Title
::makeTitleSafe( NS_USER
, $val );
708 if ( is_null( $title ) ) {
709 $this->dieUsage( "Invalid value for user parameter $encParamName", "baduser_{$encParamName}" );
711 $value[$key] = $title->getText();
719 ApiBase
::dieDebug( __METHOD__
, "Param $encParamName's type is unknown - $type" );
723 // Throw out duplicates if requested
724 if ( is_array( $value ) && !$dupes ) {
725 $value = array_unique( $value );
728 // Set a warning if a deprecated parameter has been passed
729 if ( $deprecated && $value !== false ) {
730 $this->setWarning( "The $encParamName parameter has been deprecated." );
738 * Return an array of values that were given in a 'a|b|c' notation,
739 * after it optionally validates them against the list allowed values.
741 * @param $valueName string The name of the parameter (for error
743 * @param $value mixed The value being parsed
744 * @param $allowMultiple bool Can $value contain more than one value
746 * @param $allowedValues mixed An array of values to check against. If
747 * null, all values are accepted.
748 * @return mixed (allowMultiple ? an_array_of_values : a_single_value)
750 protected function parseMultiValue( $valueName, $value, $allowMultiple, $allowedValues ) {
751 if ( trim( $value ) === '' && $allowMultiple ) {
755 // This is a bit awkward, but we want to avoid calling canApiHighLimits() because it unstubs $wgUser
756 $valuesList = explode( '|', $value, self
::LIMIT_SML2 +
1 );
757 $sizeLimit = count( $valuesList ) > self
::LIMIT_SML1
&& $this->mMainModule
->canApiHighLimits() ?
758 self
::LIMIT_SML2
: self
::LIMIT_SML1
;
760 if ( self
::truncateArray( $valuesList, $sizeLimit ) ) {
761 $this->setWarning( "Too many values supplied for parameter '$valueName': the limit is $sizeLimit" );
764 if ( !$allowMultiple && count( $valuesList ) != 1 ) {
765 $possibleValues = is_array( $allowedValues ) ?
"of '" . implode( "', '", $allowedValues ) . "'" : '';
766 $this->dieUsage( "Only one $possibleValues is allowed for parameter '$valueName'", "multival_$valueName" );
769 if ( is_array( $allowedValues ) ) {
770 // Check for unknown values
771 $unknown = array_diff( $valuesList, $allowedValues );
772 if ( count( $unknown ) ) {
773 if ( $allowMultiple ) {
774 $s = count( $unknown ) > 1 ?
's' : '';
775 $vals = implode( ", ", $unknown );
776 $this->setWarning( "Unrecognized value$s for parameter '$valueName': $vals" );
778 $this->dieUsage( "Unrecognized value for parameter '$valueName': {$valuesList[0]}", "unknown_$valueName" );
781 // Now throw them out
782 $valuesList = array_intersect( $valuesList, $allowedValues );
785 return $allowMultiple ?
$valuesList : $valuesList[0];
789 * Validate the value against the minimum and user/bot maximum limits.
790 * Prints usage info on failure.
791 * @param $paramName string Parameter name
792 * @param $value int Parameter value
793 * @param $min int Minimum value
794 * @param $max int Maximum value for users
795 * @param $botMax int Maximum value for sysops/bots
797 function validateLimit( $paramName, &$value, $min, $max, $botMax = null ) {
798 if ( !is_null( $min ) && $value < $min ) {
799 $this->setWarning( $this->encodeParamName( $paramName ) . " may not be less than $min (set to $value)" );
803 // Minimum is always validated, whereas maximum is checked only if not running in internal call mode
804 if ( $this->getMain()->isInternalMode() ) {
808 // Optimization: do not check user's bot status unless really needed -- skips db query
809 // assumes $botMax >= $max
810 if ( !is_null( $max ) && $value > $max ) {
811 if ( !is_null( $botMax ) && $this->getMain()->canApiHighLimits() ) {
812 if ( $value > $botMax ) {
813 $this->setWarning( $this->encodeParamName( $paramName ) . " may not be over $botMax (set to $value) for bots or sysops" );
817 $this->setWarning( $this->encodeParamName( $paramName ) . " may not be over $max (set to $value) for users" );
824 * Truncate an array to a certain length.
825 * @param $arr array Array to truncate
826 * @param $limit int Maximum length
827 * @return bool True if the array was truncated, false otherwise
829 public static function truncateArray( &$arr, $limit ) {
831 while ( count( $arr ) > $limit ) {
839 * Throw a UsageException, which will (if uncaught) call the main module's
840 * error handler and die with an error message.
842 * @param $description string One-line human-readable description of the
843 * error condition, e.g., "The API requires a valid action parameter"
844 * @param $errorCode string Brief, arbitrary, stable string to allow easy
845 * automated identification of the error, e.g., 'unknown_action'
846 * @param $httpRespCode int HTTP response code
847 * @param $extradata array Data to add to the <error> element; array in ApiResult format
849 public function dieUsage( $description, $errorCode, $httpRespCode = 0, $extradata = null ) {
851 throw new UsageException( $description, $this->encodeParamName( $errorCode ), $httpRespCode, $extradata );
855 * Array that maps message keys to error messages. $1 and friends are replaced.
857 public static $messageMap = array(
858 // This one MUST be present, or dieUsageMsg() will recurse infinitely
859 'unknownerror' => array( 'code' => 'unknownerror', 'info' => "Unknown error: ``\$1''" ),
860 'unknownerror-nocode' => array( 'code' => 'unknownerror', 'info' => 'Unknown error' ),
862 // Messages from Title::getUserPermissionsErrors()
863 'ns-specialprotected' => array( 'code' => 'unsupportednamespace', 'info' => "Pages in the Special namespace can't be edited" ),
864 'protectedinterface' => array( 'code' => 'protectednamespace-interface', 'info' => "You're not allowed to edit interface messages" ),
865 'namespaceprotected' => array( 'code' => 'protectednamespace', 'info' => "You're not allowed to edit pages in the ``\$1'' namespace" ),
866 'customcssjsprotected' => array( 'code' => 'customcssjsprotected', 'info' => "You're not allowed to edit custom CSS and JavaScript pages" ),
867 'cascadeprotected' => array( 'code' => 'cascadeprotected', 'info' => "The page you're trying to edit is protected because it's included in a cascade-protected page" ),
868 'protectedpagetext' => array( 'code' => 'protectedpage', 'info' => "The ``\$1'' right is required to edit this page" ),
869 'protect-cantedit' => array( 'code' => 'cantedit', 'info' => "You can't protect this page because you can't edit it" ),
870 'badaccess-group0' => array( 'code' => 'permissiondenied', 'info' => "Permission denied" ), // Generic permission denied message
871 'badaccess-groups' => array( 'code' => 'permissiondenied', 'info' => "Permission denied" ),
872 'titleprotected' => array( 'code' => 'protectedtitle', 'info' => "This title has been protected from creation" ),
873 'nocreate-loggedin' => array( 'code' => 'cantcreate', 'info' => "You don't have permission to create new pages" ),
874 'nocreatetext' => array( 'code' => 'cantcreate-anon', 'info' => "Anonymous users can't create new pages" ),
875 'movenologintext' => array( 'code' => 'cantmove-anon', 'info' => "Anonymous users can't move pages" ),
876 'movenotallowed' => array( 'code' => 'cantmove', 'info' => "You don't have permission to move pages" ),
877 'confirmedittext' => array( 'code' => 'confirmemail', 'info' => "You must confirm your e-mail address before you can edit" ),
878 'blockedtext' => array( 'code' => 'blocked', 'info' => "You have been blocked from editing" ),
879 'autoblockedtext' => array( 'code' => 'autoblocked', 'info' => "Your IP address has been blocked automatically, because it was used by a blocked user" ),
881 // Miscellaneous interface messages
882 'actionthrottledtext' => array( 'code' => 'ratelimited', 'info' => "You've exceeded your rate limit. Please wait some time and try again" ),
883 'alreadyrolled' => array( 'code' => 'alreadyrolled', 'info' => "The page you tried to rollback was already rolled back" ),
884 'cantrollback' => array( 'code' => 'onlyauthor', 'info' => "The page you tried to rollback only has one author" ),
885 'readonlytext' => array( 'code' => 'readonly', 'info' => "The wiki is currently in read-only mode" ),
886 'sessionfailure' => array( 'code' => 'badtoken', 'info' => "Invalid token" ),
887 'cannotdelete' => array( 'code' => 'cantdelete', 'info' => "Couldn't delete ``\$1''. Maybe it was deleted already by someone else" ),
888 'notanarticle' => array( 'code' => 'missingtitle', 'info' => "The page you requested doesn't exist" ),
889 'selfmove' => array( 'code' => 'selfmove', 'info' => "Can't move a page to itself" ),
890 'immobile_namespace' => array( 'code' => 'immobilenamespace', 'info' => "You tried to move pages from or to a namespace that is protected from moving" ),
891 'articleexists' => array( 'code' => 'articleexists', 'info' => "The destination article already exists and is not a redirect to the source article" ),
892 'protectedpage' => array( 'code' => 'protectedpage', 'info' => "You don't have permission to perform this move" ),
893 'hookaborted' => array( 'code' => 'hookaborted', 'info' => "The modification you tried to make was aborted by an extension hook" ),
894 'cantmove-titleprotected' => array( 'code' => 'protectedtitle', 'info' => "The destination article has been protected from creation" ),
895 'imagenocrossnamespace' => array( 'code' => 'nonfilenamespace', 'info' => "Can't move a file to a non-file namespace" ),
896 'imagetypemismatch' => array( 'code' => 'filetypemismatch', 'info' => "The new file extension doesn't match its type" ),
897 // 'badarticleerror' => shouldn't happen
898 // 'badtitletext' => shouldn't happen
899 'ip_range_invalid' => array( 'code' => 'invalidrange', 'info' => "Invalid IP range" ),
900 'range_block_disabled' => array( 'code' => 'rangedisabled', 'info' => "Blocking IP ranges has been disabled" ),
901 'nosuchusershort' => array( 'code' => 'nosuchuser', 'info' => "The user you specified doesn't exist" ),
902 'badipaddress' => array( 'code' => 'invalidip', 'info' => "Invalid IP address specified" ),
903 'ipb_expiry_invalid' => array( 'code' => 'invalidexpiry', 'info' => "Invalid expiry time" ),
904 'ipb_already_blocked' => array( 'code' => 'alreadyblocked', 'info' => "The user you tried to block was already blocked" ),
905 '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." ),
906 'ipb_cant_unblock' => array( 'code' => 'cantunblock', 'info' => "The block you specified was not found. It may have been unblocked already" ),
907 '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" ),
908 'ipbblocked' => array( 'code' => 'ipbblocked', 'info' => 'You cannot block or unblock users while you are yourself blocked' ),
909 'ipbnounblockself' => array( 'code' => 'ipbnounblockself', 'info' => 'You are not allowed to unblock yourself' ),
910 'usermaildisabled' => array( 'code' => 'usermaildisabled', 'info' => "User email has been disabled" ),
911 'blockedemailuser' => array( 'code' => 'blockedfrommail', 'info' => "You have been blocked from sending e-mail" ),
912 'notarget' => array( 'code' => 'notarget', 'info' => "You have not specified a valid target for this action" ),
913 '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" ),
914 'rcpatroldisabled' => array( 'code' => 'patroldisabled', 'info' => "Patrolling is disabled on this wiki" ),
915 'markedaspatrollederror-noautopatrol' => array( 'code' => 'noautopatrol', 'info' => "You don't have permission to patrol your own changes" ),
916 'delete-toobig' => array( 'code' => 'bigdelete', 'info' => "You can't delete this page because it has more than \$1 revisions" ),
917 'movenotallowedfile' => array( 'code' => 'cantmovefile', 'info' => "You don't have permission to move files" ),
918 'userrights-no-interwiki' => array( 'code' => 'nointerwikiuserrights', 'info' => "You don't have permission to change user rights on other wikis" ),
919 'userrights-nodatabase' => array( 'code' => 'nosuchdatabase', 'info' => "Database ``\$1'' does not exist or is not local" ),
920 'nouserspecified' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
921 'noname' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
922 'summaryrequired' => array( 'code' => 'summaryrequired', 'info' => 'Summary required' ),
924 // API-specific messages
925 'readrequired' => array( 'code' => 'readapidenied', 'info' => "You need read permission to use this module" ),
926 '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" ),
927 'writerequired' => array( 'code' => 'writeapidenied', 'info' => "You're not allowed to edit this wiki through the API" ),
928 'missingparam' => array( 'code' => 'no$1', 'info' => "The \$1 parameter must be set" ),
929 'invalidtitle' => array( 'code' => 'invalidtitle', 'info' => "Bad title ``\$1''" ),
930 'nosuchpageid' => array( 'code' => 'nosuchpageid', 'info' => "There is no page with ID \$1" ),
931 'nosuchrevid' => array( 'code' => 'nosuchrevid', 'info' => "There is no revision with ID \$1" ),
932 'nosuchuser' => array( 'code' => 'nosuchuser', 'info' => "User ``\$1'' doesn't exist" ),
933 'invaliduser' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
934 'invalidexpiry' => array( 'code' => 'invalidexpiry', 'info' => "Invalid expiry time ``\$1''" ),
935 'pastexpiry' => array( 'code' => 'pastexpiry', 'info' => "Expiry time ``\$1'' is in the past" ),
936 'create-titleexists' => array( 'code' => 'create-titleexists', 'info' => "Existing titles can't be protected with 'create'" ),
937 'missingtitle-createonly' => array( 'code' => 'missingtitle-createonly', 'info' => "Missing titles can only be protected with 'create'" ),
938 'cantblock' => array( 'code' => 'cantblock', 'info' => "You don't have permission to block users" ),
939 'canthide' => array( 'code' => 'canthide', 'info' => "You don't have permission to hide user names from the block log" ),
940 'cantblock-email' => array( 'code' => 'cantblock-email', 'info' => "You don't have permission to block users from sending e-mail through the wiki" ),
941 'unblock-notarget' => array( 'code' => 'notarget', 'info' => "Either the id or the user parameter must be set" ),
942 'unblock-idanduser' => array( 'code' => 'idanduser', 'info' => "The id and user parameters can't be used together" ),
943 'cantunblock' => array( 'code' => 'permissiondenied', 'info' => "You don't have permission to unblock users" ),
944 'cannotundelete' => array( 'code' => 'cantundelete', 'info' => "Couldn't undelete: the requested revisions may not exist, or may have been undeleted already" ),
945 'permdenied-undelete' => array( 'code' => 'permissiondenied', 'info' => "You don't have permission to restore deleted revisions" ),
946 'createonly-exists' => array( 'code' => 'articleexists', 'info' => "The article you tried to create has been created already" ),
947 'nocreate-missing' => array( 'code' => 'missingtitle', 'info' => "The article you tried to edit doesn't exist" ),
948 'nosuchrcid' => array( 'code' => 'nosuchrcid', 'info' => "There is no change with rcid ``\$1''" ),
949 'cantpurge' => array( 'code' => 'cantpurge', 'info' => "Only users with the 'purge' right can purge pages via the API" ),
950 'protect-invalidaction' => array( 'code' => 'protect-invalidaction', 'info' => "Invalid protection type ``\$1''" ),
951 'protect-invalidlevel' => array( 'code' => 'protect-invalidlevel', 'info' => "Invalid protection level ``\$1''" ),
952 'toofewexpiries' => array( 'code' => 'toofewexpiries', 'info' => "\$1 expiry timestamps were provided where \$2 were needed" ),
953 'cantimport' => array( 'code' => 'cantimport', 'info' => "You don't have permission to import pages" ),
954 'cantimport-upload' => array( 'code' => 'cantimport-upload', 'info' => "You don't have permission to import uploaded pages" ),
955 'nouploadmodule' => array( 'code' => 'nomodule', 'info' => 'No upload module set' ),
956 'importnofile' => array( 'code' => 'nofile', 'info' => "You didn't upload a file" ),
957 'importuploaderrorsize' => array( 'code' => 'filetoobig', 'info' => 'The file you uploaded is bigger than the maximum upload size' ),
958 'importuploaderrorpartial' => array( 'code' => 'partialupload', 'info' => 'The file was only partially uploaded' ),
959 'importuploaderrortemp' => array( 'code' => 'notempdir', 'info' => 'The temporary upload directory is missing' ),
960 'importcantopen' => array( 'code' => 'cantopenfile', 'info' => "Couldn't open the uploaded file" ),
961 'import-noarticle' => array( 'code' => 'badinterwiki', 'info' => 'Invalid interwiki title specified' ),
962 'importbadinterwiki' => array( 'code' => 'badinterwiki', 'info' => 'Invalid interwiki title specified' ),
963 'import-unknownerror' => array( 'code' => 'import-unknownerror', 'info' => "Unknown error on import: ``\$1''" ),
964 'cantoverwrite-sharedfile' => array( 'code' => 'cantoverwrite-sharedfile', 'info' => 'The target file exists on a shared repository and you do not have permission to override it' ),
965 'sharedfile-exists' => array( 'code' => 'fileexists-sharedrepo-perm', 'info' => 'The target file exists on a shared repository. Use the ignorewarnings parameter to override it.' ),
966 'mustbeposted' => array( 'code' => 'mustbeposted', 'info' => "The \$1 module requires a POST request" ),
967 'show' => array( 'code' => 'show', 'info' => 'Incorrect parameter - mutually exclusive values may not be supplied' ),
969 // ApiEditPage messages
970 'noimageredirect-anon' => array( 'code' => 'noimageredirect-anon', 'info' => "Anonymous users can't create image redirects" ),
971 'noimageredirect-logged' => array( 'code' => 'noimageredirect', 'info' => "You don't have permission to create image redirects" ),
972 'spamdetected' => array( 'code' => 'spamdetected', 'info' => "Your edit was refused because it contained a spam fragment: ``\$1''" ),
973 'filtered' => array( 'code' => 'filtered', 'info' => "The filter callback function refused your edit" ),
974 'contenttoobig' => array( 'code' => 'contenttoobig', 'info' => "The content you supplied exceeds the article size limit of \$1 kilobytes" ),
975 'noedit-anon' => array( 'code' => 'noedit-anon', 'info' => "Anonymous users can't edit pages" ),
976 'noedit' => array( 'code' => 'noedit', 'info' => "You don't have permission to edit pages" ),
977 'wasdeleted' => array( 'code' => 'pagedeleted', 'info' => "The page has been deleted since you fetched its timestamp" ),
978 'blankpage' => array( 'code' => 'emptypage', 'info' => "Creating new, empty pages is not allowed" ),
979 'editconflict' => array( 'code' => 'editconflict', 'info' => "Edit conflict detected" ),
980 'hashcheckfailed' => array( 'code' => 'badmd5', 'info' => "The supplied MD5 hash was incorrect" ),
981 'missingtext' => array( 'code' => 'notext', 'info' => "One of the text, appendtext, prependtext and undo parameters must be set" ),
982 'emptynewsection' => array( 'code' => 'emptynewsection', 'info' => 'Creating empty new sections is not possible.' ),
983 'revwrongpage' => array( 'code' => 'revwrongpage', 'info' => "r\$1 is not a revision of ``\$2''" ),
984 'undo-failure' => array( 'code' => 'undofailure', 'info' => 'Undo failed due to conflicting intermediate edits' ),
987 'invalid-session-key' => array( 'code' => 'invalid-session-key', 'info' => 'Not a valid session key' ),
988 'nouploadmodule' => array( 'code' => 'nouploadmodule', 'info' => 'No upload module set' ),
989 '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' ),
990 'copyuploaddisabled' => array( 'code' => 'copyuploaddisabled', 'info' => 'Uploads by URL is not enabled. Make sure $wgAllowCopyUploads is set to true in LocalSettings.php.' ),
994 * Helper function for readonly errors
996 public function dieReadOnly() {
997 $parsed = $this->parseMsg( array( 'readonlytext' ) );
998 $this->dieUsage( $parsed['info'], $parsed['code'], /* http error */ 0,
999 array( 'readonlyreason' => wfReadOnlyReason() ) );
1003 * Output the error message related to a certain array
1004 * @param $error array Element of a getUserPermissionsErrors()-style array
1006 public function dieUsageMsg( $error ) {
1007 $parsed = $this->parseMsg( $error );
1008 $this->dieUsage( $parsed['info'], $parsed['code'] );
1012 * Return the error message related to a certain array
1013 * @param $error array Element of a getUserPermissionsErrors()-style array
1014 * @return array('code' => code, 'info' => info)
1016 public function parseMsg( $error ) {
1017 $key = array_shift( $error );
1018 if ( isset( self
::$messageMap[$key] ) ) {
1019 return array( 'code' =>
1020 wfMsgReplaceArgs( self
::$messageMap[$key]['code'], $error ),
1022 wfMsgReplaceArgs( self
::$messageMap[$key]['info'], $error )
1025 // If the key isn't present, throw an "unknown error"
1026 return $this->parseMsg( array( 'unknownerror', $key ) );
1030 * Internal code errors should be reported with this method
1031 * @param $method string Method or function name
1032 * @param $message string Error message
1034 protected static function dieDebug( $method, $message ) {
1035 wfDebugDieBacktrace( "Internal error in $method: $message" );
1039 * Indicates if this module needs maxlag to be checked
1042 public function shouldCheckMaxlag() {
1047 * Indicates whether this module requires read rights
1050 public function isReadMode() {
1054 * Indicates whether this module requires write mode
1057 public function isWriteMode() {
1062 * Indicates whether this module must be called with a POST request
1065 public function mustBePosted() {
1070 * 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
1073 public function getTokenSalt() {
1078 * Gets the user for whom to get the watchlist
1082 public function getWatchlistUser( $params ) {
1084 if ( !is_null( $params['owner'] ) && !is_null( $params['token'] ) ) {
1085 $user = User
::newFromName( $params['owner'], false );
1086 if ( !$user->getId() ) {
1087 $this->dieUsage( 'Specified user does not exist', 'bad_wlowner' );
1089 $token = $user->getOption( 'watchlisttoken' );
1090 if ( $token == '' ||
$token != $params['token'] ) {
1091 $this->dieUsage( 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences', 'bad_wltoken' );
1094 if ( !$wgUser->isLoggedIn() ) {
1095 $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
1103 * Returns a list of all possible errors returned by the module
1104 * @return array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
1106 public function getPossibleErrors() {
1109 if ( $this->mustBePosted() ) {
1110 $ret[] = array( 'mustbeposted', $this->getModuleName() );
1113 if ( $this->isReadMode() ) {
1114 $ret[] = array( 'readrequired' );
1117 if ( $this->isWriteMode() ) {
1118 $ret[] = array( 'writerequired' );
1119 $ret[] = array( 'writedisabled' );
1122 if ( $this->getTokenSalt() !== false ) {
1123 $ret[] = array( 'missingparam', 'token' );
1124 $ret[] = array( 'sessionfailure' );
1131 * Parses a list of errors into a standardised format
1132 * @param $errors array List of errors. Items can be in the for array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
1133 * @return array Parsed list of errors with items in the form array( 'code' => ..., 'info' => ... )
1135 public function parseErrors( $errors ) {
1138 foreach ( $errors as $row ) {
1139 if ( isset( $row['code'] ) && isset( $row['info'] ) ) {
1142 $ret[] = $this->parseMsg( $row );
1149 * Profiling: total module execution time
1151 private $mTimeIn = 0, $mModuleTime = 0;
1154 * Start module profiling
1156 public function profileIn() {
1157 if ( $this->mTimeIn
!== 0 ) {
1158 ApiBase
::dieDebug( __METHOD__
, 'called twice without calling profileOut()' );
1160 $this->mTimeIn
= microtime( true );
1161 wfProfileIn( $this->getModuleProfileName() );
1165 * End module profiling
1167 public function profileOut() {
1168 if ( $this->mTimeIn
=== 0 ) {
1169 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileIn() first' );
1171 if ( $this->mDBTimeIn
!== 0 ) {
1172 ApiBase
::dieDebug( __METHOD__
, 'must be called after database profiling is done with profileDBOut()' );
1175 $this->mModuleTime +
= microtime( true ) - $this->mTimeIn
;
1177 wfProfileOut( $this->getModuleProfileName() );
1181 * When modules crash, sometimes it is needed to do a profileOut() regardless
1182 * of the profiling state the module was in. This method does such cleanup.
1184 public function safeProfileOut() {
1185 if ( $this->mTimeIn
!== 0 ) {
1186 if ( $this->mDBTimeIn
!== 0 ) {
1187 $this->profileDBOut();
1189 $this->profileOut();
1194 * Total time the module was executed
1197 public function getProfileTime() {
1198 if ( $this->mTimeIn
!== 0 ) {
1199 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileOut() first' );
1201 return $this->mModuleTime
;
1205 * Profiling: database execution time
1207 private $mDBTimeIn = 0, $mDBTime = 0;
1210 * Start module profiling
1212 public function profileDBIn() {
1213 if ( $this->mTimeIn
=== 0 ) {
1214 ApiBase
::dieDebug( __METHOD__
, 'must be called while profiling the entire module with profileIn()' );
1216 if ( $this->mDBTimeIn
!== 0 ) {
1217 ApiBase
::dieDebug( __METHOD__
, 'called twice without calling profileDBOut()' );
1219 $this->mDBTimeIn
= microtime( true );
1220 wfProfileIn( $this->getModuleProfileName( true ) );
1224 * End database profiling
1226 public function profileDBOut() {
1227 if ( $this->mTimeIn
=== 0 ) {
1228 ApiBase
::dieDebug( __METHOD__
, 'must be called while profiling the entire module with profileIn()' );
1230 if ( $this->mDBTimeIn
=== 0 ) {
1231 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileDBIn() first' );
1234 $time = microtime( true ) - $this->mDBTimeIn
;
1235 $this->mDBTimeIn
= 0;
1237 $this->mDBTime +
= $time;
1238 $this->getMain()->mDBTime +
= $time;
1239 wfProfileOut( $this->getModuleProfileName( true ) );
1243 * Total time the module used the database
1246 public function getProfileDBTime() {
1247 if ( $this->mDBTimeIn
!== 0 ) {
1248 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileDBOut() first' );
1250 return $this->mDBTime
;
1254 * Debugging function that prints a value and an optional backtrace
1255 * @param $value mixed Value to print
1256 * @param $name string Description of the printed value
1257 * @param $backtrace bool If true, print a backtrace
1259 public static function debugPrint( $value, $name = 'unknown', $backtrace = false ) {
1260 print "\n\n<pre><b>Debugging value '$name':</b>\n\n";
1261 var_export( $value );
1263 print "\n" . wfBacktrace();
1269 * Returns a string that identifies the version of this class.
1272 public static function getBaseVersion() {
1273 return __CLASS__
. ': $Id$';