1cc1e304dff5dfdca6b7ff3cd4a5cb4d2ee20984
4 * Created on Sep 5, 2006
6 * API for MediaWiki 1.8+
8 * Copyright © 2006, 2010 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
27 * This abstract class implements many basic API functions, and is the base of
29 * The class functions are divided into several areas of functionality:
31 * Module parameters: Derived classes can define getAllowedParams() to specify
32 * which parameters to expect,h ow to parse and validate them.
34 * Profiling: various methods to allow keeping tabs on various tasks and their
37 * Self-documentation: code to allow the API to document its own state
41 abstract class ApiBase
{
43 // These constants allow modules to specify exactly how to treat incoming parameters.
45 const PARAM_DFLT
= 0; // Default value of the parameter
46 const PARAM_ISMULTI
= 1; // Boolean, do we accept more than one item for this parameter (e.g.: titles)?
47 const PARAM_TYPE
= 2; // Can be either a string type (e.g.: 'integer') or an array of allowed values
48 const PARAM_MAX
= 3; // Max value allowed for a parameter. Only applies if TYPE='integer'
49 const PARAM_MAX2
= 4; // Max value allowed for a parameter for bots and sysops. Only applies if TYPE='integer'
50 const PARAM_MIN
= 5; // Lowest value allowed for a parameter. Only applies if TYPE='integer'
51 const PARAM_ALLOW_DUPLICATES
= 6; // Boolean, do we allow the same value to be set more than once when ISMULTI=true
52 const PARAM_DEPRECATED
= 7; // Boolean, is the parameter deprecated (will show a warning)
54 const LIMIT_BIG1
= 500; // Fast query, std user limit
55 const LIMIT_BIG2
= 5000; // Fast query, bot/sysop limit
56 const LIMIT_SML1
= 50; // Slow query, std user limit
57 const LIMIT_SML2
= 500; // Slow query, bot/sysop limit
59 private $mMainModule, $mModuleName, $mModulePrefix;
63 * @param $mainModule ApiMain object
64 * @param $moduleName string Name of this module
65 * @param $modulePrefix string Prefix to use for parameter names
67 public function __construct( $mainModule, $moduleName, $modulePrefix = '' ) {
68 $this->mMainModule
= $mainModule;
69 $this->mModuleName
= $moduleName;
70 $this->mModulePrefix
= $modulePrefix;
73 /*****************************************************************************
75 *****************************************************************************/
78 * Evaluates the parameters, performs the requested query, and sets up
79 * the result. Concrete implementations of ApiBase must override this
80 * method to provide whatever functionality their module offers.
81 * Implementations must not produce any output on their own and are not
82 * expected to handle any errors.
84 * The execute() method will be invoked directly by ApiMain immediately
85 * before the result of the module is output. Aside from the
86 * constructor, implementations should assume that no other methods
87 * will be called externally on the module before the result is
90 * The result data should be stored in the ApiResult object available
91 * through getResult().
93 public abstract function execute();
96 * Returns a string that identifies the version of the extending class.
97 * Typically includes the class name, the svn revision, timestamp, and
98 * last author. Usually done with SVN's Id keyword
101 public abstract function getVersion();
104 * Get the name of the module being executed by this instance
107 public function getModuleName() {
108 return $this->mModuleName
;
112 * Get parameter prefix (usually two letters or an empty string).
115 public function getModulePrefix() {
116 return $this->mModulePrefix
;
120 * Get the name of the module as shown in the profiler log
123 public function getModuleProfileName( $db = false ) {
125 return 'API:' . $this->mModuleName
. '-DB';
127 return 'API:' . $this->mModuleName
;
132 * Get the main module
133 * @return ApiMain object
135 public function getMain() {
136 return $this->mMainModule
;
140 * Returns true if this module is the main module ($this === $this->mMainModule),
144 public function isMain() {
145 return $this === $this->mMainModule
;
149 * Get the result object
152 public function getResult() {
153 // Main module has getResult() method overriden
154 // Safety - avoid infinite loop:
155 if ( $this->isMain() ) {
156 ApiBase
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
158 return $this->getMain()->getResult();
162 * Get the result data array (read-only)
165 public function getResultData() {
166 return $this->getResult()->getData();
170 * Set warning section for this module. Users should monitor this
171 * section to notice any changes in API. Multiple calls to this
172 * function will result in the warning messages being separated by
174 * @param $warning string Warning message
176 public function setWarning( $warning ) {
177 $data = $this->getResult()->getData();
178 if ( isset( $data['warnings'][$this->getModuleName()] ) ) {
179 // Don't add duplicate warnings
180 $warn_regex = preg_quote( $warning, '/' );
181 if ( preg_match( "/{$warn_regex}(\\n|$)/", $data['warnings'][$this->getModuleName()]['*'] ) )
185 $oldwarning = $data['warnings'][$this->getModuleName()]['*'];
186 // If there is a warning already, append it to the existing one
187 $warning = "$oldwarning\n$warning";
188 $this->getResult()->unsetValue( 'warnings', $this->getModuleName() );
191 ApiResult
::setContent( $msg, $warning );
192 $this->getResult()->disableSizeCheck();
193 $this->getResult()->addValue( 'warnings', $this->getModuleName(), $msg );
194 $this->getResult()->enableSizeCheck();
198 * If the module may only be used with a certain format module,
199 * it should override this method to return an instance of that formatter.
200 * A value of null means the default format will be used.
201 * @return mixed instance of a derived class of ApiFormatBase, or null
203 public function getCustomPrinter() {
208 * Generates help message for this module, or false if there is no description
209 * @return mixed string or false
211 public function makeHelpMsg() {
212 static $lnPrfx = "\n ";
214 $msg = $this->getDescription();
216 if ( $msg !== false ) {
218 if ( !is_array( $msg ) ) {
223 $msg = $lnPrfx . implode( $lnPrfx, $msg ) . "\n";
225 if ( $this->isReadMode() ) {
226 $msg .= "\nThis module requires read rights.";
228 if ( $this->isWriteMode() ) {
229 $msg .= "\nThis module requires write rights.";
231 if ( $this->mustBePosted() ) {
232 $msg .= "\nThis module only accepts POST requests.";
234 if ( $this->isReadMode() ||
$this->isWriteMode() ||
235 $this->mustBePosted() )
241 $paramsMsg = $this->makeHelpMsgParameters();
242 if ( $paramsMsg !== false ) {
243 $msg .= "Parameters:\n$paramsMsg";
247 $examples = $this->getExamples();
248 if ( $examples !== false ) {
249 if ( !is_array( $examples ) ) {
254 $msg .= 'Example' . ( count( $examples ) > 1 ?
's' : '' ) . ":\n ";
255 $msg .= implode( $lnPrfx, $examples ) . "\n";
258 if ( $this->getMain()->getShowVersions() ) {
259 $versions = $this->getVersion();
260 $pattern = '/(\$.*) ([0-9a-z_]+\.php) (.*\$)/i';
261 $callback = array( $this, 'makeHelpMsg_callback' );
263 if ( is_array( $versions ) ) {
264 foreach ( $versions as &$v ) {
265 $v = preg_replace_callback( $pattern, $callback, $v );
267 $versions = implode( "\n ", $versions );
269 $versions = preg_replace_callback( $pattern, $callback, $versions );
272 $msg .= "Version:\n $versions\n";
280 * Generates the parameter descriptions for this module, to be displayed in the
284 public function makeHelpMsgParameters() {
285 $params = $this->getFinalParams();
288 $paramsDescription = $this->getFinalParamDescription();
290 $paramPrefix = "\n" . str_repeat( ' ', 19 );
291 foreach ( $params as $paramName => $paramSettings ) {
292 $desc = isset( $paramsDescription[$paramName] ) ?
$paramsDescription[$paramName] : '';
293 if ( is_array( $desc ) ) {
294 $desc = implode( $paramPrefix, $desc );
297 $deprecated = isset( $paramSettings[self
::PARAM_DEPRECATED
] ) ?
298 $paramSettings[self
::PARAM_DEPRECATED
] : false;
300 $desc = "DEPRECATED! $desc";
303 $type = isset( $paramSettings[self
::PARAM_TYPE
] ) ?
$paramSettings[self
::PARAM_TYPE
] : null;
304 if ( isset( $type ) ) {
305 if ( isset( $paramSettings[self
::PARAM_ISMULTI
] ) ) {
306 $prompt = 'Values (separate with \'|\'): ';
308 $prompt = 'One value: ';
311 if ( is_array( $type ) ) {
313 $nothingPrompt = false;
314 foreach ( $type as $t )
316 $nothingPrompt = 'Can be empty, or ';
320 $desc .= $paramPrefix . $nothingPrompt . $prompt . implode( ', ', $choices );
324 // Special handling because namespaces are type-limited, yet they are not given
325 $desc .= $paramPrefix . $prompt . implode( ', ', ApiBase
::getValidNamespaces() );
328 $desc .= $paramPrefix . "No more than {$paramSettings[self :: PARAM_MAX]} ({$paramSettings[self::PARAM_MAX2]} for bots) allowed.";
331 $hasMin = isset( $paramSettings[self
::PARAM_MIN
] );
332 $hasMax = isset( $paramSettings[self
::PARAM_MAX
] );
333 if ( $hasMin ||
$hasMax ) {
335 $intRangeStr = "The value must be no less than {$paramSettings[self::PARAM_MIN]}";
336 } elseif ( !$hasMin ) {
337 $intRangeStr = "The value must be no more than {$paramSettings[self::PARAM_MAX]}";
339 $intRangeStr = "The value must be between {$paramSettings[self::PARAM_MIN]} and {$paramSettings[self::PARAM_MAX]}";
342 $desc .= $paramPrefix . $intRangeStr;
349 $default = is_array( $paramSettings ) ?
( isset( $paramSettings[self
::PARAM_DFLT
] ) ?
$paramSettings[self
::PARAM_DFLT
] : null ) : $paramSettings;
350 if ( !is_null( $default ) && $default !== false ) {
351 $desc .= $paramPrefix . "Default: $default";
354 $msg .= sprintf( " %-14s - %s\n", $this->encodeParamName( $paramName ), $desc );
364 * Callback for preg_replace_callback() call in makeHelpMsg().
365 * Replaces a source file name with a link to ViewVC
367 public function makeHelpMsg_callback( $matches ) {
368 global $wgAutoloadClasses, $wgAutoloadLocalClasses;
369 if ( isset( $wgAutoloadLocalClasses[get_class( $this )] ) ) {
370 $file = $wgAutoloadLocalClasses[get_class( $this )];
371 } elseif ( isset( $wgAutoloadClasses[get_class( $this )] ) ) {
372 $file = $wgAutoloadClasses[get_class( $this )];
375 // Do some guesswork here
376 $path = strstr( $file, 'includes/api/' );
377 if ( $path === false ) {
378 $path = strstr( $file, 'extensions/' );
380 $path = 'phase3/' . $path;
383 // Get the filename from $matches[2] instead of $file
384 // If they're not the same file, they're assumed to be in the
386 // This is necessary to make stuff like ApiMain::getVersion()
387 // returning the version string for ApiBase work
389 return "{$matches[0]}\n http://svn.wikimedia.org/" .
390 "viewvc/mediawiki/trunk/" . dirname( $path ) .
397 * Returns the description string for this module
398 * @return mixed string or array of strings
400 protected function getDescription() {
405 * Returns usage examples for this module. Return null if no examples are available.
406 * @return mixed string or array of strings
408 protected function getExamples() {
413 * Returns an array of allowed parameters (parameter name) => (default
414 * value) or (parameter name) => (array with PARAM_* constants as keys)
415 * Don't call this function directly: use getFinalParams() to allow
416 * hooks to modify parameters as needed.
419 protected function getAllowedParams() {
424 * Returns an array of parameter descriptions.
425 * Don't call this functon directly: use getFinalParamDescription() to
426 * allow hooks to modify descriptions as needed.
429 protected function getParamDescription() {
434 * Get final list of parameters, after hooks have had a chance to
435 * tweak it as needed.
438 public function getFinalParams() {
439 $params = $this->getAllowedParams();
440 wfRunHooks( 'APIGetAllowedParams', array( &$this, &$params ) );
445 * Get final description, after hooks have had a chance to tweak it as
449 public function getFinalParamDescription() {
450 $desc = $this->getParamDescription();
451 wfRunHooks( 'APIGetParamDescription', array( &$this, &$desc ) );
456 * This method mangles parameter name based on the prefix supplied to the constructor.
457 * Override this method to change parameter name during runtime
458 * @param $paramName string Parameter name
459 * @return string Prefixed parameter name
461 public function encodeParamName( $paramName ) {
462 return $this->mModulePrefix
. $paramName;
466 * Using getAllowedParams(), this function makes an array of the values
467 * provided by the user, with key being the name of the variable, and
468 * value - validated value from user or default. limits will not be
469 * parsed if $parseLimit is set to false; use this when the max
470 * limit is not definitive yet, e.g. when getting revisions.
471 * @param $parseLimit Boolean: true by default
474 public function extractRequestParams( $parseLimit = true ) {
475 $params = $this->getFinalParams();
478 foreach ( $params as $paramName => $paramSettings ) {
479 $results[$paramName] = $this->getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
486 * Get a value for the given parameter
487 * @param $paramName string Parameter name
488 * @param $parseLimit bool see extractRequestParams()
489 * @return mixed Parameter value
491 protected function getParameter( $paramName, $parseLimit = true ) {
492 $params = $this->getFinalParams();
493 $paramSettings = $params[$paramName];
494 return $this->getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
498 * Die if none or more than one of a certain set of parameters is set and not false.
499 * @param $params array of parameter names
501 public function requireOnlyOneParameter( $params ) {
502 $required = func_get_args();
503 array_shift( $required );
505 $intersection = array_intersect( array_keys( array_filter( $params,
506 create_function( '$x', 'return !is_null($x) && $x !== false;' )
508 if ( count( $intersection ) > 1 ) {
509 $this->dieUsage( 'The parameters ' . implode( ', ', $intersection ) . ' can not be used together', 'invalidparammix' );
510 } elseif ( count( $intersection ) == 0 ) {
511 $this->dieUsage( 'One of the parameters ' . implode( ', ', $required ) . ' is required', 'missingparam' );
516 * Returns an array of the namespaces (by integer id) that exist on the
517 * wiki. Used primarily in help documentation.
520 public static function getValidNamespaces() {
521 static $mValidNamespaces = null;
523 if ( is_null( $mValidNamespaces ) ) {
524 global $wgCanonicalNamespaceNames;
525 $mValidNamespaces = array( NS_MAIN
); // Doesn't appear in $wgCanonicalNamespaceNames for some reason
526 foreach ( array_keys( $wgCanonicalNamespaceNames ) as $ns ) {
528 $mValidNamespaces[] = $ns;
533 return $mValidNamespaces;
536 * Handle watchlist settings
538 protected function getWatchlistValue ( $watchlist, $titleObj ) {
539 switch ( $watchlist ) {
545 if ( $titleObj->exists() ) {
547 return $wgUser->getOption( 'watchdefault' ) ||
$titleObj->userIsWatching();
552 return $titleObj->userIsWatching();
557 * Using the settings determine the value for the given parameter
559 * @param $paramName String: parameter name
560 * @param $paramSettings Mixed: default value or an array of settings
561 * using PARAM_* constants.
562 * @param $parseLimit Boolean: parse limit?
563 * @return mixed Parameter value
565 protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
566 // Some classes may decide to change parameter names
567 $encParamName = $this->encodeParamName( $paramName );
569 if ( !is_array( $paramSettings ) ) {
570 $default = $paramSettings;
572 $type = gettype( $paramSettings );
576 $default = isset( $paramSettings[self
::PARAM_DFLT
] ) ?
$paramSettings[self
::PARAM_DFLT
] : null;
577 $multi = isset( $paramSettings[self
::PARAM_ISMULTI
] ) ?
$paramSettings[self
::PARAM_ISMULTI
] : false;
578 $type = isset( $paramSettings[self
::PARAM_TYPE
] ) ?
$paramSettings[self
::PARAM_TYPE
] : null;
579 $dupes = isset( $paramSettings[self
::PARAM_ALLOW_DUPLICATES
] ) ?
$paramSettings[self
::PARAM_ALLOW_DUPLICATES
] : false;
580 $deprecated = isset( $paramSettings[self
::PARAM_DEPRECATED
] ) ?
$paramSettings[self
::PARAM_DEPRECATED
] : false;
582 // When type is not given, and no choices, the type is the same as $default
583 if ( !isset( $type ) ) {
584 if ( isset( $default ) ) {
585 $type = gettype( $default );
587 $type = 'NULL'; // allow everything
592 if ( $type == 'boolean' ) {
593 if ( isset( $default ) && $default !== false ) {
594 // Having a default value of anything other than 'false' is pointless
595 ApiBase
::dieDebug( __METHOD__
, "Boolean param $encParamName's default is set to '$default'" );
598 $value = $this->getMain()->getRequest()->getCheck( $encParamName );
600 $value = $this->getMain()->getRequest()->getVal( $encParamName, $default );
602 if ( isset( $value ) && $type == 'namespace' ) {
603 $type = ApiBase
::getValidNamespaces();
607 if ( isset( $value ) && ( $multi ||
is_array( $type ) ) ) {
608 $value = $this->parseMultiValue( $encParamName, $value, $multi, is_array( $type ) ?
$type : null );
611 // More validation only when choices were not given
612 // choices were validated in parseMultiValue()
613 if ( isset( $value ) ) {
614 if ( !is_array( $type ) ) {
616 case 'NULL': // nothing to do
618 case 'string': // nothing to do
620 case 'integer': // Force everything using intval() and optionally validate limits
622 $value = is_array( $value ) ?
array_map( 'intval', $value ) : intval( $value );
623 $min = isset ( $paramSettings[self
::PARAM_MIN
] ) ?
$paramSettings[self
::PARAM_MIN
] : null;
624 $max = isset ( $paramSettings[self
::PARAM_MAX
] ) ?
$paramSettings[self
::PARAM_MAX
] : null;
626 if ( !is_null( $min ) ||
!is_null( $max ) ) {
627 $values = is_array( $value ) ?
$value : array( $value );
628 foreach ( $values as &$v ) {
629 $this->validateLimit( $paramName, $v, $min, $max );
634 if ( !$parseLimit ) {
635 // Don't do any validation whatsoever
638 if ( !isset( $paramSettings[self
::PARAM_MAX
] ) ||
!isset( $paramSettings[self
::PARAM_MAX2
] ) ) {
639 ApiBase
::dieDebug( __METHOD__
, "MAX1 or MAX2 are not defined for the limit $encParamName" );
642 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
644 $min = isset( $paramSettings[self
::PARAM_MIN
] ) ?
$paramSettings[self
::PARAM_MIN
] : 0;
645 if ( $value == 'max' ) {
646 $value = $this->getMain()->canApiHighLimits() ?
$paramSettings[self
::PARAM_MAX2
] : $paramSettings[self
::PARAM_MAX
];
647 $this->getResult()->addValue( 'limits', $this->getModuleName(), $value );
649 $value = intval( $value );
650 $this->validateLimit( $paramName, $value, $min, $paramSettings[self
::PARAM_MAX
], $paramSettings[self
::PARAM_MAX2
] );
655 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
659 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
661 $value = wfTimestamp( TS_UNIX
, $value );
662 if ( $value === 0 ) {
663 $this->dieUsage( "Invalid value '$value' for timestamp parameter $encParamName", "badtimestamp_{$encParamName}" );
665 $value = wfTimestamp( TS_MW
, $value );
668 if( !is_array( $value ) ) $value = array( $value );
670 foreach( $value as $key => $val ) {
671 $title = Title
::makeTitleSafe( NS_USER
, $val );
672 if ( is_null( $title ) ) {
673 $this->dieUsage( "Invalid value for user parameter $encParamName", "baduser_{$encParamName}" );
675 $value[$key] = $title->getText();
678 if( !$multi ) $value = $value[0];
682 ApiBase
::dieDebug( __METHOD__
, "Param $encParamName's type is unknown - $type" );
686 // Throw out duplicates if requested
687 if ( is_array( $value ) && !$dupes ) {
688 $value = array_unique( $value );
691 // Set a warning if a deprecated parameter has been passed
692 if ( $deprecated && $value !== false ) {
693 $this->setWarning( "The $encParamName parameter has been deprecated." );
701 * Return an array of values that were given in a 'a|b|c' notation,
702 * after it optionally validates them against the list allowed values.
704 * @param $valueName string The name of the parameter (for error
706 * @param $value mixed The value being parsed
707 * @param $allowMultiple bool Can $value contain more than one value
709 * @param $allowedValues mixed An array of values to check against. If
710 * null, all values are accepted.
711 * @return mixed (allowMultiple ? an_array_of_values : a_single_value)
713 protected function parseMultiValue( $valueName, $value, $allowMultiple, $allowedValues ) {
714 if ( trim( $value ) === '' && $allowMultiple ) {
718 // This is a bit awkward, but we want to avoid calling canApiHighLimits() because it unstubs $wgUser
719 $valuesList = explode( '|', $value, self
::LIMIT_SML2 +
1 );
720 $sizeLimit = count( $valuesList ) > self
::LIMIT_SML1
&& $this->mMainModule
->canApiHighLimits() ?
721 self
::LIMIT_SML2
: self
::LIMIT_SML1
;
723 if ( self
::truncateArray( $valuesList, $sizeLimit ) ) {
724 $this->setWarning( "Too many values supplied for parameter '$valueName': the limit is $sizeLimit" );
727 if ( !$allowMultiple && count( $valuesList ) != 1 ) {
728 $possibleValues = is_array( $allowedValues ) ?
"of '" . implode( "', '", $allowedValues ) . "'" : '';
729 $this->dieUsage( "Only one $possibleValues is allowed for parameter '$valueName'", "multival_$valueName" );
732 if ( is_array( $allowedValues ) ) {
733 // Check for unknown values
734 $unknown = array_diff( $valuesList, $allowedValues );
735 if ( count( $unknown ) ) {
736 if ( $allowMultiple ) {
737 $s = count( $unknown ) > 1 ?
's' : '';
738 $vals = implode( ", ", $unknown );
739 $this->setWarning( "Unrecognized value$s for parameter '$valueName': $vals" );
741 $this->dieUsage( "Unrecognized value for parameter '$valueName': {$valuesList[0]}", "unknown_$valueName" );
744 // Now throw them out
745 $valuesList = array_intersect( $valuesList, $allowedValues );
748 return $allowMultiple ?
$valuesList : $valuesList[0];
752 * Validate the value against the minimum and user/bot maximum limits.
753 * Prints usage info on failure.
754 * @param $paramName string Parameter name
755 * @param $value int Parameter value
756 * @param $min int Minimum value
757 * @param $max int Maximum value for users
758 * @param $botMax int Maximum value for sysops/bots
760 function validateLimit( $paramName, &$value, $min, $max, $botMax = null ) {
761 if ( !is_null( $min ) && $value < $min ) {
762 $this->setWarning( $this->encodeParamName( $paramName ) . " may not be less than $min (set to $value)" );
766 // Minimum is always validated, whereas maximum is checked only if not running in internal call mode
767 if ( $this->getMain()->isInternalMode() ) {
771 // Optimization: do not check user's bot status unless really needed -- skips db query
772 // assumes $botMax >= $max
773 if ( !is_null( $max ) && $value > $max ) {
774 if ( !is_null( $botMax ) && $this->getMain()->canApiHighLimits() ) {
775 if ( $value > $botMax ) {
776 $this->setWarning( $this->encodeParamName( $paramName ) . " may not be over $botMax (set to $value) for bots or sysops" );
780 $this->setWarning( $this->encodeParamName( $paramName ) . " may not be over $max (set to $value) for users" );
787 * Truncate an array to a certain length.
788 * @param $arr array Array to truncate
789 * @param $limit int Maximum length
790 * @return bool True if the array was truncated, false otherwise
792 public static function truncateArray( &$arr, $limit ) {
794 while ( count( $arr ) > $limit ) {
795 $junk = array_pop( $arr );
802 * Throw a UsageException, which will (if uncaught) call the main module's
803 * error handler and die with an error message.
805 * @param $description string One-line human-readable description of the
806 * error condition, e.g., "The API requires a valid action parameter"
807 * @param $errorCode string Brief, arbitrary, stable string to allow easy
808 * automated identification of the error, e.g., 'unknown_action'
809 * @param $httpRespCode int HTTP response code
810 * @param $extradata array Data to add to the <error> element; array in ApiResult format
812 public function dieUsage( $description, $errorCode, $httpRespCode = 0, $extradata = null ) {
814 throw new UsageException( $description, $this->encodeParamName( $errorCode ), $httpRespCode, $extradata );
818 * Array that maps message keys to error messages. $1 and friends are replaced.
820 public static $messageMap = array(
821 // This one MUST be present, or dieUsageMsg() will recurse infinitely
822 'unknownerror' => array( 'code' => 'unknownerror', 'info' => "Unknown error: ``\$1''" ),
823 'unknownerror-nocode' => array( 'code' => 'unknownerror', 'info' => 'Unknown error' ),
825 // Messages from Title::getUserPermissionsErrors()
826 'ns-specialprotected' => array( 'code' => 'unsupportednamespace', 'info' => "Pages in the Special namespace can't be edited" ),
827 'protectedinterface' => array( 'code' => 'protectednamespace-interface', 'info' => "You're not allowed to edit interface messages" ),
828 'namespaceprotected' => array( 'code' => 'protectednamespace', 'info' => "You're not allowed to edit pages in the ``\$1'' namespace" ),
829 'customcssjsprotected' => array( 'code' => 'customcssjsprotected', 'info' => "You're not allowed to edit custom CSS and JavaScript pages" ),
830 'cascadeprotected' => array( 'code' => 'cascadeprotected', 'info' => "The page you're trying to edit is protected because it's included in a cascade-protected page" ),
831 'protectedpagetext' => array( 'code' => 'protectedpage', 'info' => "The ``\$1'' right is required to edit this page" ),
832 'protect-cantedit' => array( 'code' => 'cantedit', 'info' => "You can't protect this page because you can't edit it" ),
833 'badaccess-group0' => array( 'code' => 'permissiondenied', 'info' => "Permission denied" ), // Generic permission denied message
834 'badaccess-groups' => array( 'code' => 'permissiondenied', 'info' => "Permission denied" ),
835 'titleprotected' => array( 'code' => 'protectedtitle', 'info' => "This title has been protected from creation" ),
836 'nocreate-loggedin' => array( 'code' => 'cantcreate', 'info' => "You don't have permission to create new pages" ),
837 'nocreatetext' => array( 'code' => 'cantcreate-anon', 'info' => "Anonymous users can't create new pages" ),
838 'movenologintext' => array( 'code' => 'cantmove-anon', 'info' => "Anonymous users can't move pages" ),
839 'movenotallowed' => array( 'code' => 'cantmove', 'info' => "You don't have permission to move pages" ),
840 'confirmedittext' => array( 'code' => 'confirmemail', 'info' => "You must confirm your e-mail address before you can edit" ),
841 'blockedtext' => array( 'code' => 'blocked', 'info' => "You have been blocked from editing" ),
842 'autoblockedtext' => array( 'code' => 'autoblocked', 'info' => "Your IP address has been blocked automatically, because it was used by a blocked user" ),
844 // Miscellaneous interface messages
845 'actionthrottledtext' => array( 'code' => 'ratelimited', 'info' => "You've exceeded your rate limit. Please wait some time and try again" ),
846 'alreadyrolled' => array( 'code' => 'alreadyrolled', 'info' => "The page you tried to rollback was already rolled back" ),
847 'cantrollback' => array( 'code' => 'onlyauthor', 'info' => "The page you tried to rollback only has one author" ),
848 'readonlytext' => array( 'code' => 'readonly', 'info' => "The wiki is currently in read-only mode" ),
849 'sessionfailure' => array( 'code' => 'badtoken', 'info' => "Invalid token" ),
850 'cannotdelete' => array( 'code' => 'cantdelete', 'info' => "Couldn't delete ``\$1''. Maybe it was deleted already by someone else" ),
851 'notanarticle' => array( 'code' => 'missingtitle', 'info' => "The page you requested doesn't exist" ),
852 'selfmove' => array( 'code' => 'selfmove', 'info' => "Can't move a page to itself" ),
853 'immobile_namespace' => array( 'code' => 'immobilenamespace', 'info' => "You tried to move pages from or to a namespace that is protected from moving" ),
854 'articleexists' => array( 'code' => 'articleexists', 'info' => "The destination article already exists and is not a redirect to the source article" ),
855 'protectedpage' => array( 'code' => 'protectedpage', 'info' => "You don't have permission to perform this move" ),
856 'hookaborted' => array( 'code' => 'hookaborted', 'info' => "The modification you tried to make was aborted by an extension hook" ),
857 'cantmove-titleprotected' => array( 'code' => 'protectedtitle', 'info' => "The destination article has been protected from creation" ),
858 'imagenocrossnamespace' => array( 'code' => 'nonfilenamespace', 'info' => "Can't move a file to a non-file namespace" ),
859 'imagetypemismatch' => array( 'code' => 'filetypemismatch', 'info' => "The new file extension doesn't match its type" ),
860 // 'badarticleerror' => shouldn't happen
861 // 'badtitletext' => shouldn't happen
862 'ip_range_invalid' => array( 'code' => 'invalidrange', 'info' => "Invalid IP range" ),
863 'range_block_disabled' => array( 'code' => 'rangedisabled', 'info' => "Blocking IP ranges has been disabled" ),
864 'nosuchusershort' => array( 'code' => 'nosuchuser', 'info' => "The user you specified doesn't exist" ),
865 'badipaddress' => array( 'code' => 'invalidip', 'info' => "Invalid IP address specified" ),
866 'ipb_expiry_invalid' => array( 'code' => 'invalidexpiry', 'info' => "Invalid expiry time" ),
867 'ipb_already_blocked' => array( 'code' => 'alreadyblocked', 'info' => "The user you tried to block was already blocked" ),
868 '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." ),
869 'ipb_cant_unblock' => array( 'code' => 'cantunblock', 'info' => "The block you specified was not found. It may have been unblocked already" ),
870 '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" ),
871 'ipbblocked' => array( 'code' => 'ipbblocked', 'info' => 'You cannot block or unblock users while you are yourself blocked' ),
872 'ipbnounblockself' => array( 'code' => 'ipbnounblockself', 'info' => 'You are not allowed to unblock yourself' ),
873 'usermaildisabled' => array( 'code' => 'usermaildisabled', 'info' => "User email has been disabled" ),
874 'blockedemailuser' => array( 'code' => 'blockedfrommail', 'info' => "You have been blocked from sending e-mail" ),
875 'notarget' => array( 'code' => 'notarget', 'info' => "You have not specified a valid target for this action" ),
876 '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" ),
877 'rcpatroldisabled' => array( 'code' => 'patroldisabled', 'info' => "Patrolling is disabled on this wiki" ),
878 'markedaspatrollederror-noautopatrol' => array( 'code' => 'noautopatrol', 'info' => "You don't have permission to patrol your own changes" ),
879 'delete-toobig' => array( 'code' => 'bigdelete', 'info' => "You can't delete this page because it has more than \$1 revisions" ),
880 'movenotallowedfile' => array( 'code' => 'cantmovefile', 'info' => "You don't have permission to move files" ),
881 'userrights-no-interwiki' => array( 'code' => 'nointerwikiuserrights', 'info' => "You don't have permission to change user rights on other wikis" ),
882 'userrights-nodatabase' => array( 'code' => 'nosuchdatabase', 'info' => "Database ``\$1'' does not exist or is not local" ),
883 'nouserspecified' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
884 'noname' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
886 // API-specific messages
887 'readrequired' => array( 'code' => 'readapidenied', 'info' => "You need read permission to use this module" ),
888 '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" ),
889 'writerequired' => array( 'code' => 'writeapidenied', 'info' => "You're not allowed to edit this wiki through the API" ),
890 'missingparam' => array( 'code' => 'no$1', 'info' => "The \$1 parameter must be set" ),
891 'invalidtitle' => array( 'code' => 'invalidtitle', 'info' => "Bad title ``\$1''" ),
892 'nosuchpageid' => array( 'code' => 'nosuchpageid', 'info' => "There is no page with ID \$1" ),
893 'nosuchrevid' => array( 'code' => 'nosuchrevid', 'info' => "There is no revision with ID \$1" ),
894 'nosuchuser' => array( 'code' => 'nosuchuser', 'info' => "User ``\$1'' doesn't exist" ),
895 'invaliduser' => array( 'code' => 'invaliduser', 'info' => "Invalid username ``\$1''" ),
896 'invalidexpiry' => array( 'code' => 'invalidexpiry', 'info' => "Invalid expiry time ``\$1''" ),
897 'pastexpiry' => array( 'code' => 'pastexpiry', 'info' => "Expiry time ``\$1'' is in the past" ),
898 'create-titleexists' => array( 'code' => 'create-titleexists', 'info' => "Existing titles can't be protected with 'create'" ),
899 'missingtitle-createonly' => array( 'code' => 'missingtitle-createonly', 'info' => "Missing titles can only be protected with 'create'" ),
900 'cantblock' => array( 'code' => 'cantblock', 'info' => "You don't have permission to block users" ),
901 'canthide' => array( 'code' => 'canthide', 'info' => "You don't have permission to hide user names from the block log" ),
902 'cantblock-email' => array( 'code' => 'cantblock-email', 'info' => "You don't have permission to block users from sending e-mail through the wiki" ),
903 'unblock-notarget' => array( 'code' => 'notarget', 'info' => "Either the id or the user parameter must be set" ),
904 'unblock-idanduser' => array( 'code' => 'idanduser', 'info' => "The id and user parameters can't be used together" ),
905 'cantunblock' => array( 'code' => 'permissiondenied', 'info' => "You don't have permission to unblock users" ),
906 'cannotundelete' => array( 'code' => 'cantundelete', 'info' => "Couldn't undelete: the requested revisions may not exist, or may have been undeleted already" ),
907 'permdenied-undelete' => array( 'code' => 'permissiondenied', 'info' => "You don't have permission to restore deleted revisions" ),
908 'createonly-exists' => array( 'code' => 'articleexists', 'info' => "The article you tried to create has been created already" ),
909 'nocreate-missing' => array( 'code' => 'missingtitle', 'info' => "The article you tried to edit doesn't exist" ),
910 'nosuchrcid' => array( 'code' => 'nosuchrcid', 'info' => "There is no change with rcid ``\$1''" ),
911 'cantpurge' => array( 'code' => 'cantpurge', 'info' => "Only users with the 'purge' right can purge pages via the API" ),
912 'protect-invalidaction' => array( 'code' => 'protect-invalidaction', 'info' => "Invalid protection type ``\$1''" ),
913 'protect-invalidlevel' => array( 'code' => 'protect-invalidlevel', 'info' => "Invalid protection level ``\$1''" ),
914 'toofewexpiries' => array( 'code' => 'toofewexpiries', 'info' => "\$1 expiry timestamps were provided where \$2 were needed" ),
915 'cantimport' => array( 'code' => 'cantimport', 'info' => "You don't have permission to import pages" ),
916 'cantimport-upload' => array( 'code' => 'cantimport-upload', 'info' => "You don't have permission to import uploaded pages" ),
917 'nouploadmodule' => array( 'code' => 'nomodule', 'info' => 'No upload module set' ),
918 'importnofile' => array( 'code' => 'nofile', 'info' => "You didn't upload a file" ),
919 'importuploaderrorsize' => array( 'code' => 'filetoobig', 'info' => 'The file you uploaded is bigger than the maximum upload size' ),
920 'importuploaderrorpartial' => array( 'code' => 'partialupload', 'info' => 'The file was only partially uploaded' ),
921 'importuploaderrortemp' => array( 'code' => 'notempdir', 'info' => 'The temporary upload directory is missing' ),
922 'importcantopen' => array( 'code' => 'cantopenfile', 'info' => "Couldn't open the uploaded file" ),
923 'import-noarticle' => array( 'code' => 'badinterwiki', 'info' => 'Invalid interwiki title specified' ),
924 'importbadinterwiki' => array( 'code' => 'badinterwiki', 'info' => 'Invalid interwiki title specified' ),
925 'import-unknownerror' => array( 'code' => 'import-unknownerror', 'info' => "Unknown error on import: ``\$1''" ),
926 'cantoverwrite-sharedfile' => array( 'code' => 'cantoverwrite-sharedfile', 'info' => 'The target file exists on a shared repository and you do not have permission to override it' ),
927 'sharedfile-exists' => array( 'code' => 'fileexists-sharedrepo-perm', 'info' => 'The target file exists on a shared repository. Use the ignorewarnings parameter to override it.' ),
928 'mustbeposted' => array( 'code' => 'mustbeposted', 'info' => "The \$1 module requires a POST request" ),
929 'show' => array( 'code' => 'show', 'info' => 'Incorrect parameter - mutually exclusive values may not be supplied' ),
931 // ApiEditPage messages
932 'noimageredirect-anon' => array( 'code' => 'noimageredirect-anon', 'info' => "Anonymous users can't create image redirects" ),
933 'noimageredirect-logged' => array( 'code' => 'noimageredirect', 'info' => "You don't have permission to create image redirects" ),
934 'spamdetected' => array( 'code' => 'spamdetected', 'info' => "Your edit was refused because it contained a spam fragment: ``\$1''" ),
935 'filtered' => array( 'code' => 'filtered', 'info' => "The filter callback function refused your edit" ),
936 'contenttoobig' => array( 'code' => 'contenttoobig', 'info' => "The content you supplied exceeds the article size limit of \$1 kilobytes" ),
937 'noedit-anon' => array( 'code' => 'noedit-anon', 'info' => "Anonymous users can't edit pages" ),
938 'noedit' => array( 'code' => 'noedit', 'info' => "You don't have permission to edit pages" ),
939 'wasdeleted' => array( 'code' => 'pagedeleted', 'info' => "The page has been deleted since you fetched its timestamp" ),
940 'blankpage' => array( 'code' => 'emptypage', 'info' => "Creating new, empty pages is not allowed" ),
941 'editconflict' => array( 'code' => 'editconflict', 'info' => "Edit conflict detected" ),
942 'hashcheckfailed' => array( 'code' => 'badmd5', 'info' => "The supplied MD5 hash was incorrect" ),
943 'missingtext' => array( 'code' => 'notext', 'info' => "One of the text, appendtext, prependtext and undo parameters must be set" ),
944 'emptynewsection' => array( 'code' => 'emptynewsection', 'info' => 'Creating empty new sections is not possible.' ),
945 'revwrongpage' => array( 'code' => 'revwrongpage', 'info' => "r\$1 is not a revision of ``\$2''" ),
946 'undo-failure' => array( 'code' => 'undofailure', 'info' => 'Undo failed due to conflicting intermediate edits' ),
949 'invalid-session-key' => array( 'code' => 'invalid-session-key', 'info' => 'Not a valid session key' ),
950 'nouploadmodule' => array( 'code' => 'nouploadmodule', 'info' => 'No upload module set' ),
951 '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' ),
955 * Helper function for readonly errors
957 public function dieReadOnly() {
958 $parsed = $this->parseMsg( array( 'readonlytext' ) );
959 $this->dieUsage( $parsed['info'], $parsed['code'], /* http error */ 0,
960 array( 'readonlyreason' => wfReadOnlyReason() ) );
964 * Output the error message related to a certain array
965 * @param $error array Element of a getUserPermissionsErrors()-style array
967 public function dieUsageMsg( $error ) {
968 $parsed = $this->parseMsg( $error );
969 $this->dieUsage( $parsed['info'], $parsed['code'] );
973 * Return the error message related to a certain array
974 * @param $error array Element of a getUserPermissionsErrors()-style array
975 * @return array('code' => code, 'info' => info)
977 public function parseMsg( $error ) {
978 $key = array_shift( $error );
979 if ( isset( self
::$messageMap[$key] ) ) {
980 return array( 'code' =>
981 wfMsgReplaceArgs( self
::$messageMap[$key]['code'], $error ),
983 wfMsgReplaceArgs( self
::$messageMap[$key]['info'], $error )
986 // If the key isn't present, throw an "unknown error"
987 return $this->parseMsg( array( 'unknownerror', $key ) );
991 * Internal code errors should be reported with this method
992 * @param $method string Method or function name
993 * @param $message string Error message
995 protected static function dieDebug( $method, $message ) {
996 wfDebugDieBacktrace( "Internal error in $method: $message" );
1000 * Indicates if this module needs maxlag to be checked
1003 public function shouldCheckMaxlag() {
1008 * Indicates whether this module requires read rights
1011 public function isReadMode() {
1015 * Indicates whether this module requires write mode
1018 public function isWriteMode() {
1023 * Indicates whether this module must be called with a POST request
1026 public function mustBePosted() {
1031 * 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
1034 public function getTokenSalt() {
1039 * Returns a list of all possible errors returned by the module
1040 * @return array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
1042 public function getPossibleErrors() {
1045 if ( $this->mustBePosted() ) {
1046 $ret[] = array( 'mustbeposted', $this->getModuleName() );
1049 if ( $this->isReadMode() ) {
1050 $ret[] = array( 'readrequired' );
1053 if ( $this->isWriteMode() ) {
1054 $ret[] = array( 'writerequired' );
1055 $ret[] = array( 'writedisabled' );
1058 if ( $this->getTokenSalt() !== false ) {
1059 $ret[] = array( 'missingparam', 'token' );
1060 $ret[] = array( 'sessionfailure' );
1067 * Parses a list of errors into a standardised format
1068 * @param $errors array List of errors. Items can be in the for array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
1069 * @return array Parsed list of errors with items in the form array( 'code' => ..., 'info' => ... )
1071 public function parseErrors( $errors ) {
1074 foreach ( $errors as $row ) {
1075 if ( isset( $row['code'] ) && isset( $row['info'] ) ) {
1078 $ret[] = $this->parseMsg( $row );
1085 * Profiling: total module execution time
1087 private $mTimeIn = 0, $mModuleTime = 0;
1090 * Start module profiling
1092 public function profileIn() {
1093 if ( $this->mTimeIn
!== 0 ) {
1094 ApiBase
::dieDebug( __METHOD__
, 'called twice without calling profileOut()' );
1096 $this->mTimeIn
= microtime( true );
1097 wfProfileIn( $this->getModuleProfileName() );
1101 * End module profiling
1103 public function profileOut() {
1104 if ( $this->mTimeIn
=== 0 ) {
1105 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileIn() first' );
1107 if ( $this->mDBTimeIn
!== 0 ) {
1108 ApiBase
::dieDebug( __METHOD__
, 'must be called after database profiling is done with profileDBOut()' );
1111 $this->mModuleTime +
= microtime( true ) - $this->mTimeIn
;
1113 wfProfileOut( $this->getModuleProfileName() );
1117 * When modules crash, sometimes it is needed to do a profileOut() regardless
1118 * of the profiling state the module was in. This method does such cleanup.
1120 public function safeProfileOut() {
1121 if ( $this->mTimeIn
!== 0 ) {
1122 if ( $this->mDBTimeIn
!== 0 ) {
1123 $this->profileDBOut();
1125 $this->profileOut();
1130 * Total time the module was executed
1133 public function getProfileTime() {
1134 if ( $this->mTimeIn
!== 0 ) {
1135 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileOut() first' );
1137 return $this->mModuleTime
;
1141 * Profiling: database execution time
1143 private $mDBTimeIn = 0, $mDBTime = 0;
1146 * Start module profiling
1148 public function profileDBIn() {
1149 if ( $this->mTimeIn
=== 0 ) {
1150 ApiBase
::dieDebug( __METHOD__
, 'must be called while profiling the entire module with profileIn()' );
1152 if ( $this->mDBTimeIn
!== 0 ) {
1153 ApiBase
::dieDebug( __METHOD__
, 'called twice without calling profileDBOut()' );
1155 $this->mDBTimeIn
= microtime( true );
1156 wfProfileIn( $this->getModuleProfileName( true ) );
1160 * End database profiling
1162 public function profileDBOut() {
1163 if ( $this->mTimeIn
=== 0 ) {
1164 ApiBase
::dieDebug( __METHOD__
, 'must be called while profiling the entire module with profileIn()' );
1166 if ( $this->mDBTimeIn
=== 0 ) {
1167 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileDBIn() first' );
1170 $time = microtime( true ) - $this->mDBTimeIn
;
1171 $this->mDBTimeIn
= 0;
1173 $this->mDBTime +
= $time;
1174 $this->getMain()->mDBTime +
= $time;
1175 wfProfileOut( $this->getModuleProfileName( true ) );
1179 * Total time the module used the database
1182 public function getProfileDBTime() {
1183 if ( $this->mDBTimeIn
!== 0 ) {
1184 ApiBase
::dieDebug( __METHOD__
, 'called without calling profileDBOut() first' );
1186 return $this->mDBTime
;
1190 * Debugging function that prints a value and an optional backtrace
1191 * @param $value mixed Value to print
1192 * @param $name string Description of the printed value
1193 * @param $backtrace bool If true, print a backtrace
1195 public static function debugPrint( $value, $name = 'unknown', $backtrace = false ) {
1196 print "\n\n<pre><b>Debugging value '$name':</b>\n\n";
1197 var_export( $value );
1199 print "\n" . wfBacktrace();
1205 * Returns a string that identifies the version of this class.
1208 public static function getBaseVersion() {
1209 return __CLASS__
. ': $Id$';