MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
31 class ApiTokens extends ApiBase {
33  public function execute() {
34  $this->setWarning(
35  'action=tokens has been deprecated. Please use action=query&meta=tokens instead.'
36  );
37  $this->logFeatureUsage( 'action=tokens' );
39  $params = $this->extractRequestParams();
40  $res = [
41  ApiResult::META_TYPE => 'assoc',
42  ];
44  $types = $this->getTokenTypes();
45  foreach ( $params['type'] as $type ) {
46  $val = call_user_func( $types[$type], null, null );
48  if ( $val === false ) {
49  $this->setWarning( "Action '$type' is not allowed for the current user" );
50  } else {
51  $res[$type . 'token'] = $val;
52  }
53  }
55  $this->getResult()->addValue( null, $this->getModuleName(), $res );
56  }
58  private function getTokenTypes() {
59  // If we're in a mode that breaks the same-origin policy, no tokens can
60  // be obtained
61  if ( $this->lacksSameOriginSecurity() ) {
62  return [];
63  }
65  static $types = null;
66  if ( $types ) {
67  return $types;
68  }
69  $types = [ 'patrol' => [ 'ApiQueryRecentChanges', 'getPatrolToken' ] ];
70  $names = [ 'edit', 'delete', 'protect', 'move', 'block', 'unblock',
71  'email', 'import', 'watch', 'options' ];
72  foreach ( $names as $name ) {
73  $types[$name] = [ 'ApiQueryInfo', 'get' . ucfirst( $name ) . 'Token' ];
74  }
75  Hooks::run( 'ApiTokensGetTokenTypes', [ &$types ] );
77  // For forwards-compat, copy any token types from ApiQueryTokens that
78  // we don't already have something for.
79  $user = $this->getUser();
80  $request = $this->getRequest();
81  foreach ( ApiQueryTokens::getTokenTypeSalts() as $name => $salt ) {
82  if ( !isset( $types[$name] ) ) {
83  $types[$name] = function () use ( $salt, $user, $request ) {
84  return ApiQueryTokens::getToken( $user, $request->getSession(), $salt )->toString();
85  };
86  }
87  }
89  ksort( $types );
91  return $types;
92  }
94  public function isDeprecated() {
95  return true;
96  }
98  public function getAllowedParams() {
99  return [
100  'type' => [
101  ApiBase::PARAM_DFLT => 'edit',
102  ApiBase::PARAM_ISMULTI => true,
103  ApiBase::PARAM_TYPE => array_keys( $this->getTokenTypes() ),
104  ],
105  ];
106  }
108  protected function getExamplesMessages() {
109  return [
110  'action=tokens'
111  => 'apihelp-tokens-example-edit',
112  'action=tokens&type=email|move'
113  => 'apihelp-tokens-example-emailmove',
114  ];
115  }
116 }
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
Get the result object.
Definition: ApiBase.php:584
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
Returns true if the current request breaks the same-origin policy.
Definition: ApiBase.php:512
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:685
Key for the 'type' metadata item.
Definition: ApiResult.php:108
Definition: ApiTokens.php:58
Definition: ApiTokens.php:94
Get the WebRequest object.
Definition: ApiTokens.php:108
Definition: database.txt:21
Get the name of the module being executed by this instance.
Definition: ApiBase.php:464
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
Set warning section for this module.
Definition: ApiBase.php:1554
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
Definition: distributors.txt:9
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
static getTokenTypeSalts()
Get the salts for known token types.
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:35
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2573
static getToken(User $user, MediaWiki\Session\Session $session, $salt)
Get a token from a salt.
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
Write logging information for API features to a debug log, for usage analysis.
Definition: ApiBase.php:2304
Get the User object.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
Definition: ApiTokens.php:98
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300