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
extends ContextSource
{
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;
76 if ( !$this->isMain() ) {
77 $this->setContext( $this->mMainModule
);
81 /*****************************************************************************
83 *****************************************************************************/
86 * Evaluates the parameters, performs the requested query, and sets up
87 * the result. Concrete implementations of ApiBase must override this
88 * method to provide whatever functionality their module offers.
89 * Implementations must not produce any output on their own and are not
90 * expected to handle any errors.
92 * The execute() method will be invoked directly by ApiMain immediately
93 * before the result of the module is output. Aside from the
94 * constructor, implementations should assume that no other methods
95 * will be called externally on the module before the result is
98 * The result data should be stored in the ApiResult object available
99 * through getResult().
101 public abstract function execute();
104 * Returns a string that identifies the version of the extending class.
105 * Typically includes the class name, the svn revision, timestamp, and
106 * last author. Usually done with SVN's Id keyword
109 public abstract function getVersion();
112 * Get the name of the module being executed by this instance
115 public function getModuleName() {
116 return $this->mModuleName
;
120 * Get parameter prefix (usually two letters or an empty string).
123 public function getModulePrefix() {
124 return $this->mModulePrefix
;
128 * Get the name of the module as shown in the profiler log
130 * @param $db DatabaseBase
134 public function getModuleProfileName( $db = false ) {
136 return 'API:' . $this->mModuleName
. '-DB';
138 return 'API:' . $this->mModuleName
;
143 * Get the main module
144 * @return ApiMain object
146 public function getMain() {
147 return $this->mMainModule
;
151 * Returns true if this module is the main module ($this === $this->mMainModule),
155 public function isMain() {
156 return $this === $this->mMainModule
;
160 * Get the result object
163 public function getResult() {
164 // Main module has getResult() method overriden
165 // Safety - avoid infinite loop:
166 if ( $this->isMain() ) {
167 ApiBase
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
169 return $this->getMain()->getResult();
173 * Get the result data array (read-only)
176 public function getResultData() {
177 return $this->getResult()->getData();
181 * Create a new RequestContext object to use e.g. for calls to other parts
183 * The object will have the WebRequest and the User object set to the ones
184 * used in this instance.
186 * @deprecated 1.19 use getContext to get the current context
187 * @return RequestContext
189 public function createContext() {
190 return $this->getContext();
194 * Set warning section for this module. Users should monitor this
195 * section to notice any changes in API. Multiple calls to this
196 * function will result in the warning messages being separated by
198 * @param $warning string Warning message
200 public function setWarning( $warning ) {
201 $result = $this->getResult();
202 $data = $result->getData();
203 if ( isset( $data['warnings'][$this->getModuleName()] ) ) {
204 // Don't add duplicate warnings
205 $warn_regex = preg_quote( $warning, '/' );
206 if ( preg_match( "/{$warn_regex}(\\n|$)/", $data['warnings'][$this->getModuleName()]['*'] ) ) {
209 $oldwarning = $data['warnings'][$this->getModuleName()]['*'];
210 // If there is a warning already, append it to the existing one
211 $warning = "$oldwarning\n$warning";
212 $result->unsetValue( 'warnings', $this->getModuleName() );
215 ApiResult
::setContent( $msg, $warning );
216 $result->disableSizeCheck();
217 $result->addValue( 'warnings', $this->getModuleName(), $msg );
218 $result->enableSizeCheck();
222 * If the module may only be used with a certain format module,
223 * it should override this method to return an instance of that formatter.
224 * A value of null means the default format will be used.
225 * @return mixed instance of a derived class of ApiFormatBase, or null
227 public function getCustomPrinter() {
232 * Generates help message for this module, or false if there is no description
233 * @return mixed string or false
235 public function makeHelpMsg() {
236 static $lnPrfx = "\n ";
238 $msg = $this->getDescription();
240 if ( $msg !== false ) {
242 if ( !is_array( $msg ) ) {
247 $msg = $lnPrfx . implode( $lnPrfx, $msg ) . "\n";
249 if ( $this->isReadMode() ) {
250 $msg .= "\nThis module requires read rights";
252 if ( $this->isWriteMode() ) {
253 $msg .= "\nThis module requires write rights";
255 if ( $this->mustBePosted() ) {
256 $msg .= "\nThis module only accepts POST requests";
258 if ( $this->isReadMode() ||
$this->isWriteMode() ||
259 $this->mustBePosted() ) {
264 $paramsMsg = $this->makeHelpMsgParameters();
265 if ( $paramsMsg !== false ) {
266 $msg .= "Parameters:\n$paramsMsg";
269 $msg .= $this->makeHelpArrayToString( $lnPrfx, "Example", $this->getExamples() );
270 $msg .= $this->makeHelpArrayToString( $lnPrfx, "Help page", $this->getHelpUrls() );
272 if ( $this->getMain()->getShowVersions() ) {
273 $versions = $this->getVersion();
274 $pattern = '/(\$.*) ([0-9a-z_]+\.php) (.*\$)/i';
275 $callback = array( $this, 'makeHelpMsg_callback' );
277 if ( is_array( $versions ) ) {
278 foreach ( $versions as &$v ) {
279 $v = preg_replace_callback( $pattern, $callback, $v );
281 $versions = implode( "\n ", $versions );
283 $versions = preg_replace_callback( $pattern, $callback, $versions );
286 $msg .= "Version:\n $versions\n";
294 * @param $prefix string Text to split output items
295 * @param $title string What is being output
296 * @param $input string|array
299 protected function makeHelpArrayToString( $prefix, $title, $input ) {
300 if ( $input === false ) {
303 if ( !is_array( $input ) ) {
309 if ( count( $input ) > 0 ) {
310 $msg = $title . ( count( $input ) > 1 ?
's' : '' ) . ":\n ";
311 $msg .= implode( $prefix, $input ) . "\n";
318 * Generates the parameter descriptions for this module, to be displayed in the
320 * @return string or false
322 public function makeHelpMsgParameters() {
323 $params = $this->getFinalParams();
326 $paramsDescription = $this->getFinalParamDescription();
328 $paramPrefix = "\n" . str_repeat( ' ', 24 );
329 $descWordwrap = "\n" . str_repeat( ' ', 28 );
330 foreach ( $params as $paramName => $paramSettings ) {
331 $desc = isset( $paramsDescription[$paramName] ) ?
$paramsDescription[$paramName] : '';
332 if ( is_array( $desc ) ) {
333 $desc = implode( $paramPrefix, $desc );
336 if ( !is_array( $paramSettings ) ) {
337 $paramSettings = array(
338 self
::PARAM_DFLT
=> $paramSettings,
342 $deprecated = isset( $paramSettings[self
::PARAM_DEPRECATED
] ) ?
343 $paramSettings[self
::PARAM_DEPRECATED
] : false;
345 $desc = "DEPRECATED! $desc";
348 $required = isset( $paramSettings[self
::PARAM_REQUIRED
] ) ?
349 $paramSettings[self
::PARAM_REQUIRED
] : false;
351 $desc .= $paramPrefix . "This parameter is required";
354 $type = isset( $paramSettings[self
::PARAM_TYPE
] ) ?
$paramSettings[self
::PARAM_TYPE
] : null;
355 if ( isset( $type ) ) {
356 if ( isset( $paramSettings[self
::PARAM_ISMULTI
] ) ) {
357 $prompt = 'Values (separate with \'|\'): ';
359 $prompt = 'One value: ';
362 if ( is_array( $type ) ) {
364 $nothingPrompt = false;
365 foreach ( $type as $t ) {
367 $nothingPrompt = 'Can be empty, or ';
372 $desc .= $paramPrefix . $nothingPrompt . $prompt;
373 $choicesstring = implode( ', ', $choices );
374 $desc .= wordwrap( $choicesstring, 100, $descWordwrap );
378 // Special handling because namespaces are type-limited, yet they are not given
379 $desc .= $paramPrefix . $prompt;
380 $desc .= wordwrap( implode( ', ', MWNamespace
::getValidNamespaces() ),
381 100, $descWordwrap );
384 $desc .= $paramPrefix . "No more than {$paramSettings[self :: PARAM_MAX]}";
385 if ( isset( $paramSettings[self
::PARAM_MAX2
] ) ) {
386 $desc .= " ({$paramSettings[self::PARAM_MAX2]} for bots)";
391 $hasMin = isset( $paramSettings[self
::PARAM_MIN
] );
392 $hasMax = isset( $paramSettings[self
::PARAM_MAX
] );
393 if ( $hasMin ||
$hasMax ) {
395 $intRangeStr = "The value must be no less than {$paramSettings[self::PARAM_MIN]}";
396 } elseif ( !$hasMin ) {
397 $intRangeStr = "The value must be no more than {$paramSettings[self::PARAM_MAX]}";
399 $intRangeStr = "The value must be between {$paramSettings[self::PARAM_MIN]} and {$paramSettings[self::PARAM_MAX]}";
402 $desc .= $paramPrefix . $intRangeStr;
407 if ( isset( $paramSettings[self
::PARAM_ISMULTI
] ) ) {
408 $isArray = is_array( $paramSettings[self
::PARAM_TYPE
] );
411 ||
$isArray && count( $paramSettings[self
::PARAM_TYPE
] ) > self
::LIMIT_SML1
) {
412 $desc .= $paramPrefix . "Maximum number of values " .
413 self
::LIMIT_SML1
. " (" . self
::LIMIT_SML2
. " for bots)";
419 $default = is_array( $paramSettings )
420 ?
( isset( $paramSettings[self
::PARAM_DFLT
] ) ?
$paramSettings[self
::PARAM_DFLT
] : null )
422 if ( !is_null( $default ) && $default !== false ) {
423 $desc .= $paramPrefix . "Default: $default";
426 $msg .= sprintf( " %-19s - %s\n", $this->encodeParamName( $paramName ), $desc );
436 * Callback for preg_replace_callback() call in makeHelpMsg().
437 * Replaces a source file name with a link to ViewVC
441 public function makeHelpMsg_callback( $matches ) {
442 global $wgAutoloadClasses, $wgAutoloadLocalClasses;
445 if ( isset( $wgAutoloadLocalClasses[get_class( $this )] ) ) {
446 $file = $wgAutoloadLocalClasses[get_class( $this )];
447 } elseif ( isset( $wgAutoloadClasses[get_class( $this )] ) ) {
448 $file = $wgAutoloadClasses[get_class( $this )];
451 // Do some guesswork here
452 $path = strstr( $file, 'includes/api/' );
453 if ( $path === false ) {
454 $path = strstr( $file, 'extensions/' );
456 $path = 'phase3/' . $path;
459 // Get the filename from $matches[2] instead of $file
460 // If they're not the same file, they're assumed to be in the
462 // This is necessary to make stuff like ApiMain::getVersion()
463 // returning the version string for ApiBase work
465 return "{$matches[0]}\n http://svn.wikimedia.org/" .
466 "viewvc/mediawiki/trunk/" . dirname( $path ) .
473 * Returns the description string for this module
474 * @return mixed string or array of strings
476 protected function getDescription() {
481 * Returns usage examples for this module. Return false if no examples are available.
482 * @return false|string|array
484 protected function getExamples() {
489 * Returns an array of allowed parameters (parameter name) => (default
490 * value) or (parameter name) => (array with PARAM_* constants as keys)
491 * Don't call this function directly: use getFinalParams() to allow
492 * hooks to modify parameters as needed.
493 * @return array or false
495 protected function getAllowedParams() {
500 * Returns an array of parameter descriptions.
501 * Don't call this functon directly: use getFinalParamDescription() to
502 * allow hooks to modify descriptions as needed.
503 * @return array or false
505 protected function getParamDescription() {
510 * Get final list of parameters, after hooks have had a chance to
511 * tweak it as needed.
512 * @return array or false
514 public function getFinalParams() {
515 $params = $this->getAllowedParams();
516 wfRunHooks( 'APIGetAllowedParams', array( &$this, &$params ) );
521 * Get final description, after hooks have had a chance to tweak it as
525 public function getFinalParamDescription() {
526 $desc = $this->getParamDescription();
527 wfRunHooks( 'APIGetParamDescription', array( &$this, &$desc ) );
532 * This method mangles parameter name based on the prefix supplied to the constructor.
533 * Override this method to change parameter name during runtime
534 * @param $paramName string Parameter name
535 * @return string Prefixed parameter name
537 public function encodeParamName( $paramName ) {
538 return $this->mModulePrefix
. $paramName;
542 * Using getAllowedParams(), this function makes an array of the values
543 * provided by the user, with key being the name of the variable, and
544 * value - validated value from user or default. limits will not be
545 * parsed if $parseLimit is set to false; use this when the max
546 * limit is not definitive yet, e.g. when getting revisions.
547 * @param $parseLimit Boolean: true by default
550 public function extractRequestParams( $parseLimit = true ) {
551 // Cache parameters, for performance and to avoid bug 24564.
552 if ( !isset( $this->mParamCache
[$parseLimit] ) ) {
553 $params = $this->getFinalParams();
556 if ( $params ) { // getFinalParams() can return false
557 foreach ( $params as $paramName => $paramSettings ) {
558 $results[$paramName] = $this->getParameterFromSettings(
559 $paramName, $paramSettings, $parseLimit );
562 $this->mParamCache
[$parseLimit] = $results;
564 return $this->mParamCache
[$parseLimit];
568 * Get a value for the given parameter
569 * @param $paramName string Parameter name
570 * @param $parseLimit bool see extractRequestParams()
571 * @return mixed Parameter value
573 protected function getParameter( $paramName, $parseLimit = true ) {
574 $params = $this->getFinalParams();
575 $paramSettings = $params[$paramName];
576 return $this->getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
580 * Die if none or more than one of a certain set of parameters is set and not false.
581 * @param $params array of parameter names
583 public function requireOnlyOneParameter( $params ) {
584 $required = func_get_args();
585 array_shift( $required );
587 $intersection = array_intersect( array_keys( array_filter( $params,
588 array( $this, "parameterNotEmpty" ) ) ), $required );
590 if ( count( $intersection ) > 1 ) {
591 $this->dieUsage( 'The parameters ' . implode( ', ', $intersection ) . ' can not be used together', 'invalidparammix' );
592 } elseif ( count( $intersection ) == 0 ) {
593 $this->dieUsage( 'One of the parameters ' . implode( ', ', $required ) . ' is required', 'missingparam' );
598 * Generates the possible errors requireOnlyOneParameter() can die with
600 * @param $params array
603 public function getRequireOnlyOneParameterErrorMessages( $params ) {
604 $p = $this->getModulePrefix();
605 $params = implode( ", {$p}", $params );
608 array( 'code' => "{$p}missingparam", 'info' => "One of the parameters {$p}{$params} is required" ),
609 array( 'code' => "{$p}invalidparammix", 'info' => "The parameters {$p}{$params} can not be used together" )
614 * Die if more than one of a certain set of parameters is set and not false.
616 * @param $params array
618 public function requireMaxOneParameter( $params ) {
619 $required = func_get_args();
620 array_shift( $required );
622 $intersection = array_intersect( array_keys( array_filter( $params,
623 array( $this, "parameterNotEmpty" ) ) ), $required );
625 if ( count( $intersection ) > 1 ) {
626 $this->dieUsage( 'The parameters ' . implode( ', ', $intersection ) . ' can not be used together', 'invalidparammix' );
631 * Generates the possible error requireMaxOneParameter() can die with
633 * @param $params array
636 public function getRequireMaxOneParameterErrorMessages( $params ) {
637 $p = $this->getModulePrefix();
638 $params = implode( ", {$p}", $params );
641 array( 'code' => "{$p}invalidparammix", 'info' => "The parameters {$p}{$params} can not be used together" )
646 * Callback function used in requireOnlyOneParameter to check whether reequired parameters are set
648 * @param $x object Parameter to check is not null/false
651 private function parameterNotEmpty( $x ) {
652 return !is_null( $x ) && $x !== false;
656 * @deprecated since 1.17 use MWNamespace::getValidNamespaces()
660 public static function getValidNamespaces() {
661 return MWNamespace
::getValidNamespaces();
665 * Return true if we're to watch the page, false if not, null if no change.
666 * @param $watchlist String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
667 * @param $titleObj Title the page under consideration
668 * @param $userOption String The user option to consider when $watchlist=preferences.
669 * If not set will magically default to either watchdefault or watchcreations
672 protected function getWatchlistValue ( $watchlist, $titleObj, $userOption = null ) {
674 $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)$this->getUser()->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 ) {
716 $user = $this->getUser();
718 WatchAction
::doWatch( $titleObj, $user );
720 WatchAction
::doUnwatch( $titleObj, $user );
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->getRequest()->getCheck( $encParamName );
770 $value = $this->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' ),
1168 // Messages from WikiPage::doEit()
1169 'edit-hook-aborted' => array( 'code' => 'edit-hook-aborted', 'info' => "Your edit was aborted by an ArticleSave hook" ),
1170 'edit-gone-missing' => array( 'code' => 'edit-gone-missing', 'info' => "The page you tried to edit doesn't seem to exist anymore" ),
1171 'edit-conflict' => array( 'code' => 'editconflict', 'info' => "Edit conflict detected" ),
1172 'edit-already-exists' => array( 'code' => 'edit-already-exists', 'info' => "It seems the page you tried to create already exist" ),
1175 'invalid-session-key' => array( 'code' => 'invalid-session-key', 'info' => 'Not a valid session key' ),
1176 'nouploadmodule' => array( 'code' => 'nouploadmodule', 'info' => 'No upload module set' ),
1177 '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' ),
1178 'copyuploaddisabled' => array( 'code' => 'copyuploaddisabled', 'info' => 'Uploads by URL is not enabled. Make sure $wgAllowCopyUploads is set to true in LocalSettings.php.' ),
1180 'filename-tooshort' => array( 'code' => 'filename-tooshort', 'info' => 'The filename is too short' ),
1181 'illegal-filename' => array( 'code' => 'illegal-filename', 'info' => 'The filename is not allowed' ),
1182 'filetype-missing' => array( 'code' => 'filetype-missing', 'info' => 'The file is missing an extension' ),
1186 * Helper function for readonly errors
1188 public function dieReadOnly() {
1189 $parsed = $this->parseMsg( array( 'readonlytext' ) );
1190 $this->dieUsage( $parsed['info'], $parsed['code'], /* http error */ 0,
1191 array( 'readonlyreason' => wfReadOnlyReason() ) );
1195 * Output the error message related to a certain array
1196 * @param $error (array|string) Element of a getUserPermissionsErrors()-style array
1198 public function dieUsageMsg( $error ) {
1199 # most of the time we send a 1 element, so we might as well send it as
1200 # a string and make this an array here.
1201 if( is_string( $error ) ) {
1202 $error = array( $error );
1204 $parsed = $this->parseMsg( $error );
1205 $this->dieUsage( $parsed['info'], $parsed['code'] );
1209 * Return the error message related to a certain array
1210 * @param $error array Element of a getUserPermissionsErrors()-style array
1211 * @return array('code' => code, 'info' => info)
1213 public function parseMsg( $error ) {
1214 $key = array_shift( $error );
1216 // Check whether the error array was nested
1217 // array( array( <code>, <params> ), array( <another_code>, <params> ) )
1218 if( is_array( $key ) ){
1220 $key = array_shift( $error );
1223 if ( isset( self
::$messageMap[$key] ) ) {
1224 return array( 'code' =>
1225 wfMsgReplaceArgs( self
::$messageMap[$key]['code'], $error ),
1227 wfMsgReplaceArgs( self
::$messageMap[$key]['info'], $error )
1231 // If the key isn't present, throw an "unknown error"
1232 return $this->parseMsg( array( 'unknownerror', $key ) );
1236 * Internal code errors should be reported with this method
1237 * @param $method string Method or function name
1238 * @param $message string Error message
1240 protected static function dieDebug( $method, $message ) {
1241 wfDebugDieBacktrace( "Internal error in $method: $message" );
1245 * Indicates if this module needs maxlag to be checked
1248 public function shouldCheckMaxlag() {
1253 * Indicates whether this module requires read rights
1256 public function isReadMode() {
1260 * Indicates whether this module requires write mode
1263 public function isWriteMode() {
1268 * Indicates whether this module must be called with a POST request
1271 public function mustBePosted() {
1276 * Returns whether this module requires a Token to execute
1279 public function needsToken() {
1284 * 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
1285 * @return bool|string
1287 public function getTokenSalt() {
1292 * Gets the user for whom to get the watchlist
1294 * @param $params array
1297 public function getWatchlistUser( $params ) {
1298 if ( !is_null( $params['owner'] ) && !is_null( $params['token'] ) ) {
1299 $user = User
::newFromName( $params['owner'], false );
1300 if ( !$user->getId() ) {
1301 $this->dieUsage( 'Specified user does not exist', 'bad_wlowner' );
1303 $token = $user->getOption( 'watchlisttoken' );
1304 if ( $token == '' ||
$token != $params['token'] ) {
1305 $this->dieUsage( 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences', 'bad_wltoken' );
1308 if ( !$this->getUser()->isLoggedIn() ) {
1309 $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
1311 $user = $this->getUser();
1317 * @return false|string|array Returns a false if the module has no help url, else returns a (array of) string
1319 public function getHelpUrls() {
1324 * Returns a list of all possible errors returned by the module
1325 * @return array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
1327 public function getPossibleErrors() {
1330 $params = $this->getFinalParams();
1332 foreach ( $params as $paramName => $paramSettings ) {
1333 if ( isset( $paramSettings[ApiBase
::PARAM_REQUIRED
] ) ) {
1334 $ret[] = array( 'missingparam', $paramName );
1339 if ( $this->mustBePosted() ) {
1340 $ret[] = array( 'mustbeposted', $this->getModuleName() );
1343 if ( $this->isReadMode() ) {
1344 $ret[] = array( 'readrequired' );
1347 if ( $this->isWriteMode() ) {
1348 $ret[] = array( 'writerequired' );
1349 $ret[] = array( 'writedisabled' );
1352 if ( $this->needsToken() ) {
1353 $ret[] = array( 'missingparam', 'token' );
1354 $ret[] = array( 'sessionfailure' );
1361 * Parses a list of errors into a standardised format
1362 * @param $errors array List of errors. Items can be in the for array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
1363 * @return array Parsed list of errors with items in the form array( 'code' => ..., 'info' => ... )
1365 public function parseErrors( $errors ) {
1368 foreach ( $errors as $row ) {
1369 if ( isset( $row['code'] ) && isset( $row['info'] ) ) {
1372 $ret[] = $this->parseMsg( $row );
1379 * Profiling: total module execution time
1381 private $mTimeIn = 0, $mModuleTime = 0;
1384 * Start module profiling
1386 public function profileIn() {
1387 if ( $this->mTimeIn
!== 0 ) {
1388 ApiBase
::dieDebug( __METHOD__
, 'called twice without calling profileOut()' );
1390 $this->mTimeIn
= microtime( true );
1391 wfProfileIn( $this->getModuleProfileName() );
1395 * End module profiling
1397 public function profileOut() {
1398 if ( $this->mTimeIn
=== 0 ) {
1399 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileIn() first' );
1401 if ( $this->mDBTimeIn
!== 0 ) {
1402 ApiBase
::dieDebug( __METHOD__
, 'must be called after database profiling is done with profileDBOut()' );
1405 $this->mModuleTime +
= microtime( true ) - $this->mTimeIn
;
1407 wfProfileOut( $this->getModuleProfileName() );
1411 * When modules crash, sometimes it is needed to do a profileOut() regardless
1412 * of the profiling state the module was in. This method does such cleanup.
1414 public function safeProfileOut() {
1415 if ( $this->mTimeIn
!== 0 ) {
1416 if ( $this->mDBTimeIn
!== 0 ) {
1417 $this->profileDBOut();
1419 $this->profileOut();
1424 * Total time the module was executed
1427 public function getProfileTime() {
1428 if ( $this->mTimeIn
!== 0 ) {
1429 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileOut() first' );
1431 return $this->mModuleTime
;
1435 * Profiling: database execution time
1437 private $mDBTimeIn = 0, $mDBTime = 0;
1440 * Start module profiling
1442 public function profileDBIn() {
1443 if ( $this->mTimeIn
=== 0 ) {
1444 ApiBase
::dieDebug( __METHOD__
, 'must be called while profiling the entire module with profileIn()' );
1446 if ( $this->mDBTimeIn
!== 0 ) {
1447 ApiBase
::dieDebug( __METHOD__
, 'called twice without calling profileDBOut()' );
1449 $this->mDBTimeIn
= microtime( true );
1450 wfProfileIn( $this->getModuleProfileName( true ) );
1454 * End database profiling
1456 public function profileDBOut() {
1457 if ( $this->mTimeIn
=== 0 ) {
1458 ApiBase
::dieDebug( __METHOD__
, 'must be called while profiling the entire module with profileIn()' );
1460 if ( $this->mDBTimeIn
=== 0 ) {
1461 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileDBIn() first' );
1464 $time = microtime( true ) - $this->mDBTimeIn
;
1465 $this->mDBTimeIn
= 0;
1467 $this->mDBTime +
= $time;
1468 $this->getMain()->mDBTime +
= $time;
1469 wfProfileOut( $this->getModuleProfileName( true ) );
1473 * Total time the module used the database
1476 public function getProfileDBTime() {
1477 if ( $this->mDBTimeIn
!== 0 ) {
1478 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileDBOut() first' );
1480 return $this->mDBTime
;
1484 * Debugging function that prints a value and an optional backtrace
1485 * @param $value mixed Value to print
1486 * @param $name string Description of the printed value
1487 * @param $backtrace bool If true, print a backtrace
1489 public static function debugPrint( $value, $name = 'unknown', $backtrace = false ) {
1490 print "\n\n<pre><b>Debugging value '$name':</b>\n\n";
1491 var_export( $value );
1493 print "\n" . wfBacktrace();
1499 * Returns a string that identifies the version of this class.
1502 public static function getBaseVersion() {
1503 return __CLASS__
. ': $Id$';