MediaWiki REL1_33
ApiAMCreateAccount.php
Go to the documentation of this file.
1<?php
25
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() {
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
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}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Create an account with AuthManager.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
isReadMode()
Indicates whether this module requires read rights.
dynamicParameterDocumentation()
Indicate if the module supports dynamically-determined parameters that cannot be included in self::ge...
getFinalDescription()
Get final module description, after hooks have had a chance to tweak it as needed.
__construct(ApiMain $main, $action)
getHelpUrls()
Return links to more detailed help pages about the module.
needsToken()
Returns the token type this module requires in order to execute.
getExamplesMessages()
Returns usage examples for this module.
isWriteMode()
Indicates whether this module requires write mode.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Helper class for AuthManager-using API modules.
static getStandardParams( $action, $param)
Fetch the standard parameters this helper recognizes.
This abstract class implements many basic API functions, and is the base of all API classes.
Definition ApiBase.php:37
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition ApiBase.php:520
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition ApiBase.php:721
static makeMessage( $msg, IContextSource $context, array $params=null)
Create a Message from a string or array.
Definition ApiBase.php:1776
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1990
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition ApiBase.php:131
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
getModulePath()
Get the path to this module.
Definition ApiBase.php:576
requireAtLeastOneParameter( $params, $required)
Die if none of a certain set of parameters is set and not false.
Definition ApiBase.php:941
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:512
This is the main API class, used for both external and internal processing.
Definition ApiMain.php:41
getContext()
Get the base IContextSource object.
This serves as the entry point to the authentication system.
This is a value object to hold authentication response data.
$res
Definition database.txt:21
this hook is for auditing only $req
Definition hooks.txt:979
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
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