MediaWiki  1.28.0
ApiClientLogin.php
Go to the documentation of this file.
1 <?php
26 
32 class ApiClientLogin extends ApiBase {
33 
34  public function __construct( ApiMain $main, $action ) {
35  parent::__construct( $main, $action, 'login' );
36  }
37 
38  public function getFinalDescription() {
39  // A bit of a hack to append 'api-help-authmanager-general-usage'
40  $msgs = parent::getFinalDescription();
41  $msgs[] = ApiBase::makeMessage( 'api-help-authmanager-general-usage', $this->getContext(), [
42  $this->getModulePrefix(),
43  $this->getModuleName(),
44  $this->getModulePath(),
45  AuthManager::ACTION_LOGIN,
46  self::needsToken(),
47  ] );
48  return $msgs;
49  }
50 
51  public function execute() {
52  $params = $this->extractRequestParams();
53 
54  $this->requireAtLeastOneParameter( $params, 'continue', 'returnurl' );
55 
56  if ( $params['returnurl'] !== null ) {
57  $bits = wfParseUrl( $params['returnurl'] );
58  if ( !$bits || $bits['scheme'] === '' ) {
59  $encParamName = $this->encodeParamName( 'returnurl' );
60  $this->dieUsage(
61  "Invalid value '{$params['returnurl']}' for url parameter $encParamName",
62  "badurl_{$encParamName}"
63  );
64  }
65  }
66 
67  $helper = new ApiAuthManagerHelper( $this );
68  $manager = AuthManager::singleton();
69 
70  // Make sure it's possible to log in
71  if ( !$manager->canAuthenticateNow() ) {
72  $this->getResult()->addValue( null, 'clientlogin', $helper->formatAuthenticationResponse(
73  AuthenticationResponse::newFail( $this->msg( 'userlogin-cannot-' . AuthManager::ACTION_LOGIN ) )
74  ) );
75  $helper->logAuthenticationResult( 'login', 'userlogin-cannot-' . AuthManager::ACTION_LOGIN );
76  return;
77  }
78 
79  // Perform the login step
80  if ( $params['continue'] ) {
81  $reqs = $helper->loadAuthenticationRequests( AuthManager::ACTION_LOGIN_CONTINUE );
82  $res = $manager->continueAuthentication( $reqs );
83  } else {
84  $reqs = $helper->loadAuthenticationRequests( AuthManager::ACTION_LOGIN );
85  if ( $params['preservestate'] ) {
86  $req = $helper->getPreservedRequest();
87  if ( $req ) {
88  $reqs[] = $req;
89  }
90  }
91  $res = $manager->beginAuthentication( $reqs, $params['returnurl'] );
92  }
93 
94  // Remove CreateFromLoginAuthenticationRequest from $res->neededRequests.
95  // It's there so a RESTART treated as UI will work right, but showing
96  // it to the API client is just confusing.
99  );
100 
101  $this->getResult()->addValue( null, 'clientlogin',
102  $helper->formatAuthenticationResponse( $res ) );
103  $helper->logAuthenticationResult( 'login', $res );
104  }
105 
106  public function isReadMode() {
107  return false;
108  }
109 
110  public function needsToken() {
111  return 'login';
112  }
113 
114  public function getAllowedParams() {
115  return ApiAuthManagerHelper::getStandardParams( AuthManager::ACTION_LOGIN,
116  'requests', 'messageformat', 'mergerequestfields', 'preservestate', 'returnurl', 'continue'
117  );
118  }
119 
120  public function dynamicParameterDocumentation() {
121  return [ 'api-help-authmanagerhelper-additional-params', AuthManager::ACTION_LOGIN ];
122  }
123 
124  protected function getExamplesMessages() {
125  return [
126  'action=clientlogin&username=Example&password=ExamplePassword&'
127  . 'loginreturnurl=http://example.org/&logintoken=123ABC'
128  => 'apihelp-clientlogin-example-login',
129  'action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC'
130  => 'apihelp-clientlogin-example-login2',
131  ];
132  }
133 
134  public function getHelpUrls() {
135  return 'https://www.mediawiki.org/wiki/API:Login';
136  }
137 }
static getStandardParams($action, $param)
Fetch the standard parameters this helper recognizes.
getResult()
Get the result object.
Definition: ApiBase.php:577
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Log in to the wiki with AuthManager.
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
static makeMessage($msg, IContextSource $context, array $params=null)
Create a Message from a string or array.
Definition: ApiBase.php:1511
$res
Definition: database.txt:21
getModulePath()
Get the path to this module.
Definition: ApiBase.php:521
getContext()
Get the base IContextSource object.
$params
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:457
__construct(ApiMain $main, $action)
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
this hook is for auditing only $req
Definition: hooks.txt:1007
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:465
static blacklistAuthenticationRequests(array $reqs, array $blacklist)
Filter out authentication requests by class name.
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
requireAtLeastOneParameter($params, $required)
Die if none of a certain set of parameters is set and not false.
Definition: ApiBase.php:763
dieUsage($description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1574
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
wfParseUrl($url)
parse_url() work-alike, but non-broken.
encodeParamName($paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:665
Helper class for AuthManager-using API modules.