MediaWiki  1.29.2
SpecialCreateAccount.php
Go to the documentation of this file.
1 <?php
26 
33  protected static $allowedActions = [
34  AuthManager::ACTION_CREATE,
35  AuthManager::ACTION_CREATE_CONTINUE
36  ];
37 
38  protected static $messages = [
39  'authform-newtoken' => 'nocookiesfornew',
40  'authform-notoken' => 'sessionfailure',
41  'authform-wrongtoken' => 'sessionfailure',
42  ];
43 
44  public function __construct() {
45  parent::__construct( 'CreateAccount' );
46  }
47 
48  public function doesWrites() {
49  return true;
50  }
51 
52  public function isRestricted() {
53  return !User::groupHasPermission( '*', 'createaccount' );
54  }
55 
56  public function userCanExecute( User $user ) {
57  return $user->isAllowed( 'createaccount' );
58  }
59 
60  public function checkPermissions() {
61  parent::checkPermissions();
62 
63  $user = $this->getUser();
64  $status = AuthManager::singleton()->checkAccountCreatePermissions( $user );
65  if ( !$status->isGood() ) {
66  throw new ErrorPageError( 'createacct-error', $status->getMessage() );
67  }
68  }
69 
70  protected function getLoginSecurityLevel() {
71  return false;
72  }
73 
74  protected function getDefaultAction( $subPage ) {
75  return AuthManager::ACTION_CREATE;
76  }
77 
78  public function getDescription() {
79  return $this->msg( 'createaccount' )->text();
80  }
81 
82  protected function isSignup() {
83  return true;
84  }
85 
93  protected function successfulAction( $direct = false, $extraMessages = null ) {
94  $session = $this->getRequest()->getSession();
95  $user = $this->targetUser ?: $this->getUser();
96 
97  if ( $direct ) {
98  # Only save preferences if the user is not creating an account for someone else.
99  if ( !$this->proxyAccountCreation ) {
100  Hooks::run( 'AddNewAccount', [ $user, false ] );
101 
102  // If the user does not have a session cookie at this point, they probably need to
103  // do something to their browser.
104  if ( !$this->hasSessionCookie() ) {
105  $this->mainLoginForm( [ /*?*/ ], $session->getProvider()->whyNoSession() );
106  // TODO something more specific? This used to use nocookiesnew
107  // FIXME should redirect to login page instead?
108  return;
109  }
110  } else {
111  $byEmail = false; // FIXME no way to set this
112 
113  Hooks::run( 'AddNewAccount', [ $user, $byEmail ] );
114 
115  $out = $this->getOutput();
116  $out->setPageTitle( $this->msg( $byEmail ? 'accmailtitle' : 'accountcreated' ) );
117  if ( $byEmail ) {
118  $out->addWikiMsg( 'accmailtext', $user->getName(), $user->getEmail() );
119  } else {
120  $out->addWikiMsg( 'accountcreatedtext', $user->getName() );
121  }
122 
123  $rt = Title::newFromText( $this->mReturnTo );
124  $out->addReturnTo(
125  ( $rt && !$rt->isExternal() ) ? $rt : $this->getPageTitle(),
126  wfCgiToArray( $this->mReturnToQuery )
127  );
128  return;
129  }
130  }
131 
132  $this->clearToken();
133 
134  # Run any hooks; display injected HTML
135  $injected_html = '';
136  $welcome_creation_msg = 'welcomecreation-msg';
137  Hooks::run( 'UserLoginComplete', [ &$user, &$injected_html, $direct ] );
138 
144  Hooks::run( 'BeforeWelcomeCreation', [ &$welcome_creation_msg, &$injected_html ] );
145 
146  $this->showSuccessPage( 'signup', $this->msg( 'welcomeuser', $this->getUser()->getName() ),
147  $welcome_creation_msg, $injected_html, $extraMessages );
148  }
149 
150  protected function getToken() {
151  return $this->getRequest()->getSession()->getToken( '', 'createaccount' );
152  }
153 
154  protected function clearToken() {
155  return $this->getRequest()->getSession()->resetToken( 'createaccount' );
156  }
157 
158  protected function getTokenName() {
159  return 'wpCreateaccountToken';
160  }
161 
162  protected function getGroupName() {
163  return 'login';
164  }
165 
166  protected function logAuthResult( $success, $status = null ) {
167  LoggerFactory::getInstance( 'authevents' )->info( 'Account creation attempt', [
168  'event' => 'accountcreation',
169  'successful' => $success,
170  'status' => $status,
171  ] );
172  }
173 }
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:628
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:265
SpecialCreateAccount\getDefaultAction
getDefaultAction( $subPage)
Get the default action for this special page, if none is given via URL/POST data.
Definition: SpecialCreateAccount.php:74
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:675
LoginSignupSpecialPage\showSuccessPage
showSuccessPage( $type, $title, $msgname, $injected_html, $extraMessages)
Show the success page.
Definition: LoginSignupSpecialPage.php:426
SpecialCreateAccount\$messages
static $messages
Definition: SpecialCreateAccount.php:38
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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:1049
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$user
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 account $user
Definition: hooks.txt:246
SpecialCreateAccount\isSignup
isSignup()
Definition: SpecialCreateAccount.php:82
SpecialCreateAccount\getTokenName
getTokenName()
Returns the name of the CSRF token (under which it should be found in the POST or GET data).
Definition: SpecialCreateAccount.php:158
SpecialCreateAccount\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialCreateAccount.php:48
$success
$success
Definition: NoLocalSettings.php:44
User\groupHasPermission
static groupHasPermission( $group, $role)
Check, if the given group has the given permission.
Definition: User.php:4766
SpecialPage\getName
getName()
Get the name of this Special Page.
Definition: SpecialPage.php:150
SpecialCreateAccount\successfulAction
successfulAction( $direct=false, $extraMessages=null)
Run any hooks registered for logins, then display a message welcoming the user.
Definition: SpecialCreateAccount.php:93
php
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
SpecialCreateAccount\clearToken
clearToken()
Definition: SpecialCreateAccount.php:154
SpecialCreateAccount
Implements Special:CreateAccount.
Definition: SpecialCreateAccount.php:32
SpecialCreateAccount\getDescription
getDescription()
Returns the name that goes in the <h1> in the special page itself, and also the name that will be l...
Definition: SpecialCreateAccount.php:78
AuthManagerSpecialPage\$subPage
string $subPage
Subpage of the special page.
Definition: AuthManagerSpecialPage.php:34
LoginSignupSpecialPage
Holds shared logic for login and account creation pages.
Definition: LoginSignupSpecialPage.php:36
SpecialCreateAccount\getLoginSecurityLevel
getLoginSecurityLevel()
Tells if the special page does something security-sensitive and needs extra defense against a stolen ...
Definition: SpecialCreateAccount.php:70
wfCgiToArray
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
Definition: GlobalFunctions.php:453
LoginSignupSpecialPage\mainLoginForm
mainLoginForm(array $requests, $msg='', $msgtype='error')
Definition: LoginSignupSpecialPage.php:507
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:685
LoginSignupSpecialPage\hasSessionCookie
hasSessionCookie()
Check if a session cookie is present.
Definition: LoginSignupSpecialPage.php:1227
SpecialCreateAccount\__construct
__construct()
Definition: SpecialCreateAccount.php:44
SpecialCreateAccount\logAuthResult
logAuthResult( $success, $status=null)
Logs to the authmanager-stats channel.
Definition: SpecialCreateAccount.php:166
SpecialCreateAccount\$allowedActions
static $allowedActions
Definition: SpecialCreateAccount.php:33
SpecialPage\msg
msg()
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:746
MediaWiki\Auth\AuthManager
This serves as the entry point to the authentication system.
Definition: AuthManager.php:82
SpecialCreateAccount\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialCreateAccount.php:162
SpecialCreateAccount\getToken
getToken()
Returns the CSRF token.
Definition: SpecialCreateAccount.php:150
SpecialCreateAccount\checkPermissions
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
Definition: SpecialCreateAccount.php:60
SpecialCreateAccount\isRestricted
isRestricted()
Can be overridden by subclasses with more complicated permissions schemes.
Definition: SpecialCreateAccount.php:52
LoggerFactory
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
AuthManagerSpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: AuthManagerSpecialPage.php:63
SpecialCreateAccount\userCanExecute
userCanExecute(User $user)
Checks if the given user (identified by an object) can execute this special page (as defined by $mRes...
Definition: SpecialCreateAccount.php:56
ErrorPageError
An error page which can definitely be safely rendered using the OutputPage.
Definition: ErrorPageError.php:27
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:50
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
$out
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:783