MediaWiki REL1_33
ApiTokens.php
Go to the documentation of this file.
1<?php
27class ApiTokens extends ApiBase {
28
29 public function execute() {
30 $this->addDeprecation(
31 [ 'apiwarn-deprecation-withreplacement', 'action=tokens', 'action=query&meta=tokens' ],
32 'action=tokens'
33 );
34
36 $res = [
37 ApiResult::META_TYPE => 'assoc',
38 ];
39
40 $types = $this->getTokenTypes();
41 foreach ( $params['type'] as $type ) {
42 $val = call_user_func( $types[$type], null, null );
43
44 if ( $val === false ) {
45 $this->addWarning( [ 'apiwarn-tokennotallowed', $type ] );
46 } else {
47 $res[$type . 'token'] = $val;
48 }
49 }
50
51 $this->getResult()->addValue( null, $this->getModuleName(), $res );
52 }
53
54 private function getTokenTypes() {
55 // If we're in a mode that breaks the same-origin policy, no tokens can
56 // be obtained
57 if ( $this->lacksSameOriginSecurity() ) {
58 return [];
59 }
60
61 static $types = null;
62 if ( $types ) {
63 return $types;
64 }
65 $types = [ 'patrol' => [ ApiQueryRecentChanges::class, 'getPatrolToken' ] ];
66 $names = [ 'edit', 'delete', 'protect', 'move', 'block', 'unblock',
67 'email', 'import', 'watch', 'options' ];
68 foreach ( $names as $name ) {
69 $types[$name] = [ ApiQueryInfo::class, 'get' . ucfirst( $name ) . 'Token' ];
70 }
71 Hooks::run( 'ApiTokensGetTokenTypes', [ &$types ] );
72
73 // For forwards-compat, copy any token types from ApiQueryTokens that
74 // we don't already have something for.
75 $user = $this->getUser();
76 $request = $this->getRequest();
77 foreach ( ApiQueryTokens::getTokenTypeSalts() as $name => $salt ) {
78 if ( !isset( $types[$name] ) ) {
79 $types[$name] = function () use ( $salt, $user, $request ) {
80 return ApiQueryTokens::getToken( $user, $request->getSession(), $salt )->toString();
81 };
82 }
83 }
84
85 ksort( $types );
86
87 return $types;
88 }
89
90 public function isDeprecated() {
91 return true;
92 }
93
94 public function getAllowedParams() {
95 return [
96 'type' => [
97 ApiBase::PARAM_DFLT => 'edit',
99 ApiBase::PARAM_TYPE => array_keys( $this->getTokenTypes() ),
100 ],
101 ];
102 }
103
104 protected function getExamplesMessages() {
105 return [
106 'action=tokens'
107 => 'apihelp-tokens-example-edit',
108 'action=tokens&type=email|move'
109 => 'apihelp-tokens-example-emailmove',
110 ];
111 }
112}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
This abstract class implements many basic API functions, and is the base of all API classes.
Definition ApiBase.php:37
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:48
addDeprecation( $msg, $feature, $data=[])
Add a deprecation warning for this module.
Definition ApiBase.php:1923
getResult()
Get the result object.
Definition ApiBase.php:632
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:743
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition ApiBase.php:1909
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:512
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:51
lacksSameOriginSecurity()
Returns true if the current request breaks the same-origin policy.
Definition ApiBase.php:560
static getTokenTypeSalts()
Get the salts for known token types.
static getToken(User $user, MediaWiki\Session\Session $session, $salt)
Get a token from a salt.
const META_TYPE
Key for the 'type' metadata item.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition ApiTokens.php:29
getExamplesMessages()
Returns usage examples for this module.
getTokenTypes()
Definition ApiTokens.php:54
isDeprecated()
Indicates whether this module is deprecated.
Definition ApiTokens.php:90
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition ApiTokens.php:94
$res
Definition database.txt:21
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2843
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:271
return true to allow those checks to and false if checking is done & $user
Definition hooks.txt:1510
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
$params