MediaWiki REL1_33
ApiQueryAuthManagerInfo.php
Go to the documentation of this file.
1<?php
25
32
33 public function __construct( ApiQuery $query, $moduleName ) {
34 parent::__construct( $query, $moduleName, 'ami' );
35 }
36
37 public function execute() {
39 $helper = new ApiAuthManagerHelper( $this );
40
41 $manager = AuthManager::singleton();
42 $ret = [
43 'canauthenticatenow' => $manager->canAuthenticateNow(),
44 'cancreateaccounts' => $manager->canCreateAccounts(),
45 'canlinkaccounts' => $manager->canLinkAccounts(),
46 ];
47
48 if ( $params['securitysensitiveoperation'] !== null ) {
49 $ret['securitysensitiveoperationstatus'] = $manager->securitySensitiveOperationStatus(
50 $params['securitysensitiveoperation']
51 );
52 }
53
54 if ( $params['requestsfor'] ) {
55 $action = $params['requestsfor'];
56
57 $preservedReq = $helper->getPreservedRequest();
58 if ( $preservedReq ) {
59 $ret += [
60 'haspreservedstate' => $preservedReq->hasStateForAction( $action ),
61 'hasprimarypreservedstate' => $preservedReq->hasPrimaryStateForAction( $action ),
62 'preservedusername' => (string)$preservedReq->username,
63 ];
64 } else {
65 $ret += [
66 'haspreservedstate' => false,
67 'hasprimarypreservedstate' => false,
68 'preservedusername' => '',
69 ];
70 }
71
72 $reqs = $manager->getAuthenticationRequests( $action, $this->getUser() );
73
74 // Filter out blacklisted requests, depending on the action
75 switch ( $action ) {
76 case AuthManager::ACTION_CHANGE:
78 $reqs, $this->getConfig()->get( 'ChangeCredentialsBlacklist' )
79 );
80 break;
81 case AuthManager::ACTION_REMOVE:
83 $reqs, $this->getConfig()->get( 'RemoveCredentialsBlacklist' )
84 );
85 break;
86 }
87
88 $ret += $helper->formatRequests( $reqs );
89 }
90
91 $this->getResult()->addValue( [ 'query' ], $this->getModuleName(), $ret );
92 }
93
94 public function isReadMode() {
95 return false;
96 }
97
98 public function getAllowedParams() {
99 return [
100 'securitysensitiveoperation' => null,
101 'requestsfor' => [
103 AuthManager::ACTION_LOGIN,
104 AuthManager::ACTION_LOGIN_CONTINUE,
105 AuthManager::ACTION_CREATE,
106 AuthManager::ACTION_CREATE_CONTINUE,
107 AuthManager::ACTION_LINK,
108 AuthManager::ACTION_LINK_CONTINUE,
109 AuthManager::ACTION_CHANGE,
110 AuthManager::ACTION_REMOVE,
111 AuthManager::ACTION_UNLINK,
112 ],
113 ],
114 ] + ApiAuthManagerHelper::getStandardParams( '', 'mergerequestfields', 'messageformat' );
115 }
116
117 protected function getExamplesMessages() {
118 return [
119 'action=query&meta=authmanagerinfo&amirequestsfor=' . urlencode( AuthManager::ACTION_LOGIN )
120 => 'apihelp-query+authmanagerinfo-example-login',
121 'action=query&meta=authmanagerinfo&amirequestsfor=' . urlencode( AuthManager::ACTION_LOGIN ) .
122 '&amimergerequestfields=1'
123 => 'apihelp-query+authmanagerinfo-example-login-merged',
124 'action=query&meta=authmanagerinfo&amisecuritysensitiveoperation=foo'
125 => 'apihelp-query+authmanagerinfo-example-securitysensitiveoperation',
126 ];
127 }
128
129 public function getHelpUrls() {
130 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Authmanagerinfo';
131 }
132}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Helper class for AuthManager-using API modules.
static getStandardParams( $action, $param)
Fetch the standard parameters this helper recognizes.
static blacklistAuthenticationRequests(array $reqs, array $blacklist)
Filter out authentication requests by class name.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
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
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:512
A query action to return meta information about AuthManager state.
getHelpUrls()
Return links to more detailed help pages about the module.
getExamplesMessages()
Returns usage examples for this module.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
__construct(ApiQuery $query, $moduleName)
isReadMode()
Indicates whether this module requires read rights.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
This is a base class for all Query modules.
This is the main query class.
Definition ApiQuery.php:36
This serves as the entry point to the authentication system.
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition hooks.txt:181
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:2003
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1617
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