3 * Implements Special:UserLogin
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * Implements Special:UserLogin
27 * @ingroup SpecialPage
29 class LoginForm
extends SpecialPage
{
34 const WRONG_PLUGIN_PASS
= 3;
40 const CREATE_BLOCKED
= 9;
42 const USER_BLOCKED
= 11;
43 const NEED_TOKEN
= 12;
44 const WRONG_TOKEN
= 13;
46 var $mUsername, $mPassword, $mRetype, $mReturnTo, $mCookieCheck, $mPosted;
47 var $mAction, $mCreateaccount, $mCreateaccountMail;
48 var $mLoginattempt, $mRemember, $mEmail, $mDomain, $mLanguage;
49 var $mSkipCookieCheck, $mReturnToQuery, $mToken, $mStickHTTPS;
50 var $mType, $mReason, $mRealName;
51 var $mAbortLoginErrorMsg = 'login-abort-generic';
52 private $mLoaded = false;
57 private $mExtUser = null;
62 private $mOverrideRequest = null;
65 * @param WebRequest $request
67 public function __construct( $request = null ) {
68 parent
::__construct( 'Userlogin' );
70 $this->mOverrideRequest
= $request;
77 global $wgAuth, $wgHiddenPrefs, $wgEnableEmail;
79 if ( $this->mLoaded
) {
82 $this->mLoaded
= true;
84 if ( $this->mOverrideRequest
=== null ) {
85 $request = $this->getRequest();
87 $request = $this->mOverrideRequest
;
90 $this->mType
= $request->getText( 'type' );
91 $this->mUsername
= $request->getText( 'wpName' );
92 $this->mPassword
= $request->getText( 'wpPassword' );
93 $this->mRetype
= $request->getText( 'wpRetype' );
94 $this->mDomain
= $request->getText( 'wpDomain' );
95 $this->mReason
= $request->getText( 'wpReason' );
96 $this->mCookieCheck
= $request->getVal( 'wpCookieCheck' );
97 $this->mPosted
= $request->wasPosted();
98 $this->mCreateaccountMail
= $request->getCheck( 'wpCreateaccountMail' )
100 $this->mCreateaccount
= $request->getCheck( 'wpCreateaccount' ) && !$this->mCreateaccountMail
;
101 $this->mLoginattempt
= $request->getCheck( 'wpLoginattempt' );
102 $this->mAction
= $request->getVal( 'action' );
103 $this->mRemember
= $request->getCheck( 'wpRemember' );
104 $this->mStickHTTPS
= $request->getCheck( 'wpStickHTTPS' );
105 $this->mLanguage
= $request->getText( 'uselang' );
106 $this->mSkipCookieCheck
= $request->getCheck( 'wpSkipCookieCheck' );
107 $this->mToken
= ( $this->mType
== 'signup' ) ?
$request->getVal( 'wpCreateaccountToken' ) : $request->getVal( 'wpLoginToken' );
108 $this->mReturnTo
= $request->getVal( 'returnto', '' );
109 $this->mReturnToQuery
= $request->getVal( 'returntoquery', '' );
111 if( $wgEnableEmail ) {
112 $this->mEmail
= $request->getText( 'wpEmail' );
116 if( !in_array( 'realname', $wgHiddenPrefs ) ) {
117 $this->mRealName
= $request->getText( 'wpRealName' );
119 $this->mRealName
= '';
122 if( !$wgAuth->validDomain( $this->mDomain
) ) {
123 $this->mDomain
= $wgAuth->getDomain();
125 $wgAuth->setDomain( $this->mDomain
);
127 # 1. When switching accounts, it sucks to get automatically logged out
128 # 2. Do not return to PasswordReset after a successful password change
129 # but goto Wiki start page (Main_Page) instead ( bug 33997 )
130 $returnToTitle = Title
::newFromText( $this->mReturnTo
);
131 if( is_object( $returnToTitle ) && (
132 $returnToTitle->isSpecial( 'Userlogout' )
133 ||
$returnToTitle->isSpecial( 'PasswordReset' ) ) ) {
134 $this->mReturnTo
= '';
135 $this->mReturnToQuery
= '';
139 function getDescription() {
140 return $this->msg( $this->getUser()->isAllowed( 'createaccount' ) ?
141 'userlogin' : 'userloginnocreate' )->text();
144 public function execute( $par ) {
145 if ( session_id() == '' ) {
152 global $wgSecureLogin;
154 $this->mType
!== 'signup' &&
156 WebRequest
::detectProtocol() !== 'https'
158 $title = $this->getFullTitle();
160 'returnto' => $this->mReturnTo
,
161 'returntoquery' => $this->mReturnToQuery
,
162 'wpStickHTTPS' => $this->mStickHTTPS
164 $url = $title->getFullURL( $query, false, PROTO_HTTPS
);
165 $this->getOutput()->redirect( $url );
169 if ( $par == 'signup' ) { # Check for [[Special:Userlogin/signup]]
170 $this->mType
= 'signup';
173 if ( !is_null( $this->mCookieCheck
) ) {
174 $this->onCookieRedirectCheck( $this->mCookieCheck
);
176 } elseif( $this->mPosted
) {
177 if( $this->mCreateaccount
) {
178 $this->addNewAccount();
180 } elseif ( $this->mCreateaccountMail
) {
181 $this->addNewAccountMailPassword();
183 } elseif ( ( 'submitlogin' == $this->mAction
) ||
$this->mLoginattempt
) {
184 $this->processLogin();
188 $this->mainLoginForm( '' );
194 function addNewAccountMailPassword() {
195 if ( $this->mEmail
== '' ) {
196 $this->mainLoginForm( $this->msg( 'noemailcreate' )->escaped() );
200 $status = $this->addNewaccountInternal();
201 if( !$status->isGood() ) {
202 $error = $this->getOutput()->parse( $status->getWikiText() );
203 $this->mainLoginForm( $error );
207 $u = $status->getValue();
209 // Wipe the initial password and mail a temporary one
210 $u->setPassword( null );
212 $result = $this->mailPasswordInternal( $u, false, 'createaccount-title', 'createaccount-text' );
214 wfRunHooks( 'AddNewAccount', array( $u, true ) );
215 $u->addNewUserLogEntry( 'byemail', $this->mReason
);
217 $out = $this->getOutput();
218 $out->setPageTitle( $this->msg( 'accmailtitle' ) );
220 if( !$result->isGood() ) {
221 $this->mainLoginForm( $this->msg( 'mailerror', $result->getWikiText() )->text() );
223 $out->addWikiMsg( 'accmailtext', $u->getName(), $u->getEmail() );
224 $this->executeReturnTo( 'success' );
232 function addNewAccount() {
233 global $wgContLang, $wgUser, $wgEmailAuthentication, $wgLoginLanguageSelector;
235 # Create the account and abort if there's a problem doing so
236 $status = $this->addNewAccountInternal();
237 if( !$status->isGood() ) {
238 $error = $this->getOutput()->parse( $status->getWikiText() );
239 $this->mainLoginForm( $error );
243 $u = $status->getValue();
245 # Only save preferences if the user is not creating an account for someone else.
246 if ( $this->getUser()->isAnon() ) {
247 # If we showed up language selection links, and one was in use, be
248 # smart (and sensible) and save that language as the user's preference
249 if( $wgLoginLanguageSelector && $this->mLanguage
) {
250 $u->setOption( 'language', $this->mLanguage
);
253 # Otherwise the user's language preference defaults to $wgContLang,
254 # but it may be better to set it to their preferred $wgContLang variant,
255 # based on browser preferences or URL parameters.
256 $u->setOption( 'language', $wgContLang->getPreferredVariant() );
258 if ( $wgContLang->hasVariants() ) {
259 $u->setOption( 'variant', $wgContLang->getPreferredVariant() );
263 $out = $this->getOutput();
265 # Send out an email authentication message if needed
266 if( $wgEmailAuthentication && Sanitizer
::validateEmail( $u->getEmail() ) ) {
267 $status = $u->sendConfirmationMail();
268 if( $status->isGood() ) {
269 $out->addWikiMsg( 'confirmemail_oncreate' );
271 $out->addWikiText( $status->getWikiText( 'confirmemail_sendfailed' ) );
275 # Save settings (including confirmation token)
278 # If not logged in, assume the new account as the current one and set
279 # session cookies then show a "welcome" message or a "need cookies"
281 if( $this->getUser()->isAnon() ) {
284 // This should set it for OutputPage and the Skin
285 // which is needed or the personal links will be
287 $this->getContext()->setUser( $u );
288 wfRunHooks( 'AddNewAccount', array( $u, false ) );
289 $u->addNewUserLogEntry( 'create' );
290 if( $this->hasSessionCookie() ) {
291 $this->successfulCreation();
293 $this->cookieRedirectCheck( 'new' );
296 # Confirm that the account was created
297 $out->setPageTitle( $this->msg( 'accountcreated' ) );
298 $out->addWikiMsg( 'accountcreatedtext', $u->getName() );
299 $out->addReturnTo( $this->getTitle() );
300 wfRunHooks( 'AddNewAccount', array( $u, false ) );
301 $u->addNewUserLogEntry( 'create2', $this->mReason
);
307 * Make a new user account using the loaded data.
309 * @throws PermissionsError|ReadOnlyError
312 public function addNewAccountInternal() {
313 global $wgAuth, $wgMemc, $wgAccountCreationThrottle,
314 $wgMinimalPasswordLength, $wgEmailConfirmToEdit;
316 // If the user passes an invalid domain, something is fishy
317 if( !$wgAuth->validDomain( $this->mDomain
) ) {
318 return Status
::newFatal( 'wrongpassword' );
321 // If we are not allowing users to login locally, we should be checking
322 // to see if the user is actually able to authenticate to the authenti-
323 // cation server before they create an account (otherwise, they can
324 // create a local account and login as any domain user). We only need
325 // to check this for domains that aren't local.
326 if( 'local' != $this->mDomain
&& $this->mDomain
!= '' ) {
328 !$wgAuth->canCreateAccounts() &&
330 !$wgAuth->userExists( $this->mUsername
) ||
331 !$wgAuth->authenticate( $this->mUsername
, $this->mPassword
)
334 return Status
::newFatal( 'wrongpassword' );
338 if ( wfReadOnly() ) {
339 throw new ReadOnlyError
;
342 # Request forgery checks.
343 if ( !self
::getCreateaccountToken() ) {
344 self
::setCreateaccountToken();
345 return Status
::newFatal( 'nocookiesfornew' );
348 # The user didn't pass a createaccount token
349 if ( !$this->mToken
) {
350 return Status
::newFatal( 'sessionfailure' );
353 # Validate the createaccount token
354 if ( $this->mToken
!== self
::getCreateaccountToken() ) {
355 return Status
::newFatal( 'sessionfailure' );
359 $currentUser = $this->getUser();
360 $creationBlock = $currentUser->isBlockedFromCreateAccount();
361 if ( !$currentUser->isAllowed( 'createaccount' ) ) {
362 throw new PermissionsError( 'createaccount' );
363 } elseif ( $creationBlock instanceof Block
) {
364 // Throws an ErrorPageError.
365 $this->userBlockedMessage( $creationBlock );
366 // This should never be reached.
370 # Include checks that will include GlobalBlocking (Bug 38333)
371 $permErrors = $this->getTitle()->getUserPermissionsErrors( 'createaccount', $currentUser, true );
372 if ( count( $permErrors ) ) {
373 throw new PermissionsError( 'createaccount', $permErrors );
376 $ip = $this->getRequest()->getIP();
377 if ( $currentUser->isDnsBlacklisted( $ip, true /* check $wgProxyWhitelist */ ) ) {
378 return Status
::newFatal( 'sorbs_create_account_reason' );
381 # Now create a dummy user ($u) and check if it is valid
382 $name = trim( $this->mUsername
);
383 $u = User
::newFromName( $name, 'creatable' );
384 if ( !is_object( $u ) ) {
385 return Status
::newFatal( 'noname' );
386 } elseif ( 0 != $u->idForName() ) {
387 return Status
::newFatal( 'userexists' );
390 if ( $this->mCreateaccountMail
) {
391 # do not force a password for account creation by email
392 # set invalid password, it will be replaced later by a random generated password
393 $this->mPassword
= null;
395 if ( $this->mPassword
!== $this->mRetype
) {
396 return Status
::newFatal( 'badretype' );
399 # check for minimal password length
400 $valid = $u->getPasswordValidity( $this->mPassword
);
401 if ( $valid !== true ) {
402 if ( !is_array( $valid ) ) {
403 $valid = array( $valid, $wgMinimalPasswordLength );
405 return call_user_func_array( 'Status::newFatal', $valid );
409 # if you need a confirmed email address to edit, then obviously you
410 # need an email address.
411 if ( $wgEmailConfirmToEdit && strval( $this->mEmail
) === '' ) {
412 return Status
::newFatal( 'noemailtitle' );
415 if ( strval( $this->mEmail
) !== '' && !Sanitizer
::validateEmail( $this->mEmail
) ) {
416 return Status
::newFatal( 'invalidemailaddress' );
419 # Set some additional data so the AbortNewAccount hook can be used for
420 # more than just username validation
421 $u->setEmail( $this->mEmail
);
422 $u->setRealName( $this->mRealName
);
425 if( !wfRunHooks( 'AbortNewAccount', array( $u, &$abortError ) ) ) {
426 // Hook point to add extra creation throttles and blocks
427 wfDebug( "LoginForm::addNewAccountInternal: a hook blocked creation\n" );
428 return Status
::newFatal( new RawMessage( $abortError ) );
431 // Hook point to check for exempt from account creation throttle
432 if ( !wfRunHooks( 'ExemptFromAccountCreationThrottle', array( $ip ) ) ) {
433 wfDebug( "LoginForm::exemptFromAccountCreationThrottle: a hook allowed account creation w/o throttle\n" );
435 if ( ( $wgAccountCreationThrottle && $currentUser->isPingLimitable() ) ) {
436 $key = wfMemcKey( 'acctcreate', 'ip', $ip );
437 $value = $wgMemc->get( $key );
439 $wgMemc->set( $key, 0, 86400 );
441 if ( $value >= $wgAccountCreationThrottle ) {
442 return Status
::newFatal( 'acct_creation_throttle_hit', $wgAccountCreationThrottle );
444 $wgMemc->incr( $key );
448 if( !$wgAuth->addUser( $u, $this->mPassword
, $this->mEmail
, $this->mRealName
) ) {
449 return Status
::newFatal( 'externaldberror' );
452 self
::clearCreateaccountToken();
453 return $this->initUser( $u, false );
457 * Actually add a user to the database.
458 * Give it a User object that has been initialised with a name.
460 * @param $u User object.
461 * @param $autocreate boolean -- true if this is an autocreation via auth plugin
462 * @return Status object, with the User object in the value member on success
465 function initUser( $u, $autocreate ) {
468 $status = $u->addToDatabase();
469 if ( !$status->isOK() ) {
473 if ( $wgAuth->allowPasswordChange() ) {
474 $u->setPassword( $this->mPassword
);
477 $u->setEmail( $this->mEmail
);
478 $u->setRealName( $this->mRealName
);
481 $wgAuth->initUser( $u, $autocreate );
483 if ( $this->mExtUser
) {
484 $this->mExtUser
->linkToLocal( $u->getId() );
485 $email = $this->mExtUser
->getPref( 'emailaddress' );
486 if ( $email && !$this->mEmail
) {
487 $u->setEmail( $email );
491 $u->setOption( 'rememberpassword', $this->mRemember ?
1 : 0 );
495 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 0, 0, 0, 1 ) );
497 return Status
::newGood( $u );
501 * Internally authenticate the login request.
503 * This may create a local account as a side effect if the
504 * authentication plugin allows transparent local account
508 public function authenticateUserData() {
509 global $wgUser, $wgAuth;
513 if ( $this->mUsername
== '' ) {
514 return self
::NO_NAME
;
517 // We require a login token to prevent login CSRF
518 // Handle part of this before incrementing the throttle so
519 // token-less login attempts don't count towards the throttle
520 // but wrong-token attempts do.
522 // If the user doesn't have a login token yet, set one.
523 if ( !self
::getLoginToken() ) {
524 self
::setLoginToken();
525 return self
::NEED_TOKEN
;
527 // If the user didn't pass a login token, tell them we need one
528 if ( !$this->mToken
) {
529 return self
::NEED_TOKEN
;
532 $throttleCount = self
::incLoginThrottle( $this->mUsername
);
533 if ( $throttleCount === true ) {
534 return self
::THROTTLED
;
537 // Validate the login token
538 if ( $this->mToken
!== self
::getLoginToken() ) {
539 return self
::WRONG_TOKEN
;
542 // Load the current user now, and check to see if we're logging in as
543 // the same name. This is necessary because loading the current user
544 // (say by calling getName()) calls the UserLoadFromSession hook, which
545 // potentially creates the user in the database. Until we load $wgUser,
546 // checking for user existence using User::newFromName($name)->getId() below
547 // will effectively be using stale data.
548 if ( $this->getUser()->getName() === $this->mUsername
) {
549 wfDebug( __METHOD__
. ": already logged in as {$this->mUsername}\n" );
550 return self
::SUCCESS
;
553 $this->mExtUser
= ExternalUser
::newFromName( $this->mUsername
);
555 # TODO: Allow some magic here for invalid external names, e.g., let the
556 # user choose a different wiki name.
557 $u = User
::newFromName( $this->mUsername
);
558 if( !( $u instanceof User
) ||
!User
::isUsableName( $u->getName() ) ) {
559 return self
::ILLEGAL
;
562 $isAutoCreated = false;
563 if ( $u->getID() == 0 ) {
564 $status = $this->attemptAutoCreate( $u );
565 if ( $status !== self
::SUCCESS
) {
568 $isAutoCreated = true;
571 global $wgExternalAuthType, $wgAutocreatePolicy;
572 if ( $wgExternalAuthType && $wgAutocreatePolicy != 'never'
573 && is_object( $this->mExtUser
)
574 && $this->mExtUser
->authenticate( $this->mPassword
)
576 # The external user and local user have the same name and
577 # password, so we assume they're the same.
578 $this->mExtUser
->linkToLocal( $u->getID() );
584 // Give general extensions, such as a captcha, a chance to abort logins
585 $abort = self
::ABORTED
;
586 if( !wfRunHooks( 'AbortLogin', array( $u, $this->mPassword
, &$abort, &$this->mAbortLoginErrorMsg
) ) ) {
590 global $wgBlockDisablesLogin;
591 if ( !$u->checkPassword( $this->mPassword
) ) {
592 if( $u->checkTemporaryPassword( $this->mPassword
) ) {
593 // The e-mailed temporary password should not be used for actu-
594 // al logins; that's a very sloppy habit, and insecure if an
595 // attacker has a few seconds to click "search" on someone's o-
598 // Allow it to be used only to reset the password a single time
599 // to a new value, which won't be in the user's e-mail ar-
602 // For backwards compatibility, we'll still recognize it at the
603 // login form to minimize surprises for people who have been
604 // logging in with a temporary password for some time.
606 // As a side-effect, we can authenticate the user's e-mail ad-
607 // dress if it's not already done, since the temporary password
608 // was sent via e-mail.
609 if( !$u->isEmailConfirmed() ) {
614 // At this point we just return an appropriate code/ indicating
615 // that the UI should show a password reset form; bot inter-
616 // faces etc will probably just fail cleanly here.
617 $retval = self
::RESET_PASS
;
619 $retval = ( $this->mPassword
== '' ) ? self
::EMPTY_PASS
: self
::WRONG_PASS
;
621 } elseif ( $wgBlockDisablesLogin && $u->isBlocked() ) {
622 // If we've enabled it, make it so that a blocked user cannot login
623 $retval = self
::USER_BLOCKED
;
625 $wgAuth->updateUser( $u );
627 // This should set it for OutputPage and the Skin
628 // which is needed or the personal links will be
630 $this->getContext()->setUser( $u );
632 // Please reset throttle for successful logins, thanks!
633 if ( $throttleCount ) {
634 self
::clearLoginThrottle( $this->mUsername
);
637 if ( $isAutoCreated ) {
638 // Must be run after $wgUser is set, for correct new user log
639 wfRunHooks( 'AuthPluginAutoCreate', array( $u ) );
642 $retval = self
::SUCCESS
;
644 wfRunHooks( 'LoginAuthenticateAudit', array( $u, $this->mPassword
, $retval ) );
649 * Increment the login attempt throttle hit count for the (username,current IP)
650 * tuple unless the throttle was already reached.
651 * @param string $username The user name
652 * @return Bool|Integer The integer hit count or True if it is already at the limit
654 public static function incLoginThrottle( $username ) {
655 global $wgPasswordAttemptThrottle, $wgMemc, $wgRequest;
656 $username = trim( $username ); // sanity
659 if ( is_array( $wgPasswordAttemptThrottle ) ) {
660 $throttleKey = wfMemcKey( 'password-throttle', $wgRequest->getIP(), md5( $username ) );
661 $count = $wgPasswordAttemptThrottle['count'];
662 $period = $wgPasswordAttemptThrottle['seconds'];
664 $throttleCount = $wgMemc->get( $throttleKey );
665 if ( !$throttleCount ) {
666 $wgMemc->add( $throttleKey, 1, $period ); // start counter
667 } elseif ( $throttleCount < $count ) {
668 $wgMemc->incr( $throttleKey );
669 } elseif ( $throttleCount >= $count ) {
674 return $throttleCount;
678 * Clear the login attempt throttle hit count for the (username,current IP) tuple.
679 * @param string $username The user name
682 public static function clearLoginThrottle( $username ) {
683 global $wgMemc, $wgRequest;
684 $username = trim( $username ); // sanity
686 $throttleKey = wfMemcKey( 'password-throttle', $wgRequest->getIP(), md5( $username ) );
687 $wgMemc->delete( $throttleKey );
691 * Attempt to automatically create a user on login. Only succeeds if there
692 * is an external authentication method which allows it.
696 * @return integer Status code
698 function attemptAutoCreate( $user ) {
699 global $wgAuth, $wgAutocreatePolicy;
701 if ( $this->getUser()->isBlockedFromCreateAccount() ) {
702 wfDebug( __METHOD__
. ": user is blocked from account creation\n" );
703 return self
::CREATE_BLOCKED
;
707 * If the external authentication plugin allows it, automatically cre-
708 * ate a new account for users that are externally defined but have not
711 if ( $this->mExtUser
) {
712 # mExtUser is neither null nor false, so use the new ExternalAuth
714 if ( $wgAutocreatePolicy == 'never' ) {
715 return self
::NOT_EXISTS
;
717 if ( !$this->mExtUser
->authenticate( $this->mPassword
) ) {
718 return self
::WRONG_PLUGIN_PASS
;
722 if ( !$wgAuth->autoCreate() ) {
723 return self
::NOT_EXISTS
;
725 if ( !$wgAuth->userExists( $user->getName() ) ) {
726 wfDebug( __METHOD__
. ": user does not exist\n" );
727 return self
::NOT_EXISTS
;
729 if ( !$wgAuth->authenticate( $user->getName(), $this->mPassword
) ) {
730 wfDebug( __METHOD__
. ": \$wgAuth->authenticate() returned false, aborting\n" );
731 return self
::WRONG_PLUGIN_PASS
;
736 if( !wfRunHooks( 'AbortAutoAccount', array( $user, &$abortError ) ) ) {
737 // Hook point to add extra creation throttles and blocks
738 wfDebug( "LoginForm::attemptAutoCreate: a hook blocked creation: $abortError\n" );
739 $this->mAbortLoginErrorMsg
= $abortError;
740 return self
::ABORTED
;
743 wfDebug( __METHOD__
. ": creating account\n" );
744 $status = $this->initUser( $user, true );
746 if ( !$status->isOK() ) {
747 $errors = $status->getErrorsByType( 'error' );
748 $this->mAbortLoginErrorMsg
= $errors[0]['message'];
749 return self
::ABORTED
;
752 return self
::SUCCESS
;
755 function processLogin() {
756 global $wgMemc, $wgLang, $wgSecureLogin;
758 switch ( $this->authenticateUserData() ) {
760 # We've verified now, update the real record
761 $user = $this->getUser();
762 if( (bool)$this->mRemember
!= $user->getBoolOption( 'rememberpassword' ) ) {
763 $user->setOption( 'rememberpassword', $this->mRemember ?
1 : 0 );
764 $user->saveSettings();
766 $user->invalidateCache();
769 if( $wgSecureLogin && !$this->mStickHTTPS
) {
770 $user->setCookies( null, false );
774 self
::clearLoginToken();
776 // Reset the throttle
777 $request = $this->getRequest();
778 $key = wfMemcKey( 'password-throttle', $request->getIP(), md5( $this->mUsername
) );
779 $wgMemc->delete( $key );
781 if( $this->hasSessionCookie() ||
$this->mSkipCookieCheck
) {
782 /* Replace the language object to provide user interface in
783 * correct language immediately on this first page load.
785 $code = $request->getVal( 'uselang', $user->getOption( 'language' ) );
786 $userLang = Language
::factory( $code );
788 $this->getContext()->setLanguage( $userLang );
789 // Reset SessionID on Successful login (bug 40995)
790 $this->renewSessionId();
791 $this->successfulLogin();
793 $this->cookieRedirectCheck( 'login' );
797 case self
::NEED_TOKEN
:
798 $this->mainLoginForm( $this->msg( 'nocookiesforlogin' )->parse() );
800 case self
::WRONG_TOKEN
:
801 $this->mainLoginForm( $this->msg( 'sessionfailure' )->text() );
805 $this->mainLoginForm( $this->msg( 'noname' )->text() );
807 case self
::WRONG_PLUGIN_PASS
:
808 $this->mainLoginForm( $this->msg( 'wrongpassword' )->text() );
810 case self
::NOT_EXISTS
:
811 if( $this->getUser()->isAllowed( 'createaccount' ) ) {
812 $this->mainLoginForm( $this->msg( 'nosuchuser',
813 wfEscapeWikiText( $this->mUsername
) )->parse() );
815 $this->mainLoginForm( $this->msg( 'nosuchusershort',
816 wfEscapeWikiText( $this->mUsername
) )->text() );
819 case self
::WRONG_PASS
:
820 $this->mainLoginForm( $this->msg( 'wrongpassword' )->text() );
822 case self
::EMPTY_PASS
:
823 $this->mainLoginForm( $this->msg( 'wrongpasswordempty' )->text() );
825 case self
::RESET_PASS
:
826 $this->resetLoginForm( $this->msg( 'resetpass_announce' )->text() );
828 case self
::CREATE_BLOCKED
:
829 $this->userBlockedMessage( $this->getUser()->mBlock
);
831 case self
::THROTTLED
:
832 $this->mainLoginForm( $this->msg( 'login-throttled' )->text() );
834 case self
::USER_BLOCKED
:
835 $this->mainLoginForm( $this->msg( 'login-userblocked',
836 $this->mUsername
)->escaped() );
839 $this->mainLoginForm( $this->msg( $this->mAbortLoginErrorMsg
)->text() );
842 throw new MWException( 'Unhandled case value' );
847 * @param $error string
849 function resetLoginForm( $error ) {
850 $this->getOutput()->addHTML( Xml
::element( 'p', array( 'class' => 'error' ), $error ) );
851 $reset = new SpecialChangePassword();
852 $reset->setContext( $this->getContext() );
853 $reset->execute( null );
857 * @param $u User object
858 * @param $throttle Boolean
859 * @param string $emailTitle message name of email title
860 * @param string $emailText message name of email text
861 * @return Status object
863 function mailPasswordInternal( $u, $throttle = true, $emailTitle = 'passwordremindertitle', $emailText = 'passwordremindertext' ) {
864 global $wgCanonicalServer, $wgScript, $wgNewPasswordExpiry;
866 if ( $u->getEmail() == '' ) {
867 return Status
::newFatal( 'noemail', $u->getName() );
869 $ip = $this->getRequest()->getIP();
871 return Status
::newFatal( 'badipaddress' );
874 $currentUser = $this->getUser();
875 wfRunHooks( 'User::mailPasswordInternal', array( &$currentUser, &$ip, &$u ) );
877 $np = $u->randomPassword();
878 $u->setNewpassword( $np, $throttle );
880 $userLanguage = $u->getOption( 'language' );
881 $m = $this->msg( $emailText, $ip, $u->getName(), $np, '<' . $wgCanonicalServer . $wgScript . '>',
882 round( $wgNewPasswordExpiry / 86400 ) )->inLanguage( $userLanguage )->text();
883 $result = $u->sendMail( $this->msg( $emailTitle )->inLanguage( $userLanguage )->text(), $m );
889 * Run any hooks registered for logins, then HTTP redirect to
890 * $this->mReturnTo (or Main Page if that's undefined). Formerly we had a
891 * nice message here, but that's really not as useful as just being sent to
892 * wherever you logged in from. It should be clear that the action was
893 * successful, given the lack of error messages plus the appearance of your
894 * name in the upper right.
898 function successfulLogin() {
899 # Run any hooks; display injected HTML if any, else redirect
900 $currentUser = $this->getUser();
902 wfRunHooks( 'UserLoginComplete', array( &$currentUser, &$injected_html ) );
904 if( $injected_html !== '' ) {
905 $this->displaySuccessfulAction( $this->msg( 'loginsuccesstitle' ),
906 'loginsuccess', $injected_html );
908 $this->executeReturnTo( 'successredirect' );
913 * Run any hooks registered for logins, then display a message welcoming
918 function successfulCreation() {
919 # Run any hooks; display injected HTML
920 $currentUser = $this->getUser();
922 $welcome_creation_msg = 'welcomecreation-msg';
924 wfRunHooks( 'UserLoginComplete', array( &$currentUser, &$injected_html ) );
927 * Let any extensions change what message is shown.
928 * @see https://www.mediawiki.org/wiki/Manual:Hooks/BeforeWelcomeCreation
931 wfRunHooks( 'BeforeWelcomeCreation', array( &$welcome_creation_msg, &$injected_html ) );
933 $this->displaySuccessfulAction( $this->msg( 'welcomeuser', $this->getUser()->getName() ),
934 $welcome_creation_msg, $injected_html );
938 * Display an "successful action" page.
940 * @param string|Message $title page's title
941 * @param $msgname string
942 * @param $injected_html string
944 private function displaySuccessfulAction( $title, $msgname, $injected_html ) {
945 $out = $this->getOutput();
946 $out->setPageTitle( $title );
948 $out->addWikiMsg( $msgname, wfEscapeWikiText( $this->getUser()->getName() ) );
951 $out->addHTML( $injected_html );
953 $this->executeReturnTo( 'success' );
957 * Output a message that informs the user that they cannot create an account because
958 * there is a block on them or their IP which prevents account creation. Note that
959 * User::isBlockedFromCreateAccount(), which gets this block, ignores the 'hardblock'
960 * setting on blocks (bug 13611).
961 * @param $block Block the block causing this error
962 * @throws ErrorPageError
964 function userBlockedMessage( Block
$block ) {
965 # Let's be nice about this, it's likely that this feature will be used
966 # for blocking large numbers of innocent people, e.g. range blocks on
967 # schools. Don't blame it on the user. There's a small chance that it
968 # really is the user's fault, i.e. the username is blocked and they
969 # haven't bothered to log out before trying to create an account to
970 # evade it, but we'll leave that to their guilty conscience to figure
972 throw new ErrorPageError(
973 'cantcreateaccounttitle',
974 'cantcreateaccount-text',
977 $block->mReason ?
$block->mReason
: $this->msg( 'blockednoreason' )->text(),
984 * Add a "return to" link or redirect to it.
986 * @param $type string, one of the following:
987 * - error: display a return to link ignoring $wgRedirectOnLogin
988 * - success: display a return to link using $wgRedirectOnLogin if needed
989 * - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
991 private function executeReturnTo( $type ) {
992 global $wgRedirectOnLogin, $wgSecureLogin;
994 if ( $type != 'error' && $wgRedirectOnLogin !== null ) {
995 $returnTo = $wgRedirectOnLogin;
996 $returnToQuery = array();
998 $returnTo = $this->mReturnTo
;
999 $returnToQuery = wfCgiToArray( $this->mReturnToQuery
);
1002 $returnToTitle = Title
::newFromText( $returnTo );
1003 if ( !$returnToTitle ) {
1004 $returnToTitle = Title
::newMainPage();
1007 if ( $wgSecureLogin && !$this->mStickHTTPS
) {
1008 $options = array( 'http' );
1009 $proto = PROTO_HTTP
;
1010 } elseif( $wgSecureLogin ) {
1011 $options = array( 'https' );
1012 $proto = PROTO_HTTPS
;
1015 $proto = PROTO_RELATIVE
;
1018 if ( $type == 'successredirect' ) {
1019 $redirectUrl = $returnToTitle->getFullURL( $returnToQuery, false, $proto );
1020 $this->getOutput()->redirect( $redirectUrl );
1022 $this->getOutput()->addReturnTo( $returnToTitle, $returnToQuery, null, $options );
1029 function mainLoginForm( $msg, $msgtype = 'error' ) {
1030 global $wgEnableEmail, $wgEnableUserEmail;
1031 global $wgHiddenPrefs, $wgLoginLanguageSelector;
1032 global $wgAuth, $wgEmailConfirmToEdit, $wgCookieExpiration;
1033 global $wgSecureLogin, $wgSecureLoginDefaultHTTPS, $wgPasswordResetRoutes;
1035 $titleObj = $this->getTitle();
1036 $user = $this->getUser();
1038 if ( $this->mType
== 'signup' ) {
1039 // Block signup here if in readonly. Keeps user from
1040 // going through the process (filling out data, etc)
1041 // and being informed later.
1042 $permErrors = $titleObj->getUserPermissionsErrors( 'createaccount', $user, true );
1043 if ( count( $permErrors ) ) {
1044 throw new PermissionsError( 'createaccount', $permErrors );
1045 } elseif ( $user->isBlockedFromCreateAccount() ) {
1046 $this->userBlockedMessage( $user->isBlockedFromCreateAccount() );
1048 } elseif ( wfReadOnly() ) {
1049 throw new ReadOnlyError
;
1053 // Pre-fill username (if not creating an account, bug 44775).
1054 if ( $this->mUsername
== '' && $this->mType
!= 'signup' ) {
1055 if ( $user->isLoggedIn() ) {
1056 $this->mUsername
= $user->getName();
1058 $this->mUsername
= $this->getRequest()->getCookie( 'UserName' );
1062 if ( $this->mType
== 'signup' ) {
1063 $template = new UsercreateTemplate();
1064 $q = 'action=submitlogin&type=signup';
1065 $linkq = 'type=login';
1066 $linkmsg = 'gotaccount';
1067 $this->getOutput()->addModules( 'mediawiki.special.userlogin.signup' );
1069 $template = new UserloginTemplate();
1070 $q = 'action=submitlogin&type=login';
1071 $linkq = 'type=signup';
1072 $linkmsg = 'nologin';
1075 if ( $this->mReturnTo
!== '' ) {
1076 $returnto = '&returnto=' . wfUrlencode( $this->mReturnTo
);
1077 if ( $this->mReturnToQuery
!== '' ) {
1078 $returnto .= '&returntoquery=' .
1079 wfUrlencode( $this->mReturnToQuery
);
1082 $linkq .= $returnto;
1085 # Don't show a "create account" link if the user can't
1086 if( $this->showCreateOrLoginLink( $user ) ) {
1087 # Pass any language selection on to the mode switch link
1088 if( $wgLoginLanguageSelector && $this->mLanguage
) {
1089 $linkq .= '&uselang=' . $this->mLanguage
;
1091 $link = Html
::element( 'a', array( 'href' => $titleObj->getLocalURL( $linkq ) ),
1092 $this->msg( $linkmsg . 'link' )->text() ); # Calling either 'gotaccountlink' or 'nologinlink'
1094 $template->set( 'link', $this->msg( $linkmsg )->rawParams( $link )->parse() );
1096 $template->set( 'link', '' );
1099 // Decide if we default stickHTTPS on
1100 if ( $wgSecureLoginDefaultHTTPS && $this->mAction
!= 'submitlogin' && !$this->mLoginattempt
) {
1101 $this->mStickHTTPS
= true;
1104 $resetLink = $this->mType
== 'signup'
1106 : is_array( $wgPasswordResetRoutes ) && in_array( true, array_values( $wgPasswordResetRoutes ) );
1108 $template->set( 'header', '' );
1109 $template->set( 'name', $this->mUsername
);
1110 $template->set( 'password', $this->mPassword
);
1111 $template->set( 'retype', $this->mRetype
);
1112 $template->set( 'createemailset', $this->mCreateaccountMail
);
1113 $template->set( 'email', $this->mEmail
);
1114 $template->set( 'realname', $this->mRealName
);
1115 $template->set( 'domain', $this->mDomain
);
1116 $template->set( 'reason', $this->mReason
);
1118 $template->set( 'action', $titleObj->getLocalURL( $q ) );
1119 $template->set( 'message', $msg );
1120 $template->set( 'messagetype', $msgtype );
1121 $template->set( 'createemail', $wgEnableEmail && $user->isLoggedIn() );
1122 $template->set( 'userealname', !in_array( 'realname', $wgHiddenPrefs ) );
1123 $template->set( 'useemail', $wgEnableEmail );
1124 $template->set( 'emailrequired', $wgEmailConfirmToEdit );
1125 $template->set( 'emailothers', $wgEnableUserEmail );
1126 $template->set( 'canreset', $wgAuth->allowPasswordChange() );
1127 $template->set( 'resetlink', $resetLink );
1128 $template->set( 'canremember', ( $wgCookieExpiration > 0 ) );
1129 $template->set( 'usereason', $user->isLoggedIn() );
1130 $template->set( 'remember', $user->getOption( 'rememberpassword' ) ||
$this->mRemember
);
1131 $template->set( 'cansecurelogin', ( $wgSecureLogin === true ) );
1132 $template->set( 'stickHTTPS', $this->mStickHTTPS
);
1134 if ( $this->mType
== 'signup' ) {
1135 if ( !self
::getCreateaccountToken() ) {
1136 self
::setCreateaccountToken();
1138 $template->set( 'token', self
::getCreateaccountToken() );
1140 if ( !self
::getLoginToken() ) {
1141 self
::setLoginToken();
1143 $template->set( 'token', self
::getLoginToken() );
1146 # Prepare language selection links as needed
1147 if( $wgLoginLanguageSelector ) {
1148 $template->set( 'languages', $this->makeLanguageSelector() );
1149 if( $this->mLanguage
) {
1150 $template->set( 'uselang', $this->mLanguage
);
1154 // Use loginend-https for HTTPS requests if it's not blank, loginend otherwise
1155 // Ditto for signupend
1156 $usingHTTPS = WebRequest
::detectProtocol() == 'https';
1157 $loginendHTTPS = $this->msg( 'loginend-https' );
1158 $signupendHTTPS = $this->msg( 'signupend-https' );
1159 if ( $usingHTTPS && !$loginendHTTPS->isBlank() ) {
1160 $template->set( 'loginend', $loginendHTTPS->parse() );
1162 $template->set( 'loginend', $this->msg( 'loginend' )->parse() );
1164 if ( $usingHTTPS && !$signupendHTTPS->isBlank() ) {
1165 $template->set( 'signupend', $signupendHTTPS->parse() );
1167 $template->set( 'signupend', $this->msg( 'signupend' )->parse() );
1170 // Give authentication and captcha plugins a chance to modify the form
1171 $wgAuth->modifyUITemplate( $template, $this->mType
);
1172 if ( $this->mType
== 'signup' ) {
1173 wfRunHooks( 'UserCreateForm', array( &$template ) );
1175 wfRunHooks( 'UserLoginForm', array( &$template ) );
1178 $out = $this->getOutput();
1179 $out->disallowUserJs(); // just in case...
1180 $out->addTemplate( $template );
1190 function showCreateOrLoginLink( &$user ) {
1191 if( $this->mType
== 'signup' ) {
1193 } elseif( $user->isAllowed( 'createaccount' ) ) {
1201 * Check if a session cookie is present.
1203 * This will not pick up a cookie set during _this_ request, but is meant
1204 * to ensure that the client is returning the cookie which was set on a
1205 * previous pass through the system.
1210 function hasSessionCookie() {
1211 global $wgDisableCookieCheck;
1212 return $wgDisableCookieCheck ?
true : $this->getRequest()->checkSessionCookie();
1216 * Get the login token from the current session
1219 public static function getLoginToken() {
1221 return $wgRequest->getSessionData( 'wsLoginToken' );
1225 * Randomly generate a new login token and attach it to the current session
1227 public static function setLoginToken() {
1229 // Generate a token directly instead of using $user->editToken()
1230 // because the latter reuses $_SESSION['wsEditToken']
1231 $wgRequest->setSessionData( 'wsLoginToken', MWCryptRand
::generateHex( 32 ) );
1235 * Remove any login token attached to the current session
1237 public static function clearLoginToken() {
1239 $wgRequest->setSessionData( 'wsLoginToken', null );
1243 * Get the createaccount token from the current session
1246 public static function getCreateaccountToken() {
1248 return $wgRequest->getSessionData( 'wsCreateaccountToken' );
1252 * Randomly generate a new createaccount token and attach it to the current session
1254 public static function setCreateaccountToken() {
1256 $wgRequest->setSessionData( 'wsCreateaccountToken', MWCryptRand
::generateHex( 32 ) );
1260 * Remove any createaccount token attached to the current session
1262 public static function clearCreateaccountToken() {
1264 $wgRequest->setSessionData( 'wsCreateaccountToken', null );
1268 * Renew the user's session id, using strong entropy
1270 private function renewSessionId() {
1271 global $wgSecureLogin, $wgCookieSecure;
1272 if( $wgSecureLogin && !$this->mStickHTTPS
) {
1273 $wgCookieSecure = false;
1276 // If either we don't trust PHP's entropy, or if we need
1277 // to change cookie settings when logging in because of
1278 // wpStickHTTPS, then change the session ID manually.
1279 $cookieParams = session_get_cookie_params();
1280 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
1281 session_regenerate_id( false );
1285 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
1293 function cookieRedirectCheck( $type ) {
1294 $titleObj = SpecialPage
::getTitleFor( 'Userlogin' );
1295 $query = array( 'wpCookieCheck' => $type );
1296 if ( $this->mReturnTo
!== '' ) {
1297 $query['returnto'] = $this->mReturnTo
;
1298 $query['returntoquery'] = $this->mReturnToQuery
;
1300 $check = $titleObj->getFullURL( $query );
1302 $this->getOutput()->redirect( $check );
1308 function onCookieRedirectCheck( $type ) {
1309 if ( !$this->hasSessionCookie() ) {
1310 if ( $type == 'new' ) {
1311 $this->mainLoginForm( $this->msg( 'nocookiesnew' )->parse() );
1312 } elseif ( $type == 'login' ) {
1313 $this->mainLoginForm( $this->msg( 'nocookieslogin' )->parse() );
1316 $this->mainLoginForm( $this->msg( 'error' )->text() );
1319 $this->successfulLogin();
1324 * Produce a bar of links which allow the user to select another language
1325 * during login/registration but retain "returnto"
1329 function makeLanguageSelector() {
1330 $msg = $this->msg( 'loginlanguagelinks' )->inContentLanguage();
1331 if( !$msg->isBlank() ) {
1332 $langs = explode( "\n", $msg->text() );
1334 foreach( $langs as $lang ) {
1335 $lang = trim( $lang, '* ' );
1336 $parts = explode( '|', $lang );
1337 if ( count( $parts ) >= 2 ) {
1338 $links[] = $this->makeLanguageSelectorLink( $parts[0], trim( $parts[1] ) );
1341 return count( $links ) > 0 ?
$this->msg( 'loginlanguagelabel' )->rawParams(
1342 $this->getLanguage()->pipeList( $links ) )->escaped() : '';
1349 * Create a language selector link for a particular language
1350 * Links back to this page preserving type and returnto
1352 * @param string $text Link text
1353 * @param string $lang Language code
1356 function makeLanguageSelectorLink( $text, $lang ) {
1357 if( $this->getLanguage()->getCode() == $lang ) {
1358 // no link for currently used language
1359 return htmlspecialchars( $text );
1361 $query = array( 'uselang' => $lang );
1362 if( $this->mType
== 'signup' ) {
1363 $query['type'] = 'signup';
1365 if( $this->mReturnTo
!== '' ) {
1366 $query['returnto'] = $this->mReturnTo
;
1367 $query['returntoquery'] = $this->mReturnToQuery
;
1371 $targetLanguage = Language
::factory( $lang );
1372 $attr['lang'] = $attr['hreflang'] = $targetLanguage->getHtmlCode();
1374 return Linker
::linkKnown(
1376 htmlspecialchars( $text ),
1382 protected function getGroupName() {