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 * Self-documentation: code to allow the API to document its own state
39 abstract class ApiBase
extends ContextSource
{
40 // These constants allow modules to specify exactly how to treat incoming parameters.
42 // Default value of the parameter
44 // Boolean, do we accept more than one item for this parameter (e.g.: titles)?
45 const PARAM_ISMULTI
= 1;
46 // Can be either a string type (e.g.: 'integer') or an array of allowed values
48 // Max value allowed for a parameter. Only applies if TYPE='integer'
50 // Max value allowed for a parameter for bots and sysops. Only applies if TYPE='integer'
52 // Lowest value allowed for a parameter. Only applies if TYPE='integer'
54 // Boolean, do we allow the same value to be set more than once when ISMULTI=true
55 const PARAM_ALLOW_DUPLICATES
= 6;
56 // Boolean, is the parameter deprecated (will show a warning)
57 const PARAM_DEPRECATED
= 7;
59 const PARAM_REQUIRED
= 8; // Boolean, is the parameter required?
61 // Boolean, if MIN/MAX are set, enforce (die) these?
62 // Only applies if TYPE='integer' Use with extreme caution
63 const PARAM_RANGE_ENFORCE
= 9;
65 // Specify an alternative i18n message for this help parameter.
66 // Value is $msg for ApiBase::makeMessage()
67 const PARAM_HELP_MSG
= 10;
69 // Specify additional i18n messages to append to the normal message. Value
70 // is an array of $msg for ApiBase::makeMessage()
71 const PARAM_HELP_MSG_APPEND
= 11;
73 // Specify additional information tags for the parameter. Value is an array
74 // of arrays, with the first member being the 'tag' for the info and the
75 // remaining members being the values. In the help, this is formatted using
76 // apihelp-{$path}-paraminfo-{$tag}, which is passed $1 = count, $2 =
77 // comma-joined list of values, $3 = module prefix.
78 const PARAM_HELP_MSG_INFO
= 12;
80 // When PARAM_TYPE is an array, this may be an array mapping those values
81 // to page titles which will be linked in the help.
82 const PARAM_VALUE_LINKS
= 13;
84 // When PARAM_TYPE is an array, this is an array mapping those values to
85 // $msg for ApiBase::makeMessage(). Any value not having a mapping will use
86 // apihelp-{$path}-paramvalue-{$param}-{$value} is used.
87 const PARAM_HELP_MSG_PER_VALUE
= 14;
89 // When PARAM_TYPE is 'submodule', map parameter values to submodule paths.
90 // Default is to use all modules in $this->getModuleManager() in the group
91 // matching the parameter name.
92 const PARAM_SUBMODULE_MAP
= 15;
94 // When PARAM_TYPE is 'submodule', used to indicate the 'g' prefix added by
95 // ApiQueryGeneratorBase (and similar if anything else ever does that).
96 const PARAM_SUBMODULE_PARAM_PREFIX
= 16;
98 const LIMIT_BIG1
= 500; // Fast query, std user limit
99 const LIMIT_BIG2
= 5000; // Fast query, bot/sysop limit
100 const LIMIT_SML1
= 50; // Slow query, std user limit
101 const LIMIT_SML2
= 500; // Slow query, bot/sysop limit
104 * getAllowedParams() flag: When set, the result could take longer to generate,
105 * but should be more thorough. E.g. get the list of generators for ApiSandBox extension
108 const GET_VALUES_FOR_HELP
= 1;
110 /** @var array Maps extension paths to info arrays */
111 private static $extensionInfo = null;
114 private $mMainModule;
116 private $mModuleName, $mModulePrefix;
117 private $mSlaveDB = null;
118 private $mParamCache = array();
119 /** @var array|null|bool */
120 private $mModuleSource = false;
123 * @param ApiMain $mainModule
124 * @param string $moduleName Name of this module
125 * @param string $modulePrefix Prefix to use for parameter names
127 public function __construct( ApiMain
$mainModule, $moduleName, $modulePrefix = '' ) {
128 $this->mMainModule
= $mainModule;
129 $this->mModuleName
= $moduleName;
130 $this->mModulePrefix
= $modulePrefix;
132 if ( !$this->isMain() ) {
133 $this->setContext( $mainModule->getContext() );
138 /************************************************************************//**
139 * @name Methods to implement
144 * Evaluates the parameters, performs the requested query, and sets up
145 * the result. Concrete implementations of ApiBase must override this
146 * method to provide whatever functionality their module offers.
147 * Implementations must not produce any output on their own and are not
148 * expected to handle any errors.
150 * The execute() method will be invoked directly by ApiMain immediately
151 * before the result of the module is output. Aside from the
152 * constructor, implementations should assume that no other methods
153 * will be called externally on the module before the result is
156 * The result data should be stored in the ApiResult object available
157 * through getResult().
159 abstract public function execute();
162 * Get the module manager, or null if this module has no sub-modules
164 * @return ApiModuleManager
166 public function getModuleManager() {
171 * If the module may only be used with a certain format module,
172 * it should override this method to return an instance of that formatter.
173 * A value of null means the default format will be used.
174 * @note Do not use this just because you don't want to support non-json
175 * formats. This should be used only when there is a fundamental
176 * requirement for a specific format.
177 * @return mixed Instance of a derived class of ApiFormatBase, or null
179 public function getCustomPrinter() {
184 * Returns usage examples for this module.
186 * Return value has query strings as keys, with values being either strings
187 * (message key), arrays (message key + parameter), or Message objects.
189 * Do not call this base class implementation when overriding this method.
194 protected function getExamplesMessages() {
195 // Fall back to old non-localised method
198 $examples = $this->getExamples();
200 if ( !is_array( $examples ) ) {
201 $examples = array( $examples );
202 } elseif ( $examples && ( count( $examples ) & 1 ) == 0 &&
203 array_keys( $examples ) === range( 0, count( $examples ) - 1 ) &&
204 !preg_match( '/^\s*api\.php\?/', $examples[0] )
206 // Fix up the ugly "even numbered elements are description, odd
207 // numbered elemts are the link" format (see doc for self::getExamples)
209 $examplesCount = count( $examples );
210 for ( $i = 0; $i < $examplesCount; $i +
= 2 ) {
211 $tmp[$examples[$i +
1]] = $examples[$i];
216 foreach ( $examples as $k => $v ) {
217 if ( is_numeric( $k ) ) {
222 $msg = self
::escapeWikiText( $v );
223 if ( is_array( $msg ) ) {
224 $msg = join( " ", $msg );
228 $qs = preg_replace( '/^\s*api\.php\?/', '', $qs );
229 $ret[$qs] = $this->msg( 'api-help-fallback-example', array( $msg ) );
237 * Return links to more detailed help pages about the module.
238 * @since 1.25, returning boolean false is deprecated
239 * @return string|array
241 public function getHelpUrls() {
246 * Returns an array of allowed parameters (parameter name) => (default
247 * value) or (parameter name) => (array with PARAM_* constants as keys)
248 * Don't call this function directly: use getFinalParams() to allow
249 * hooks to modify parameters as needed.
251 * Some derived classes may choose to handle an integer $flags parameter
252 * in the overriding methods. Callers of this method can pass zero or
253 * more OR-ed flags like GET_VALUES_FOR_HELP.
257 protected function getAllowedParams( /* $flags = 0 */ ) {
258 // int $flags is not declared because it causes "Strict standards"
259 // warning. Most derived classes do not implement it.
264 * Indicates if this module needs maxlag to be checked
267 public function shouldCheckMaxlag() {
272 * Indicates whether this module requires read rights
275 public function isReadMode() {
280 * Indicates whether this module requires write mode
283 public function isWriteMode() {
288 * Indicates whether this module must be called with a POST request
291 public function mustBePosted() {
292 return $this->needsToken() !== false;
296 * Indicates whether this module is deprecated
300 public function isDeprecated() {
305 * Indicates whether this module is "internal"
306 * Internal API modules are not (yet) intended for 3rd party use and may be unstable.
310 public function isInternal() {
315 * Returns the token type this module requires in order to execute.
317 * Modules are strongly encouraged to use the core 'csrf' type unless they
318 * have specialized security needs. If the token type is not one of the
319 * core types, you must use the ApiQueryTokensRegisterTypes hook to
322 * Returning a non-falsey value here will force the addition of an
323 * appropriate 'token' parameter in self::getFinalParams(). Also,
324 * self::mustBePosted() must return true when tokens are used.
326 * In previous versions of MediaWiki, true was a valid return value.
327 * Returning true will generate errors indicating that the API module needs
330 * @return string|false
332 public function needsToken() {
337 * Fetch the salt used in the Web UI corresponding to this module.
339 * Only override this if the Web UI uses a token with a non-constant salt.
342 * @param array $params All supplied parameters for the module
343 * @return string|array|null
345 protected function getWebUITokenSalt( array $params ) {
350 * Returns data for HTTP conditional request mechanisms.
353 * @param string $condition Condition being queried:
354 * - last-modified: Return a timestamp representing the maximum of the
355 * last-modified dates for all resources involved in the request. See
356 * RFC 7232 § 2.2 for semantics.
357 * - etag: Return an entity-tag representing the state of all resources involved
358 * in the request. Quotes must be included. See RFC 7232 § 2.3 for semantics.
359 * @return string|boolean|null As described above, or null if no value is available.
361 public function getConditionalRequestData( $condition ) {
367 /************************************************************************//**
368 * @name Data access methods
373 * Get the name of the module being executed by this instance
376 public function getModuleName() {
377 return $this->mModuleName
;
381 * Get parameter prefix (usually two letters or an empty string).
384 public function getModulePrefix() {
385 return $this->mModulePrefix
;
389 * Get the main module
392 public function getMain() {
393 return $this->mMainModule
;
397 * Returns true if this module is the main module ($this === $this->mMainModule),
401 public function isMain() {
402 return $this === $this->mMainModule
;
406 * Get the parent of this module
408 * @return ApiBase|null
410 public function getParent() {
411 return $this->isMain() ?
null : $this->getMain();
415 * Returns true if the current request breaks the same-origin policy.
417 * For example, json with callbacks.
419 * https://en.wikipedia.org/wiki/Same-origin_policy
424 public function lacksSameOriginSecurity() {
425 return $this->getMain()->getRequest()->getVal( 'callback' ) !== null;
429 * Get the path to this module
434 public function getModulePath() {
435 if ( $this->isMain() ) {
437 } elseif ( $this->getParent()->isMain() ) {
438 return $this->getModuleName();
440 return $this->getParent()->getModulePath() . '+' . $this->getModuleName();
445 * Get a module from its module path
448 * @param string $path
449 * @return ApiBase|null
450 * @throws UsageException
452 public function getModuleFromPath( $path ) {
453 $module = $this->getMain();
454 if ( $path === 'main' ) {
458 $parts = explode( '+', $path );
459 if ( count( $parts ) === 1 ) {
460 // In case the '+' was typed into URL, it resolves as a space
461 $parts = explode( ' ', $path );
464 $count = count( $parts );
465 for ( $i = 0; $i < $count; $i++
) {
467 $manager = $parent->getModuleManager();
468 if ( $manager === null ) {
469 $errorPath = join( '+', array_slice( $parts, 0, $i ) );
470 $this->dieUsage( "The module \"$errorPath\" has no submodules", 'badmodule' );
472 $module = $manager->getModule( $parts[$i] );
474 if ( $module === null ) {
475 $errorPath = $i ?
join( '+', array_slice( $parts, 0, $i ) ) : $parent->getModuleName();
477 "The module \"$errorPath\" does not have a submodule \"{$parts[$i]}\"",
487 * Get the result object
490 public function getResult() {
491 // Main module has getResult() method overridden
492 // Safety - avoid infinite loop:
493 if ( $this->isMain() ) {
494 ApiBase
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
497 return $this->getMain()->getResult();
501 * Get the error formatter
502 * @return ApiErrorFormatter
504 public function getErrorFormatter() {
505 // Main module has getErrorFormatter() method overridden
506 // Safety - avoid infinite loop:
507 if ( $this->isMain() ) {
508 ApiBase
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
511 return $this->getMain()->getErrorFormatter();
515 * Gets a default slave database connection object
516 * @return DatabaseBase
518 protected function getDB() {
519 if ( !isset( $this->mSlaveDB
) ) {
520 $this->mSlaveDB
= wfGetDB( DB_SLAVE
, 'api' );
523 return $this->mSlaveDB
;
527 * Get the continuation manager
528 * @return ApiContinuationManager|null
530 public function getContinuationManager() {
531 // Main module has getContinuationManager() method overridden
532 // Safety - avoid infinite loop:
533 if ( $this->isMain() ) {
534 ApiBase
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
537 return $this->getMain()->getContinuationManager();
541 * Set the continuation manager
542 * @param ApiContinuationManager|null
544 public function setContinuationManager( $manager ) {
545 // Main module has setContinuationManager() method overridden
546 // Safety - avoid infinite loop:
547 if ( $this->isMain() ) {
548 ApiBase
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
551 $this->getMain()->setContinuationManager( $manager );
556 /************************************************************************//**
557 * @name Parameter handling
562 * This method mangles parameter name based on the prefix supplied to the constructor.
563 * Override this method to change parameter name during runtime
564 * @param string $paramName Parameter name
565 * @return string Prefixed parameter name
567 public function encodeParamName( $paramName ) {
568 return $this->mModulePrefix
. $paramName;
572 * Using getAllowedParams(), this function makes an array of the values
573 * provided by the user, with key being the name of the variable, and
574 * value - validated value from user or default. limits will not be
575 * parsed if $parseLimit is set to false; use this when the max
576 * limit is not definitive yet, e.g. when getting revisions.
577 * @param bool $parseLimit True by default
580 public function extractRequestParams( $parseLimit = true ) {
581 // Cache parameters, for performance and to avoid bug 24564.
582 if ( !isset( $this->mParamCache
[$parseLimit] ) ) {
583 $params = $this->getFinalParams();
586 if ( $params ) { // getFinalParams() can return false
587 foreach ( $params as $paramName => $paramSettings ) {
588 $results[$paramName] = $this->getParameterFromSettings(
589 $paramName, $paramSettings, $parseLimit );
592 $this->mParamCache
[$parseLimit] = $results;
595 return $this->mParamCache
[$parseLimit];
599 * Get a value for the given parameter
600 * @param string $paramName Parameter name
601 * @param bool $parseLimit See extractRequestParams()
602 * @return mixed Parameter value
604 protected function getParameter( $paramName, $parseLimit = true ) {
605 $params = $this->getFinalParams();
606 $paramSettings = $params[$paramName];
608 return $this->getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
612 * Die if none or more than one of a certain set of parameters is set and not false.
614 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
615 * @param string $required,... Names of parameters of which exactly one must be set
617 public function requireOnlyOneParameter( $params, $required /*...*/ ) {
618 $required = func_get_args();
619 array_shift( $required );
620 $p = $this->getModulePrefix();
622 $intersection = array_intersect( array_keys( array_filter( $params,
623 array( $this, "parameterNotEmpty" ) ) ), $required );
625 if ( count( $intersection ) > 1 ) {
627 "The parameters {$p}" . implode( ", {$p}", $intersection ) . ' can not be used together',
629 } elseif ( count( $intersection ) == 0 ) {
631 "One of the parameters {$p}" . implode( ", {$p}", $required ) . ' is required',
638 * Die if more than one of a certain set of parameters is set and not false.
640 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
641 * @param string $required,... Names of parameters of which at most one must be set
643 public function requireMaxOneParameter( $params, $required /*...*/ ) {
644 $required = func_get_args();
645 array_shift( $required );
646 $p = $this->getModulePrefix();
648 $intersection = array_intersect( array_keys( array_filter( $params,
649 array( $this, "parameterNotEmpty" ) ) ), $required );
651 if ( count( $intersection ) > 1 ) {
653 "The parameters {$p}" . implode( ", {$p}", $intersection ) . ' can not be used together',
660 * Die if none of a certain set of parameters is set and not false.
663 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
664 * @param string $required,... Names of parameters of which at least one must be set
666 public function requireAtLeastOneParameter( $params, $required /*...*/ ) {
667 $required = func_get_args();
668 array_shift( $required );
669 $p = $this->getModulePrefix();
671 $intersection = array_intersect(
672 array_keys( array_filter( $params, array( $this, "parameterNotEmpty" ) ) ),
676 if ( count( $intersection ) == 0 ) {
677 $this->dieUsage( "At least one of the parameters {$p}" .
678 implode( ", {$p}", $required ) . ' is required', "{$p}missingparam" );
683 * Callback function used in requireOnlyOneParameter to check whether required parameters are set
685 * @param object $x Parameter to check is not null/false
688 private function parameterNotEmpty( $x ) {
689 return !is_null( $x ) && $x !== false;
693 * Get a WikiPage object from a title or pageid param, if possible.
694 * Can die, if no param is set or if the title or page id is not valid.
696 * @param array $params
697 * @param bool|string $load Whether load the object's state from the database:
698 * - false: don't load (if the pageid is given, it will still be loaded)
699 * - 'fromdb': load from a slave database
700 * - 'fromdbmaster': load from the master database
703 public function getTitleOrPageId( $params, $load = false ) {
704 $this->requireOnlyOneParameter( $params, 'title', 'pageid' );
707 if ( isset( $params['title'] ) ) {
708 $titleObj = Title
::newFromText( $params['title'] );
709 if ( !$titleObj ||
$titleObj->isExternal() ) {
710 $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
712 if ( !$titleObj->canExist() ) {
713 $this->dieUsage( "Namespace doesn't allow actual pages", 'pagecannotexist' );
715 $pageObj = WikiPage
::factory( $titleObj );
716 if ( $load !== false ) {
717 $pageObj->loadPageData( $load );
719 } elseif ( isset( $params['pageid'] ) ) {
720 if ( $load === false ) {
723 $pageObj = WikiPage
::newFromID( $params['pageid'], $load );
725 $this->dieUsageMsg( array( 'nosuchpageid', $params['pageid'] ) );
733 * Return true if we're to watch the page, false if not, null if no change.
734 * @param string $watchlist Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
735 * @param Title $titleObj The page under consideration
736 * @param string $userOption The user option to consider when $watchlist=preferences.
737 * If not set will use watchdefault always and watchcreations if $titleObj doesn't exist.
740 protected function getWatchlistValue( $watchlist, $titleObj, $userOption = null ) {
742 $userWatching = $this->getUser()->isWatched( $titleObj, WatchedItem
::IGNORE_USER_RIGHTS
);
744 switch ( $watchlist ) {
752 # If the user is already watching, don't bother checking
753 if ( $userWatching ) {
756 # If no user option was passed, use watchdefault and watchcreations
757 if ( is_null( $userOption ) ) {
758 return $this->getUser()->getBoolOption( 'watchdefault' ) ||
759 $this->getUser()->getBoolOption( 'watchcreations' ) && !$titleObj->exists();
762 # Watch the article based on the user preference
763 return $this->getUser()->getBoolOption( $userOption );
766 return $userWatching;
769 return $userWatching;
774 * Using the settings determine the value for the given parameter
776 * @param string $paramName Parameter name
777 * @param array|mixed $paramSettings Default value or an array of settings
778 * using PARAM_* constants.
779 * @param bool $parseLimit Parse limit?
780 * @return mixed Parameter value
782 protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
783 // Some classes may decide to change parameter names
784 $encParamName = $this->encodeParamName( $paramName );
786 if ( !is_array( $paramSettings ) ) {
787 $default = $paramSettings;
789 $type = gettype( $paramSettings );
794 $default = isset( $paramSettings[self
::PARAM_DFLT
] )
795 ?
$paramSettings[self
::PARAM_DFLT
]
797 $multi = isset( $paramSettings[self
::PARAM_ISMULTI
] )
798 ?
$paramSettings[self
::PARAM_ISMULTI
]
800 $type = isset( $paramSettings[self
::PARAM_TYPE
] )
801 ?
$paramSettings[self
::PARAM_TYPE
]
803 $dupes = isset( $paramSettings[self
::PARAM_ALLOW_DUPLICATES
] )
804 ?
$paramSettings[self
::PARAM_ALLOW_DUPLICATES
]
806 $deprecated = isset( $paramSettings[self
::PARAM_DEPRECATED
] )
807 ?
$paramSettings[self
::PARAM_DEPRECATED
]
809 $required = isset( $paramSettings[self
::PARAM_REQUIRED
] )
810 ?
$paramSettings[self
::PARAM_REQUIRED
]
813 // When type is not given, and no choices, the type is the same as $default
814 if ( !isset( $type ) ) {
815 if ( isset( $default ) ) {
816 $type = gettype( $default );
818 $type = 'NULL'; // allow everything
823 if ( $type == 'boolean' ) {
824 if ( isset( $default ) && $default !== false ) {
825 // Having a default value of anything other than 'false' is not allowed
828 "Boolean param $encParamName's default is set to '$default'. " .
829 "Boolean parameters must default to false."
833 $value = $this->getMain()->getCheck( $encParamName );
834 } elseif ( $type == 'upload' ) {
835 if ( isset( $default ) ) {
836 // Having a default value is not allowed
839 "File upload param $encParamName's default is set to " .
840 "'$default'. File upload parameters may not have a default." );
843 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
845 $value = $this->getMain()->getUpload( $encParamName );
846 if ( !$value->exists() ) {
847 // This will get the value without trying to normalize it
848 // (because trying to normalize a large binary file
849 // accidentally uploaded as a field fails spectacularly)
850 $value = $this->getMain()->getRequest()->unsetVal( $encParamName );
851 if ( $value !== null ) {
853 "File upload param $encParamName is not a file upload; " .
854 "be sure to use multipart/form-data for your POST and include " .
855 "a filename in the Content-Disposition header.",
856 "badupload_{$encParamName}"
861 $value = $this->getMain()->getVal( $encParamName, $default );
863 if ( isset( $value ) && $type == 'namespace' ) {
864 $type = MWNamespace
::getValidNamespaces();
866 if ( isset( $value ) && $type == 'submodule' ) {
867 if ( isset( $paramSettings[self
::PARAM_SUBMODULE_MAP
] ) ) {
868 $type = array_keys( $paramSettings[self
::PARAM_SUBMODULE_MAP
] );
870 $type = $this->getModuleManager()->getNames( $paramName );
875 if ( isset( $value ) && ( $multi ||
is_array( $type ) ) ) {
876 $value = $this->parseMultiValue(
880 is_array( $type ) ?
$type : null
884 // More validation only when choices were not given
885 // choices were validated in parseMultiValue()
886 if ( isset( $value ) ) {
887 if ( !is_array( $type ) ) {
889 case 'NULL': // nothing to do
894 if ( $required && $value === '' ) {
895 $this->dieUsageMsg( array( 'missingparam', $paramName ) );
898 case 'integer': // Force everything using intval() and optionally validate limits
899 $min = isset( $paramSettings[self
::PARAM_MIN
] ) ?
$paramSettings[self
::PARAM_MIN
] : null;
900 $max = isset( $paramSettings[self
::PARAM_MAX
] ) ?
$paramSettings[self
::PARAM_MAX
] : null;
901 $enforceLimits = isset( $paramSettings[self
::PARAM_RANGE_ENFORCE
] )
902 ?
$paramSettings[self
::PARAM_RANGE_ENFORCE
] : false;
904 if ( is_array( $value ) ) {
905 $value = array_map( 'intval', $value );
906 if ( !is_null( $min ) ||
!is_null( $max ) ) {
907 foreach ( $value as &$v ) {
908 $this->validateLimit( $paramName, $v, $min, $max, null, $enforceLimits );
912 $value = intval( $value );
913 if ( !is_null( $min ) ||
!is_null( $max ) ) {
914 $this->validateLimit( $paramName, $value, $min, $max, null, $enforceLimits );
919 if ( !$parseLimit ) {
920 // Don't do any validation whatsoever
923 if ( !isset( $paramSettings[self
::PARAM_MAX
] )
924 ||
!isset( $paramSettings[self
::PARAM_MAX2
] )
928 "MAX1 or MAX2 are not defined for the limit $encParamName"
932 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
934 $min = isset( $paramSettings[self
::PARAM_MIN
] ) ?
$paramSettings[self
::PARAM_MIN
] : 0;
935 if ( $value == 'max' ) {
936 $value = $this->getMain()->canApiHighLimits()
937 ?
$paramSettings[self
::PARAM_MAX2
]
938 : $paramSettings[self
::PARAM_MAX
];
939 $this->getResult()->addParsedLimit( $this->getModuleName(), $value );
941 $value = intval( $value );
942 $this->validateLimit(
946 $paramSettings[self
::PARAM_MAX
],
947 $paramSettings[self
::PARAM_MAX2
]
953 ApiBase
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
957 if ( is_array( $value ) ) {
958 foreach ( $value as $key => $val ) {
959 $value[$key] = $this->validateTimestamp( $val, $encParamName );
962 $value = $this->validateTimestamp( $value, $encParamName );
966 if ( is_array( $value ) ) {
967 foreach ( $value as $key => $val ) {
968 $value[$key] = $this->validateUser( $val, $encParamName );
971 $value = $this->validateUser( $value, $encParamName );
974 case 'upload': // nothing to do
977 ApiBase
::dieDebug( __METHOD__
, "Param $encParamName's type is unknown - $type" );
981 // Throw out duplicates if requested
982 if ( !$dupes && is_array( $value ) ) {
983 $value = array_unique( $value );
986 // Set a warning if a deprecated parameter has been passed
987 if ( $deprecated && $value !== false ) {
988 $this->setWarning( "The $encParamName parameter has been deprecated." );
990 } elseif ( $required ) {
991 $this->dieUsageMsg( array( 'missingparam', $paramName ) );
998 * Return an array of values that were given in a 'a|b|c' notation,
999 * after it optionally validates them against the list allowed values.
1001 * @param string $valueName The name of the parameter (for error
1003 * @param mixed $value The value being parsed
1004 * @param bool $allowMultiple Can $value contain more than one value
1006 * @param string[]|null $allowedValues An array of values to check against. If
1007 * null, all values are accepted.
1008 * @return string|string[] (allowMultiple ? an_array_of_values : a_single_value)
1010 protected function parseMultiValue( $valueName, $value, $allowMultiple, $allowedValues ) {
1011 if ( trim( $value ) === '' && $allowMultiple ) {
1015 // This is a bit awkward, but we want to avoid calling canApiHighLimits()
1016 // because it unstubs $wgUser
1017 $valuesList = explode( '|', $value, self
::LIMIT_SML2 +
1 );
1018 $sizeLimit = count( $valuesList ) > self
::LIMIT_SML1
&& $this->mMainModule
->canApiHighLimits()
1022 if ( self
::truncateArray( $valuesList, $sizeLimit ) ) {
1023 $this->setWarning( "Too many values supplied for parameter '$valueName': " .
1024 "the limit is $sizeLimit" );
1027 if ( !$allowMultiple && count( $valuesList ) != 1 ) {
1028 // Bug 33482 - Allow entries with | in them for non-multiple values
1029 if ( in_array( $value, $allowedValues, true ) ) {
1033 $possibleValues = is_array( $allowedValues )
1034 ?
"of '" . implode( "', '", $allowedValues ) . "'"
1037 "Only one $possibleValues is allowed for parameter '$valueName'",
1038 "multival_$valueName"
1042 if ( is_array( $allowedValues ) ) {
1043 // Check for unknown values
1044 $unknown = array_diff( $valuesList, $allowedValues );
1045 if ( count( $unknown ) ) {
1046 if ( $allowMultiple ) {
1047 $s = count( $unknown ) > 1 ?
's' : '';
1048 $vals = implode( ", ", $unknown );
1049 $this->setWarning( "Unrecognized value$s for parameter '$valueName': $vals" );
1052 "Unrecognized value for parameter '$valueName': {$valuesList[0]}",
1053 "unknown_$valueName"
1057 // Now throw them out
1058 $valuesList = array_intersect( $valuesList, $allowedValues );
1061 return $allowMultiple ?
$valuesList : $valuesList[0];
1065 * Validate the value against the minimum and user/bot maximum limits.
1066 * Prints usage info on failure.
1067 * @param string $paramName Parameter name
1068 * @param int $value Parameter value
1069 * @param int|null $min Minimum value
1070 * @param int|null $max Maximum value for users
1071 * @param int $botMax Maximum value for sysops/bots
1072 * @param bool $enforceLimits Whether to enforce (die) if value is outside limits
1074 protected function validateLimit( $paramName, &$value, $min, $max, $botMax = null,
1075 $enforceLimits = false
1077 if ( !is_null( $min ) && $value < $min ) {
1078 $msg = $this->encodeParamName( $paramName ) . " may not be less than $min (set to $value)";
1079 $this->warnOrDie( $msg, $enforceLimits );
1083 // Minimum is always validated, whereas maximum is checked only if not
1084 // running in internal call mode
1085 if ( $this->getMain()->isInternalMode() ) {
1089 // Optimization: do not check user's bot status unless really needed -- skips db query
1090 // assumes $botMax >= $max
1091 if ( !is_null( $max ) && $value > $max ) {
1092 if ( !is_null( $botMax ) && $this->getMain()->canApiHighLimits() ) {
1093 if ( $value > $botMax ) {
1094 $msg = $this->encodeParamName( $paramName ) .
1095 " may not be over $botMax (set to $value) for bots or sysops";
1096 $this->warnOrDie( $msg, $enforceLimits );
1100 $msg = $this->encodeParamName( $paramName ) . " may not be over $max (set to $value) for users";
1101 $this->warnOrDie( $msg, $enforceLimits );
1108 * Validate and normalize of parameters of type 'timestamp'
1109 * @param string $value Parameter value
1110 * @param string $encParamName Parameter name
1111 * @return string Validated and normalized parameter
1113 protected function validateTimestamp( $value, $encParamName ) {
1114 // Confusing synonyms for the current time accepted by wfTimestamp()
1115 // (wfTimestamp() also accepts various non-strings and the string of 14
1116 // ASCII NUL bytes, but those can't get here)
1118 $this->logFeatureUsage( 'unclear-"now"-timestamp' );
1120 "Passing '$value' for timestamp parameter $encParamName has been deprecated." .
1121 ' If for some reason you need to explicitly specify the current time without' .
1122 ' calculating it client-side, use "now".'
1124 return wfTimestamp( TS_MW
);
1127 // Explicit synonym for the current time
1128 if ( $value === 'now' ) {
1129 return wfTimestamp( TS_MW
);
1132 $unixTimestamp = wfTimestamp( TS_UNIX
, $value );
1133 if ( $unixTimestamp === false ) {
1135 "Invalid value '$value' for timestamp parameter $encParamName",
1136 "badtimestamp_{$encParamName}"
1140 return wfTimestamp( TS_MW
, $unixTimestamp );
1144 * Validate the supplied token.
1147 * @param string $token Supplied token
1148 * @param array $params All supplied parameters for the module
1150 * @throws MWException
1152 final public function validateToken( $token, array $params ) {
1153 $tokenType = $this->needsToken();
1154 $salts = ApiQueryTokens
::getTokenTypeSalts();
1155 if ( !isset( $salts[$tokenType] ) ) {
1156 throw new MWException(
1157 "Module '{$this->getModuleName()}' tried to use token type '$tokenType' " .
1158 'without registering it'
1162 if ( $this->getUser()->matchEditToken(
1170 $webUiSalt = $this->getWebUITokenSalt( $params );
1171 if ( $webUiSalt !== null && $this->getUser()->matchEditToken(
1183 * Validate and normalize of parameters of type 'user'
1184 * @param string $value Parameter value
1185 * @param string $encParamName Parameter name
1186 * @return string Validated and normalized parameter
1188 private function validateUser( $value, $encParamName ) {
1189 $title = Title
::makeTitleSafe( NS_USER
, $value );
1190 if ( $title === null ) {
1192 "Invalid value '$value' for user parameter $encParamName",
1193 "baduser_{$encParamName}"
1197 return $title->getText();
1202 /************************************************************************//**
1203 * @name Utility methods
1208 * Set a watch (or unwatch) based the based on a watchlist parameter.
1209 * @param string $watch Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
1210 * @param Title $titleObj The article's title to change
1211 * @param string $userOption The user option to consider when $watch=preferences
1213 protected function setWatch( $watch, $titleObj, $userOption = null ) {
1214 $value = $this->getWatchlistValue( $watch, $titleObj, $userOption );
1215 if ( $value === null ) {
1219 WatchAction
::doWatchOrUnwatch( $value, $titleObj, $this->getUser() );
1223 * Truncate an array to a certain length.
1224 * @param array $arr Array to truncate
1225 * @param int $limit Maximum length
1226 * @return bool True if the array was truncated, false otherwise
1228 public static function truncateArray( &$arr, $limit ) {
1230 while ( count( $arr ) > $limit ) {
1239 * Gets the user for whom to get the watchlist
1241 * @param array $params
1244 public function getWatchlistUser( $params ) {
1245 if ( !is_null( $params['owner'] ) && !is_null( $params['token'] ) ) {
1246 $user = User
::newFromName( $params['owner'], false );
1247 if ( !( $user && $user->getId() ) ) {
1248 $this->dieUsage( 'Specified user does not exist', 'bad_wlowner' );
1250 $token = $user->getOption( 'watchlisttoken' );
1251 if ( $token == '' ||
!hash_equals( $token, $params['token'] ) ) {
1253 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences',
1258 if ( !$this->getUser()->isLoggedIn() ) {
1259 $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
1261 if ( !$this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
1262 $this->dieUsage( 'You don\'t have permission to view your watchlist', 'permissiondenied' );
1264 $user = $this->getUser();
1271 * A subset of wfEscapeWikiText for BC texts
1274 * @param string|array $v
1275 * @return string|array
1277 private static function escapeWikiText( $v ) {
1278 if ( is_array( $v ) ) {
1279 return array_map( 'self::escapeWikiText', $v );
1281 return strtr( $v, array(
1282 '__' => '__', '{' => '{', '}' => '}',
1283 '[[Category:' => '[[:Category:',
1284 '[[File:' => '[[:File:', '[[Image:' => '[[:Image:',
1290 * Create a Message from a string or array
1292 * A string is used as a message key. An array has the message key as the
1293 * first value and message parameters as subsequent values.
1296 * @param string|array|Message $msg
1297 * @param IContextSource $context
1298 * @param array $params
1299 * @return Message|null
1301 public static function makeMessage( $msg, IContextSource
$context, array $params = null ) {
1302 if ( is_string( $msg ) ) {
1303 $msg = wfMessage( $msg );
1304 } elseif ( is_array( $msg ) ) {
1305 $msg = call_user_func_array( 'wfMessage', $msg );
1307 if ( !$msg instanceof Message
) {
1311 $msg->setContext( $context );
1313 $msg->params( $params );
1321 /************************************************************************//**
1322 * @name Warning and error reporting
1327 * Set warning section for this module. Users should monitor this
1328 * section to notice any changes in API. Multiple calls to this
1329 * function will result in the warning messages being separated by
1331 * @param string $warning Warning message
1333 public function setWarning( $warning ) {
1334 $msg = new ApiRawMessage( $warning, 'warning' );
1335 $this->getErrorFormatter()->addWarning( $this->getModuleName(), $msg );
1339 * Adds a warning to the output, else dies
1341 * @param string $msg Message to show as a warning, or error message if dying
1342 * @param bool $enforceLimits Whether this is an enforce (die)
1344 private function warnOrDie( $msg, $enforceLimits = false ) {
1345 if ( $enforceLimits ) {
1346 $this->dieUsage( $msg, 'integeroutofrange' );
1349 $this->setWarning( $msg );
1353 * Throw a UsageException, which will (if uncaught) call the main module's
1354 * error handler and die with an error message.
1356 * @param string $description One-line human-readable description of the
1357 * error condition, e.g., "The API requires a valid action parameter"
1358 * @param string $errorCode Brief, arbitrary, stable string to allow easy
1359 * automated identification of the error, e.g., 'unknown_action'
1360 * @param int $httpRespCode HTTP response code
1361 * @param array $extradata Data to add to the "<error>" element; array in ApiResult format
1362 * @throws UsageException
1364 public function dieUsage( $description, $errorCode, $httpRespCode = 0, $extradata = null ) {
1365 throw new UsageException(
1367 $this->encodeParamName( $errorCode ),
1374 * Get error (as code, string) from a Status object.
1377 * @param Status $status
1378 * @return array Array of code and error string
1379 * @throws MWException
1381 public function getErrorFromStatus( $status ) {
1382 if ( $status->isGood() ) {
1383 throw new MWException( 'Successful status passed to ApiBase::dieStatus' );
1386 $errors = $status->getErrorsArray();
1388 // No errors? Assume the warnings should be treated as errors
1389 $errors = $status->getWarningsArray();
1392 // Still no errors? Punt
1393 $errors = array( array( 'unknownerror-nocode' ) );
1396 // Cannot use dieUsageMsg() because extensions might return custom
1398 if ( $errors[0] instanceof Message
) {
1400 $code = $msg->getKey();
1402 $code = array_shift( $errors[0] );
1403 $msg = wfMessage( $code, $errors[0] );
1405 if ( isset( ApiBase
::$messageMap[$code] ) ) {
1406 // Translate message to code, for backwards compatibility
1407 $code = ApiBase
::$messageMap[$code]['code'];
1410 return array( $code, $msg->inLanguage( 'en' )->useDatabase( false )->plain() );
1414 * Throw a UsageException based on the errors in the Status object.
1417 * @param Status $status
1418 * @throws MWException
1420 public function dieStatus( $status ) {
1422 list( $code, $msg ) = $this->getErrorFromStatus( $status );
1423 $this->dieUsage( $msg, $code );
1426 // @codingStandardsIgnoreStart Allow long lines. Cannot split these.
1428 * Array that maps message keys to error messages. $1 and friends are replaced.
1430 public static $messageMap = array(
1431 // This one MUST be present, or dieUsageMsg() will recurse infinitely
1432 'unknownerror' => array( 'code' => 'unknownerror', 'info' => "Unknown error: \"\$1\"" ),
1433 'unknownerror-nocode' => array( 'code' => 'unknownerror', 'info' => 'Unknown error' ),
1435 // Messages from Title::getUserPermissionsErrors()
1436 'ns-specialprotected' => array(
1437 'code' => 'unsupportednamespace',
1438 'info' => "Pages in the Special namespace can't be edited"
1440 'protectedinterface' => array(
1441 'code' => 'protectednamespace-interface',
1442 'info' => "You're not allowed to edit interface messages"
1444 'namespaceprotected' => array(
1445 'code' => 'protectednamespace',
1446 'info' => "You're not allowed to edit pages in the \"\$1\" namespace"
1448 'customcssprotected' => array(
1449 'code' => 'customcssprotected',
1450 'info' => "You're not allowed to edit custom CSS pages"
1452 'customjsprotected' => array(
1453 'code' => 'customjsprotected',
1454 'info' => "You're not allowed to edit custom JavaScript pages"
1456 'cascadeprotected' => array(
1457 'code' => 'cascadeprotected',
1458 'info' => "The page you're trying to edit is protected because it's included in a cascade-protected page"
1460 'protectedpagetext' => array(
1461 'code' => 'protectedpage',
1462 'info' => "The \"\$1\" right is required to edit this page"
1464 'protect-cantedit' => array(
1465 'code' => 'cantedit',
1466 'info' => "You can't protect this page because you can't edit it"
1468 'deleteprotected' => array(
1469 'code' => 'cantedit',
1470 'info' => "You can't delete this page because it has been protected"
1472 'badaccess-group0' => array(
1473 'code' => 'permissiondenied',
1474 'info' => "Permission denied"
1475 ), // Generic permission denied message
1476 'badaccess-groups' => array(
1477 'code' => 'permissiondenied',
1478 'info' => "Permission denied"
1480 'titleprotected' => array(
1481 'code' => 'protectedtitle',
1482 'info' => "This title has been protected from creation"
1484 'nocreate-loggedin' => array(
1485 'code' => 'cantcreate',
1486 'info' => "You don't have permission to create new pages"
1488 'nocreatetext' => array(
1489 'code' => 'cantcreate-anon',
1490 'info' => "Anonymous users can't create new pages"
1492 'movenologintext' => array(
1493 'code' => 'cantmove-anon',
1494 'info' => "Anonymous users can't move pages"
1496 'movenotallowed' => array(
1497 'code' => 'cantmove',
1498 'info' => "You don't have permission to move pages"
1500 'confirmedittext' => array(
1501 'code' => 'confirmemail',
1502 'info' => "You must confirm your email address before you can edit"
1504 'blockedtext' => array(
1505 'code' => 'blocked',
1506 'info' => "You have been blocked from editing"
1508 'autoblockedtext' => array(
1509 'code' => 'autoblocked',
1510 'info' => "Your IP address has been blocked automatically, because it was used by a blocked user"
1513 // Miscellaneous interface messages
1514 'actionthrottledtext' => array(
1515 'code' => 'ratelimited',
1516 'info' => "You've exceeded your rate limit. Please wait some time and try again"
1518 'alreadyrolled' => array(
1519 'code' => 'alreadyrolled',
1520 'info' => "The page you tried to rollback was already rolled back"
1522 'cantrollback' => array(
1523 'code' => 'onlyauthor',
1524 'info' => "The page you tried to rollback only has one author"
1526 'readonlytext' => array(
1527 'code' => 'readonly',
1528 'info' => "The wiki is currently in read-only mode"
1530 'sessionfailure' => array(
1531 'code' => 'badtoken',
1532 'info' => "Invalid token" ),
1533 'cannotdelete' => array(
1534 'code' => 'cantdelete',
1535 'info' => "Couldn't delete \"\$1\". Maybe it was deleted already by someone else"
1537 'notanarticle' => array(
1538 'code' => 'missingtitle',
1539 'info' => "The page you requested doesn't exist"
1541 'selfmove' => array( 'code' => 'selfmove', 'info' => "Can't move a page to itself"
1543 'immobile_namespace' => array(
1544 'code' => 'immobilenamespace',
1545 'info' => "You tried to move pages from or to a namespace that is protected from moving"
1547 'articleexists' => array(
1548 'code' => 'articleexists',
1549 'info' => "The destination article already exists and is not a redirect to the source article"
1551 'protectedpage' => array(
1552 'code' => 'protectedpage',
1553 'info' => "You don't have permission to perform this move"
1555 'hookaborted' => array(
1556 'code' => 'hookaborted',
1557 'info' => "The modification you tried to make was aborted by an extension hook"
1559 'cantmove-titleprotected' => array(
1560 'code' => 'protectedtitle',
1561 'info' => "The destination article has been protected from creation"
1563 'imagenocrossnamespace' => array(
1564 'code' => 'nonfilenamespace',
1565 'info' => "Can't move a file to a non-file namespace"
1567 'imagetypemismatch' => array(
1568 'code' => 'filetypemismatch',
1569 'info' => "The new file extension doesn't match its type"
1571 // 'badarticleerror' => shouldn't happen
1572 // 'badtitletext' => shouldn't happen
1573 'ip_range_invalid' => array( 'code' => 'invalidrange', 'info' => "Invalid IP range" ),
1574 'range_block_disabled' => array(
1575 'code' => 'rangedisabled',
1576 'info' => "Blocking IP ranges has been disabled"
1578 'nosuchusershort' => array(
1579 'code' => 'nosuchuser',
1580 'info' => "The user you specified doesn't exist"
1582 'badipaddress' => array( 'code' => 'invalidip', 'info' => "Invalid IP address specified" ),
1583 'ipb_expiry_invalid' => array( 'code' => 'invalidexpiry', 'info' => "Invalid expiry time" ),
1584 'ipb_already_blocked' => array(
1585 'code' => 'alreadyblocked',
1586 'info' => "The user you tried to block was already blocked"
1588 'ipb_blocked_as_range' => array(
1589 'code' => 'blockedasrange',
1590 'info' => "IP address \"\$1\" was blocked as part of range \"\$2\". You can't unblock the IP individually, but you can unblock the range as a whole."
1592 'ipb_cant_unblock' => array(
1593 'code' => 'cantunblock',
1594 'info' => "The block you specified was not found. It may have been unblocked already"
1596 'mailnologin' => array(
1597 'code' => 'cantsend',
1598 'info' => "You are not logged in, you do not have a confirmed email address, or you are not allowed to send email to other users, so you cannot send email"
1600 'ipbblocked' => array(
1601 'code' => 'ipbblocked',
1602 'info' => 'You cannot block or unblock users while you are yourself blocked'
1604 'ipbnounblockself' => array(
1605 'code' => 'ipbnounblockself',
1606 'info' => 'You are not allowed to unblock yourself'
1608 'usermaildisabled' => array(
1609 'code' => 'usermaildisabled',
1610 'info' => "User email has been disabled"
1612 'blockedemailuser' => array(
1613 'code' => 'blockedfrommail',
1614 'info' => "You have been blocked from sending email"
1616 'notarget' => array(
1617 'code' => 'notarget',
1618 'info' => "You have not specified a valid target for this action"
1621 'code' => 'noemail',
1622 'info' => "The user has not specified a valid email address, or has chosen not to receive email from other users"
1624 'rcpatroldisabled' => array(
1625 'code' => 'patroldisabled',
1626 'info' => "Patrolling is disabled on this wiki"
1628 'markedaspatrollederror-noautopatrol' => array(
1629 'code' => 'noautopatrol',
1630 'info' => "You don't have permission to patrol your own changes"
1632 'delete-toobig' => array(
1633 'code' => 'bigdelete',
1634 'info' => "You can't delete this page because it has more than \$1 revisions"
1636 'movenotallowedfile' => array(
1637 'code' => 'cantmovefile',
1638 'info' => "You don't have permission to move files"
1640 'userrights-no-interwiki' => array(
1641 'code' => 'nointerwikiuserrights',
1642 'info' => "You don't have permission to change user rights on other wikis"
1644 'userrights-nodatabase' => array(
1645 'code' => 'nosuchdatabase',
1646 'info' => "Database \"\$1\" does not exist or is not local"
1648 'nouserspecified' => array( 'code' => 'invaliduser', 'info' => "Invalid username \"\$1\"" ),
1649 'noname' => array( 'code' => 'invaliduser', 'info' => "Invalid username \"\$1\"" ),
1650 'summaryrequired' => array( 'code' => 'summaryrequired', 'info' => 'Summary required' ),
1651 'import-rootpage-invalid' => array(
1652 'code' => 'import-rootpage-invalid',
1653 'info' => 'Root page is an invalid title'
1655 'import-rootpage-nosubpage' => array(
1656 'code' => 'import-rootpage-nosubpage',
1657 'info' => 'Namespace "$1" of the root page does not allow subpages'
1660 // API-specific messages
1661 'readrequired' => array(
1662 'code' => 'readapidenied',
1663 'info' => "You need read permission to use this module"
1665 'writedisabled' => array(
1666 'code' => 'noapiwrite',
1667 '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"
1669 'writerequired' => array(
1670 'code' => 'writeapidenied',
1671 'info' => "You're not allowed to edit this wiki through the API"
1673 'missingparam' => array( 'code' => 'no$1', 'info' => "The \$1 parameter must be set" ),
1674 'invalidtitle' => array( 'code' => 'invalidtitle', 'info' => "Bad title \"\$1\"" ),
1675 'nosuchpageid' => array( 'code' => 'nosuchpageid', 'info' => "There is no page with ID \$1" ),
1676 'nosuchrevid' => array( 'code' => 'nosuchrevid', 'info' => "There is no revision with ID \$1" ),
1677 'nosuchuser' => array( 'code' => 'nosuchuser', 'info' => "User \"\$1\" doesn't exist" ),
1678 'invaliduser' => array( 'code' => 'invaliduser', 'info' => "Invalid username \"\$1\"" ),
1679 'invalidexpiry' => array( 'code' => 'invalidexpiry', 'info' => "Invalid expiry time \"\$1\"" ),
1680 'pastexpiry' => array( 'code' => 'pastexpiry', 'info' => "Expiry time \"\$1\" is in the past" ),
1681 'create-titleexists' => array(
1682 'code' => 'create-titleexists',
1683 'info' => "Existing titles can't be protected with 'create'"
1685 'missingtitle-createonly' => array(
1686 'code' => 'missingtitle-createonly',
1687 'info' => "Missing titles can only be protected with 'create'"
1689 'cantblock' => array( 'code' => 'cantblock',
1690 'info' => "You don't have permission to block users"
1692 'canthide' => array(
1693 'code' => 'canthide',
1694 'info' => "You don't have permission to hide user names from the block log"
1696 'cantblock-email' => array(
1697 'code' => 'cantblock-email',
1698 'info' => "You don't have permission to block users from sending email through the wiki"
1700 'unblock-notarget' => array(
1701 'code' => 'notarget',
1702 'info' => "Either the id or the user parameter must be set"
1704 'unblock-idanduser' => array(
1705 'code' => 'idanduser',
1706 'info' => "The id and user parameters can't be used together"
1708 'cantunblock' => array(
1709 'code' => 'permissiondenied',
1710 'info' => "You don't have permission to unblock users"
1712 'cannotundelete' => array(
1713 'code' => 'cantundelete',
1714 'info' => "Couldn't undelete: the requested revisions may not exist, or may have been undeleted already"
1716 'permdenied-undelete' => array(
1717 'code' => 'permissiondenied',
1718 'info' => "You don't have permission to restore deleted revisions"
1720 'createonly-exists' => array(
1721 'code' => 'articleexists',
1722 'info' => "The article you tried to create has been created already"
1724 'nocreate-missing' => array(
1725 'code' => 'missingtitle',
1726 'info' => "The article you tried to edit doesn't exist"
1728 'cantchangecontentmodel' => array(
1729 'code' => 'cantchangecontentmodel',
1730 'info' => "You don't have permission to change the content model of a page"
1732 'nosuchrcid' => array(
1733 'code' => 'nosuchrcid',
1734 'info' => "There is no change with rcid \"\$1\""
1736 'nosuchlogid' => array(
1737 'code' => 'nosuchlogid',
1738 'info' => "There is no log entry with ID \"\$1\""
1740 'protect-invalidaction' => array(
1741 'code' => 'protect-invalidaction',
1742 'info' => "Invalid protection type \"\$1\""
1744 'protect-invalidlevel' => array(
1745 'code' => 'protect-invalidlevel',
1746 'info' => "Invalid protection level \"\$1\""
1748 'toofewexpiries' => array(
1749 'code' => 'toofewexpiries',
1750 'info' => "\$1 expiry timestamps were provided where \$2 were needed"
1752 'cantimport' => array(
1753 'code' => 'cantimport',
1754 'info' => "You don't have permission to import pages"
1756 'cantimport-upload' => array(
1757 'code' => 'cantimport-upload',
1758 'info' => "You don't have permission to import uploaded pages"
1760 'importnofile' => array( 'code' => 'nofile', 'info' => "You didn't upload a file" ),
1761 'importuploaderrorsize' => array(
1762 'code' => 'filetoobig',
1763 'info' => 'The file you uploaded is bigger than the maximum upload size'
1765 'importuploaderrorpartial' => array(
1766 'code' => 'partialupload',
1767 'info' => 'The file was only partially uploaded'
1769 'importuploaderrortemp' => array(
1770 'code' => 'notempdir',
1771 'info' => 'The temporary upload directory is missing'
1773 'importcantopen' => array(
1774 'code' => 'cantopenfile',
1775 'info' => "Couldn't open the uploaded file"
1777 'import-noarticle' => array(
1778 'code' => 'badinterwiki',
1779 'info' => 'Invalid interwiki title specified'
1781 'importbadinterwiki' => array(
1782 'code' => 'badinterwiki',
1783 'info' => 'Invalid interwiki title specified'
1785 'import-unknownerror' => array(
1786 'code' => 'import-unknownerror',
1787 'info' => "Unknown error on import: \"\$1\""
1789 'cantoverwrite-sharedfile' => array(
1790 'code' => 'cantoverwrite-sharedfile',
1791 'info' => 'The target file exists on a shared repository and you do not have permission to override it'
1793 'sharedfile-exists' => array(
1794 'code' => 'fileexists-sharedrepo-perm',
1795 'info' => 'The target file exists on a shared repository. Use the ignorewarnings parameter to override it.'
1797 'mustbeposted' => array(
1798 'code' => 'mustbeposted',
1799 'info' => "The \$1 module requires a POST request"
1803 'info' => 'Incorrect parameter - mutually exclusive values may not be supplied'
1805 'specialpage-cantexecute' => array(
1806 'code' => 'specialpage-cantexecute',
1807 'info' => "You don't have permission to view the results of this special page"
1809 'invalidoldimage' => array(
1810 'code' => 'invalidoldimage',
1811 'info' => 'The oldimage parameter has invalid format'
1813 'nodeleteablefile' => array(
1814 'code' => 'nodeleteablefile',
1815 'info' => 'No such old version of the file'
1817 'fileexists-forbidden' => array(
1818 'code' => 'fileexists-forbidden',
1819 'info' => 'A file with name "$1" already exists, and cannot be overwritten.'
1821 'fileexists-shared-forbidden' => array(
1822 'code' => 'fileexists-shared-forbidden',
1823 'info' => 'A file with name "$1" already exists in the shared file repository, and cannot be overwritten.'
1825 'filerevert-badversion' => array(
1826 'code' => 'filerevert-badversion',
1827 'info' => 'There is no previous local version of this file with the provided timestamp.'
1830 // ApiEditPage messages
1831 'noimageredirect-anon' => array(
1832 'code' => 'noimageredirect-anon',
1833 'info' => "Anonymous users can't create image redirects"
1835 'noimageredirect-logged' => array(
1836 'code' => 'noimageredirect',
1837 'info' => "You don't have permission to create image redirects"
1839 'spamdetected' => array(
1840 'code' => 'spamdetected',
1841 'info' => "Your edit was refused because it contained a spam fragment: \"\$1\""
1843 'contenttoobig' => array(
1844 'code' => 'contenttoobig',
1845 'info' => "The content you supplied exceeds the article size limit of \$1 kilobytes"
1847 'noedit-anon' => array( 'code' => 'noedit-anon', 'info' => "Anonymous users can't edit pages" ),
1848 'noedit' => array( 'code' => 'noedit', 'info' => "You don't have permission to edit pages" ),
1849 'wasdeleted' => array(
1850 'code' => 'pagedeleted',
1851 'info' => "The page has been deleted since you fetched its timestamp"
1853 'blankpage' => array(
1854 'code' => 'emptypage',
1855 'info' => "Creating new, empty pages is not allowed"
1857 'editconflict' => array( 'code' => 'editconflict', 'info' => "Edit conflict detected" ),
1858 'hashcheckfailed' => array( 'code' => 'badmd5', 'info' => "The supplied MD5 hash was incorrect" ),
1859 'missingtext' => array(
1861 'info' => "One of the text, appendtext, prependtext and undo parameters must be set"
1863 'emptynewsection' => array(
1864 'code' => 'emptynewsection',
1865 'info' => 'Creating empty new sections is not possible.'
1867 'revwrongpage' => array(
1868 'code' => 'revwrongpage',
1869 'info' => "r\$1 is not a revision of \"\$2\""
1871 'undo-failure' => array(
1872 'code' => 'undofailure',
1873 'info' => 'Undo failed due to conflicting intermediate edits'
1875 'content-not-allowed-here' => array(
1876 'code' => 'contentnotallowedhere',
1877 'info' => 'Content model "$1" is not allowed at title "$2"'
1880 // Messages from WikiPage::doEit()
1881 'edit-hook-aborted' => array(
1882 'code' => 'edit-hook-aborted',
1883 'info' => "Your edit was aborted by an ArticleSave hook"
1885 'edit-gone-missing' => array(
1886 'code' => 'edit-gone-missing',
1887 'info' => "The page you tried to edit doesn't seem to exist anymore"
1889 'edit-conflict' => array( 'code' => 'editconflict', 'info' => "Edit conflict detected" ),
1890 'edit-already-exists' => array(
1891 'code' => 'edit-already-exists',
1892 'info' => 'It seems the page you tried to create already exist'
1896 'invalid-file-key' => array( 'code' => 'invalid-file-key', 'info' => 'Not a valid file key' ),
1897 'nouploadmodule' => array( 'code' => 'nouploadmodule', 'info' => 'No upload module set' ),
1898 'uploaddisabled' => array(
1899 'code' => 'uploaddisabled',
1900 'info' => 'Uploads are not enabled. Make sure $wgEnableUploads is set to true in LocalSettings.php and the PHP ini setting file_uploads is true'
1902 'copyuploaddisabled' => array(
1903 'code' => 'copyuploaddisabled',
1904 'info' => 'Uploads by URL is not enabled. Make sure $wgAllowCopyUploads is set to true in LocalSettings.php.'
1906 'copyuploadbaddomain' => array(
1907 'code' => 'copyuploadbaddomain',
1908 'info' => 'Uploads by URL are not allowed from this domain.'
1910 'copyuploadbadurl' => array(
1911 'code' => 'copyuploadbadurl',
1912 'info' => 'Upload not allowed from this URL.'
1915 'filename-tooshort' => array(
1916 'code' => 'filename-tooshort',
1917 'info' => 'The filename is too short'
1919 'filename-toolong' => array( 'code' => 'filename-toolong', 'info' => 'The filename is too long' ),
1920 'illegal-filename' => array(
1921 'code' => 'illegal-filename',
1922 'info' => 'The filename is not allowed'
1924 'filetype-missing' => array(
1925 'code' => 'filetype-missing',
1926 'info' => 'The file is missing an extension'
1929 'mustbeloggedin' => array( 'code' => 'mustbeloggedin', 'info' => 'You must be logged in to $1.' )
1931 // @codingStandardsIgnoreEnd
1934 * Helper function for readonly errors
1936 public function dieReadOnly() {
1937 $parsed = $this->parseMsg( array( 'readonlytext' ) );
1938 $this->dieUsage( $parsed['info'], $parsed['code'], /* http error */ 0,
1939 array( 'readonlyreason' => wfReadOnlyReason() ) );
1943 * Output the error message related to a certain array
1944 * @param array|string $error Element of a getUserPermissionsErrors()-style array
1946 public function dieUsageMsg( $error ) {
1947 # most of the time we send a 1 element, so we might as well send it as
1948 # a string and make this an array here.
1949 if ( is_string( $error ) ) {
1950 $error = array( $error );
1952 $parsed = $this->parseMsg( $error );
1953 $this->dieUsage( $parsed['info'], $parsed['code'] );
1957 * Will only set a warning instead of failing if the global $wgDebugAPI
1958 * is set to true. Otherwise behaves exactly as dieUsageMsg().
1959 * @param array|string $error Element of a getUserPermissionsErrors()-style array
1962 public function dieUsageMsgOrDebug( $error ) {
1963 if ( $this->getConfig()->get( 'DebugAPI' ) !== true ) {
1964 $this->dieUsageMsg( $error );
1967 if ( is_string( $error ) ) {
1968 $error = array( $error );
1970 $parsed = $this->parseMsg( $error );
1971 $this->setWarning( '$wgDebugAPI: ' . $parsed['code'] . ' - ' . $parsed['info'] );
1975 * Die with the $prefix.'badcontinue' error. This call is common enough to
1976 * make it into the base method.
1977 * @param bool $condition Will only die if this value is true
1980 protected function dieContinueUsageIf( $condition ) {
1983 'Invalid continue param. You should pass the original value returned by the previous query',
1989 * Return the error message related to a certain array
1990 * @param array $error Element of a getUserPermissionsErrors()-style array
1991 * @return array('code' => code, 'info' => info)
1993 public function parseMsg( $error ) {
1994 $error = (array)$error; // It seems strings sometimes make their way in here
1995 $key = array_shift( $error );
1997 // Check whether the error array was nested
1998 // array( array( <code>, <params> ), array( <another_code>, <params> ) )
1999 if ( is_array( $key ) ) {
2001 $key = array_shift( $error );
2004 if ( isset( self
::$messageMap[$key] ) ) {
2006 'code' => wfMsgReplaceArgs( self
::$messageMap[$key]['code'], $error ),
2007 'info' => wfMsgReplaceArgs( self
::$messageMap[$key]['info'], $error )
2011 // If the key isn't present, throw an "unknown error"
2012 return $this->parseMsg( array( 'unknownerror', $key ) );
2016 * Internal code errors should be reported with this method
2017 * @param string $method Method or function name
2018 * @param string $message Error message
2019 * @throws MWException
2021 protected static function dieDebug( $method, $message ) {
2022 throw new MWException( "Internal error in $method: $message" );
2026 * Write logging information for API features to a debug log, for usage
2028 * @param string $feature Feature being used.
2030 protected function logFeatureUsage( $feature ) {
2031 $request = $this->getRequest();
2032 $s = '"' . addslashes( $feature ) . '"' .
2033 ' "' . wfUrlencode( str_replace( ' ', '_', $this->getUser()->getName() ) ) . '"' .
2034 ' "' . $request->getIP() . '"' .
2035 ' "' . addslashes( $request->getHeader( 'Referer' ) ) . '"' .
2036 ' "' . addslashes( $this->getMain()->getUserAgent() ) . '"';
2037 wfDebugLog( 'api-feature-usage', $s, 'private' );
2042 /************************************************************************//**
2043 * @name Help message generation
2048 * Return the description message.
2050 * @return string|array|Message
2052 protected function getDescriptionMessage() {
2053 return "apihelp-{$this->getModulePath()}-description";
2057 * Get final module description, after hooks have had a chance to tweak it as
2060 * @since 1.25, returns Message[] rather than string[]
2063 public function getFinalDescription() {
2064 $desc = $this->getDescription();
2065 Hooks
::run( 'APIGetDescription', array( &$this, &$desc ) );
2066 $desc = self
::escapeWikiText( $desc );
2067 if ( is_array( $desc ) ) {
2068 $desc = join( "\n", $desc );
2070 $desc = (string)$desc;
2073 $msg = ApiBase
::makeMessage( $this->getDescriptionMessage(), $this->getContext(), array(
2074 $this->getModulePrefix(),
2075 $this->getModuleName(),
2076 $this->getModulePath(),
2078 if ( !$msg->exists() ) {
2079 $msg = $this->msg( 'api-help-fallback-description', $desc );
2081 $msgs = array( $msg );
2083 Hooks
::run( 'APIGetDescriptionMessages', array( $this, &$msgs ) );
2089 * Get final list of parameters, after hooks have had a chance to
2090 * tweak it as needed.
2092 * @param int $flags Zero or more flags like GET_VALUES_FOR_HELP
2093 * @return array|bool False on no parameters
2094 * @since 1.21 $flags param added
2096 public function getFinalParams( $flags = 0 ) {
2097 $params = $this->getAllowedParams( $flags );
2102 if ( $this->needsToken() ) {
2103 $params['token'] = array(
2104 ApiBase
::PARAM_TYPE
=> 'string',
2105 ApiBase
::PARAM_REQUIRED
=> true,
2106 ApiBase
::PARAM_HELP_MSG
=> array(
2107 'api-help-param-token',
2108 $this->needsToken(),
2110 ) +
( isset( $params['token'] ) ?
$params['token'] : array() );
2113 Hooks
::run( 'APIGetAllowedParams', array( &$this, &$params, $flags ) );
2119 * Get final parameter descriptions, after hooks have had a chance to tweak it as
2122 * @since 1.25, returns array of Message[] rather than array of string[]
2123 * @return array Keys are parameter names, values are arrays of Message objects
2125 public function getFinalParamDescription() {
2126 $prefix = $this->getModulePrefix();
2127 $name = $this->getModuleName();
2128 $path = $this->getModulePath();
2130 $desc = $this->getParamDescription();
2131 Hooks
::run( 'APIGetParamDescription', array( &$this, &$desc ) );
2136 $desc = self
::escapeWikiText( $desc );
2138 $params = $this->getFinalParams( ApiBase
::GET_VALUES_FOR_HELP
);
2140 foreach ( $params as $param => $settings ) {
2141 if ( !is_array( $settings ) ) {
2142 $settings = array();
2145 $d = isset( $desc[$param] ) ?
$desc[$param] : '';
2146 if ( is_array( $d ) ) {
2147 // Special handling for prop parameters
2148 $d = array_map( function ( $line ) {
2149 if ( preg_match( '/^\s+(\S+)\s+-\s+(.+)$/', $line, $m ) ) {
2150 $line = "\n;{$m[1]}:{$m[2]}";
2154 $d = join( ' ', $d );
2157 if ( isset( $settings[ApiBase
::PARAM_HELP_MSG
] ) ) {
2158 $msg = $settings[ApiBase
::PARAM_HELP_MSG
];
2160 $msg = $this->msg( "apihelp-{$path}-param-{$param}" );
2161 if ( !$msg->exists() ) {
2162 $msg = $this->msg( 'api-help-fallback-parameter', $d );
2165 $msg = ApiBase
::makeMessage( $msg, $this->getContext(),
2166 array( $prefix, $param, $name, $path ) );
2168 $this->dieDebug( __METHOD__
,
2169 'Value in ApiBase::PARAM_HELP_MSG is not valid' );
2171 $msgs[$param] = array( $msg );
2173 if ( isset( $settings[ApiBase
::PARAM_HELP_MSG_PER_VALUE
] ) ) {
2174 if ( !is_array( $settings[ApiBase
::PARAM_HELP_MSG_PER_VALUE
] ) ) {
2175 $this->dieDebug( __METHOD__
,
2176 'ApiBase::PARAM_HELP_MSG_PER_VALUE is not valid' );
2178 if ( !is_array( $settings[ApiBase
::PARAM_TYPE
] ) ) {
2179 $this->dieDebug( __METHOD__
,
2180 'ApiBase::PARAM_HELP_MSG_PER_VALUE may only be used when ' .
2181 'ApiBase::PARAM_TYPE is an array' );
2184 $valueMsgs = $settings[ApiBase
::PARAM_HELP_MSG_PER_VALUE
];
2185 foreach ( $settings[ApiBase
::PARAM_TYPE
] as $value ) {
2186 if ( isset( $valueMsgs[$value] ) ) {
2187 $msg = $valueMsgs[$value];
2189 $msg = "apihelp-{$path}-paramvalue-{$param}-{$value}";
2191 $m = ApiBase
::makeMessage( $msg, $this->getContext(),
2192 array( $prefix, $param, $name, $path, $value ) );
2194 $m = new ApiHelpParamValueMessage(
2196 array( $m->getKey(), 'api-help-param-no-description' ),
2199 $msgs[$param][] = $m->setContext( $this->getContext() );
2201 $this->dieDebug( __METHOD__
,
2202 "Value in ApiBase::PARAM_HELP_MSG_PER_VALUE for $value is not valid" );
2207 if ( isset( $settings[ApiBase
::PARAM_HELP_MSG_APPEND
] ) ) {
2208 if ( !is_array( $settings[ApiBase
::PARAM_HELP_MSG_APPEND
] ) ) {
2209 $this->dieDebug( __METHOD__
,
2210 'Value for ApiBase::PARAM_HELP_MSG_APPEND is not an array' );
2212 foreach ( $settings[ApiBase
::PARAM_HELP_MSG_APPEND
] as $m ) {
2213 $m = ApiBase
::makeMessage( $m, $this->getContext(),
2214 array( $prefix, $param, $name, $path ) );
2216 $msgs[$param][] = $m;
2218 $this->dieDebug( __METHOD__
,
2219 'Value in ApiBase::PARAM_HELP_MSG_APPEND is not valid' );
2225 Hooks
::run( 'APIGetParamDescriptionMessages', array( $this, &$msgs ) );
2231 * Generates the list of flags for the help screen and for action=paraminfo
2233 * Corresponding messages: api-help-flag-deprecated,
2234 * api-help-flag-internal, api-help-flag-readrights,
2235 * api-help-flag-writerights, api-help-flag-mustbeposted
2239 protected function getHelpFlags() {
2242 if ( $this->isDeprecated() ) {
2243 $flags[] = 'deprecated';
2245 if ( $this->isInternal() ) {
2246 $flags[] = 'internal';
2248 if ( $this->isReadMode() ) {
2249 $flags[] = 'readrights';
2251 if ( $this->isWriteMode() ) {
2252 $flags[] = 'writerights';
2254 if ( $this->mustBePosted() ) {
2255 $flags[] = 'mustbeposted';
2262 * Returns information about the source of this module, if known
2264 * Returned array is an array with the following keys:
2265 * - path: Install path
2266 * - name: Extension name, or "MediaWiki" for core
2267 * - namemsg: (optional) i18n message key for a display name
2268 * - license-name: (optional) Name of license
2270 * @return array|null
2272 protected function getModuleSourceInfo() {
2275 if ( $this->mModuleSource
!== false ) {
2276 return $this->mModuleSource
;
2279 // First, try to find where the module comes from...
2280 $rClass = new ReflectionClass( $this );
2281 $path = $rClass->getFileName();
2284 $this->mModuleSource
= null;
2287 $path = realpath( $path ) ?
: $path;
2289 // Build map of extension directories to extension info
2290 if ( self
::$extensionInfo === null ) {
2291 self
::$extensionInfo = array(
2292 realpath( __DIR__
) ?
: __DIR__
=> array(
2294 'name' => 'MediaWiki',
2295 'license-name' => 'GPL-2.0+',
2297 realpath( "$IP/extensions" ) ?
: "$IP/extensions" => null,
2303 'license-name' => null,
2305 foreach ( $this->getConfig()->get( 'ExtensionCredits' ) as $group ) {
2306 foreach ( $group as $ext ) {
2307 if ( !isset( $ext['path'] ) ||
!isset( $ext['name'] ) ) {
2308 // This shouldn't happen, but does anyway.
2312 $extpath = $ext['path'];
2313 if ( !is_dir( $extpath ) ) {
2314 $extpath = dirname( $extpath );
2316 self
::$extensionInfo[realpath( $extpath ) ?
: $extpath] =
2317 array_intersect_key( $ext, $keep );
2320 foreach ( ExtensionRegistry
::getInstance()->getAllThings() as $ext ) {
2321 $extpath = $ext['path'];
2322 if ( !is_dir( $extpath ) ) {
2323 $extpath = dirname( $extpath );
2325 self
::$extensionInfo[realpath( $extpath ) ?
: $extpath] =
2326 array_intersect_key( $ext, $keep );
2330 // Now traverse parent directories until we find a match or run out of
2333 if ( array_key_exists( $path, self
::$extensionInfo ) ) {
2335 $this->mModuleSource
= self
::$extensionInfo[$path];
2336 return $this->mModuleSource
;
2340 $path = dirname( $path );
2341 } while ( $path !== $oldpath );
2343 // No idea what extension this might be.
2344 $this->mModuleSource
= null;
2349 * Called from ApiHelp before the pieces are joined together and returned.
2351 * This exists mainly for ApiMain to add the Permissions and Credits
2352 * sections. Other modules probably don't need it.
2354 * @param string[] &$help Array of help data
2355 * @param array $options Options passed to ApiHelp::getHelp
2356 * @param array &$tocData If a TOC is being generated, this array has keys
2357 * as anchors in the page and values as for Linker::generateTOC().
2359 public function modifyHelp( array &$help, array $options, array &$tocData ) {
2364 /************************************************************************//**
2369 /// @deprecated since 1.24
2370 const PROP_ROOT
= 'ROOT';
2371 /// @deprecated since 1.24
2372 const PROP_LIST
= 'LIST';
2373 /// @deprecated since 1.24
2374 const PROP_TYPE
= 0;
2375 /// @deprecated since 1.24
2376 const PROP_NULLABLE
= 1;
2379 * Formerly returned a string that identifies the version of the extending
2380 * class. Typically included the class name, the svn revision, timestamp,
2381 * and last author. Usually done with SVN's Id keyword
2383 * @deprecated since 1.21, version string is no longer supported
2386 public function getVersion() {
2387 wfDeprecated( __METHOD__
, '1.21' );
2392 * Formerly used to fetch a list of possible properites in the result,
2393 * somehow organized with respect to the prop parameter that causes them to
2394 * be returned. The specific semantics of the return value was never
2395 * specified. Since this was never possible to be accurately updated, it
2398 * @deprecated since 1.24
2399 * @return array|bool
2401 protected function getResultProperties() {
2402 wfDeprecated( __METHOD__
, '1.24' );
2407 * @see self::getResultProperties()
2408 * @deprecated since 1.24
2409 * @return array|bool
2411 public function getFinalResultProperties() {
2412 wfDeprecated( __METHOD__
, '1.24' );
2417 * @see self::getResultProperties()
2418 * @deprecated since 1.24
2420 protected static function addTokenProperties( &$props, $tokenFunctions ) {
2421 wfDeprecated( __METHOD__
, '1.24' );
2425 * @see self::getPossibleErrors()
2426 * @deprecated since 1.24
2429 public function getRequireOnlyOneParameterErrorMessages( $params ) {
2430 wfDeprecated( __METHOD__
, '1.24' );
2435 * @see self::getPossibleErrors()
2436 * @deprecated since 1.24
2439 public function getRequireMaxOneParameterErrorMessages( $params ) {
2440 wfDeprecated( __METHOD__
, '1.24' );
2445 * @see self::getPossibleErrors()
2446 * @deprecated since 1.24
2449 public function getRequireAtLeastOneParameterErrorMessages( $params ) {
2450 wfDeprecated( __METHOD__
, '1.24' );
2455 * @see self::getPossibleErrors()
2456 * @deprecated since 1.24
2459 public function getTitleOrPageIdErrorMessage() {
2460 wfDeprecated( __METHOD__
, '1.24' );
2465 * This formerly attempted to return a list of all possible errors returned
2466 * by the module. However, this was impossible to maintain in many cases
2467 * since errors could come from other areas of MediaWiki and in some cases
2468 * from arbitrary extension hooks. Since a partial list claiming to be
2469 * comprehensive is unlikely to be useful, it was removed.
2471 * @deprecated since 1.24
2474 public function getPossibleErrors() {
2475 wfDeprecated( __METHOD__
, '1.24' );
2480 * @see self::getPossibleErrors()
2481 * @deprecated since 1.24
2484 public function getFinalPossibleErrors() {
2485 wfDeprecated( __METHOD__
, '1.24' );
2490 * @see self::getPossibleErrors()
2491 * @deprecated since 1.24
2494 public function parseErrors( $errors ) {
2495 wfDeprecated( __METHOD__
, '1.24' );
2500 * Returns the description string for this module
2502 * Ignored if an i18n message exists for
2503 * "apihelp-{$this->getModulePath()}-description".
2505 * @deprecated since 1.25
2506 * @return Message|string|array
2508 protected function getDescription() {
2513 * Returns an array of parameter descriptions.
2515 * For each parameter, ignored if an i18n message exists for the parameter.
2516 * By default that message is
2517 * "apihelp-{$this->getModulePath()}-param-{$param}", but it may be
2518 * overridden using ApiBase::PARAM_HELP_MSG in the data returned by
2519 * self::getFinalParams().
2521 * @deprecated since 1.25
2522 * @return array|bool False on no parameter descriptions
2524 protected function getParamDescription() {
2529 * Returns usage examples for this module.
2531 * Return value as an array is either:
2532 * - numeric keys with partial URLs ("api.php?" plus a query string) as
2534 * - sequential numeric keys with even-numbered keys being display-text
2535 * and odd-numbered keys being partial urls
2536 * - partial URLs as keys with display-text (string or array-to-be-joined)
2538 * Return value as a string is the same as an array with a numeric key and
2539 * that value, and boolean false means "no examples".
2541 * @deprecated since 1.25, use getExamplesMessages() instead
2542 * @return bool|string|array
2544 protected function getExamples() {
2549 * Generates help message for this module, or false if there is no description
2550 * @deprecated since 1.25
2551 * @return string|bool
2553 public function makeHelpMsg() {
2554 wfDeprecated( __METHOD__
, '1.25' );
2555 static $lnPrfx = "\n ";
2557 $msg = $this->getFinalDescription();
2559 if ( $msg !== false ) {
2561 if ( !is_array( $msg ) ) {
2566 $msg = $lnPrfx . implode( $lnPrfx, $msg ) . "\n";
2568 $msg .= $this->makeHelpArrayToString( $lnPrfx, false, $this->getHelpUrls() );
2570 if ( $this->isReadMode() ) {
2571 $msg .= "\nThis module requires read rights";
2573 if ( $this->isWriteMode() ) {
2574 $msg .= "\nThis module requires write rights";
2576 if ( $this->mustBePosted() ) {
2577 $msg .= "\nThis module only accepts POST requests";
2579 if ( $this->isReadMode() ||
$this->isWriteMode() ||
2580 $this->mustBePosted()
2586 $paramsMsg = $this->makeHelpMsgParameters();
2587 if ( $paramsMsg !== false ) {
2588 $msg .= "Parameters:\n$paramsMsg";
2591 $examples = $this->getExamples();
2593 if ( !is_array( $examples ) ) {
2598 $msg .= "Example" . ( count( $examples ) > 1 ?
's' : '' ) . ":\n";
2599 foreach ( $examples as $k => $v ) {
2600 if ( is_numeric( $k ) ) {
2603 if ( is_array( $v ) ) {
2604 $msgExample = implode( "\n", array_map( array( $this, 'indentExampleText' ), $v ) );
2606 $msgExample = " $v";
2609 $msg .= wordwrap( $msgExample, 100, "\n" ) . "\n $k\n";
2619 * @deprecated since 1.25
2620 * @param string $item
2623 private function indentExampleText( $item ) {
2628 * @deprecated since 1.25
2629 * @param string $prefix Text to split output items
2630 * @param string $title What is being output
2631 * @param string|array $input
2634 protected function makeHelpArrayToString( $prefix, $title, $input ) {
2635 wfDeprecated( __METHOD__
, '1.25' );
2636 if ( $input === false ) {
2639 if ( !is_array( $input ) ) {
2640 $input = array( $input );
2643 if ( count( $input ) > 0 ) {
2645 $msg = $title . ( count( $input ) > 1 ?
's' : '' ) . ":\n ";
2649 $msg .= implode( $prefix, $input ) . "\n";
2658 * Generates the parameter descriptions for this module, to be displayed in the
2660 * @deprecated since 1.25
2661 * @return string|bool
2663 public function makeHelpMsgParameters() {
2664 wfDeprecated( __METHOD__
, '1.25' );
2665 $params = $this->getFinalParams( ApiBase
::GET_VALUES_FOR_HELP
);
2667 $paramsDescription = $this->getFinalParamDescription();
2669 $paramPrefix = "\n" . str_repeat( ' ', 24 );
2670 $descWordwrap = "\n" . str_repeat( ' ', 28 );
2671 foreach ( $params as $paramName => $paramSettings ) {
2672 $desc = isset( $paramsDescription[$paramName] ) ?
$paramsDescription[$paramName] : '';
2673 if ( is_array( $desc ) ) {
2674 $desc = implode( $paramPrefix, $desc );
2678 if ( !is_array( $paramSettings ) ) {
2679 $paramSettings = array(
2680 self
::PARAM_DFLT
=> $paramSettings,
2684 // handle missing type
2685 if ( !isset( $paramSettings[ApiBase
::PARAM_TYPE
] ) ) {
2686 $dflt = isset( $paramSettings[ApiBase
::PARAM_DFLT
] )
2687 ?
$paramSettings[ApiBase
::PARAM_DFLT
]
2689 if ( is_bool( $dflt ) ) {
2690 $paramSettings[ApiBase
::PARAM_TYPE
] = 'boolean';
2691 } elseif ( is_string( $dflt ) ||
is_null( $dflt ) ) {
2692 $paramSettings[ApiBase
::PARAM_TYPE
] = 'string';
2693 } elseif ( is_int( $dflt ) ) {
2694 $paramSettings[ApiBase
::PARAM_TYPE
] = 'integer';
2698 if ( isset( $paramSettings[self
::PARAM_DEPRECATED
] )
2699 && $paramSettings[self
::PARAM_DEPRECATED
]
2701 $desc = "DEPRECATED! $desc";
2704 if ( isset( $paramSettings[self
::PARAM_REQUIRED
] )
2705 && $paramSettings[self
::PARAM_REQUIRED
]
2707 $desc .= $paramPrefix . "This parameter is required";
2710 $type = isset( $paramSettings[self
::PARAM_TYPE
] )
2711 ?
$paramSettings[self
::PARAM_TYPE
]
2713 if ( isset( $type ) ) {
2714 $hintPipeSeparated = true;
2715 $multi = isset( $paramSettings[self
::PARAM_ISMULTI
] )
2716 ?
$paramSettings[self
::PARAM_ISMULTI
]
2719 $prompt = 'Values (separate with \'|\'): ';
2721 $prompt = 'One value: ';
2724 if ( $type === 'submodule' ) {
2725 if ( isset( $paramSettings[self
::PARAM_SUBMODULE_MAP
] ) ) {
2726 $type = array_keys( $paramSettings[self
::PARAM_SUBMODULE_MAP
] );
2728 $type = $this->getModuleManager()->getNames( $paramName );
2732 if ( is_array( $type ) ) {
2734 $nothingPrompt = '';
2735 foreach ( $type as $t ) {
2737 $nothingPrompt = 'Can be empty, or ';
2742 $desc .= $paramPrefix . $nothingPrompt . $prompt;
2743 $choicesstring = implode( ', ', $choices );
2744 $desc .= wordwrap( $choicesstring, 100, $descWordwrap );
2745 $hintPipeSeparated = false;
2749 // Special handling because namespaces are
2750 // type-limited, yet they are not given
2751 $desc .= $paramPrefix . $prompt;
2752 $desc .= wordwrap( implode( ', ', MWNamespace
::getValidNamespaces() ),
2753 100, $descWordwrap );
2754 $hintPipeSeparated = false;
2757 $desc .= $paramPrefix . "No more than {$paramSettings[self::PARAM_MAX]}";
2758 if ( isset( $paramSettings[self
::PARAM_MAX2
] ) ) {
2759 $desc .= " ({$paramSettings[self::PARAM_MAX2]} for bots)";
2761 $desc .= ' allowed';
2764 $s = $multi ?
's' : '';
2765 $hasMin = isset( $paramSettings[self
::PARAM_MIN
] );
2766 $hasMax = isset( $paramSettings[self
::PARAM_MAX
] );
2767 if ( $hasMin ||
$hasMax ) {
2769 $intRangeStr = "The value$s must be no less than " .
2770 "{$paramSettings[self::PARAM_MIN]}";
2771 } elseif ( !$hasMin ) {
2772 $intRangeStr = "The value$s must be no more than " .
2773 "{$paramSettings[self::PARAM_MAX]}";
2775 $intRangeStr = "The value$s must be between " .
2776 "{$paramSettings[self::PARAM_MIN]} and {$paramSettings[self::PARAM_MAX]}";
2779 $desc .= $paramPrefix . $intRangeStr;
2783 $desc .= $paramPrefix . "Must be posted as a file upload using multipart/form-data";
2789 if ( $hintPipeSeparated ) {
2790 $desc .= $paramPrefix . "Separate values with '|'";
2793 $isArray = is_array( $type );
2795 ||
$isArray && count( $type ) > self
::LIMIT_SML1
2797 $desc .= $paramPrefix . "Maximum number of values " .
2798 self
::LIMIT_SML1
. " (" . self
::LIMIT_SML2
. " for bots)";
2803 $default = isset( $paramSettings[self
::PARAM_DFLT
] ) ?
$paramSettings[self
::PARAM_DFLT
] : null;
2804 if ( !is_null( $default ) && $default !== false ) {
2805 $desc .= $paramPrefix . "Default: $default";
2808 $msg .= sprintf( " %-19s - %s\n", $this->encodeParamName( $paramName ), $desc );
2818 * @deprecated since 1.25, always returns empty string
2819 * @param DatabaseBase|bool $db
2822 public function getModuleProfileName( $db = false ) {
2823 wfDeprecated( __METHOD__
, '1.25' );
2828 * @deprecated since 1.25
2830 public function profileIn() {
2831 // No wfDeprecated() yet because extensions call this and might need to
2832 // keep doing so for BC.
2836 * @deprecated since 1.25
2838 public function profileOut() {
2839 // No wfDeprecated() yet because extensions call this and might need to
2840 // keep doing so for BC.
2844 * @deprecated since 1.25
2846 public function safeProfileOut() {
2847 wfDeprecated( __METHOD__
, '1.25' );
2851 * @deprecated since 1.25, always returns 0
2854 public function getProfileTime() {
2855 wfDeprecated( __METHOD__
, '1.25' );
2860 * @deprecated since 1.25
2862 public function profileDBIn() {
2863 wfDeprecated( __METHOD__
, '1.25' );
2867 * @deprecated since 1.25
2869 public function profileDBOut() {
2870 wfDeprecated( __METHOD__
, '1.25' );
2874 * @deprecated since 1.25, always returns 0
2877 public function getProfileDBTime() {
2878 wfDeprecated( __METHOD__
, '1.25' );
2883 * Get the result data array (read-only)
2884 * @deprecated since 1.25, use $this->getResult() methods instead
2887 public function getResultData() {
2888 wfDeprecated( __METHOD__
, '1.25' );
2889 return $this->getResult()->getData();
2893 * Call wfTransactionalTimeLimit() if this request was POSTed
2896 protected function useTransactionalTimeLimit() {
2897 if ( $this->getRequest()->wasPosted() ) {
2898 wfTransactionalTimeLimit();
2906 * For really cool vim folding this needs to be at the end:
2907 * vim: foldmarker=@{,@} foldmethod=marker