3 * Copyright © 2006, 2010 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\Block\AbstractBlock
;
24 use MediaWiki\Block\DatabaseBlock
;
25 use MediaWiki\Linker\LinkTarget
;
26 use MediaWiki\MediaWikiServices
;
27 use MediaWiki\Permissions\PermissionManager
;
28 use Wikimedia\Rdbms\IDatabase
;
31 * This abstract class implements many basic API functions, and is the base of
33 * The class functions are divided into several areas of functionality:
35 * Module parameters: Derived classes can define getAllowedParams() to specify
36 * which parameters to expect, how to parse and validate them.
38 * Self-documentation: code to allow the API to document its own state
42 abstract class ApiBase
extends ContextSource
{
44 use ApiBlockInfoTrait
;
47 * @name Constants for ::getAllowedParams() arrays
48 * These constants are keys in the arrays returned by ::getAllowedParams()
49 * and accepted by ::getParameterFromSettings() that define how the
50 * parameters coming in from the request are to be interpreted.
54 /** (null|boolean|integer|string) Default value of the parameter. */
57 /** (boolean) Accept multiple pipe-separated values for this parameter (e.g. titles)? */
58 const PARAM_ISMULTI
= 1;
61 * (string|string[]) Either an array of allowed value strings, or a string
62 * type as described below. If not specified, will be determined from the
65 * Supported string types are:
66 * - boolean: A boolean parameter, returned as false if the parameter is
67 * omitted and true if present (even with a falsey value, i.e. it works
68 * like HTML checkboxes). PARAM_DFLT must be boolean false, if specified.
69 * Cannot be used with PARAM_ISMULTI.
70 * - integer: An integer value. See also PARAM_MIN, PARAM_MAX, and
71 * PARAM_RANGE_ENFORCE.
72 * - limit: An integer or the string 'max'. Default lower limit is 0 (but
73 * see PARAM_MIN), and requires that PARAM_MAX and PARAM_MAX2 be
74 * specified. Cannot be used with PARAM_ISMULTI.
75 * - namespace: An integer representing a MediaWiki namespace. Forces PARAM_ALL = true to
76 * support easily specifying all namespaces.
78 * - password: Any non-empty string. Input value is private or sensitive.
79 * <input type="password"> would be an appropriate HTML form field.
80 * - string: Any non-empty string, not expected to be very long or contain newlines.
81 * <input type="text"> would be an appropriate HTML form field.
82 * - submodule: The name of a submodule of this module, see PARAM_SUBMODULE_MAP.
83 * - tags: A string naming an existing, explicitly-defined tag. Should usually be
84 * used with PARAM_ISMULTI.
85 * - text: Any non-empty string, expected to be very long or contain newlines.
86 * <textarea> would be an appropriate HTML form field.
87 * - timestamp: A timestamp in any format recognized by MWTimestamp, or the
88 * string 'now' representing the current timestamp. Will be returned in
90 * - user: A MediaWiki username or IP. Will be returned normalized but not canonicalized.
91 * - upload: An uploaded file. Will be returned as a WebRequestUpload object.
92 * Cannot be used with PARAM_ISMULTI.
96 /** (integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. */
100 * (integer) Max value allowed for the parameter for users with the
101 * apihighlimits right, for PARAM_TYPE 'limit'.
103 const PARAM_MAX2
= 4;
105 /** (integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. */
108 /** (boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true? */
109 const PARAM_ALLOW_DUPLICATES
= 6;
111 /** (boolean) Is the parameter deprecated (will show a warning)? */
112 const PARAM_DEPRECATED
= 7;
115 * (boolean) Is the parameter required?
118 const PARAM_REQUIRED
= 8;
121 * (boolean) For PARAM_TYPE 'integer', enforce PARAM_MIN and PARAM_MAX?
124 const PARAM_RANGE_ENFORCE
= 9;
127 * (string|array|Message) Specify an alternative i18n documentation message
128 * for this parameter. Default is apihelp-{$path}-param-{$param}.
131 const PARAM_HELP_MSG
= 10;
134 * ((string|array|Message)[]) Specify additional i18n messages to append to
135 * the normal message for this parameter.
138 const PARAM_HELP_MSG_APPEND
= 11;
141 * (array) Specify additional information tags for the parameter. Value is
142 * an array of arrays, with the first member being the 'tag' for the info
143 * and the remaining members being the values. In the help, this is
144 * formatted using apihelp-{$path}-paraminfo-{$tag}, which is passed
145 * $1 = count, $2 = comma-joined list of values, $3 = module prefix.
148 const PARAM_HELP_MSG_INFO
= 12;
151 * (string[]) When PARAM_TYPE is an array, this may be an array mapping
152 * those values to page titles which will be linked in the help.
155 const PARAM_VALUE_LINKS
= 13;
158 * ((string|array|Message)[]) When PARAM_TYPE is an array, this is an array
159 * mapping those values to $msg for ApiBase::makeMessage(). Any value not
160 * having a mapping will use apihelp-{$path}-paramvalue-{$param}-{$value}.
161 * Specify an empty array to use the default message key for all values.
164 const PARAM_HELP_MSG_PER_VALUE
= 14;
167 * (string[]) When PARAM_TYPE is 'submodule', map parameter values to
168 * submodule paths. Default is to use all modules in
169 * $this->getModuleManager() in the group matching the parameter name.
172 const PARAM_SUBMODULE_MAP
= 15;
175 * (string) When PARAM_TYPE is 'submodule', used to indicate the 'g' prefix
176 * added by ApiQueryGeneratorBase (and similar if anything else ever does that).
179 const PARAM_SUBMODULE_PARAM_PREFIX
= 16;
182 * (boolean|string) When PARAM_TYPE has a defined set of values and PARAM_ISMULTI is true,
183 * this allows for an asterisk ('*') to be passed in place of a pipe-separated list of
184 * every possible value. If a string is set, it will be used in place of the asterisk.
187 const PARAM_ALL
= 17;
190 * (int[]) When PARAM_TYPE is 'namespace', include these as additional possible values.
193 const PARAM_EXTRA_NAMESPACES
= 18;
196 * (boolean) Is the parameter sensitive? Note 'password'-type fields are
197 * always sensitive regardless of the value of this field.
200 const PARAM_SENSITIVE
= 19;
203 * (array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.
204 * Keys are the deprecated parameter values, values define the warning
205 * message to emit: either boolean true (to use a default message) or a
206 * $msg for ApiBase::makeMessage().
209 const PARAM_DEPRECATED_VALUES
= 20;
212 * (integer) Maximum number of values, for normal users. Must be used with PARAM_ISMULTI.
215 const PARAM_ISMULTI_LIMIT1
= 21;
218 * (integer) Maximum number of values, for users with the apihighimits right.
219 * Must be used with PARAM_ISMULTI.
222 const PARAM_ISMULTI_LIMIT2
= 22;
225 * (integer) Maximum length of a string in bytes (in UTF-8 encoding).
228 const PARAM_MAX_BYTES
= 23;
231 * (integer) Maximum length of a string in characters (unicode codepoints).
234 const PARAM_MAX_CHARS
= 24;
237 * (array) Indicate that this is a templated parameter, and specify replacements. Keys are the
238 * placeholders in the parameter name and values are the names of (unprefixed) parameters from
239 * which the replacement values are taken.
241 * For example, a parameter "foo-{ns}-{title}" could be defined with
242 * PARAM_TEMPLATE_VARS => [ 'ns' => 'namespaces', 'title' => 'titles' ]. Then a query for
243 * namespaces=0|1&titles=X|Y would support parameters foo-0-X, foo-0-Y, foo-1-X, and foo-1-Y.
245 * All placeholders must be present in the parameter's name. Each target parameter must have
246 * PARAM_ISMULTI true. If a target is itself a templated parameter, its PARAM_TEMPLATE_VARS must
247 * be a subset of the referring parameter's, mapping the same placeholders to the same targets.
248 * A parameter cannot target itself.
252 const PARAM_TEMPLATE_VARS
= 25;
256 const ALL_DEFAULT_STRING
= '*';
258 /** Fast query, standard limit. */
259 const LIMIT_BIG1
= 500;
260 /** Fast query, apihighlimits limit. */
261 const LIMIT_BIG2
= 5000;
262 /** Slow query, standard limit. */
263 const LIMIT_SML1
= 50;
264 /** Slow query, apihighlimits limit. */
265 const LIMIT_SML2
= 500;
268 * getAllowedParams() flag: When set, the result could take longer to generate,
269 * but should be more thorough. E.g. get the list of generators for ApiSandBox extension
272 const GET_VALUES_FOR_HELP
= 1;
274 /** @var array Maps extension paths to info arrays */
275 private static $extensionInfo = null;
277 /** @var int[][][] Cache for self::filterIDs() */
278 private static $filterIDsCache = [];
280 /** $var array Map of web UI block messages to corresponding API messages and codes */
281 private static $blockMsgMap = [
282 'blockedtext' => [ 'apierror-blocked', 'blocked' ],
283 'blockedtext-partial' => [ 'apierror-blocked-partial', 'blocked' ],
284 'autoblockedtext' => [ 'apierror-autoblocked', 'autoblocked' ],
285 'systemblockedtext' => [ 'apierror-systemblocked', 'blocked' ],
286 'blockedtext-composite' => [ 'apierror-blocked', 'blocked' ],
290 private $mMainModule;
292 private $mModuleName, $mModulePrefix;
293 private $mReplicaDB = null;
294 private $mParamCache = [];
295 /** @var array|null|bool */
296 private $mModuleSource = false;
299 * @param ApiMain $mainModule
300 * @param string $moduleName Name of this module
301 * @param string $modulePrefix Prefix to use for parameter names
303 public function __construct( ApiMain
$mainModule, $moduleName, $modulePrefix = '' ) {
304 $this->mMainModule
= $mainModule;
305 $this->mModuleName
= $moduleName;
306 $this->mModulePrefix
= $modulePrefix;
308 if ( !$this->isMain() ) {
309 $this->setContext( $mainModule->getContext() );
313 /************************************************************************//**
314 * @name Methods to implement
319 * Evaluates the parameters, performs the requested query, and sets up
320 * the result. Concrete implementations of ApiBase must override this
321 * method to provide whatever functionality their module offers.
322 * Implementations must not produce any output on their own and are not
323 * expected to handle any errors.
325 * The execute() method will be invoked directly by ApiMain immediately
326 * before the result of the module is output. Aside from the
327 * constructor, implementations should assume that no other methods
328 * will be called externally on the module before the result is
331 * The result data should be stored in the ApiResult object available
332 * through getResult().
334 abstract public function execute();
337 * Get the module manager, or null if this module has no sub-modules
339 * @return ApiModuleManager
341 public function getModuleManager() {
346 * If the module may only be used with a certain format module,
347 * it should override this method to return an instance of that formatter.
348 * A value of null means the default format will be used.
349 * @note Do not use this just because you don't want to support non-json
350 * formats. This should be used only when there is a fundamental
351 * requirement for a specific format.
352 * @return mixed Instance of a derived class of ApiFormatBase, or null
354 public function getCustomPrinter() {
359 * Returns usage examples for this module.
361 * Return value has query strings as keys, with values being either strings
362 * (message key), arrays (message key + parameter), or Message objects.
364 * Do not call this base class implementation when overriding this method.
369 protected function getExamplesMessages() {
374 * Return links to more detailed help pages about the module.
375 * @since 1.25, returning boolean false is deprecated
376 * @return string|array
378 public function getHelpUrls() {
383 * Returns an array of allowed parameters (parameter name) => (default
384 * value) or (parameter name) => (array with PARAM_* constants as keys)
385 * Don't call this function directly: use getFinalParams() to allow
386 * hooks to modify parameters as needed.
388 * Some derived classes may choose to handle an integer $flags parameter
389 * in the overriding methods. Callers of this method can pass zero or
390 * more OR-ed flags like GET_VALUES_FOR_HELP.
394 protected function getAllowedParams( /* $flags = 0 */ ) {
395 // int $flags is not declared because it causes "Strict standards"
396 // warning. Most derived classes do not implement it.
401 * Indicates if this module needs maxlag to be checked
404 public function shouldCheckMaxlag() {
409 * Indicates whether this module requires read rights
412 public function isReadMode() {
417 * Indicates whether this module requires write mode
419 * This should return true for modules that may require synchronous database writes.
420 * Modules that do not need such writes should also not rely on master database access,
421 * since only read queries are needed and each master DB is a single point of failure.
422 * Additionally, requests that only need replica DBs can be efficiently routed to any
423 * datacenter via the Promise-Non-Write-API-Action header.
427 public function isWriteMode() {
432 * Indicates whether this module must be called with a POST request
435 public function mustBePosted() {
436 return $this->needsToken() !== false;
440 * Indicates whether this module is deprecated
444 public function isDeprecated() {
449 * Indicates whether this module is "internal"
450 * Internal API modules are not (yet) intended for 3rd party use and may be unstable.
454 public function isInternal() {
459 * Returns the token type this module requires in order to execute.
461 * Modules are strongly encouraged to use the core 'csrf' type unless they
462 * have specialized security needs. If the token type is not one of the
463 * core types, you must use the ApiQueryTokensRegisterTypes hook to
466 * Returning a non-falsey value here will force the addition of an
467 * appropriate 'token' parameter in self::getFinalParams(). Also,
468 * self::mustBePosted() must return true when tokens are used.
470 * In previous versions of MediaWiki, true was a valid return value.
471 * Returning true will generate errors indicating that the API module needs
474 * @return string|false
476 public function needsToken() {
481 * Fetch the salt used in the Web UI corresponding to this module.
483 * Only override this if the Web UI uses a token with a non-constant salt.
486 * @param array $params All supplied parameters for the module
487 * @return string|array|null
489 protected function getWebUITokenSalt( array $params ) {
494 * Returns data for HTTP conditional request mechanisms.
497 * @param string $condition Condition being queried:
498 * - last-modified: Return a timestamp representing the maximum of the
499 * last-modified dates for all resources involved in the request. See
500 * RFC 7232 § 2.2 for semantics.
501 * - etag: Return an entity-tag representing the state of all resources involved
502 * in the request. Quotes must be included. See RFC 7232 § 2.3 for semantics.
503 * @return string|bool|null As described above, or null if no value is available.
505 public function getConditionalRequestData( $condition ) {
511 /************************************************************************//**
512 * @name Data access methods
517 * Get the name of the module being executed by this instance
520 public function getModuleName() {
521 return $this->mModuleName
;
525 * Get parameter prefix (usually two letters or an empty string).
528 public function getModulePrefix() {
529 return $this->mModulePrefix
;
533 * Get the main module
536 public function getMain() {
537 return $this->mMainModule
;
541 * Returns true if this module is the main module ($this === $this->mMainModule),
545 public function isMain() {
546 return $this === $this->mMainModule
;
550 * Get the parent of this module
552 * @return ApiBase|null
554 public function getParent() {
555 return $this->isMain() ?
null : $this->getMain();
559 * Returns true if the current request breaks the same-origin policy.
561 * For example, json with callbacks.
563 * https://en.wikipedia.org/wiki/Same-origin_policy
568 public function lacksSameOriginSecurity() {
569 // Main module has this method overridden
570 // Safety - avoid infinite loop:
571 if ( $this->isMain() ) {
572 self
::dieDebug( __METHOD__
, 'base method was called on main module.' );
575 return $this->getMain()->lacksSameOriginSecurity();
579 * Get the path to this module
584 public function getModulePath() {
585 if ( $this->isMain() ) {
587 } elseif ( $this->getParent()->isMain() ) {
588 return $this->getModuleName();
590 return $this->getParent()->getModulePath() . '+' . $this->getModuleName();
595 * Get a module from its module path
598 * @param string $path
599 * @return ApiBase|null
600 * @throws ApiUsageException
602 public function getModuleFromPath( $path ) {
603 $module = $this->getMain();
604 if ( $path === 'main' ) {
608 $parts = explode( '+', $path );
609 if ( count( $parts ) === 1 ) {
610 // In case the '+' was typed into URL, it resolves as a space
611 $parts = explode( ' ', $path );
614 $count = count( $parts );
615 for ( $i = 0; $i < $count; $i++
) {
617 $manager = $parent->getModuleManager();
618 if ( $manager === null ) {
619 $errorPath = implode( '+', array_slice( $parts, 0, $i ) );
620 $this->dieWithError( [ 'apierror-badmodule-nosubmodules', $errorPath ], 'badmodule' );
622 $module = $manager->getModule( $parts[$i] );
624 if ( $module === null ) {
625 $errorPath = $i ?
implode( '+', array_slice( $parts, 0, $i ) ) : $parent->getModuleName();
627 [ 'apierror-badmodule-badsubmodule', $errorPath, wfEscapeWikiText( $parts[$i] ) ],
637 * Get the result object
640 public function getResult() {
641 // Main module has getResult() method overridden
642 // Safety - avoid infinite loop:
643 if ( $this->isMain() ) {
644 self
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
647 return $this->getMain()->getResult();
651 * Get the error formatter
652 * @return ApiErrorFormatter
654 public function getErrorFormatter() {
655 // Main module has getErrorFormatter() method overridden
656 // Safety - avoid infinite loop:
657 if ( $this->isMain() ) {
658 self
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
661 return $this->getMain()->getErrorFormatter();
665 * Gets a default replica DB connection object
668 protected function getDB() {
669 if ( !isset( $this->mReplicaDB
) ) {
670 $this->mReplicaDB
= wfGetDB( DB_REPLICA
, 'api' );
673 return $this->mReplicaDB
;
677 * Get the continuation manager
678 * @return ApiContinuationManager|null
680 public function getContinuationManager() {
681 // Main module has getContinuationManager() method overridden
682 // Safety - avoid infinite loop:
683 if ( $this->isMain() ) {
684 self
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
687 return $this->getMain()->getContinuationManager();
691 * Set the continuation manager
692 * @param ApiContinuationManager|null $manager
694 public function setContinuationManager( ApiContinuationManager
$manager = null ) {
695 // Main module has setContinuationManager() method overridden
696 // Safety - avoid infinite loop:
697 if ( $this->isMain() ) {
698 self
::dieDebug( __METHOD__
, 'base method was called on main module. ' );
701 $this->getMain()->setContinuationManager( $manager );
705 * Obtain a PermissionManager instance that subclasses may use in their authorization checks.
708 * @return PermissionManager
710 protected function getPermissionManager(): PermissionManager
{
711 return MediaWikiServices
::getInstance()->getPermissionManager();
716 /************************************************************************//**
717 * @name Parameter handling
722 * Indicate if the module supports dynamically-determined parameters that
723 * cannot be included in self::getAllowedParams().
724 * @return string|array|Message|null Return null if the module does not
725 * support additional dynamic parameters, otherwise return a message
728 public function dynamicParameterDocumentation() {
733 * This method mangles parameter name based on the prefix supplied to the constructor.
734 * Override this method to change parameter name during runtime
735 * @param string|string[] $paramName Parameter name
736 * @return string|string[] Prefixed parameter name
737 * @since 1.29 accepts an array of strings
739 public function encodeParamName( $paramName ) {
740 if ( is_array( $paramName ) ) {
741 return array_map( function ( $name ) {
742 return $this->mModulePrefix
. $name;
745 return $this->mModulePrefix
. $paramName;
750 * Using getAllowedParams(), this function makes an array of the values
751 * provided by the user, with key being the name of the variable, and
752 * value - validated value from user or default. limits will not be
753 * parsed if $parseLimit is set to false; use this when the max
754 * limit is not definitive yet, e.g. when getting revisions.
755 * @param bool|array $options If a boolean, uses that as the value for 'parseLimit'
756 * - parseLimit: (bool, default true) Whether to parse the 'max' value for limit types
757 * - safeMode: (bool, default false) If true, avoid throwing for parameter validation errors.
758 * Returned parameter values might be ApiUsageException instances.
761 public function extractRequestParams( $options = [] ) {
762 if ( is_bool( $options ) ) {
763 $options = [ 'parseLimit' => $options ];
766 'parseLimit' => true,
770 $parseLimit = (bool)$options['parseLimit'];
772 // Cache parameters, for performance and to avoid T26564.
773 if ( !isset( $this->mParamCache
[$parseLimit] ) ) {
774 $params = $this->getFinalParams() ?
: [];
778 // Process all non-templates and save templates for secondary
781 foreach ( $params as $paramName => $paramSettings ) {
782 if ( isset( $paramSettings[self
::PARAM_TEMPLATE_VARS
] ) ) {
783 $toProcess[] = [ $paramName, $paramSettings[self
::PARAM_TEMPLATE_VARS
], $paramSettings ];
786 $results[$paramName] = $this->getParameterFromSettings(
787 $paramName, $paramSettings, $parseLimit
789 } catch ( ApiUsageException
$ex ) {
790 $results[$paramName] = $ex;
795 // Now process all the templates by successively replacing the
796 // placeholders with all client-supplied values.
797 // This bit duplicates JavaScript logic in
798 // ApiSandbox.PageLayout.prototype.updateTemplatedParams().
799 // If you update this, see if that needs updating too.
800 while ( $toProcess ) {
801 list( $name, $targets, $settings ) = array_shift( $toProcess );
803 foreach ( $targets as $placeholder => $target ) {
804 if ( !array_key_exists( $target, $results ) ) {
805 // The target wasn't processed yet, try the next one.
806 // If all hit this case, the parameter has no expansions.
809 if ( !is_array( $results[$target] ) ||
!$results[$target] ) {
810 // The target was processed but has no (valid) values.
811 // That means it has no expansions.
815 // Expand this target in the name and all other targets,
816 // then requeue if there are more targets left or put in
817 // $results if all are done.
818 unset( $targets[$placeholder] );
819 $placeholder = '{' . $placeholder . '}';
820 // @phan-suppress-next-line PhanTypeNoAccessiblePropertiesForeach
821 foreach ( $results[$target] as $value ) {
822 if ( !preg_match( '/^[^{}]*$/', $value ) ) {
823 // Skip values that make invalid parameter names.
824 $encTargetName = $this->encodeParamName( $target );
825 if ( !isset( $warned[$encTargetName][$value] ) ) {
826 $warned[$encTargetName][$value] = true;
828 'apiwarn-ignoring-invalid-templated-value',
829 wfEscapeWikiText( $encTargetName ),
830 wfEscapeWikiText( $value ),
836 $newName = str_replace( $placeholder, $value, $name );
839 $results[$newName] = $this->getParameterFromSettings( $newName, $settings, $parseLimit );
840 } catch ( ApiUsageException
$ex ) {
841 $results[$newName] = $ex;
845 foreach ( $targets as $k => $v ) {
846 $newTargets[$k] = str_replace( $placeholder, $value, $v );
848 $toProcess[] = [ $newName, $newTargets, $settings ];
855 $this->mParamCache
[$parseLimit] = $results;
858 $ret = $this->mParamCache
[$parseLimit];
859 if ( !$options['safeMode'] ) {
860 foreach ( $ret as $v ) {
861 if ( $v instanceof ApiUsageException
) {
867 return $this->mParamCache
[$parseLimit];
871 * Get a value for the given parameter
872 * @param string $paramName Parameter name
873 * @param bool $parseLimit See extractRequestParams()
874 * @return mixed Parameter value
876 protected function getParameter( $paramName, $parseLimit = true ) {
877 $ret = $this->extractRequestParams( [
878 'parseLimit' => $parseLimit,
881 if ( $ret instanceof ApiUsageException
) {
888 * Die if none or more than one of a certain set of parameters is set and not false.
890 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
891 * @param string $required,... Names of parameters of which exactly one must be set
893 public function requireOnlyOneParameter( $params, $required /*...*/ ) {
894 $required = func_get_args();
895 array_shift( $required );
897 $intersection = array_intersect( array_keys( array_filter( $params,
898 [ $this, 'parameterNotEmpty' ] ) ), $required );
900 if ( count( $intersection ) > 1 ) {
901 $this->dieWithError( [
902 'apierror-invalidparammix',
903 Message
::listParam( array_map(
905 return '<var>' . $this->encodeParamName( $p ) . '</var>';
907 array_values( $intersection )
909 count( $intersection ),
911 } elseif ( count( $intersection ) == 0 ) {
912 $this->dieWithError( [
913 'apierror-missingparam-one-of',
914 Message
::listParam( array_map(
916 return '<var>' . $this->encodeParamName( $p ) . '</var>';
918 array_values( $required )
926 * Die if more than one of a certain set of parameters is set and not false.
928 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
929 * @param string $required,... Names of parameters of which at most one must be set
931 public function requireMaxOneParameter( $params, $required /*...*/ ) {
932 $required = func_get_args();
933 array_shift( $required );
935 $intersection = array_intersect( array_keys( array_filter( $params,
936 [ $this, 'parameterNotEmpty' ] ) ), $required );
938 if ( count( $intersection ) > 1 ) {
939 $this->dieWithError( [
940 'apierror-invalidparammix',
941 Message
::listParam( array_map(
943 return '<var>' . $this->encodeParamName( $p ) . '</var>';
945 array_values( $intersection )
947 count( $intersection ),
953 * Die if none of a certain set of parameters is set and not false.
956 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
957 * @param string $required,... Names of parameters of which at least one must be set
959 public function requireAtLeastOneParameter( $params, $required /*...*/ ) {
960 $required = func_get_args();
961 array_shift( $required );
963 $intersection = array_intersect(
964 array_keys( array_filter( $params, [ $this, 'parameterNotEmpty' ] ) ),
968 if ( count( $intersection ) == 0 ) {
969 $this->dieWithError( [
970 'apierror-missingparam-at-least-one-of',
971 Message
::listParam( array_map(
973 return '<var>' . $this->encodeParamName( $p ) . '</var>';
975 array_values( $required )
983 * Die if any of the specified parameters were found in the query part of
984 * the URL rather than the post body.
986 * @param string[] $params Parameters to check
987 * @param string $prefix Set to 'noprefix' to skip calling $this->encodeParamName()
989 public function requirePostedParameters( $params, $prefix = 'prefix' ) {
990 // Skip if $wgDebugAPI is set or we're in internal mode
991 if ( $this->getConfig()->get( 'DebugAPI' ) ||
$this->getMain()->isInternalMode() ) {
995 $queryValues = $this->getRequest()->getQueryValues();
997 foreach ( $params as $param ) {
998 if ( $prefix !== 'noprefix' ) {
999 $param = $this->encodeParamName( $param );
1001 if ( array_key_exists( $param, $queryValues ) ) {
1002 $badParams[] = $param;
1007 $this->dieWithError(
1008 [ 'apierror-mustpostparams', implode( ', ', $badParams ), count( $badParams ) ]
1014 * Callback function used in requireOnlyOneParameter to check whether required parameters are set
1016 * @param object $x Parameter to check is not null/false
1019 private function parameterNotEmpty( $x ) {
1020 return !is_null( $x ) && $x !== false;
1024 * Get a WikiPage object from a title or pageid param, if possible.
1025 * Can die, if no param is set or if the title or page id is not valid.
1027 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
1028 * @param bool|string $load Whether load the object's state from the database:
1029 * - false: don't load (if the pageid is given, it will still be loaded)
1030 * - 'fromdb': load from a replica DB
1031 * - 'fromdbmaster': load from the master database
1034 public function getTitleOrPageId( $params, $load = false ) {
1035 $this->requireOnlyOneParameter( $params, 'title', 'pageid' );
1038 if ( isset( $params['title'] ) ) {
1039 $titleObj = Title
::newFromText( $params['title'] );
1040 if ( !$titleObj ||
$titleObj->isExternal() ) {
1041 $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['title'] ) ] );
1043 if ( !$titleObj->canExist() ) {
1044 $this->dieWithError( 'apierror-pagecannotexist' );
1046 $pageObj = WikiPage
::factory( $titleObj );
1047 if ( $load !== false ) {
1048 $pageObj->loadPageData( $load );
1050 } elseif ( isset( $params['pageid'] ) ) {
1051 if ( $load === false ) {
1054 $pageObj = WikiPage
::newFromID( $params['pageid'], $load );
1056 $this->dieWithError( [ 'apierror-nosuchpageid', $params['pageid'] ] );
1064 * Get a Title object from a title or pageid param, if possible.
1065 * Can die, if no param is set or if the title or page id is not valid.
1068 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
1071 public function getTitleFromTitleOrPageId( $params ) {
1072 $this->requireOnlyOneParameter( $params, 'title', 'pageid' );
1075 if ( isset( $params['title'] ) ) {
1076 $titleObj = Title
::newFromText( $params['title'] );
1077 if ( !$titleObj ||
$titleObj->isExternal() ) {
1078 $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['title'] ) ] );
1081 } elseif ( isset( $params['pageid'] ) ) {
1082 $titleObj = Title
::newFromID( $params['pageid'] );
1084 $this->dieWithError( [ 'apierror-nosuchpageid', $params['pageid'] ] );
1092 * Return true if we're to watch the page, false if not, null if no change.
1093 * @param string $watchlist Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
1094 * @param Title $titleObj The page under consideration
1095 * @param string|null $userOption The user option to consider when $watchlist=preferences.
1096 * If not set will use watchdefault always and watchcreations if $titleObj doesn't exist.
1099 protected function getWatchlistValue( $watchlist, $titleObj, $userOption = null ) {
1100 $userWatching = $this->getUser()->isWatched( $titleObj, User
::IGNORE_USER_RIGHTS
);
1102 switch ( $watchlist ) {
1110 # If the user is already watching, don't bother checking
1111 if ( $userWatching ) {
1114 # If no user option was passed, use watchdefault and watchcreations
1115 if ( is_null( $userOption ) ) {
1116 return $this->getUser()->getBoolOption( 'watchdefault' ) ||
1117 $this->getUser()->getBoolOption( 'watchcreations' ) && !$titleObj->exists();
1120 # Watch the article based on the user preference
1121 return $this->getUser()->getBoolOption( $userOption );
1124 return $userWatching;
1127 return $userWatching;
1132 * Using the settings determine the value for the given parameter
1134 * @param string $paramName Parameter name
1135 * @param array|mixed $paramSettings Default value or an array of settings
1136 * using PARAM_* constants.
1137 * @param bool $parseLimit Whether to parse and validate 'limit' parameters
1138 * @return mixed Parameter value
1140 protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
1141 // Some classes may decide to change parameter names
1142 $encParamName = $this->encodeParamName( $paramName );
1145 if ( !is_array( $paramSettings ) ) {
1147 self
::PARAM_DFLT
=> $paramSettings,
1151 $default = $paramSettings[self
::PARAM_DFLT
] ??
null;
1152 $multi = $paramSettings[self
::PARAM_ISMULTI
] ??
false;
1153 $multiLimit1 = $paramSettings[self
::PARAM_ISMULTI_LIMIT1
] ??
null;
1154 $multiLimit2 = $paramSettings[self
::PARAM_ISMULTI_LIMIT2
] ??
null;
1155 $type = $paramSettings[self
::PARAM_TYPE
] ??
null;
1156 $dupes = $paramSettings[self
::PARAM_ALLOW_DUPLICATES
] ??
false;
1157 $deprecated = $paramSettings[self
::PARAM_DEPRECATED
] ??
false;
1158 $deprecatedValues = $paramSettings[self
::PARAM_DEPRECATED_VALUES
] ??
[];
1159 $required = $paramSettings[self
::PARAM_REQUIRED
] ??
false;
1160 $allowAll = $paramSettings[self
::PARAM_ALL
] ??
false;
1162 // When type is not given, and no choices, the type is the same as $default
1163 if ( !isset( $type ) ) {
1164 if ( isset( $default ) ) {
1165 $type = gettype( $default );
1167 $type = 'NULL'; // allow everything
1171 if ( $type == 'password' ||
!empty( $paramSettings[self
::PARAM_SENSITIVE
] ) ) {
1172 $this->getMain()->markParamsSensitive( $encParamName );
1175 if ( $type == 'boolean' ) {
1176 if ( isset( $default ) && $default !== false ) {
1177 // Having a default value of anything other than 'false' is not allowed
1180 "Boolean param $encParamName's default is set to '$default'. " .
1181 'Boolean parameters must default to false.'
1185 $value = $this->getMain()->getCheck( $encParamName );
1187 } elseif ( $type == 'upload' ) {
1188 if ( isset( $default ) ) {
1189 // Having a default value is not allowed
1192 "File upload param $encParamName's default is set to " .
1193 "'$default'. File upload parameters may not have a default." );
1196 self
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
1198 $value = $this->getMain()->getUpload( $encParamName );
1199 $provided = $value->exists();
1200 if ( !$value->exists() ) {
1201 // This will get the value without trying to normalize it
1202 // (because trying to normalize a large binary file
1203 // accidentally uploaded as a field fails spectacularly)
1204 $value = $this->getMain()->getRequest()->unsetVal( $encParamName );
1205 if ( $value !== null ) {
1206 $this->dieWithError(
1207 [ 'apierror-badupload', $encParamName ],
1208 "badupload_{$encParamName}"
1213 $value = $this->getMain()->getVal( $encParamName, $default );
1214 $provided = $this->getMain()->getCheck( $encParamName );
1216 if ( isset( $value ) && $type == 'namespace' ) {
1217 $type = MediaWikiServices
::getInstance()->getNamespaceInfo()->
1218 getValidNamespaces();
1219 if ( isset( $paramSettings[self
::PARAM_EXTRA_NAMESPACES
] ) &&
1220 is_array( $paramSettings[self
::PARAM_EXTRA_NAMESPACES
] )
1222 $type = array_merge( $type, $paramSettings[self
::PARAM_EXTRA_NAMESPACES
] );
1224 // Namespace parameters allow ALL_DEFAULT_STRING to be used to
1225 // specify all namespaces irrespective of PARAM_ALL.
1228 if ( isset( $value ) && $type == 'submodule' ) {
1229 if ( isset( $paramSettings[self
::PARAM_SUBMODULE_MAP
] ) ) {
1230 $type = array_keys( $paramSettings[self
::PARAM_SUBMODULE_MAP
] );
1232 $type = $this->getModuleManager()->getNames( $paramName );
1236 $request = $this->getMain()->getRequest();
1237 $rawValue = $request->getRawVal( $encParamName );
1238 if ( $rawValue === null ) {
1239 $rawValue = $default;
1242 // Preserve U+001F for self::parseMultiValue(), or error out if that won't be called
1243 if ( isset( $value ) && substr( $rawValue, 0, 1 ) === "\x1f" ) {
1245 // This loses the potential checkTitleEncoding() transformation done by
1246 // WebRequest for $_GET. Let's call that a feature.
1247 $value = implode( "\x1f", $request->normalizeUnicode( explode( "\x1f", $rawValue ) ) );
1249 $this->dieWithError( 'apierror-badvalue-notmultivalue', 'badvalue_notmultivalue' );
1253 // Check for NFC normalization, and warn
1254 if ( $rawValue !== $value ) {
1255 $this->handleParamNormalization( $paramName, $value, $rawValue );
1259 $allSpecifier = ( is_string( $allowAll ) ?
$allowAll : self
::ALL_DEFAULT_STRING
);
1260 if ( $allowAll && $multi && is_array( $type ) && in_array( $allSpecifier, $type, true ) ) {
1263 "For param $encParamName, PARAM_ALL collides with a possible value" );
1265 if ( isset( $value ) && ( $multi ||
is_array( $type ) ) ) {
1266 $value = $this->parseMultiValue(
1270 is_array( $type ) ?
$type : null,
1271 $allowAll ?
$allSpecifier : null,
1277 if ( isset( $value ) ) {
1278 // More validation only when choices were not given
1279 // choices were validated in parseMultiValue()
1280 if ( !is_array( $type ) ) {
1282 case 'NULL': // nothing to do
1287 if ( $required && $value === '' ) {
1288 $this->dieWithError( [ 'apierror-missingparam', $encParamName ] );
1291 case 'integer': // Force everything using intval() and optionally validate limits
1292 $min = $paramSettings[self
::PARAM_MIN
] ??
null;
1293 $max = $paramSettings[self
::PARAM_MAX
] ??
null;
1294 $enforceLimits = $paramSettings[self
::PARAM_RANGE_ENFORCE
] ??
false;
1296 if ( is_array( $value ) ) {
1297 $value = array_map( 'intval', $value );
1298 if ( !is_null( $min ) ||
!is_null( $max ) ) {
1299 foreach ( $value as &$v ) {
1300 $this->validateLimit( $paramName, $v, $min, $max, null, $enforceLimits );
1304 $value = (int)$value;
1305 if ( !is_null( $min ) ||
!is_null( $max ) ) {
1306 $this->validateLimit( $paramName, $value, $min, $max, null, $enforceLimits );
1311 if ( !$parseLimit ) {
1312 // Don't do any validation whatsoever
1315 if ( !isset( $paramSettings[self
::PARAM_MAX
] )
1316 ||
!isset( $paramSettings[self
::PARAM_MAX2
] )
1320 "MAX1 or MAX2 are not defined for the limit $encParamName"
1324 self
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
1326 $min = $paramSettings[self
::PARAM_MIN
] ??
0;
1327 if ( $value == 'max' ) {
1328 $value = $this->getMain()->canApiHighLimits()
1329 ?
$paramSettings[self
::PARAM_MAX2
]
1330 : $paramSettings[self
::PARAM_MAX
];
1331 $this->getResult()->addParsedLimit( $this->getModuleName(), $value );
1333 $value = (int)$value;
1334 $this->validateLimit(
1338 $paramSettings[self
::PARAM_MAX
],
1339 $paramSettings[self
::PARAM_MAX2
]
1345 self
::dieDebug( __METHOD__
, "Multi-values not supported for $encParamName" );
1349 if ( is_array( $value ) ) {
1350 foreach ( $value as $key => $val ) {
1351 $value[$key] = $this->validateTimestamp( $val, $encParamName );
1354 $value = $this->validateTimestamp( $value, $encParamName );
1358 if ( is_array( $value ) ) {
1359 foreach ( $value as $key => $val ) {
1360 $value[$key] = $this->validateUser( $val, $encParamName );
1363 $value = $this->validateUser( $value, $encParamName );
1366 case 'upload': // nothing to do
1369 // If change tagging was requested, check that the tags are valid.
1370 if ( !is_array( $value ) && !$multi ) {
1371 $value = [ $value ];
1373 $tagsStatus = ChangeTags
::canAddTagsAccompanyingChange( $value );
1374 if ( !$tagsStatus->isGood() ) {
1375 $this->dieStatus( $tagsStatus );
1379 self
::dieDebug( __METHOD__
, "Param $encParamName's type is unknown - $type" );
1383 // Throw out duplicates if requested
1384 if ( !$dupes && is_array( $value ) ) {
1385 $value = array_unique( $value );
1388 if ( in_array( $type, [ 'NULL', 'string', 'text', 'password' ], true ) ) {
1389 foreach ( (array)$value as $val ) {
1390 if ( isset( $paramSettings[self
::PARAM_MAX_BYTES
] )
1391 && strlen( $val ) > $paramSettings[self
::PARAM_MAX_BYTES
]
1393 $this->dieWithError( [ 'apierror-maxbytes', $encParamName,
1394 $paramSettings[self
::PARAM_MAX_BYTES
] ] );
1396 if ( isset( $paramSettings[self
::PARAM_MAX_CHARS
] )
1397 && mb_strlen( $val, 'UTF-8' ) > $paramSettings[self
::PARAM_MAX_CHARS
]
1399 $this->dieWithError( [ 'apierror-maxchars', $encParamName,
1400 $paramSettings[self
::PARAM_MAX_CHARS
] ] );
1405 // Set a warning if a deprecated parameter has been passed
1406 if ( $deprecated && $provided ) {
1407 $feature = $encParamName;
1409 while ( !$m->isMain() ) {
1410 $p = $m->getParent();
1411 $name = $m->getModuleName();
1412 $param = $p->encodeParamName( $p->getModuleManager()->getModuleGroup( $name ) );
1413 $feature = "{$param}={$name}&{$feature}";
1416 $this->addDeprecation( [ 'apiwarn-deprecation-parameter', $encParamName ], $feature );
1419 // Set a warning if a deprecated parameter value has been passed
1420 $usedDeprecatedValues = $deprecatedValues && $provided
1421 ?
array_intersect( array_keys( $deprecatedValues ), (array)$value )
1423 if ( $usedDeprecatedValues ) {
1424 $feature = "$encParamName=";
1426 while ( !$m->isMain() ) {
1427 $p = $m->getParent();
1428 $name = $m->getModuleName();
1429 $param = $p->encodeParamName( $p->getModuleManager()->getModuleGroup( $name ) );
1430 $feature = "{$param}={$name}&{$feature}";
1433 foreach ( $usedDeprecatedValues as $v ) {
1434 $msg = $deprecatedValues[$v];
1435 if ( $msg === true ) {
1436 $msg = [ 'apiwarn-deprecation-parameter', "$encParamName=$v" ];
1438 $this->addDeprecation( $msg, "$feature$v" );
1441 } elseif ( $required ) {
1442 $this->dieWithError( [ 'apierror-missingparam', $encParamName ] );
1449 * Handle when a parameter was Unicode-normalized
1451 * @param string $paramName Unprefixed parameter name
1452 * @param string $value Input that will be used.
1453 * @param string $rawValue Input before normalization.
1455 protected function handleParamNormalization( $paramName, $value, $rawValue ) {
1456 $encParamName = $this->encodeParamName( $paramName );
1457 $this->addWarning( [ 'apiwarn-badutf8', $encParamName ] );
1461 * Split a multi-valued parameter string, like explode()
1463 * @param string $value
1467 protected function explodeMultiValue( $value, $limit ) {
1468 if ( substr( $value, 0, 1 ) === "\x1f" ) {
1470 $value = substr( $value, 1 );
1475 return explode( $sep, $value, $limit );
1479 * Return an array of values that were given in a 'a|b|c' notation,
1480 * after it optionally validates them against the list allowed values.
1482 * @param string $valueName The name of the parameter (for error
1484 * @param mixed $value The value being parsed
1485 * @param bool $allowMultiple Can $value contain more than one value
1487 * @param string[]|null $allowedValues An array of values to check against. If
1488 * null, all values are accepted.
1489 * @param string|null $allSpecifier String to use to specify all allowed values, or null
1490 * if this behavior should not be allowed
1491 * @param int|null $limit1 Maximum number of values, for normal users.
1492 * @param int|null $limit2 Maximum number of values, for users with the apihighlimits right.
1493 * @return string|string[] (allowMultiple ? an_array_of_values : a_single_value)
1495 protected function parseMultiValue( $valueName, $value, $allowMultiple, $allowedValues,
1496 $allSpecifier = null, $limit1 = null, $limit2 = null
1498 if ( ( $value === '' ||
$value === "\x1f" ) && $allowMultiple ) {
1501 $limit1 = $limit1 ?
: self
::LIMIT_SML1
;
1502 $limit2 = $limit2 ?
: self
::LIMIT_SML2
;
1504 // This is a bit awkward, but we want to avoid calling canApiHighLimits()
1505 // because it unstubs $wgUser
1506 $valuesList = $this->explodeMultiValue( $value, $limit2 +
1 );
1507 $sizeLimit = count( $valuesList ) > $limit1 && $this->mMainModule
->canApiHighLimits()
1511 if ( $allowMultiple && is_array( $allowedValues ) && $allSpecifier &&
1512 count( $valuesList ) === 1 && $valuesList[0] === $allSpecifier
1514 return $allowedValues;
1517 if ( count( $valuesList ) > $sizeLimit ) {
1518 $this->dieWithError(
1519 [ 'apierror-toomanyvalues', $valueName, $sizeLimit ],
1520 "too-many-$valueName"
1524 if ( !$allowMultiple && count( $valuesList ) != 1 ) {
1525 // T35482 - Allow entries with | in them for non-multiple values
1526 if ( in_array( $value, $allowedValues, true ) ) {
1530 $values = array_map( function ( $v ) {
1531 return '<kbd>' . wfEscapeWikiText( $v ) . '</kbd>';
1532 }, $allowedValues );
1533 $this->dieWithError( [
1534 'apierror-multival-only-one-of',
1536 Message
::listParam( $values ),
1538 ], "multival_$valueName" );
1541 if ( is_array( $allowedValues ) ) {
1542 // Check for unknown values
1543 $unknown = array_map( 'wfEscapeWikiText', array_diff( $valuesList, $allowedValues ) );
1544 if ( count( $unknown ) ) {
1545 if ( $allowMultiple ) {
1546 $this->addWarning( [
1547 'apiwarn-unrecognizedvalues',
1549 Message
::listParam( $unknown, 'comma' ),
1553 $this->dieWithError(
1554 [ 'apierror-unrecognizedvalue', $valueName, wfEscapeWikiText( $valuesList[0] ) ],
1555 "unknown_$valueName"
1559 // Now throw them out
1560 $valuesList = array_intersect( $valuesList, $allowedValues );
1563 return $allowMultiple ?
$valuesList : $valuesList[0];
1567 * Validate the value against the minimum and user/bot maximum limits.
1568 * Prints usage info on failure.
1569 * @param string $paramName Parameter name
1570 * @param int &$value Parameter value
1571 * @param int|null $min Minimum value
1572 * @param int|null $max Maximum value for users
1573 * @param int|null $botMax Maximum value for sysops/bots
1574 * @param bool $enforceLimits Whether to enforce (die) if value is outside limits
1576 protected function validateLimit( $paramName, &$value, $min, $max, $botMax = null,
1577 $enforceLimits = false
1579 if ( !is_null( $min ) && $value < $min ) {
1580 $msg = ApiMessage
::create(
1581 [ 'apierror-integeroutofrange-belowminimum',
1582 $this->encodeParamName( $paramName ), $min, $value ],
1583 'integeroutofrange',
1584 [ 'min' => $min, 'max' => $max, 'botMax' => $botMax ?
: $max ]
1586 $this->warnOrDie( $msg, $enforceLimits );
1590 // Minimum is always validated, whereas maximum is checked only if not
1591 // running in internal call mode
1592 if ( $this->getMain()->isInternalMode() ) {
1596 // Optimization: do not check user's bot status unless really needed -- skips db query
1597 // assumes $botMax >= $max
1598 if ( !is_null( $max ) && $value > $max ) {
1599 if ( !is_null( $botMax ) && $this->getMain()->canApiHighLimits() ) {
1600 if ( $value > $botMax ) {
1601 $msg = ApiMessage
::create(
1602 [ 'apierror-integeroutofrange-abovebotmax',
1603 $this->encodeParamName( $paramName ), $botMax, $value ],
1604 'integeroutofrange',
1605 [ 'min' => $min, 'max' => $max, 'botMax' => $botMax ?
: $max ]
1607 $this->warnOrDie( $msg, $enforceLimits );
1611 $msg = ApiMessage
::create(
1612 [ 'apierror-integeroutofrange-abovemax',
1613 $this->encodeParamName( $paramName ), $max, $value ],
1614 'integeroutofrange',
1615 [ 'min' => $min, 'max' => $max, 'botMax' => $botMax ?
: $max ]
1617 $this->warnOrDie( $msg, $enforceLimits );
1624 * Validate and normalize parameters of type 'timestamp'
1625 * @param string $value Parameter value
1626 * @param string $encParamName Parameter name
1627 * @return string Validated and normalized parameter
1629 protected function validateTimestamp( $value, $encParamName ) {
1630 // Confusing synonyms for the current time accepted by wfTimestamp()
1631 // (wfTimestamp() also accepts various non-strings and the string of 14
1632 // ASCII NUL bytes, but those can't get here)
1634 $this->addDeprecation(
1635 [ 'apiwarn-unclearnowtimestamp', $encParamName, wfEscapeWikiText( $value ) ],
1636 'unclear-"now"-timestamp'
1638 return wfTimestamp( TS_MW
);
1641 // Explicit synonym for the current time
1642 if ( $value === 'now' ) {
1643 return wfTimestamp( TS_MW
);
1646 $timestamp = wfTimestamp( TS_MW
, $value );
1647 if ( $timestamp === false ) {
1648 $this->dieWithError(
1649 [ 'apierror-badtimestamp', $encParamName, wfEscapeWikiText( $value ) ],
1650 "badtimestamp_{$encParamName}"
1658 * Validate the supplied token.
1661 * @param string $token Supplied token
1662 * @param array $params All supplied parameters for the module
1664 * @throws MWException
1666 final public function validateToken( $token, array $params ) {
1667 $tokenType = $this->needsToken();
1668 $salts = ApiQueryTokens
::getTokenTypeSalts();
1669 if ( !isset( $salts[$tokenType] ) ) {
1670 throw new MWException(
1671 "Module '{$this->getModuleName()}' tried to use token type '$tokenType' " .
1672 'without registering it'
1676 $tokenObj = ApiQueryTokens
::getToken(
1677 $this->getUser(), $this->getRequest()->getSession(), $salts[$tokenType]
1679 if ( $tokenObj->match( $token ) ) {
1683 $webUiSalt = $this->getWebUITokenSalt( $params );
1684 if ( $webUiSalt !== null && $this->getUser()->matchEditToken(
1696 * Validate and normalize parameters of type 'user'
1697 * @param string $value Parameter value
1698 * @param string $encParamName Parameter name
1699 * @return string Validated and normalized parameter
1701 private function validateUser( $value, $encParamName ) {
1702 if ( ExternalUserNames
::isExternal( $value ) && User
::newFromName( $value, false ) ) {
1706 $name = User
::getCanonicalName( $value, 'valid' );
1707 if ( $name !== false ) {
1712 // We allow ranges as well, for blocks.
1713 IP
::isIPAddress( $value ) ||
1714 // See comment for User::isIP. We don't just call that function
1715 // here because it also returns true for things like
1716 // 300.300.300.300 that are neither valid usernames nor valid IP
1719 '/^' . RE_IP_BYTE
. '\.' . RE_IP_BYTE
. '\.' . RE_IP_BYTE
. '\.xxx$/',
1723 return IP
::sanitizeIP( $value );
1726 $this->dieWithError(
1727 [ 'apierror-baduser', $encParamName, wfEscapeWikiText( $value ) ],
1728 "baduser_{$encParamName}"
1734 /************************************************************************//**
1735 * @name Utility methods
1740 * Set a watch (or unwatch) based the based on a watchlist parameter.
1741 * @param string $watch Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
1742 * @param Title $titleObj The article's title to change
1743 * @param string|null $userOption The user option to consider when $watch=preferences
1745 protected function setWatch( $watch, $titleObj, $userOption = null ) {
1746 $value = $this->getWatchlistValue( $watch, $titleObj, $userOption );
1747 if ( $value === null ) {
1751 WatchAction
::doWatchOrUnwatch( $value, $titleObj, $this->getUser() );
1755 * Gets the user for whom to get the watchlist
1757 * @param array $params
1760 public function getWatchlistUser( $params ) {
1761 if ( !is_null( $params['owner'] ) && !is_null( $params['token'] ) ) {
1762 $user = User
::newFromName( $params['owner'], false );
1763 if ( !( $user && $user->getId() ) ) {
1764 $this->dieWithError(
1765 [ 'nosuchusershort', wfEscapeWikiText( $params['owner'] ) ], 'bad_wlowner'
1768 $token = $user->getOption( 'watchlisttoken' );
1769 if ( $token == '' ||
!hash_equals( $token, $params['token'] ) ) {
1770 $this->dieWithError( 'apierror-bad-watchlist-token', 'bad_wltoken' );
1773 if ( !$this->getUser()->isLoggedIn() ) {
1774 $this->dieWithError( 'watchlistanontext', 'notloggedin' );
1776 $this->checkUserRightsAny( 'viewmywatchlist' );
1777 $user = $this->getUser();
1784 * Create a Message from a string or array
1786 * A string is used as a message key. An array has the message key as the
1787 * first value and message parameters as subsequent values.
1790 * @param string|array|Message $msg
1791 * @param IContextSource $context
1792 * @param array|null $params
1793 * @return Message|null
1795 public static function makeMessage( $msg, IContextSource
$context, array $params = null ) {
1796 if ( is_string( $msg ) ) {
1797 $msg = wfMessage( $msg );
1798 } elseif ( is_array( $msg ) ) {
1799 $msg = wfMessage( ...$msg );
1801 if ( !$msg instanceof Message
) {
1805 $msg->setContext( $context );
1807 $msg->params( $params );
1814 * Turn an array of message keys or key+param arrays into a Status
1816 * @param array $errors
1817 * @param User|null $user
1820 public function errorArrayToStatus( array $errors, User
$user = null ) {
1821 if ( $user === null ) {
1822 $user = $this->getUser();
1825 $status = Status
::newGood();
1826 foreach ( $errors as $error ) {
1827 if ( !is_array( $error ) ) {
1828 $error = [ $error ];
1830 if ( is_string( $error[0] ) && isset( self
::$blockMsgMap[$error[0]] ) && $user->getBlock() ) {
1831 list( $msg, $code ) = self
::$blockMsgMap[$error[0]];
1832 $status->fatal( ApiMessage
::create( $msg, $code,
1833 [ 'blockinfo' => $this->getBlockDetails( $user->getBlock() ) ]
1836 $status->fatal( ...$error );
1843 * Add block info to block messages in a Status
1845 * @param StatusValue $status
1846 * @param User|null $user
1848 public function addBlockInfoToStatus( StatusValue
$status, User
$user = null ) {
1849 if ( $user === null ) {
1850 $user = $this->getUser();
1853 foreach ( self
::$blockMsgMap as $msg => list( $apiMsg, $code ) ) {
1854 if ( $status->hasMessage( $msg ) && $user->getBlock() ) {
1855 $status->replaceMessage( $msg, ApiMessage
::create( $apiMsg, $code,
1856 [ 'blockinfo' => $this->getBlockDetails( $user->getBlock() ) ]
1863 * Call wfTransactionalTimeLimit() if this request was POSTed
1866 protected function useTransactionalTimeLimit() {
1867 if ( $this->getRequest()->wasPosted() ) {
1868 wfTransactionalTimeLimit();
1873 * Filter out-of-range values from a list of positive integer IDs
1875 * @param array $fields Array of pairs of table and field to check
1876 * @param (string|int)[] $ids IDs to filter. Strings in the array are
1877 * expected to be stringified ints.
1878 * @return (string|int)[] Filtered IDs.
1880 protected function filterIDs( $fields, array $ids ) {
1883 foreach ( $fields as list( $table, $field ) ) {
1884 if ( isset( self
::$filterIDsCache[$table][$field] ) ) {
1885 $row = self
::$filterIDsCache[$table][$field];
1887 $row = $this->getDB()->selectRow(
1890 'min_id' => "MIN($field)",
1891 'max_id' => "MAX($field)",
1896 self
::$filterIDsCache[$table][$field] = $row;
1898 $min = min( $min, $row->min_id
);
1899 $max = max( $max, $row->max_id
);
1901 return array_filter( $ids, function ( $id ) use ( $min, $max ) {
1902 return ( is_int( $id ) && $id >= 0 ||
ctype_digit( $id ) )
1903 && $id >= $min && $id <= $max;
1909 /************************************************************************//**
1910 * @name Warning and error reporting
1915 * Add a warning for this module.
1917 * Users should monitor this section to notice any changes in API. Multiple
1918 * calls to this function will result in multiple warning messages.
1920 * If $msg is not an ApiMessage, the message code will be derived from the
1921 * message key by stripping any "apiwarn-" or "apierror-" prefix.
1924 * @param string|array|Message $msg See ApiErrorFormatter::addWarning()
1925 * @param string|null $code See ApiErrorFormatter::addWarning()
1926 * @param array|null $data See ApiErrorFormatter::addWarning()
1928 public function addWarning( $msg, $code = null, $data = null ) {
1929 $this->getErrorFormatter()->addWarning( $this->getModulePath(), $msg, $code, $data );
1933 * Add a deprecation warning for this module.
1935 * A combination of $this->addWarning() and $this->logFeatureUsage()
1938 * @param string|array|Message $msg See ApiErrorFormatter::addWarning()
1939 * @param string|null $feature See ApiBase::logFeatureUsage()
1940 * @param array|null $data See ApiErrorFormatter::addWarning()
1942 public function addDeprecation( $msg, $feature, $data = [] ) {
1943 $data = (array)$data;
1944 if ( $feature !== null ) {
1945 $data['feature'] = $feature;
1946 $this->logFeatureUsage( $feature );
1948 $this->addWarning( $msg, 'deprecation', $data );
1950 // No real need to deduplicate here, ApiErrorFormatter does that for
1951 // us (assuming the hook is deterministic).
1952 $msgs = [ $this->msg( 'api-usage-mailinglist-ref' ) ];
1953 Hooks
::run( 'ApiDeprecationHelp', [ &$msgs ] );
1954 if ( count( $msgs ) > 1 ) {
1955 $key = '$' . implode( ' $', range( 1, count( $msgs ) ) );
1956 $msg = ( new RawMessage( $key ) )->params( $msgs );
1958 $msg = reset( $msgs );
1960 $this->getMain()->addWarning( $msg, 'deprecation-help' );
1964 * Add an error for this module without aborting
1966 * If $msg is not an ApiMessage, the message code will be derived from the
1967 * message key by stripping any "apiwarn-" or "apierror-" prefix.
1969 * @note If you want to abort processing, use self::dieWithError() instead.
1971 * @param string|array|Message $msg See ApiErrorFormatter::addError()
1972 * @param string|null $code See ApiErrorFormatter::addError()
1973 * @param array|null $data See ApiErrorFormatter::addError()
1975 public function addError( $msg, $code = null, $data = null ) {
1976 $this->getErrorFormatter()->addError( $this->getModulePath(), $msg, $code, $data );
1980 * Add warnings and/or errors from a Status
1982 * @note If you want to abort processing, use self::dieStatus() instead.
1984 * @param StatusValue $status
1985 * @param string[] $types 'warning' and/or 'error'
1986 * @param string[] $filter Message keys to filter out (since 1.33)
1988 public function addMessagesFromStatus(
1989 StatusValue
$status, $types = [ 'warning', 'error' ], array $filter = []
1991 $this->getErrorFormatter()->addMessagesFromStatus(
1992 $this->getModulePath(), $status, $types, $filter
1997 * Abort execution with an error
1999 * If $msg is not an ApiMessage, the message code will be derived from the
2000 * message key by stripping any "apiwarn-" or "apierror-" prefix.
2003 * @param string|array|Message $msg See ApiErrorFormatter::addError()
2004 * @param string|null $code See ApiErrorFormatter::addError()
2005 * @param array|null $data See ApiErrorFormatter::addError()
2006 * @param int|null $httpCode HTTP error code to use
2007 * @throws ApiUsageException always
2009 public function dieWithError( $msg, $code = null, $data = null, $httpCode = null ) {
2010 throw ApiUsageException
::newWithMessage( $this, $msg, $code, $data, $httpCode );
2014 * Abort execution with an error derived from an exception
2017 * @param Exception|Throwable $exception See ApiErrorFormatter::getMessageFromException()
2018 * @param array $options See ApiErrorFormatter::getMessageFromException()
2019 * @throws ApiUsageException always
2021 public function dieWithException( $exception, array $options = [] ) {
2022 $this->dieWithError(
2023 $this->getErrorFormatter()->getMessageFromException( $exception, $options )
2028 * Adds a warning to the output, else dies
2030 * @param ApiMessage $msg Message to show as a warning, or error message if dying
2031 * @param bool $enforceLimits Whether this is an enforce (die)
2033 private function warnOrDie( ApiMessage
$msg, $enforceLimits = false ) {
2034 if ( $enforceLimits ) {
2035 $this->dieWithError( $msg );
2037 $this->addWarning( $msg );
2042 * Throw an ApiUsageException, which will (if uncaught) call the main module's
2043 * error handler and die with an error message including block info.
2046 * @param AbstractBlock $block The block used to generate the ApiUsageException
2047 * @throws ApiUsageException always
2049 public function dieBlocked( AbstractBlock
$block ) {
2050 // Die using the appropriate message depending on block type
2051 if ( $block->getType() == DatabaseBlock
::TYPE_AUTO
) {
2052 $this->dieWithError(
2053 'apierror-autoblocked',
2055 [ 'blockinfo' => $this->getBlockDetails( $block ) ]
2057 } elseif ( !$block->isSitewide() ) {
2058 $this->dieWithError(
2059 'apierror-blocked-partial',
2061 [ 'blockinfo' => $this->getBlockDetails( $block ) ]
2064 $this->dieWithError(
2067 [ 'blockinfo' => $this->getBlockDetails( $block ) ]
2073 * Throw an ApiUsageException based on the Status object.
2076 * @since 1.29 Accepts a StatusValue
2077 * @param StatusValue $status
2078 * @throws ApiUsageException always
2080 public function dieStatus( StatusValue
$status ) {
2081 if ( $status->isGood() ) {
2082 throw new MWException( 'Successful status passed to ApiBase::dieStatus' );
2085 // ApiUsageException needs a fatal status, but this method has
2086 // historically accepted any non-good status. Convert it if necessary.
2087 $status->setOK( false );
2088 if ( !$status->getErrorsByType( 'error' ) ) {
2089 $newStatus = Status
::newGood();
2090 foreach ( $status->getErrorsByType( 'warning' ) as $err ) {
2091 $newStatus->fatal( $err['message'], ...$err['params'] );
2093 if ( !$newStatus->getErrorsByType( 'error' ) ) {
2094 $newStatus->fatal( 'unknownerror-nocode' );
2096 $status = $newStatus;
2099 $this->addBlockInfoToStatus( $status );
2100 throw new ApiUsageException( $this, $status );
2104 * Helper function for readonly errors
2106 * @throws ApiUsageException always
2108 public function dieReadOnly() {
2109 $this->dieWithError(
2110 'apierror-readonly',
2112 [ 'readonlyreason' => wfReadOnlyReason() ]
2117 * Helper function for permission-denied errors
2119 * @param string|string[] $rights
2120 * @param User|null $user
2121 * @throws ApiUsageException if the user doesn't have any of the rights.
2122 * The error message is based on $rights[0].
2124 public function checkUserRightsAny( $rights, $user = null ) {
2126 $user = $this->getUser();
2128 $rights = (array)$rights;
2129 if ( !$this->getPermissionManager()
2130 ->userHasAnyRight( $user, ...$rights )
2132 $this->dieWithError( [ 'apierror-permissiondenied', $this->msg( "action-{$rights[0]}" ) ] );
2137 * Helper function for permission-denied errors
2139 * @param LinkTarget $linkTarget
2140 * @param string|string[] $actions
2141 * @param array $options Additional options
2142 * - user: (User) User to use rather than $this->getUser()
2143 * - autoblock: (bool, default false) Whether to spread autoblocks
2144 * For compatibility, passing a User object is treated as the value for the 'user' option.
2145 * @throws ApiUsageException if the user doesn't have all of the rights.
2148 * @since 1.33 Changed the third parameter from $user to $options.
2150 public function checkTitleUserPermissions( LinkTarget
$linkTarget, $actions, $options = [] ) {
2151 if ( !is_array( $options ) ) {
2152 wfDeprecated( '$user as the third parameter to ' . __METHOD__
, '1.33' );
2153 $options = [ 'user' => $options ];
2155 $user = $options['user'] ??
$this->getUser();
2158 foreach ( (array)$actions as $action ) {
2159 $errors = array_merge(
2161 $this->getPermissionManager()->getPermissionErrors( $action, $user, $linkTarget )
2166 if ( !empty( $options['autoblock'] ) ) {
2167 $user->spreadAnyEditBlock();
2170 $this->dieStatus( $this->errorArrayToStatus( $errors, $user ) );
2175 * Will only set a warning instead of failing if the global $wgDebugAPI
2176 * is set to true. Otherwise behaves exactly as self::dieWithError().
2179 * @param string|array|Message $msg
2180 * @param string|null $code
2181 * @param array|null $data
2182 * @param int|null $httpCode
2183 * @throws ApiUsageException
2185 public function dieWithErrorOrDebug( $msg, $code = null, $data = null, $httpCode = null ) {
2186 if ( $this->getConfig()->get( 'DebugAPI' ) !== true ) {
2187 $this->dieWithError( $msg, $code, $data, $httpCode );
2189 $this->addWarning( $msg, $code, $data );
2194 * Die with the 'badcontinue' error.
2196 * This call is common enough to make it into the base method.
2198 * @param bool $condition Will only die if this value is true
2199 * @throws ApiUsageException
2202 protected function dieContinueUsageIf( $condition ) {
2204 $this->dieWithError( 'apierror-badcontinue' );
2209 * Internal code errors should be reported with this method
2210 * @param string $method Method or function name
2211 * @param string $message Error message
2212 * @throws MWException always
2214 protected static function dieDebug( $method, $message ) {
2215 throw new MWException( "Internal error in $method: $message" );
2219 * Write logging information for API features to a debug log, for usage
2221 * @note Consider using $this->addDeprecation() instead to both warn and log.
2222 * @param string $feature Feature being used.
2224 public function logFeatureUsage( $feature ) {
2225 static $loggedFeatures = [];
2227 // Only log each feature once per request. We can get multiple calls from calls to
2228 // extractRequestParams() with different values for 'parseLimit', for example.
2229 if ( isset( $loggedFeatures[$feature] ) ) {
2232 $loggedFeatures[$feature] = true;
2234 $request = $this->getRequest();
2236 'feature' => $feature,
2237 // Spaces to underscores in 'username' for historical reasons.
2238 'username' => str_replace( ' ', '_', $this->getUser()->getName() ),
2239 'ip' => $request->getIP(),
2240 'referer' => (string)$request->getHeader( 'Referer' ),
2241 'agent' => $this->getMain()->getUserAgent(),
2244 // Text string is deprecated. Remove (or replace with just $feature) in MW 1.34.
2245 $s = '"' . addslashes( $ctx['feature'] ) . '"' .
2246 ' "' . wfUrlencode( $ctx['username'] ) . '"' .
2247 ' "' . $ctx['ip'] . '"' .
2248 ' "' . addslashes( $ctx['referer'] ) . '"' .
2249 ' "' . addslashes( $ctx['agent'] ) . '"';
2251 wfDebugLog( 'api-feature-usage', $s, 'private', $ctx );
2256 /************************************************************************//**
2257 * @name Help message generation
2262 * Return the summary message.
2264 * This is a one-line description of the module, suitable for display in a
2268 * @return string|array|Message
2270 protected function getSummaryMessage() {
2271 return "apihelp-{$this->getModulePath()}-summary";
2275 * Return the extended help text message.
2277 * This is additional text to display at the top of the help section, below
2281 * @return string|array|Message
2283 protected function getExtendedDescription() {
2285 "apihelp-{$this->getModulePath()}-extended-description",
2286 'api-help-no-extended-description',
2291 * Get final module summary
2296 public function getFinalSummary() {
2297 $msg = self
::makeMessage( $this->getSummaryMessage(), $this->getContext(), [
2298 $this->getModulePrefix(),
2299 $this->getModuleName(),
2300 $this->getModulePath(),
2306 * Get final module description, after hooks have had a chance to tweak it as
2309 * @since 1.25, returns Message[] rather than string[]
2312 public function getFinalDescription() {
2313 $summary = self
::makeMessage( $this->getSummaryMessage(), $this->getContext(), [
2314 $this->getModulePrefix(),
2315 $this->getModuleName(),
2316 $this->getModulePath(),
2318 $extendedDescription = self
::makeMessage(
2319 $this->getExtendedDescription(), $this->getContext(), [
2320 $this->getModulePrefix(),
2321 $this->getModuleName(),
2322 $this->getModulePath(),
2326 $msgs = [ $summary, $extendedDescription ];
2328 Hooks
::run( 'APIGetDescriptionMessages', [ $this, &$msgs ] );
2334 * Get final list of parameters, after hooks have had a chance to
2335 * tweak it as needed.
2337 * @param int $flags Zero or more flags like GET_VALUES_FOR_HELP
2338 * @return array|bool False on no parameters
2339 * @since 1.21 $flags param added
2341 public function getFinalParams( $flags = 0 ) {
2342 $params = $this->getAllowedParams( $flags );
2347 if ( $this->needsToken() ) {
2348 $params['token'] = [
2349 self
::PARAM_TYPE
=> 'string',
2350 self
::PARAM_REQUIRED
=> true,
2351 self
::PARAM_SENSITIVE
=> true,
2352 self
::PARAM_HELP_MSG
=> [
2353 'api-help-param-token',
2354 $this->needsToken(),
2356 ] +
( $params['token'] ??
[] );
2359 // Avoid PHP 7.1 warning of passing $this by reference
2361 Hooks
::run( 'APIGetAllowedParams', [ &$apiModule, &$params, $flags ] );
2367 * Get final parameter descriptions, after hooks have had a chance to tweak it as
2370 * @since 1.25, returns array of Message[] rather than array of string[]
2371 * @return array Keys are parameter names, values are arrays of Message objects
2373 public function getFinalParamDescription() {
2374 $prefix = $this->getModulePrefix();
2375 $name = $this->getModuleName();
2376 $path = $this->getModulePath();
2378 $params = $this->getFinalParams( self
::GET_VALUES_FOR_HELP
);
2380 foreach ( $params as $param => $settings ) {
2381 if ( !is_array( $settings ) ) {
2385 if ( isset( $settings[self
::PARAM_HELP_MSG
] ) ) {
2386 $msg = $settings[self
::PARAM_HELP_MSG
];
2388 $msg = $this->msg( "apihelp-{$path}-param-{$param}" );
2390 $msg = self
::makeMessage( $msg, $this->getContext(),
2391 [ $prefix, $param, $name, $path ] );
2393 self
::dieDebug( __METHOD__
,
2394 'Value in ApiBase::PARAM_HELP_MSG is not valid' );
2396 $msgs[$param] = [ $msg ];
2398 if ( isset( $settings[self
::PARAM_TYPE
] ) &&
2399 $settings[self
::PARAM_TYPE
] === 'submodule'
2401 if ( isset( $settings[self
::PARAM_SUBMODULE_MAP
] ) ) {
2402 $map = $settings[self
::PARAM_SUBMODULE_MAP
];
2404 $prefix = $this->isMain() ?
'' : ( $this->getModulePath() . '+' );
2406 foreach ( $this->getModuleManager()->getNames( $param ) as $submoduleName ) {
2407 $map[$submoduleName] = $prefix . $submoduleName;
2412 $deprecatedSubmodules = [];
2413 foreach ( $map as $v => $m ) {
2414 $arr = &$submodules;
2415 $isDeprecated = false;
2418 $submod = $this->getModuleFromPath( $m );
2420 $summary = $submod->getFinalSummary();
2421 $isDeprecated = $submod->isDeprecated();
2422 if ( $isDeprecated ) {
2423 $arr = &$deprecatedSubmodules;
2426 } catch ( ApiUsageException
$ex ) {
2430 $key = $summary->getKey();
2431 $params = $summary->getParams();
2433 $key = 'api-help-undocumented-module';
2436 $m = new ApiHelpParamValueMessage( "[[Special:ApiHelp/$m|$v]]", $key, $params, $isDeprecated );
2437 $arr[] = $m->setContext( $this->getContext() );
2439 $msgs[$param] = array_merge( $msgs[$param], $submodules, $deprecatedSubmodules );
2440 } elseif ( isset( $settings[self
::PARAM_HELP_MSG_PER_VALUE
] ) ) {
2441 if ( !is_array( $settings[self
::PARAM_HELP_MSG_PER_VALUE
] ) ) {
2442 self
::dieDebug( __METHOD__
,
2443 'ApiBase::PARAM_HELP_MSG_PER_VALUE is not valid' );
2445 if ( !is_array( $settings[self
::PARAM_TYPE
] ) ) {
2446 self
::dieDebug( __METHOD__
,
2447 'ApiBase::PARAM_HELP_MSG_PER_VALUE may only be used when ' .
2448 'ApiBase::PARAM_TYPE is an array' );
2451 $valueMsgs = $settings[self
::PARAM_HELP_MSG_PER_VALUE
];
2452 $deprecatedValues = $settings[self
::PARAM_DEPRECATED_VALUES
] ??
[];
2454 foreach ( $settings[self
::PARAM_TYPE
] as $value ) {
2455 if ( isset( $valueMsgs[$value] ) ) {
2456 $msg = $valueMsgs[$value];
2458 $msg = "apihelp-{$path}-paramvalue-{$param}-{$value}";
2460 $m = self
::makeMessage( $msg, $this->getContext(),
2461 [ $prefix, $param, $name, $path, $value ] );
2463 $m = new ApiHelpParamValueMessage(
2465 [ $m->getKey(), 'api-help-param-no-description' ],
2467 isset( $deprecatedValues[$value] )
2469 $msgs[$param][] = $m->setContext( $this->getContext() );
2471 self
::dieDebug( __METHOD__
,
2472 "Value in ApiBase::PARAM_HELP_MSG_PER_VALUE for $value is not valid" );
2477 if ( isset( $settings[self
::PARAM_HELP_MSG_APPEND
] ) ) {
2478 if ( !is_array( $settings[self
::PARAM_HELP_MSG_APPEND
] ) ) {
2479 self
::dieDebug( __METHOD__
,
2480 'Value for ApiBase::PARAM_HELP_MSG_APPEND is not an array' );
2482 foreach ( $settings[self
::PARAM_HELP_MSG_APPEND
] as $m ) {
2483 $m = self
::makeMessage( $m, $this->getContext(),
2484 [ $prefix, $param, $name, $path ] );
2486 $msgs[$param][] = $m;
2488 self
::dieDebug( __METHOD__
,
2489 'Value in ApiBase::PARAM_HELP_MSG_APPEND is not valid' );
2495 Hooks
::run( 'APIGetParamDescriptionMessages', [ $this, &$msgs ] );
2501 * Generates the list of flags for the help screen and for action=paraminfo
2503 * Corresponding messages: api-help-flag-deprecated,
2504 * api-help-flag-internal, api-help-flag-readrights,
2505 * api-help-flag-writerights, api-help-flag-mustbeposted
2509 protected function getHelpFlags() {
2512 if ( $this->isDeprecated() ) {
2513 $flags[] = 'deprecated';
2515 if ( $this->isInternal() ) {
2516 $flags[] = 'internal';
2518 if ( $this->isReadMode() ) {
2519 $flags[] = 'readrights';
2521 if ( $this->isWriteMode() ) {
2522 $flags[] = 'writerights';
2524 if ( $this->mustBePosted() ) {
2525 $flags[] = 'mustbeposted';
2532 * Returns information about the source of this module, if known
2534 * Returned array is an array with the following keys:
2535 * - path: Install path
2536 * - name: Extension name, or "MediaWiki" for core
2537 * - namemsg: (optional) i18n message key for a display name
2538 * - license-name: (optional) Name of license
2540 * @return array|null
2542 protected function getModuleSourceInfo() {
2545 if ( $this->mModuleSource
!== false ) {
2546 return $this->mModuleSource
;
2549 // First, try to find where the module comes from...
2550 $rClass = new ReflectionClass( $this );
2551 $path = $rClass->getFileName();
2554 $this->mModuleSource
= null;
2557 $path = realpath( $path ) ?
: $path;
2559 // Build map of extension directories to extension info
2560 if ( self
::$extensionInfo === null ) {
2561 $extDir = $this->getConfig()->get( 'ExtensionDirectory' );
2562 self
::$extensionInfo = [
2563 realpath( __DIR__
) ?
: __DIR__
=> [
2565 'name' => 'MediaWiki',
2566 'license-name' => 'GPL-2.0-or-later',
2568 realpath( "$IP/extensions" ) ?
: "$IP/extensions" => null,
2569 realpath( $extDir ) ?
: $extDir => null,
2575 'license-name' => null,
2577 foreach ( $this->getConfig()->get( 'ExtensionCredits' ) as $group ) {
2578 foreach ( $group as $ext ) {
2579 if ( !isset( $ext['path'] ) ||
!isset( $ext['name'] ) ) {
2580 // This shouldn't happen, but does anyway.
2584 $extpath = $ext['path'];
2585 if ( !is_dir( $extpath ) ) {
2586 $extpath = dirname( $extpath );
2588 self
::$extensionInfo[realpath( $extpath ) ?
: $extpath] =
2589 array_intersect_key( $ext, $keep );
2592 foreach ( ExtensionRegistry
::getInstance()->getAllThings() as $ext ) {
2593 $extpath = $ext['path'];
2594 if ( !is_dir( $extpath ) ) {
2595 $extpath = dirname( $extpath );
2597 self
::$extensionInfo[realpath( $extpath ) ?
: $extpath] =
2598 array_intersect_key( $ext, $keep );
2602 // Now traverse parent directories until we find a match or run out of
2605 if ( array_key_exists( $path, self
::$extensionInfo ) ) {
2607 $this->mModuleSource
= self
::$extensionInfo[$path];
2608 return $this->mModuleSource
;
2612 $path = dirname( $path );
2613 } while ( $path !== $oldpath );
2615 // No idea what extension this might be.
2616 $this->mModuleSource
= null;
2621 * Called from ApiHelp before the pieces are joined together and returned.
2623 * This exists mainly for ApiMain to add the Permissions and Credits
2624 * sections. Other modules probably don't need it.
2626 * @param string[] &$help Array of help data
2627 * @param array $options Options passed to ApiHelp::getHelp
2628 * @param array &$tocData If a TOC is being generated, this array has keys
2629 * as anchors in the page and values as for Linker::generateTOC().
2631 public function modifyHelp( array &$help, array $options, array &$tocData ) {
2638 * For really cool vim folding this needs to be at the end:
2639 * vim: foldmarker=@{,@} foldmethod=marker