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