5 * Created on Sep 5, 2006
7 * Copyright © 2006, 2010 Yuri Astrakhan <Firstname><Lastname>@gmail.com
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
28 * This abstract class implements many basic API functions, and is the base of
30 * The class functions are divided into several areas of functionality:
32 * Module parameters: Derived classes can define getAllowedParams() to specify
33 * which parameters to expect, how to parse and validate them.
35 * Profiling: various methods to allow keeping tabs on various tasks and their
38 * Self-documentation: code to allow the API to document its own state
42 abstract class ApiBase
{
44 // These constants allow modules to specify exactly how to treat incoming parameters.
46 const PARAM_DFLT
= 0; // Default value of the parameter
47 const PARAM_ISMULTI
= 1; // Boolean, do we accept more than one item for this parameter (e.g.: titles)?
48 const PARAM_TYPE
= 2; // Can be either a string type (e.g.: 'integer') or an array of allowed values
49 const PARAM_MAX
= 3; // Max value allowed for a parameter. Only applies if TYPE='integer'
50 const PARAM_MAX2
= 4; // Max value allowed for a parameter for bots and sysops. Only applies if TYPE='integer'
51 const PARAM_MIN
= 5; // Lowest value allowed for a parameter. Only applies if TYPE='integer'
52 const PARAM_ALLOW_DUPLICATES
= 6; // Boolean, do we allow the same value to be set more than once when ISMULTI=true
53 const PARAM_DEPRECATED
= 7; // Boolean, is the parameter deprecated (will show a warning)
54 const PARAM_REQUIRED
= 8; // Boolean, is the parameter required?
55 const PARAM_RANGE_ENFORCE
= 9; // Boolean, if MIN/MAX are set, enforce (die) these? Only applies if TYPE='integer' Use with extreme caution
57 const LIMIT_BIG1
= 500; // Fast query, std user limit
58 const LIMIT_BIG2
= 5000; // Fast query, bot/sysop limit
59 const LIMIT_SML1
= 50; // Slow query, std user limit
60 const LIMIT_SML2
= 500; // Slow query, bot/sysop limit
62 private $mMainModule, $mModuleName, $mModulePrefix;
63 private $mParamCache = array();
67 * @param $mainModule ApiMain object
68 * @param $moduleName string Name of this module
69 * @param $modulePrefix string Prefix to use for parameter names
71 public function __construct( $mainModule, $moduleName, $modulePrefix = '' ) {
72 $this->mMainModule
= $mainModule;
73 $this->mModuleName
= $moduleName;
74 $this->mModulePrefix
= $modulePrefix;
77 /*****************************************************************************
79 *****************************************************************************/
82 * Evaluates the parameters, performs the requested query, and sets up
83 * the result. Concrete implementations of ApiBase must override this
84 * method to provide whatever functionality their module offers.
85 * Implementations must not produce any output on their own and are not
86 * expected to handle any errors.
88 * The execute() method will be invoked directly by ApiMain immediately
89 * before the result of the module is output. Aside from the
90 * constructor, implementations should assume that no other methods
91 * will be called externally on the module before the result is
94 * The result data should be stored in the ApiResult object available
95 * through getResult().
97 public abstract function execute();
100 * Returns a string that identifies the version of the extending class.
101 * Typically includes the class name, the svn revision, timestamp, and
102 * last author. Usually done with SVN's Id keyword
105 public abstract function getVersion();
108 * Get the name of the module being executed by this instance
111 public function getModuleName() {
112 return $this->mModuleName
;
116 * Get parameter prefix (usually two letters or an empty string).
119 public function getModulePrefix() {
120 return $this->mModulePrefix
;
124 * Get the name of the module as shown in the profiler log
126 * @param $db DatabaseBase
130 public function getModuleProfileName( $db = false ) {
132 return 'API:' . $this->mModuleName
. '-DB';
134 return 'API:' . $this->mModuleName
;
139 * Get the main module
140 * @return ApiMain object
142 public function getMain() {
143 return $this->mMainModule
;
147 * Returns true if this module is the main module ($this === $this->mMainModule),
151 public function isMain() {
152 return $this === $this->mMainModule
;
156 * Get the result object
159 public function getResult() {
160 // Main module has getResult() method overriden
161 // Safety - avoid infinite loop:
162 if ( $this->isMain() ) {
163 ApiBase
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
165 return $this->getMain()->getResult();
169 * Get the result data array (read-only)
172 public function getResultData() {
173 return $this->getResult()->getData();
177 * Create a new RequestContext object to use e.g. for calls to other parts
179 * The object will have the WebRequest and the User object set to the ones
180 * used in this instance.
182 * @return RequestContext
184 public function createContext() {
187 $context = new RequestContext
;
188 $context->setRequest( $this->getMain()->getRequest() );
189 $context->setUser( $wgUser ); /// @todo FIXME: we should store the User object
195 * Set warning section for this module. Users should monitor this
196 * section to notice any changes in API. Multiple calls to this
197 * function will result in the warning messages being separated by
199 * @param $warning string Warning message
201 public function setWarning( $warning ) {
202 $result = $this->getResult();
203 $data = $result->getData();
204 if ( isset( $data['warnings'][$this->getModuleName()] ) ) {
205 // Don't add duplicate warnings
206 $warn_regex = preg_quote( $warning, '/' );
207 if ( preg_match( "/{$warn_regex}(\\n|$)/", $data['warnings'][$this->getModuleName()]['*'] ) ) {
210 $oldwarning = $data['warnings'][$this->getModuleName()]['*'];
211 // If there is a warning already, append it to the existing one
212 $warning = "$oldwarning\n$warning";
213 $result->unsetValue( 'warnings', $this->getModuleName() );
216 ApiResult
::setContent( $msg, $warning );
217 $result->disableSizeCheck();
218 $result->addValue( 'warnings', $this->getModuleName(), $msg );
219 $result->enableSizeCheck();
223 * If the module may only be used with a certain format module,
224 * it should override this method to return an instance of that formatter.
225 * A value of null means the default format will be used.
226 * @return mixed instance of a derived class of ApiFormatBase, or null
228 public function getCustomPrinter() {
233 * Generates help message for this module, or false if there is no description
234 * @return mixed string or false
236 public function makeHelpMsg() {
237 static $lnPrfx = "\n ";
239 $msg = $this->getDescription();
241 if ( $msg !== false ) {
243 if ( !is_array( $msg ) ) {
248 $msg = $lnPrfx . implode( $lnPrfx, $msg ) . "\n";
250 if ( $this->isReadMode() ) {
251 $msg .= "\nThis module requires read rights";
253 if ( $this->isWriteMode() ) {
254 $msg .= "\nThis module requires write rights";
256 if ( $this->mustBePosted() ) {
257 $msg .= "\nThis module only accepts POST requests";
259 if ( $this->isReadMode() ||
$this->isWriteMode() ||
260 $this->mustBePosted() ) {
265 $paramsMsg = $this->makeHelpMsgParameters();
266 if ( $paramsMsg !== false ) {
267 $msg .= "Parameters:\n$paramsMsg";
270 $msg .= $this->makeHelpArrayToString( $lnPrfx, "Example", $this->getExamples() );
271 $msg .= $this->makeHelpArrayToString( $lnPrfx, "Help page", $this->getHelpUrl() );
273 if ( $this->getMain()->getShowVersions() ) {
274 $versions = $this->getVersion();
275 $pattern = '/(\$.*) ([0-9a-z_]+\.php) (.*\$)/i';
276 $callback = array( $this, 'makeHelpMsg_callback' );
278 if ( is_array( $versions ) ) {
279 foreach ( $versions as &$v ) {
280 $v = preg_replace_callback( $pattern, $callback, $v );
282 $versions = implode( "\n ", $versions );
284 $versions = preg_replace_callback( $pattern, $callback, $versions );
287 $msg .= "Version:\n $versions\n";
295 * @param $prefix string Text to split output items
296 * @param $title string What is being output
297 * @param $input string|array
300 protected function makeHelpArrayToString( $prefix, $title, $input ) {
301 if ( $input !== false ) {
304 if ( !is_array( $input ) ) {
310 if ( count( $input ) > 0 ) {
311 $msg = $title . ( count( $input ) > 1 ?
's' : '' ) . ":\n ";
312 $msg .= implode( $prefix, $input ) . "\n";
319 * Generates the parameter descriptions for this module, to be displayed in the
321 * @return string or false
323 public function makeHelpMsgParameters() {
324 $params = $this->getFinalParams();
327 $paramsDescription = $this->getFinalParamDescription();
329 $paramPrefix = "\n" . str_repeat( ' ', 24 );
330 $descWordwrap = "\n" . str_repeat( ' ', 28 );
331 foreach ( $params as $paramName => $paramSettings ) {
332 $desc = isset( $paramsDescription[$paramName] ) ?
$paramsDescription[$paramName] : '';
333 if ( is_array( $desc ) ) {
334 $desc = implode( $paramPrefix, $desc );
337 if ( !is_array( $paramSettings ) ) {
338 $paramSettings = array(
339 self
::PARAM_DFLT
=> $paramSettings,
343 $deprecated = isset( $paramSettings[self
::PARAM_DEPRECATED
] ) ?
344 $paramSettings[self
::PARAM_DEPRECATED
] : false;
346 $desc = "DEPRECATED! $desc";
349 $required = isset( $paramSettings[self
::PARAM_REQUIRED
] ) ?
350 $paramSettings[self
::PARAM_REQUIRED
] : false;
352 $desc .= $paramPrefix . "This parameter is required";
355 $type = isset( $paramSettings[self
::PARAM_TYPE
] ) ?
$paramSettings[self
::PARAM_TYPE
] : null;
356 if ( isset( $type ) ) {
357 if ( isset( $paramSettings[self
::PARAM_ISMULTI
] ) ) {
358 $prompt = 'Values (separate with \'|\'): ';
360 $prompt = 'One value: ';
363 if ( is_array( $type ) ) {
365 $nothingPrompt = false;
366 foreach ( $type as $t ) {
368 $nothingPrompt = 'Can be empty, or ';
373 $desc .= $paramPrefix . $nothingPrompt . $prompt;
374 $choicesstring = implode( ', ', $choices );
375 $desc .= wordwrap( $choicesstring, 100, $descWordwrap );
379 // Special handling because namespaces are type-limited, yet they are not given
380 $desc .= $paramPrefix . $prompt;
381 $desc .= wordwrap( implode( ', ', MWNamespace
::getValidNamespaces() ),
382 100, $descWordwrap );
385 $desc .= $paramPrefix . "No more than {$paramSettings[self :: PARAM_MAX]}";
386 if ( isset( $paramSettings[self
::PARAM_MAX2
] ) ) {
387 $desc .= " ({$paramSettings[self::PARAM_MAX2]} for bots)";
392 $hasMin = isset( $paramSettings[self
::PARAM_MIN
] );
393 $hasMax = isset( $paramSettings[self
::PARAM_MAX
] );
394 if ( $hasMin ||
$hasMax ) {
396 $intRangeStr = "The value must be no less than {$paramSettings[self::PARAM_MIN]}";
397 } elseif ( !$hasMin ) {
398 $intRangeStr = "The value must be no more than {$paramSettings[self::PARAM_MAX]}";
400 $intRangeStr = "The value must be between {$paramSettings[self::PARAM_MIN]} and {$paramSettings[self::PARAM_MAX]}";
403 $desc .= $paramPrefix . $intRangeStr;
408 if ( isset( $paramSettings[self
::PARAM_ISMULTI
] ) ) {
409 $isArray = is_array( $paramSettings[self
::PARAM_TYPE
] );
412 ||
$isArray && count( $paramSettings[self
::PARAM_TYPE
] ) > self
::LIMIT_SML1
) {
413 $desc .= $paramPrefix . "Maximum number of values " .
414 self
::LIMIT_SML1
. " (" . self
::LIMIT_SML2
. " for bots)";
420 $default = is_array( $paramSettings )
421 ?
( isset( $paramSettings[self
::PARAM_DFLT
] ) ?
$paramSettings[self
::PARAM_DFLT
] : null )
423 if ( !is_null( $default ) && $default !== false ) {
424 $desc .= $paramPrefix . "Default: $default";
427 $msg .= sprintf( " %-19s - %s\n", $this->encodeParamName( $paramName ), $desc );
437 * Callback for preg_replace_callback() call in makeHelpMsg().
438 * Replaces a source file name with a link to ViewVC
442 public function makeHelpMsg_callback( $matches ) {
443 global $wgAutoloadClasses, $wgAutoloadLocalClasses;
446 if ( isset( $wgAutoloadLocalClasses[get_class( $this )] ) ) {
447 $file = $wgAutoloadLocalClasses[get_class( $this )];
448 } elseif ( isset( $wgAutoloadClasses[get_class( $this )] ) ) {
449 $file = $wgAutoloadClasses[get_class( $this )];
452 // Do some guesswork here
453 $path = strstr( $file, 'includes/api/' );
454 if ( $path === false ) {
455 $path = strstr( $file, 'extensions/' );
457 $path = 'phase3/' . $path;
460 // Get the filename from $matches[2] instead of $file
461 // If they're not the same file, they're assumed to be in the
463 // This is necessary to make stuff like ApiMain::getVersion()
464 // returning the version string for ApiBase work
466 return "{$matches[0]}\n http://svn.wikimedia.org/" .
467 "viewvc/mediawiki/trunk/" . dirname( $path ) .
474 * Returns the description string for this module
475 * @return mixed string or array of strings
477 protected function getDescription() {
482 * Returns usage examples for this module. Return false if no examples are available.
483 * @return false|string|array
485 protected function getExamples() {
490 * Returns an array of allowed parameters (parameter name) => (default
491 * value) or (parameter name) => (array with PARAM_* constants as keys)
492 * Don't call this function directly: use getFinalParams() to allow
493 * hooks to modify parameters as needed.
494 * @return array or false
496 protected function getAllowedParams() {
501 * Returns an array of parameter descriptions.
502 * Don't call this functon directly: use getFinalParamDescription() to
503 * allow hooks to modify descriptions as needed.
504 * @return array or false
506 protected function getParamDescription() {
511 * Get final list of parameters, after hooks have had a chance to
512 * tweak it as needed.
513 * @return array or false
515 public function getFinalParams() {
516 $params = $this->getAllowedParams();
517 wfRunHooks( 'APIGetAllowedParams', array( &$this, &$params ) );
522 * Get final description, after hooks have had a chance to tweak it as
526 public function getFinalParamDescription() {
527 $desc = $this->getParamDescription();
528 wfRunHooks( 'APIGetParamDescription', array( &$this, &$desc ) );
533 * This method mangles parameter name based on the prefix supplied to the constructor.
534 * Override this method to change parameter name during runtime
535 * @param $paramName string Parameter name
536 * @return string Prefixed parameter name
538 public function encodeParamName( $paramName ) {
539 return $this->mModulePrefix
. $paramName;
543 * Using getAllowedParams(), this function makes an array of the values
544 * provided by the user, with key being the name of the variable, and
545 * value - validated value from user or default. limits will not be
546 * parsed if $parseLimit is set to false; use this when the max
547 * limit is not definitive yet, e.g. when getting revisions.
548 * @param $parseLimit Boolean: true by default
551 public function extractRequestParams( $parseLimit = true ) {
552 // Cache parameters, for performance and to avoid bug 24564.
553 if ( !isset( $this->mParamCache
[$parseLimit] ) ) {
554 $params = $this->getFinalParams();
557 if ( $params ) { // getFinalParams() can return false
558 foreach ( $params as $paramName => $paramSettings ) {
559 $results[$paramName] = $this->getParameterFromSettings(
560 $paramName, $paramSettings, $parseLimit );
563 $this->mParamCache
[$parseLimit] = $results;
565 return $this->mParamCache
[$parseLimit];
569 * Get a value for the given parameter
570 * @param $paramName string Parameter name
571 * @param $parseLimit bool see extractRequestParams()
572 * @return mixed Parameter value
574 protected function getParameter( $paramName, $parseLimit = true ) {
575 $params = $this->getFinalParams();
576 $paramSettings = $params[$paramName];
577 return $this->getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
581 * Die if none or more than one of a certain set of parameters is set and not false.
582 * @param $params array of parameter names
584 public function requireOnlyOneParameter( $params ) {
585 $required = func_get_args();
586 array_shift( $required );
588 $intersection = array_intersect( array_keys( array_filter( $params,
589 array( $this, "parameterNotEmpty" ) ) ), $required );
591 if ( count( $intersection ) > 1 ) {
592 $this->dieUsage( 'The parameters ' . implode( ', ', $intersection ) . ' can not be used together', 'invalidparammix' );
593 } elseif ( count( $intersection ) == 0 ) {
594 $this->dieUsage( 'One of the parameters ' . implode( ', ', $required ) . ' is required', 'missingparam' );
599 * Generates the possible errors requireOnlyOneParameter() can die with
601 * @param $params array
604 public function getRequireOnlyOneParameterErrorMessages( $params ) {
605 $p = $this->getModulePrefix();
606 $params = implode( ", {$p}", $params );
609 array( 'code' => "{$p}missingparam", 'info' => "One of the parameters {$p}{$params} is required" ),
610 array( 'code' => "{$p}invalidparammix", 'info' => "The parameters {$p}{$params} can not be used together" )
615 * Die if more than one of a certain set of parameters is set and not false.
617 * @param $params array
619 public function requireMaxOneParameter( $params ) {
620 $required = func_get_args();
621 array_shift( $required );
623 $intersection = array_intersect( array_keys( array_filter( $params,
624 array( $this, "parameterNotEmpty" ) ) ), $required );
626 if ( count( $intersection ) > 1 ) {
627 $this->dieUsage( 'The parameters ' . implode( ', ', $intersection ) . ' can not be used together', 'invalidparammix' );
632 * Generates the possible error requireMaxOneParameter() can die with
634 * @param $params array
637 public function getRequireMaxOneParameterErrorMessages( $params ) {
638 $p = $this->getModulePrefix();
639 $params = implode( ", {$p}", $params );
642 array( 'code' => "{$p}invalidparammix", 'info' => "The parameters {$p}{$params} can not be used together" )
647 * Callback function used in requireOnlyOneParameter to check whether reequired parameters are set
649 * @param $x object Parameter to check is not null/false
652 private function parameterNotEmpty( $x ) {
653 return !is_null( $x ) && $x !== false;
657 * @deprecated since 1.17 use MWNamespace::getValidNamespaces()
659 public static function getValidNamespaces() {
660 return MWNamespace
::getValidNamespaces();
664 * Return true if we're to watch the page, false if not, null if no change.
665 * @param $watchlist String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
666 * @param $titleObj Title the page under consideration
667 * @param $userOption String The user option to consider when $watchlist=preferences.
668 * If not set will magically default to either watchdefault or watchcreations
671 protected function getWatchlistValue ( $watchlist, $titleObj, $userOption = null ) {
673 $userWatching = $titleObj->userIsWatching();
676 switch ( $watchlist ) {
684 # If the user is already watching, don't bother checking
685 if ( $userWatching ) {
688 # If no user option was passed, use watchdefault or watchcreation
689 if ( is_null( $userOption ) ) {
690 $userOption = $titleObj->exists()
691 ?
'watchdefault' : 'watchcreations';
693 # Watch the article based on the user preference
694 return (bool)$wgUser->getOption( $userOption );
697 return $userWatching;
700 return $userWatching;
705 * Set a watch (or unwatch) based the based on a watchlist parameter.
706 * @param $watch String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
707 * @param $titleObj Title the article's title to change
708 * @param $userOption String The user option to consider when $watch=preferences
710 protected function setWatch( $watch, $titleObj, $userOption = null ) {
711 $value = $this->getWatchlistValue( $watch, $titleObj, $userOption );
712 if ( $value === null ) {
718 WatchAction
::doWatch( $titleObj, $wgUser );
720 WatchAction
::doUnwatch( $titleObj, $wgUser );
725 * Using the settings determine the value for the given parameter
727 * @param $paramName String: parameter name
728 * @param $paramSettings Mixed: default value or an array of settings
729 * using PARAM_* constants.
730 * @param $parseLimit Boolean: parse limit?
731 * @return mixed Parameter value
733 protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
734 // Some classes may decide to change parameter names
735 $encParamName = $this->encodeParamName( $paramName );
737 if ( !is_array( $paramSettings ) ) {
738 $default = $paramSettings;
740 $type = gettype( $paramSettings );
745 $default = isset( $paramSettings[self
::PARAM_DFLT
] ) ?
$paramSettings[self
::PARAM_DFLT
] : null;
746 $multi = isset( $paramSettings[self
::PARAM_ISMULTI
] ) ?
$paramSettings[self
::PARAM_ISMULTI
] : false;
747 $type = isset( $paramSettings[self
::PARAM_TYPE
] ) ?
$paramSettings[self
::PARAM_TYPE
] : null;
748 $dupes = isset( $paramSettings[self
::PARAM_ALLOW_DUPLICATES
] ) ?
$paramSettings[self
::PARAM_ALLOW_DUPLICATES
] : false;
749 $deprecated = isset( $paramSettings[self
::PARAM_DEPRECATED
] ) ?
$paramSettings[self
::PARAM_DEPRECATED
] : false;
750 $required = isset( $paramSettings[self
::PARAM_REQUIRED
] ) ?
$paramSettings[self
::PARAM_REQUIRED
] : false;
752 // When type is not given, and no choices, the type is the same as $default
753 if ( !isset( $type ) ) {
754 if ( isset( $default ) ) {
755 $type = gettype( $default );
757 $type = 'NULL'; // allow everything
762 if ( $type == 'boolean' ) {
763 if ( isset( $default ) && $default !== false ) {
764 // Having a default value of anything other than 'false' is pointless
765 ApiBase
::dieDebug( __METHOD__
, "Boolean param $encParamName's default is set to '$default'" );
768 $value = $this->getMain()->getRequest()->getCheck( $encParamName );
770 $value = $this->getMain()->getRequest()->getVal( $encParamName, $default );
772 if ( isset( $value ) && $type == 'namespace' ) {
773 $type = MWNamespace
::getValidNamespaces();
777 if ( isset( $value ) && ( $multi ||
is_array( $type ) ) ) {
778 $value = $this->parseMultiValue( $encParamName, $value, $multi, is_array( $type ) ?
$type : null );
781 // More validation only when choices were not given
782 // choices were validated in parseMultiValue()
783 if ( isset( $value ) ) {
784 if ( !is_array( $type ) ) {
786 case 'NULL': // nothing to do
789 if ( $required && $value === '' ) {
790 $this->dieUsageMsg( array( 'missingparam', $paramName ) );
794 case 'integer': // Force everything using intval() and optionally validate limits
795 $min = isset ( $paramSettings[self
::PARAM_MIN
] ) ?
$paramSettings[self
::PARAM_MIN
] : null;
796 $max = isset ( $paramSettings[self
::PARAM_MAX
] ) ?
$paramSettings[self
::PARAM_MAX
] : null;
797 $enforceLimits = isset ( $paramSettings[self
::PARAM_RANGE_ENFORCE
] )
798 ?
$paramSettings[self
::PARAM_RANGE_ENFORCE
] : false;
800 if ( is_array( $value ) ) {
801 $value = array_map( 'intval', $value );
802 if ( !is_null( $min ) ||
!is_null( $max ) ) {
803 foreach ( $value as &$v ) {
804 $this->validateLimit( $paramName, $v, $min, $max, null, $enforceLimits );
808 $value = intval( $value );
809 if ( !is_null( $min ) ||
!is_null( $max ) ) {
810 $this->validateLimit( $paramName, $value, $min, $max, null, $enforceLimits );
815 if ( !$parseLimit ) {
816 // Don't do any validation whatsoever
819 if ( !isset( $paramSettings[self
::PARAM_MAX
] ) ||
!isset( $paramSettings[self
::PARAM_MAX2
] ) ) {
820 ApiBase
::dieDebug( __METHOD__
, "MAX1 or MAX2 are not defined for the limit $encParamName" );
823 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
825 $min = isset( $paramSettings[self
::PARAM_MIN
] ) ?
$paramSettings[self
::PARAM_MIN
] : 0;
826 if ( $value == 'max' ) {
827 $value = $this->getMain()->canApiHighLimits() ?
$paramSettings[self
::PARAM_MAX2
] : $paramSettings[self
::PARAM_MAX
];
828 $this->getResult()->setParsedLimit( $this->getModuleName(), $value );
830 $value = intval( $value );
831 $this->validateLimit( $paramName, $value, $min, $paramSettings[self
::PARAM_MAX
], $paramSettings[self
::PARAM_MAX2
] );
836 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
840 if ( is_array( $value ) ) {
841 foreach ( $value as $key => $val ) {
842 $value[$key] = $this->validateTimestamp( $val, $encParamName );
845 $value = $this->validateTimestamp( $value, $encParamName );
849 if ( !is_array( $value ) ) {
850 $value = array( $value );
853 foreach ( $value as $key => $val ) {
854 $title = Title
::makeTitleSafe( NS_USER
, $val );
855 if ( is_null( $title ) ) {
856 $this->dieUsage( "Invalid value for user parameter $encParamName", "baduser_{$encParamName}" );
858 $value[$key] = $title->getText();
866 ApiBase
::dieDebug( __METHOD__
, "Param $encParamName's type is unknown - $type" );
870 // Throw out duplicates if requested
871 if ( is_array( $value ) && !$dupes ) {
872 $value = array_unique( $value );
875 // Set a warning if a deprecated parameter has been passed
876 if ( $deprecated && $value !== false ) {
877 $this->setWarning( "The $encParamName parameter has been deprecated." );
879 } elseif ( $required ) {
880 $this->dieUsageMsg( array( 'missingparam', $paramName ) );
887 * Return an array of values that were given in a 'a|b|c' notation,
888 * after it optionally validates them against the list allowed values.
890 * @param $valueName string The name of the parameter (for error
892 * @param $value mixed The value being parsed
893 * @param $allowMultiple bool Can $value contain more than one value
895 * @param $allowedValues mixed An array of values to check against. If
896 * null, all values are accepted.
897 * @return mixed (allowMultiple ? an_array_of_values : a_single_value)
899 protected function parseMultiValue( $valueName, $value, $allowMultiple, $allowedValues ) {
900 if ( trim( $value ) === '' && $allowMultiple ) {
904 // This is a bit awkward, but we want to avoid calling canApiHighLimits() because it unstubs $wgUser
905 $valuesList = explode( '|', $value, self
::LIMIT_SML2 +
1 );
906 $sizeLimit = count( $valuesList ) > self
::LIMIT_SML1
&& $this->mMainModule
->canApiHighLimits() ?
907 self
::LIMIT_SML2
: self
::LIMIT_SML1
;
909 if ( self
::truncateArray( $valuesList, $sizeLimit ) ) {
910 $this->setWarning( "Too many values supplied for parameter '$valueName': the limit is $sizeLimit" );
913 if ( !$allowMultiple && count( $valuesList ) != 1 ) {
914 $possibleValues = is_array( $allowedValues ) ?
"of '" . implode( "', '", $allowedValues ) . "'" : '';
915 $this->dieUsage( "Only one $possibleValues is allowed for parameter '$valueName'", "multival_$valueName" );
918 if ( is_array( $allowedValues ) ) {
919 // Check for unknown values
920 $unknown = array_diff( $valuesList, $allowedValues );
921 if ( count( $unknown ) ) {
922 if ( $allowMultiple ) {
923 $s = count( $unknown ) > 1 ?
's' : '';
924 $vals = implode( ", ", $unknown );
925 $this->setWarning( "Unrecognized value$s for parameter '$valueName': $vals" );
927 $this->dieUsage( "Unrecognized value for parameter '$valueName': {$valuesList[0]}", "unknown_$valueName" );
930 // Now throw them out
931 $valuesList = array_intersect( $valuesList, $allowedValues );
934 return $allowMultiple ?
$valuesList : $valuesList[0];
938 * Validate the value against the minimum and user/bot maximum limits.
939 * Prints usage info on failure.
940 * @param $paramName string Parameter name
941 * @param $value int Parameter value
942 * @param $min int|null Minimum value
943 * @param $max int|null Maximum value for users
944 * @param $botMax int Maximum value for sysops/bots
945 * @param $enforceLimits Boolean Whether to enforce (die) if value is outside limits
947 function validateLimit( $paramName, &$value, $min, $max, $botMax = null, $enforceLimits = false ) {
948 if ( !is_null( $min ) && $value < $min ) {
950 $msg = $this->encodeParamName( $paramName ) . " may not be less than $min (set to $value)";
951 $this->warnOrDie( $msg, $enforceLimits );
955 // Minimum is always validated, whereas maximum is checked only if not running in internal call mode
956 if ( $this->getMain()->isInternalMode() ) {
960 // Optimization: do not check user's bot status unless really needed -- skips db query
961 // assumes $botMax >= $max
962 if ( !is_null( $max ) && $value > $max ) {
963 if ( !is_null( $botMax ) && $this->getMain()->canApiHighLimits() ) {
964 if ( $value > $botMax ) {
965 $msg = $this->encodeParamName( $paramName ) . " may not be over $botMax (set to $value) for bots or sysops";
966 $this->warnOrDie( $msg, $enforceLimits );
970 $msg = $this->encodeParamName( $paramName ) . " may not be over $max (set to $value) for users";
971 $this->warnOrDie( $msg, $enforceLimits );
978 * @param $value string
979 * @param $paramName string
982 function validateTimestamp( $value, $paramName ) {
983 $value = wfTimestamp( TS_UNIX
, $value );
984 if ( $value === 0 ) {
985 $this->dieUsage( "Invalid value '$value' for timestamp parameter $paramName", "badtimestamp_{$paramName}" );
987 return wfTimestamp( TS_MW
, $value );
991 * Adds a warning to the output, else dies
993 * @param $msg String Message to show as a warning, or error message if dying
994 * @param $enforceLimits Boolean Whether this is an enforce (die)
996 private function warnOrDie( $msg, $enforceLimits = false ) {
997 if ( $enforceLimits ) {
998 $this->dieUsage( $msg, 'integeroutofrange' );
1000 $this->setWarning( $msg );
1005 * Truncate an array to a certain length.
1006 * @param $arr array Array to truncate
1007 * @param $limit int Maximum length
1008 * @return bool True if the array was truncated, false otherwise
1010 public static function truncateArray( &$arr, $limit ) {
1012 while ( count( $arr ) > $limit ) {
1020 * Throw a UsageException, which will (if uncaught) call the main module's
1021 * error handler and die with an error message.
1023 * @param $description string One-line human-readable description of the
1024 * error condition, e.g., "The API requires a valid action parameter"
1025 * @param $errorCode string Brief, arbitrary, stable string to allow easy
1026 * automated identification of the error, e.g., 'unknown_action'
1027 * @param $httpRespCode int HTTP response code
1028 * @param $extradata array Data to add to the <error> element; array in ApiResult format
1030 public function dieUsage( $description, $errorCode, $httpRespCode = 0, $extradata = null ) {
1031 Profiler
::instance()->close();
1032 throw new UsageException( $description, $this->encodeParamName( $errorCode ), $httpRespCode, $extradata );
1036 * Array that maps message keys to error messages. $1 and friends are replaced.
1038 public static $messageMap = array(
1039 // This one MUST be present, or dieUsageMsg() will recurse infinitely
1040 'unknownerror' => array( 'code' => 'unknownerror', 'info' => "Unknown error: ``\$1''" ),
1041 'unknownerror-nocode' => array( 'code' => 'unknownerror', 'info' => 'Unknown error' ),
1043 // Messages from Title::getUserPermissionsErrors()
1044 'ns-specialprotected' => array( 'code' => 'unsupportednamespace', 'info' => "Pages in the Special namespace can't be edited" ),
1045 'protectedinterface' => array( 'code' => 'protectednamespace-interface', 'info' => "You're not allowed to edit interface messages" ),
1046 'namespaceprotected' => array( 'code' => 'protectednamespace', 'info' => "You're not allowed to edit pages in the ``\$1'' namespace" ),
1047 'customcssprotected' => array( 'code' => 'customcssprotected', 'info' => "You're not allowed to edit custom CSS pages" ),
1048 'customjsprotected' => array( 'code' => 'customjsprotected', 'info' => "You're not allowed to edit custom JavaScript pages" ),
1049 'cascadeprotected' => array( 'code' => 'cascadeprotected', 'info' => "The page you're trying to edit is protected because it's included in a cascade-protected page" ),
1050 'protectedpagetext' => array( 'code' => 'protectedpage', 'info' => "The ``\$1'' right is required to edit this page" ),
1051 'protect-cantedit' => array( 'code' => 'cantedit', 'info' => "You can't protect this page because you can't edit it" ),
1052 'badaccess-group0' => array( 'code' => 'permissiondenied', 'info' => "Permission denied" ), // Generic permission denied message
1053 'badaccess-groups' => array( 'code' => 'permissiondenied', 'info' => "Permission denied" ),
1054 'titleprotected' => array( 'code' => 'protectedtitle', 'info' => "This title has been protected from creation" ),
1055 'nocreate-loggedin' => array( 'code' => 'cantcreate', 'info' => "You don't have permission to create new pages" ),
1056 'nocreatetext' => array( 'code' => 'cantcreate-anon', 'info' => "Anonymous users can't create new pages" ),
1057 'movenologintext' => array( 'code' => 'cantmove-anon', 'info' => "Anonymous users can't move pages" ),
1058 'movenotallowed' => array( 'code' => 'cantmove', 'info' => "You don't have permission to move pages" ),
1059 'confirmedittext' => array( 'code' => 'confirmemail', 'info' => "You must confirm your e-mail address before you can edit" ),
1060 'blockedtext' => array( 'code' => 'blocked', 'info' => "You have been blocked from editing" ),
1061 'autoblockedtext' => array( 'code' => 'autoblocked', 'info' => "Your IP address has been blocked automatically, because it was used by a blocked user" ),
1063 // Miscellaneous interface messages
1064 'actionthrottledtext' => array( 'code' => 'ratelimited', 'info' => "You've exceeded your rate limit. Please wait some time and try again" ),
1065 'alreadyrolled' => array( 'code' => 'alreadyrolled', 'info' => "The page you tried to rollback was already rolled back" ),
1066 'cantrollback' => array( 'code' => 'onlyauthor', 'info' => "The page you tried to rollback only has one author" ),
1067 'readonlytext' => array( 'code' => 'readonly', 'info' => "The wiki is currently in read-only mode" ),
1068 'sessionfailure' => array( 'code' => 'badtoken', 'info' => "Invalid token" ),
1069 'cannotdelete' => array( 'code' => 'cantdelete', 'info' => "Couldn't delete ``\$1''. Maybe it was deleted already by someone else" ),
1070 'notanarticle' => array( 'code' => 'missingtitle', 'info' => "The page you requested doesn't exist" ),
1071 'selfmove' => array( 'code' => 'selfmove', 'info' => "Can't move a page to itself" ),
1072 'immobile_namespace' => array( 'code' => 'immobilenamespace', 'info' => "You tried to move pages from or to a namespace that is protected from moving" ),
1073 'articleexists' => array( 'code' => 'articleexists', 'info' => "The destination article already exists and is not a redirect to the source article" ),
1074 'protectedpage' => array( 'code' => 'protectedpage', 'info' => "You don't have permission to perform this move" ),
1075 'hookaborted' => array( 'code' => 'hookaborted', 'info' => "The modification you tried to make was aborted by an extension hook" ),
1076 'cantmove-titleprotected' => array( 'code' => 'protectedtitle', 'info' => "The destination article has been protected from creation" ),
1077 'imagenocrossnamespace' => array( 'code' => 'nonfilenamespace', 'info' => "Can't move a file to a non-file namespace" ),
1078 'imagetypemismatch' => array( 'code' => 'filetypemismatch', 'info' => "The new file extension doesn't match its type" ),
1079 // 'badarticleerror' => shouldn't happen
1080 // 'badtitletext' => shouldn't happen
1081 'ip_range_invalid' => array( 'code' => 'invalidrange', 'info' => "Invalid IP range" ),
1082 'range_block_disabled' => array( 'code' => 'rangedisabled', 'info' => "Blocking IP ranges has been disabled" ),
1083 'nosuchusershort' => array( 'code' => 'nosuchuser', 'info' => "The user you specified doesn't exist" ),
1084 'badipaddress' => array( 'code' => 'invalidip', 'info' => "Invalid IP address specified" ),
1085 'ipb_expiry_invalid' => array( 'code' => 'invalidexpiry', 'info' => "Invalid expiry time" ),
1086 'ipb_already_blocked' => array( 'code' => 'alreadyblocked', 'info' => "The user you tried to block was already blocked" ),
1087 '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." ),
1088 'ipb_cant_unblock' => array( 'code' => 'cantunblock', 'info' => "The block you specified was not found. It may have been unblocked already" ),
1089 '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" ),
1090 'ipbblocked' => array( 'code' => 'ipbblocked', 'info' => 'You cannot block or unblock users while you are yourself blocked' ),
1091 'ipbnounblockself' => array( 'code' => 'ipbnounblockself', 'info' => 'You are not allowed to unblock yourself' ),
1092 'usermaildisabled' => array( 'code' => 'usermaildisabled', 'info' => "User email has been disabled" ),
1093 'blockedemailuser' => array( 'code' => 'blockedfrommail', 'info' => "You have been blocked from sending e-mail" ),
1094 'notarget' => array( 'code' => 'notarget', 'info' => "You have not specified a valid target for this action" ),
1095 '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" ),
1096 'rcpatroldisabled' => array( 'code' => 'patroldisabled', 'info' => "Patrolling is disabled on this wiki" ),
1097 'markedaspatrollederror-noautopatrol' => array( 'code' => 'noautopatrol', 'info' => "You don't have permission to patrol your own changes" ),
1098 'delete-toobig' => array( 'code' => 'bigdelete', 'info' => "You can't delete this page because it has more than \$1 revisions" ),
1099 'movenotallowedfile' => array( 'code' => 'cantmovefile', 'info' => "You don't have permission to move files" ),
1100 'userrights-no-interwiki' => array( 'code' => 'nointerwikiuserrights', 'info' => "You don't have permission to change user rights on other wikis" ),
1101 'userrights-nodatabase' => array( 'code' => 'nosuchdatabase', 'info' => "Database ``\$1'' does not exist or is not local" ),
1102 'nouserspecified' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
1103 'noname' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
1104 'summaryrequired' => array( 'code' => 'summaryrequired', 'info' => 'Summary required' ),
1106 // API-specific messages
1107 'readrequired' => array( 'code' => 'readapidenied', 'info' => "You need read permission to use this module" ),
1108 '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" ),
1109 'writerequired' => array( 'code' => 'writeapidenied', 'info' => "You're not allowed to edit this wiki through the API" ),
1110 'missingparam' => array( 'code' => 'no$1', 'info' => "The \$1 parameter must be set" ),
1111 'invalidtitle' => array( 'code' => 'invalidtitle', 'info' => "Bad title ``\$1''" ),
1112 'nosuchpageid' => array( 'code' => 'nosuchpageid', 'info' => "There is no page with ID \$1" ),
1113 'nosuchrevid' => array( 'code' => 'nosuchrevid', 'info' => "There is no revision with ID \$1" ),
1114 'nosuchuser' => array( 'code' => 'nosuchuser', 'info' => "User ``\$1'' doesn't exist" ),
1115 'invaliduser' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
1116 'invalidexpiry' => array( 'code' => 'invalidexpiry', 'info' => "Invalid expiry time ``\$1''" ),
1117 'pastexpiry' => array( 'code' => 'pastexpiry', 'info' => "Expiry time ``\$1'' is in the past" ),
1118 'create-titleexists' => array( 'code' => 'create-titleexists', 'info' => "Existing titles can't be protected with 'create'" ),
1119 'missingtitle-createonly' => array( 'code' => 'missingtitle-createonly', 'info' => "Missing titles can only be protected with 'create'" ),
1120 'cantblock' => array( 'code' => 'cantblock', 'info' => "You don't have permission to block users" ),
1121 'canthide' => array( 'code' => 'canthide', 'info' => "You don't have permission to hide user names from the block log" ),
1122 'cantblock-email' => array( 'code' => 'cantblock-email', 'info' => "You don't have permission to block users from sending e-mail through the wiki" ),
1123 'unblock-notarget' => array( 'code' => 'notarget', 'info' => "Either the id or the user parameter must be set" ),
1124 'unblock-idanduser' => array( 'code' => 'idanduser', 'info' => "The id and user parameters can't be used together" ),
1125 'cantunblock' => array( 'code' => 'permissiondenied', 'info' => "You don't have permission to unblock users" ),
1126 'cannotundelete' => array( 'code' => 'cantundelete', 'info' => "Couldn't undelete: the requested revisions may not exist, or may have been undeleted already" ),
1127 'permdenied-undelete' => array( 'code' => 'permissiondenied', 'info' => "You don't have permission to restore deleted revisions" ),
1128 'createonly-exists' => array( 'code' => 'articleexists', 'info' => "The article you tried to create has been created already" ),
1129 'nocreate-missing' => array( 'code' => 'missingtitle', 'info' => "The article you tried to edit doesn't exist" ),
1130 'nosuchrcid' => array( 'code' => 'nosuchrcid', 'info' => "There is no change with rcid ``\$1''" ),
1131 'protect-invalidaction' => array( 'code' => 'protect-invalidaction', 'info' => "Invalid protection type ``\$1''" ),
1132 'protect-invalidlevel' => array( 'code' => 'protect-invalidlevel', 'info' => "Invalid protection level ``\$1''" ),
1133 'toofewexpiries' => array( 'code' => 'toofewexpiries', 'info' => "\$1 expiry timestamps were provided where \$2 were needed" ),
1134 'cantimport' => array( 'code' => 'cantimport', 'info' => "You don't have permission to import pages" ),
1135 'cantimport-upload' => array( 'code' => 'cantimport-upload', 'info' => "You don't have permission to import uploaded pages" ),
1136 'nouploadmodule' => array( 'code' => 'nomodule', 'info' => 'No upload module set' ),
1137 'importnofile' => array( 'code' => 'nofile', 'info' => "You didn't upload a file" ),
1138 'importuploaderrorsize' => array( 'code' => 'filetoobig', 'info' => 'The file you uploaded is bigger than the maximum upload size' ),
1139 'importuploaderrorpartial' => array( 'code' => 'partialupload', 'info' => 'The file was only partially uploaded' ),
1140 'importuploaderrortemp' => array( 'code' => 'notempdir', 'info' => 'The temporary upload directory is missing' ),
1141 'importcantopen' => array( 'code' => 'cantopenfile', 'info' => "Couldn't open the uploaded file" ),
1142 'import-noarticle' => array( 'code' => 'badinterwiki', 'info' => 'Invalid interwiki title specified' ),
1143 'importbadinterwiki' => array( 'code' => 'badinterwiki', 'info' => 'Invalid interwiki title specified' ),
1144 'import-unknownerror' => array( 'code' => 'import-unknownerror', 'info' => "Unknown error on import: ``\$1''" ),
1145 'cantoverwrite-sharedfile' => array( 'code' => 'cantoverwrite-sharedfile', 'info' => 'The target file exists on a shared repository and you do not have permission to override it' ),
1146 'sharedfile-exists' => array( 'code' => 'fileexists-sharedrepo-perm', 'info' => 'The target file exists on a shared repository. Use the ignorewarnings parameter to override it.' ),
1147 'mustbeposted' => array( 'code' => 'mustbeposted', 'info' => "The \$1 module requires a POST request" ),
1148 'show' => array( 'code' => 'show', 'info' => 'Incorrect parameter - mutually exclusive values may not be supplied' ),
1149 'specialpage-cantexecute' => array( 'code' => 'specialpage-cantexecute', 'info' => "You don't have permission to view the results of this special page" ),
1151 // ApiEditPage messages
1152 'noimageredirect-anon' => array( 'code' => 'noimageredirect-anon', 'info' => "Anonymous users can't create image redirects" ),
1153 'noimageredirect-logged' => array( 'code' => 'noimageredirect', 'info' => "You don't have permission to create image redirects" ),
1154 'spamdetected' => array( 'code' => 'spamdetected', 'info' => "Your edit was refused because it contained a spam fragment: ``\$1''" ),
1155 'filtered' => array( 'code' => 'filtered', 'info' => "The filter callback function refused your edit" ),
1156 'contenttoobig' => array( 'code' => 'contenttoobig', 'info' => "The content you supplied exceeds the article size limit of \$1 kilobytes" ),
1157 'noedit-anon' => array( 'code' => 'noedit-anon', 'info' => "Anonymous users can't edit pages" ),
1158 'noedit' => array( 'code' => 'noedit', 'info' => "You don't have permission to edit pages" ),
1159 'wasdeleted' => array( 'code' => 'pagedeleted', 'info' => "The page has been deleted since you fetched its timestamp" ),
1160 'blankpage' => array( 'code' => 'emptypage', 'info' => "Creating new, empty pages is not allowed" ),
1161 'editconflict' => array( 'code' => 'editconflict', 'info' => "Edit conflict detected" ),
1162 'hashcheckfailed' => array( 'code' => 'badmd5', 'info' => "The supplied MD5 hash was incorrect" ),
1163 'missingtext' => array( 'code' => 'notext', 'info' => "One of the text, appendtext, prependtext and undo parameters must be set" ),
1164 'emptynewsection' => array( 'code' => 'emptynewsection', 'info' => 'Creating empty new sections is not possible.' ),
1165 'revwrongpage' => array( 'code' => 'revwrongpage', 'info' => "r\$1 is not a revision of ``\$2''" ),
1166 'undo-failure' => array( 'code' => 'undofailure', 'info' => 'Undo failed due to conflicting intermediate edits' ),
1169 'invalid-session-key' => array( 'code' => 'invalid-session-key', 'info' => 'Not a valid session key' ),
1170 'nouploadmodule' => array( 'code' => 'nouploadmodule', 'info' => 'No upload module set' ),
1171 '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' ),
1172 'copyuploaddisabled' => array( 'code' => 'copyuploaddisabled', 'info' => 'Uploads by URL is not enabled. Make sure $wgAllowCopyUploads is set to true in LocalSettings.php.' ),
1174 'filename-tooshort' => array( 'code' => 'filename-tooshort', 'info' => 'The filename is too short' ),
1175 'illegal-filename' => array( 'code' => 'illegal-filename', 'info' => 'The filename is not allowed' ),
1176 'filetype-missing' => array( 'code' => 'filetype-missing', 'info' => 'The file is missing an extension' ),
1180 * Helper function for readonly errors
1182 public function dieReadOnly() {
1183 $parsed = $this->parseMsg( array( 'readonlytext' ) );
1184 $this->dieUsage( $parsed['info'], $parsed['code'], /* http error */ 0,
1185 array( 'readonlyreason' => wfReadOnlyReason() ) );
1189 * Output the error message related to a certain array
1190 * @param $error (array|string) Element of a getUserPermissionsErrors()-style array
1192 public function dieUsageMsg( $error ) {
1193 # most of the time we send a 1 element, so we might as well send it as
1194 # a string and make this an array here.
1195 if( is_string( $error ) ) {
1196 $error = array( $error );
1198 $parsed = $this->parseMsg( $error );
1199 $this->dieUsage( $parsed['info'], $parsed['code'] );
1203 * Return the error message related to a certain array
1204 * @param $error array Element of a getUserPermissionsErrors()-style array
1205 * @return array('code' => code, 'info' => info)
1207 public function parseMsg( $error ) {
1208 $key = array_shift( $error );
1210 // Check whether the error array was nested
1211 // array( array( <code>, <params> ), array( <another_code>, <params> ) )
1212 if( is_array( $key ) ){
1214 $key = array_shift( $error );
1217 if ( isset( self
::$messageMap[$key] ) ) {
1218 return array( 'code' =>
1219 wfMsgReplaceArgs( self
::$messageMap[$key]['code'], $error ),
1221 wfMsgReplaceArgs( self
::$messageMap[$key]['info'], $error )
1225 // If the key isn't present, throw an "unknown error"
1226 return $this->parseMsg( array( 'unknownerror', $key ) );
1230 * Internal code errors should be reported with this method
1231 * @param $method string Method or function name
1232 * @param $message string Error message
1234 protected static function dieDebug( $method, $message ) {
1235 wfDebugDieBacktrace( "Internal error in $method: $message" );
1239 * Indicates if this module needs maxlag to be checked
1242 public function shouldCheckMaxlag() {
1247 * Indicates whether this module requires read rights
1250 public function isReadMode() {
1254 * Indicates whether this module requires write mode
1257 public function isWriteMode() {
1262 * Indicates whether this module must be called with a POST request
1265 public function mustBePosted() {
1270 * Returns whether this module requires a Token to execute
1273 public function needsToken() {
1278 * 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
1281 public function getTokenSalt() {
1286 * Gets the user for whom to get the watchlist
1288 * @param $params array
1291 public function getWatchlistUser( $params ) {
1293 if ( !is_null( $params['owner'] ) && !is_null( $params['token'] ) ) {
1294 $user = User
::newFromName( $params['owner'], false );
1295 if ( !$user->getId() ) {
1296 $this->dieUsage( 'Specified user does not exist', 'bad_wlowner' );
1298 $token = $user->getOption( 'watchlisttoken' );
1299 if ( $token == '' ||
$token != $params['token'] ) {
1300 $this->dieUsage( 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences', 'bad_wltoken' );
1303 if ( !$wgUser->isLoggedIn() ) {
1304 $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
1312 * @return false|string|array Returns a false if the module has no help url, else returns a (array of) string
1314 public function getHelpUrl() {
1319 * Returns a list of all possible errors returned by the module
1320 * @return array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
1322 public function getPossibleErrors() {
1325 $params = $this->getFinalParams();
1327 foreach ( $params as $paramName => $paramSettings ) {
1328 if ( isset( $paramSettings[ApiBase
::PARAM_REQUIRED
] ) ) {
1329 $ret[] = array( 'missingparam', $paramName );
1334 if ( $this->mustBePosted() ) {
1335 $ret[] = array( 'mustbeposted', $this->getModuleName() );
1338 if ( $this->isReadMode() ) {
1339 $ret[] = array( 'readrequired' );
1342 if ( $this->isWriteMode() ) {
1343 $ret[] = array( 'writerequired' );
1344 $ret[] = array( 'writedisabled' );
1347 if ( $this->needsToken() ) {
1348 $ret[] = array( 'missingparam', 'token' );
1349 $ret[] = array( 'sessionfailure' );
1356 * Parses a list of errors into a standardised format
1357 * @param $errors array List of errors. Items can be in the for array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
1358 * @return array Parsed list of errors with items in the form array( 'code' => ..., 'info' => ... )
1360 public function parseErrors( $errors ) {
1363 foreach ( $errors as $row ) {
1364 if ( isset( $row['code'] ) && isset( $row['info'] ) ) {
1367 $ret[] = $this->parseMsg( $row );
1374 * Profiling: total module execution time
1376 private $mTimeIn = 0, $mModuleTime = 0;
1379 * Start module profiling
1381 public function profileIn() {
1382 if ( $this->mTimeIn
!== 0 ) {
1383 ApiBase
::dieDebug( __METHOD__
, 'called twice without calling profileOut()' );
1385 $this->mTimeIn
= microtime( true );
1386 wfProfileIn( $this->getModuleProfileName() );
1390 * End module profiling
1392 public function profileOut() {
1393 if ( $this->mTimeIn
=== 0 ) {
1394 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileIn() first' );
1396 if ( $this->mDBTimeIn
!== 0 ) {
1397 ApiBase
::dieDebug( __METHOD__
, 'must be called after database profiling is done with profileDBOut()' );
1400 $this->mModuleTime +
= microtime( true ) - $this->mTimeIn
;
1402 wfProfileOut( $this->getModuleProfileName() );
1406 * When modules crash, sometimes it is needed to do a profileOut() regardless
1407 * of the profiling state the module was in. This method does such cleanup.
1409 public function safeProfileOut() {
1410 if ( $this->mTimeIn
!== 0 ) {
1411 if ( $this->mDBTimeIn
!== 0 ) {
1412 $this->profileDBOut();
1414 $this->profileOut();
1419 * Total time the module was executed
1422 public function getProfileTime() {
1423 if ( $this->mTimeIn
!== 0 ) {
1424 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileOut() first' );
1426 return $this->mModuleTime
;
1430 * Profiling: database execution time
1432 private $mDBTimeIn = 0, $mDBTime = 0;
1435 * Start module profiling
1437 public function profileDBIn() {
1438 if ( $this->mTimeIn
=== 0 ) {
1439 ApiBase
::dieDebug( __METHOD__
, 'must be called while profiling the entire module with profileIn()' );
1441 if ( $this->mDBTimeIn
!== 0 ) {
1442 ApiBase
::dieDebug( __METHOD__
, 'called twice without calling profileDBOut()' );
1444 $this->mDBTimeIn
= microtime( true );
1445 wfProfileIn( $this->getModuleProfileName( true ) );
1449 * End database profiling
1451 public function profileDBOut() {
1452 if ( $this->mTimeIn
=== 0 ) {
1453 ApiBase
::dieDebug( __METHOD__
, 'must be called while profiling the entire module with profileIn()' );
1455 if ( $this->mDBTimeIn
=== 0 ) {
1456 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileDBIn() first' );
1459 $time = microtime( true ) - $this->mDBTimeIn
;
1460 $this->mDBTimeIn
= 0;
1462 $this->mDBTime +
= $time;
1463 $this->getMain()->mDBTime +
= $time;
1464 wfProfileOut( $this->getModuleProfileName( true ) );
1468 * Total time the module used the database
1471 public function getProfileDBTime() {
1472 if ( $this->mDBTimeIn
!== 0 ) {
1473 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileDBOut() first' );
1475 return $this->mDBTime
;
1479 * Debugging function that prints a value and an optional backtrace
1480 * @param $value mixed Value to print
1481 * @param $name string Description of the printed value
1482 * @param $backtrace bool If true, print a backtrace
1484 public static function debugPrint( $value, $name = 'unknown', $backtrace = false ) {
1485 print "\n\n<pre><b>Debugging value '$name':</b>\n\n";
1486 var_export( $value );
1488 print "\n" . wfBacktrace();
1494 * Returns a string that identifies the version of this class.
1497 public static function getBaseVersion() {
1498 return __CLASS__
. ': $Id$';