MediaWiki REL1_27
SpecialCreateAccount.php
Go to the documentation of this file.
1<?php
26use Psr\Log\LogLevel;
27
34 protected static $allowedActions = [
35 AuthManager::ACTION_CREATE,
36 AuthManager::ACTION_CREATE_CONTINUE
37 ];
38
39 protected static $messages = [
40 'authform-newtoken' => 'nocookiesfornew',
41 'authform-notoken' => 'sessionfailure',
42 'authform-wrongtoken' => 'sessionfailure',
43 ];
44
45 public function __construct() {
46 parent::__construct( 'CreateAccount' );
47 }
48
49 public function doesWrites() {
50 return true;
51 }
52
53 public function isRestricted() {
54 return !User::groupHasPermission( '*', 'createaccount' );
55 }
56
57 public function userCanExecute( User $user ) {
58 return $user->isAllowed( 'createaccount' );
59 }
60
61 public function checkPermissions() {
62 parent::checkPermissions();
63
64 $user = $this->getUser();
65 $status = AuthManager::singleton()->checkAccountCreatePermissions( $user );
66 if ( !$status->isGood() ) {
67 throw new ErrorPageError( 'createacct-error', $status->getMessage() );
68 }
69 }
70
71 protected function getLoginSecurityLevel() {
72 return false;
73 }
74
75 protected function getDefaultAction( $subPage ) {
76 return AuthManager::ACTION_CREATE;
77 }
78
79 public function getDescription() {
80 return $this->msg( 'createaccount' )->text();
81 }
82
83 protected function isSignup() {
84 return true;
85 }
86
94 protected function successfulAction( $direct = false, $extraMessages = null ) {
95 $session = $this->getRequest()->getSession();
96 $user = $this->targetUser ?: $this->getUser();
97
98 if ( $direct ) {
99 # Only save preferences if the user is not creating an account for someone else.
100 if ( !$this->proxyAccountCreation ) {
101 Hooks::run( 'AddNewAccount', [ $user, false ] );
102
103 // If the user does not have a session cookie at this point, they probably need to
104 // do something to their browser.
105 if ( !$this->hasSessionCookie() ) {
106 $this->mainLoginForm( [ /*?*/ ], $session->getProvider()->whyNoSession() );
107 // TODO something more specific? This used to use nocookiesnew
108 // FIXME should redirect to login page instead?
109 return;
110 }
111 } else {
112 $byEmail = false; // FIXME no way to set this
113
114 Hooks::run( 'AddNewAccount', [ $user, $byEmail ] );
115
116 $out = $this->getOutput();
117 $out->setPageTitle( $this->msg( $byEmail ? 'accmailtitle' : 'accountcreated' ) );
118 if ( $byEmail ) {
119 $out->addWikiMsg( 'accmailtext', $user->getName(), $user->getEmail() );
120 } else {
121 $out->addWikiMsg( 'accountcreatedtext', $user->getName() );
122 }
123
124 $rt = Title::newFromText( $this->mReturnTo );
125 $out->addReturnTo(
126 ( $rt && !$rt->isExternal() ) ? $rt : $this->getPageTitle(),
127 wfCgiToArray( $this->mReturnToQuery )
128 );
129 return;
130 }
131 }
132
133 $this->clearToken();
134
135 # Run any hooks; display injected HTML
136 $injected_html = '';
137 $welcome_creation_msg = 'welcomecreation-msg';
138 Hooks::run( 'UserLoginComplete', [ &$user, &$injected_html ] );
139
145 Hooks::run( 'BeforeWelcomeCreation', [ &$welcome_creation_msg, &$injected_html ] );
146
147 $this->showSuccessPage( 'signup', $this->msg( 'welcomeuser', $this->getUser()->getName() ),
148 $welcome_creation_msg, $injected_html, $extraMessages );
149 }
150
151 protected function getToken() {
152 return $this->getRequest()->getSession()->getToken( '', 'createaccount' );
153 }
154
155 protected function clearToken() {
156 return $this->getRequest()->getSession()->resetToken( 'createaccount' );
157 }
158
159 protected function getTokenName() {
160 return 'wpCreateaccountToken';
161 }
162
163 protected function getGroupName() {
164 return 'login';
165 }
166
167 protected function logAuthResult( $success, $status = null ) {
168 LoggerFactory::getInstance( 'authmanager-stats' )->info( 'Account creation attempt', [
169 'event' => 'accountcreation',
170 'successful' => $success,
171 'status' => $status,
172 ] );
173 }
174}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
string $subPage
Subpage of the special page.
getRequest()
Get the WebRequest being used for this instance.
An error page which can definitely be safely rendered using the OutputPage.
Holds shared logic for login and account creation pages.
mainLoginForm(array $requests, $msg='', $msgtype='error')
showSuccessPage( $type, $title, $msgname, $injected_html, $extraMessages)
Show the success page.
hasSessionCookie()
Check if a session cookie is present.
This serves as the entry point to the authentication system.
PSR-3 logger instance factory.
Implements Special:CreateAccount.
getTokenName()
Returns the name of the CSRF token (under which it should be found in the POST or GET data).
successfulAction( $direct=false, $extraMessages=null)
Run any hooks registered for logins, then display a message welcoming the user.
getToken()
Returns the CSRF token.
logAuthResult( $success, $status=null)
Logs to the authmanager-stats channel.
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
doesWrites()
Indicates whether this special page may perform database writes.
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
isRestricted()
Can be overridden by subclasses with more complicated permissions schemes.
getDescription()
Returns the name that goes in the <h1> in the special page itself, and also the name that will be l...
userCanExecute(User $user)
Checks if the given user (identified by an object) can execute this special page (as defined by $mRes...
getLoginSecurityLevel()
Tells if the special page does something security-sensitive and needs extra defense against a stolen ...
getDefaultAction( $subPage)
Get the default action for this special page, if none is given via URL/POST data.
getName()
Get the name of this Special Page.
getOutput()
Get the OutputPage being used for this instance.
getUser()
Shortcut to get the User executing this instance.
getPageTitle( $subpage=false)
Get a self-referential title object.
msg()
Wrapper around wfMessage that sets the current context.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition Title.php:277
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition hooks.txt:1007
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:249
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:846
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