MediaWiki  master
ApiAMCreateAccount.php
Go to the documentation of this file.
1 <?php
26 
32 class ApiAMCreateAccount extends ApiBase {
33 
34  public function __construct( ApiMain $main, $action ) {
35  parent::__construct( $main, $action, 'create' );
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_CREATE,
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->dieWithError(
61  [ 'apierror-badurl', $encParamName, wfEscapeWikiText( $params['returnurl'] ) ],
62  "badurl_{$encParamName}"
63  );
64  }
65  }
66 
67  $manager = MediaWikiServices::getInstance()->getAuthManager();
68  $helper = new ApiAuthManagerHelper( $this, $manager );
69 
70  // Make sure it's possible to create accounts
71  if ( !$manager->canCreateAccounts() ) {
72  $this->getResult()->addValue( null, 'createaccount', $helper->formatAuthenticationResponse(
73  AuthenticationResponse::newFail(
74  $this->msg( 'userlogin-cannot-' . AuthManager::ACTION_CREATE )
75  )
76  ) );
77  $helper->logAuthenticationResult( 'accountcreation',
78  'userlogin-cannot-' . AuthManager::ACTION_CREATE );
79  return;
80  }
81 
82  // Perform the create step
83  if ( $params['continue'] ) {
84  $reqs = $helper->loadAuthenticationRequests( AuthManager::ACTION_CREATE_CONTINUE );
85  $res = $manager->continueAccountCreation( $reqs );
86  } else {
87  $reqs = $helper->loadAuthenticationRequests( AuthManager::ACTION_CREATE );
88  if ( $params['preservestate'] ) {
89  $req = $helper->getPreservedRequest();
90  if ( $req ) {
91  $reqs[] = $req;
92  }
93  }
94  $res = $manager->beginAccountCreation( $this->getUser(), $reqs, $params['returnurl'] );
95  }
96 
97  $this->getResult()->addValue( null, 'createaccount',
98  $helper->formatAuthenticationResponse( $res ) );
99  $helper->logAuthenticationResult( 'accountcreation', $res );
100  }
101 
102  public function isReadMode() {
103  return false;
104  }
105 
106  public function isWriteMode() {
107  return true;
108  }
109 
110  public function needsToken() {
111  return 'createaccount';
112  }
113 
114  public function getAllowedParams() {
115  $ret = ApiAuthManagerHelper::getStandardParams( AuthManager::ACTION_CREATE,
116  'requests', 'messageformat', 'mergerequestfields', 'preservestate', 'returnurl', 'continue'
117  );
118  $ret['preservestate'][ApiBase::PARAM_HELP_MSG_APPEND][] =
119  'apihelp-createaccount-param-preservestate';
120  return $ret;
121  }
122 
123  public function dynamicParameterDocumentation() {
124  return [ 'api-help-authmanagerhelper-additional-params', AuthManager::ACTION_CREATE ];
125  }
126 
127  protected function getExamplesMessages() {
128  return [
129  'action=createaccount&username=Example&password=ExamplePassword&retype=ExamplePassword'
130  . '&createreturnurl=http://example.org/&createtoken=123ABC'
131  => 'apihelp-createaccount-example-create',
132  ];
133  }
134 
135  public function getHelpUrls() {
136  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Account_creation';
137  }
138 }
ApiMain
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:47
ContextSource\getContext
getContext()
Get the base IContextSource object.
Definition: ContextSource.php:42
ApiAMCreateAccount\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiAMCreateAccount.php:114
ApiAMCreateAccount\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiAMCreateAccount.php:135
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:154
ApiAMCreateAccount\__construct
__construct(ApiMain $main, $action)
Definition: ApiAMCreateAccount.php:34
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1382
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:565
ApiBase\makeMessage
static makeMessage( $msg, IContextSource $context, array $params=null)
Create a Message from a string or array.
Definition: ApiBase.php:1168
ApiAuthManagerHelper\getStandardParams
static getStandardParams( $action,... $wantedParams)
Fetch the standard parameters this helper recognizes.
Definition: ApiAuthManagerHelper.php:362
$res
$res
Definition: testCompression.php:57
ContextSource\getUser
getUser()
Stable to override.
Definition: ContextSource.php:131
ApiBase\PARAM_HELP_MSG_APPEND
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:114
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:52
wfParseUrl
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Definition: GlobalFunctions.php:791
ApiAMCreateAccount\isReadMode
isReadMode()
Indicates whether this module requires read rights Stable to override.
Definition: ApiAMCreateAccount.php:102
ApiBase\getModulePath
getModulePath()
Get the path to this module.
Definition: ApiBase.php:509
MediaWiki\Auth\AuthenticationResponse
This is a value object to hold authentication response data.
Definition: AuthenticationResponse.php:37
ApiAMCreateAccount\isWriteMode
isWriteMode()
Indicates whether this module requires write mode.
Definition: ApiAMCreateAccount.php:106
ApiAuthManagerHelper
Helper class for AuthManager-using API modules.
Definition: ApiAuthManagerHelper.php:37
ApiBase\extractRequestParams
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:717
ApiBase\requireAtLeastOneParameter
requireAtLeastOneParameter( $params,... $required)
Die if none of a certain set of parameters is set and not false.
Definition: ApiBase.php:914
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:452
ApiBase\encodeParamName
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:695
ApiAMCreateAccount\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiAMCreateAccount.php:51
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1487
ApiAMCreateAccount\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiAMCreateAccount.php:127
MediaWiki\Auth\AuthManager
This serves as the entry point to the authentication system.
Definition: AuthManager.php:88
ApiAMCreateAccount\dynamicParameterDocumentation
dynamicParameterDocumentation()
Indicate if the module supports dynamically-determined parameters that cannot be included in self::ge...
Definition: ApiAMCreateAccount.php:123
ApiAMCreateAccount
Create an account with AuthManager.
Definition: ApiAMCreateAccount.php:32
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:444
ApiAMCreateAccount\needsToken
needsToken()
Returns the token type this module requires in order to execute.
Definition: ApiAMCreateAccount.php:110
ApiAMCreateAccount\getFinalDescription
getFinalDescription()
Get final module description, after hooks have had a chance to tweak it as needed.
Definition: ApiAMCreateAccount.php:38