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
27 function wfSpecialUserlogin( $par = '' ) {
29 if( session_id() == '' ) {
33 $form = new LoginForm( $wgRequest, $par );
38 * Implements Special:UserLogin
40 * @ingroup SpecialPage
47 const WRONG_PLUGIN_PASS
= 3;
53 const CREATE_BLOCKED
= 9;
55 const USER_BLOCKED
= 11;
56 const NEED_TOKEN
= 12;
57 const WRONG_TOKEN
= 13;
59 var $mName, $mPassword, $mRetype, $mReturnTo, $mCookieCheck, $mPosted;
60 var $mAction, $mCreateaccount, $mCreateaccountMail, $mMailmypassword;
61 var $mLoginattempt, $mRemember, $mEmail, $mDomain, $mLanguage;
62 var $mSkipCookieCheck, $mReturnToQuery, $mToken, $mStickHTTPS;
64 private $mExtUser = null;
68 * @param $request WebRequest: a WebRequest object passed by reference
69 * @param $par String: subpage parameter
71 function __construct( &$request, $par = '' ) {
72 global $wgAuth, $wgHiddenPrefs, $wgEnableEmail, $wgRedirectOnLogin;
74 $this->mType
= ( $par == 'signup' ) ?
$par : $request->getText( 'type' ); # Check for [[Special:Userlogin/signup]]
75 $this->mName
= $request->getText( 'wpName' );
76 $this->mPassword
= $request->getText( 'wpPassword' );
77 $this->mRetype
= $request->getText( 'wpRetype' );
78 $this->mDomain
= $request->getText( 'wpDomain' );
79 $this->mReason
= $request->getText( 'wpReason' );
80 $this->mReturnTo
= $request->getVal( 'returnto' );
81 $this->mReturnToQuery
= $request->getVal( 'returntoquery' );
82 $this->mCookieCheck
= $request->getVal( 'wpCookieCheck' );
83 $this->mPosted
= $request->wasPosted();
84 $this->mCreateaccount
= $request->getCheck( 'wpCreateaccount' );
85 $this->mCreateaccountMail
= $request->getCheck( 'wpCreateaccountMail' )
87 $this->mMailmypassword
= $request->getCheck( 'wpMailmypassword' )
89 $this->mLoginattempt
= $request->getCheck( 'wpLoginattempt' );
90 $this->mAction
= $request->getVal( 'action' );
91 $this->mRemember
= $request->getCheck( 'wpRemember' );
92 $this->mStickHTTPS
= $request->getCheck( 'wpStickHTTPS' );
93 $this->mLanguage
= $request->getText( 'uselang' );
94 $this->mSkipCookieCheck
= $request->getCheck( 'wpSkipCookieCheck' );
95 $this->mToken
= ( $this->mType
== 'signup' ) ?
$request->getVal( 'wpCreateaccountToken' ) : $request->getVal( 'wpLoginToken' );
97 if ( $wgRedirectOnLogin ) {
98 $this->mReturnTo
= $wgRedirectOnLogin;
99 $this->mReturnToQuery
= '';
102 if( $wgEnableEmail ) {
103 $this->mEmail
= $request->getText( 'wpEmail' );
107 if( !in_array( 'realname', $wgHiddenPrefs ) ) {
108 $this->mRealName
= $request->getText( 'wpRealName' );
110 $this->mRealName
= '';
113 if( !$wgAuth->validDomain( $this->mDomain
) ) {
114 $this->mDomain
= 'invaliddomain';
116 $wgAuth->setDomain( $this->mDomain
);
118 # When switching accounts, it sucks to get automatically logged out
119 $returnToTitle = Title
::newFromText( $this->mReturnTo
);
120 if( is_object( $returnToTitle ) && $returnToTitle->isSpecial( 'Userlogout' ) ) {
121 $this->mReturnTo
= '';
122 $this->mReturnToQuery
= '';
127 if ( !is_null( $this->mCookieCheck
) ) {
128 $this->onCookieRedirectCheck( $this->mCookieCheck
);
130 } elseif( $this->mPosted
) {
131 if( $this->mCreateaccount
) {
132 return $this->addNewAccount();
133 } elseif ( $this->mCreateaccountMail
) {
134 return $this->addNewAccountMailPassword();
135 } elseif ( $this->mMailmypassword
) {
136 return $this->mailPassword();
137 } elseif ( ( 'submitlogin' == $this->mAction
) ||
$this->mLoginattempt
) {
138 return $this->processLogin();
141 $this->mainLoginForm( '' );
147 function addNewAccountMailPassword() {
150 if ( $this->mEmail
== '' ) {
151 $this->mainLoginForm( wfMsgExt( 'noemail', array( 'parsemag', 'escape' ), $this->mName
) );
155 $u = $this->addNewaccountInternal();
161 // Wipe the initial password and mail a temporary one
162 $u->setPassword( null );
164 $result = $this->mailPasswordInternal( $u, false, 'createaccount-title', 'createaccount-text' );
166 wfRunHooks( 'AddNewAccount', array( $u, true ) );
167 $u->addNewUserLogEntry( true, $this->mReason
);
169 $wgOut->setPageTitle( wfMsg( 'accmailtitle' ) );
170 $wgOut->setRobotPolicy( 'noindex,nofollow' );
171 $wgOut->setArticleRelated( false );
173 if( !$result->isGood() ) {
174 $this->mainLoginForm( wfMsg( 'mailerror', $result->getWikiText() ) );
176 $wgOut->addWikiMsg( 'accmailtext', $u->getName(), $u->getEmail() );
177 $wgOut->returnToMain( false );
184 function addNewAccount() {
185 global $wgUser, $wgEmailAuthentication, $wgOut;
187 # Create the account and abort if there's a problem doing so
188 $u = $this->addNewAccountInternal();
193 # If we showed up language selection links, and one was in use, be
194 # smart (and sensible) and save that language as the user's preference
195 global $wgLoginLanguageSelector;
196 if( $wgLoginLanguageSelector && $this->mLanguage
) {
197 $u->setOption( 'language', $this->mLanguage
);
200 # Send out an email authentication message if needed
201 if( $wgEmailAuthentication && User
::isValidEmailAddr( $u->getEmail() ) ) {
202 $status = $u->sendConfirmationMail();
203 if( $status->isGood() ) {
204 $wgOut->addWikiMsg( 'confirmemail_oncreate' );
206 $wgOut->addWikiText( $status->getWikiText( 'confirmemail_sendfailed' ) );
210 # Save settings (including confirmation token)
213 # If not logged in, assume the new account as the current one and set
214 # session cookies then show a "welcome" message or a "need cookies"
216 if( $wgUser->isAnon() ) {
218 $wgUser->setCookies();
219 wfRunHooks( 'AddNewAccount', array( $wgUser, false ) );
220 $wgUser->addNewUserLogEntry();
221 if( $this->hasSessionCookie() ) {
222 return $this->successfulCreation();
224 return $this->cookieRedirectCheck( 'new' );
227 # Confirm that the account was created
228 $self = SpecialPage
::getTitleFor( 'Userlogin' );
229 $wgOut->setPageTitle( wfMsgHtml( 'accountcreated' ) );
230 $wgOut->setArticleRelated( false );
231 $wgOut->setRobotPolicy( 'noindex,nofollow' );
232 $wgOut->addHTML( wfMsgWikiHtml( 'accountcreatedtext', $u->getName() ) );
233 $wgOut->returnToMain( false, $self );
234 wfRunHooks( 'AddNewAccount', array( $u, false ) );
235 $u->addNewUserLogEntry( false, $this->mReason
);
243 function addNewAccountInternal() {
244 global $wgUser, $wgOut;
245 global $wgMemc, $wgAccountCreationThrottle;
246 global $wgAuth, $wgMinimalPasswordLength;
247 global $wgEmailConfirmToEdit;
249 // If the user passes an invalid domain, something is fishy
250 if( !$wgAuth->validDomain( $this->mDomain
) ) {
251 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
255 // If we are not allowing users to login locally, we should be checking
256 // to see if the user is actually able to authenticate to the authenti-
257 // cation server before they create an account (otherwise, they can
258 // create a local account and login as any domain user). We only need
259 // to check this for domains that aren't local.
260 if( 'local' != $this->mDomain
&& $this->mDomain
!= '' ) {
261 if( !$wgAuth->canCreateAccounts() && ( !$wgAuth->userExists( $this->mName
) ||
!$wgAuth->authenticate( $this->mName
, $this->mPassword
) ) ) {
262 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
267 if ( wfReadOnly() ) {
268 $wgOut->readOnlyPage();
272 # Request forgery checks.
273 if ( !self
::getCreateaccountToken() ) {
274 self
::setCreateaccountToken();
275 $this->mainLoginForm( wfMsgExt( 'nocookiesnew', array( 'parseinline' ) ) );
279 # The user didn't pass a createaccount token
280 if ( !$this->mToken
) {
281 $this->mainLoginForm( wfMsg( 'sessionfailure' ) );
285 # Validate the createaccount token
286 if ( $this->mToken
!== self
::getCreateaccountToken() ) {
287 $this->mainLoginForm( wfMsg( 'sessionfailure' ) );
292 if ( !$wgUser->isAllowed( 'createaccount' ) ) {
293 $wgOut->permissionRequired( 'createaccount' );
295 } elseif ( $wgUser->isBlockedFromCreateAccount() ) {
296 $this->userBlockedMessage();
301 if ( $wgUser->isDnsBlacklisted( $ip, true /* check $wgProxyWhitelist */ ) ) {
302 $this->mainLoginForm( wfMsg( 'sorbs_create_account_reason' ) . ' (' . htmlspecialchars( $ip ) . ')' );
306 # Now create a dummy user ($u) and check if it is valid
307 $name = trim( $this->mName
);
308 $u = User
::newFromName( $name, 'creatable' );
309 if ( !is_object( $u ) ) {
310 $this->mainLoginForm( wfMsg( 'noname' ) );
314 if ( 0 != $u->idForName() ) {
315 $this->mainLoginForm( wfMsg( 'userexists' ) );
319 if ( 0 != strcmp( $this->mPassword
, $this->mRetype
) ) {
320 $this->mainLoginForm( wfMsg( 'badretype' ) );
324 # check for minimal password length
325 $valid = $u->getPasswordValidity( $this->mPassword
);
326 if ( $valid !== true ) {
327 if ( !$this->mCreateaccountMail
) {
328 $this->mainLoginForm( wfMsgExt( $valid, array( 'parsemag' ), $wgMinimalPasswordLength ) );
331 # do not force a password for account creation by email
332 # set invalid password, it will be replaced later by a random generated password
333 $this->mPassword
= null;
337 # if you need a confirmed email address to edit, then obviously you
338 # need an email address.
339 if ( $wgEmailConfirmToEdit && empty( $this->mEmail
) ) {
340 $this->mainLoginForm( wfMsg( 'noemailtitle' ) );
344 if( !empty( $this->mEmail
) && !User
::isValidEmailAddr( $this->mEmail
) ) {
345 $this->mainLoginForm( wfMsg( 'invalidemailaddress' ) );
349 # Set some additional data so the AbortNewAccount hook can be used for
350 # more than just username validation
351 $u->setEmail( $this->mEmail
);
352 $u->setRealName( $this->mRealName
);
355 if( !wfRunHooks( 'AbortNewAccount', array( $u, &$abortError ) ) ) {
356 // Hook point to add extra creation throttles and blocks
357 wfDebug( "LoginForm::addNewAccountInternal: a hook blocked creation\n" );
358 $this->mainLoginForm( $abortError );
362 if ( $wgAccountCreationThrottle && $wgUser->isPingLimitable() ) {
363 $key = wfMemcKey( 'acctcreate', 'ip', $ip );
364 $value = $wgMemc->get( $key );
366 $wgMemc->set( $key, 0, 86400 );
368 if ( $value >= $wgAccountCreationThrottle ) {
369 $this->throttleHit( $wgAccountCreationThrottle );
372 $wgMemc->incr( $key );
375 if( !$wgAuth->addUser( $u, $this->mPassword
, $this->mEmail
, $this->mRealName
) ) {
376 $this->mainLoginForm( wfMsg( 'externaldberror' ) );
380 self
::clearCreateaccountToken();
381 return $this->initUser( $u, false );
385 * Actually add a user to the database.
386 * Give it a User object that has been initialised with a name.
388 * @param $u User object.
389 * @param $autocreate boolean -- true if this is an autocreation via auth plugin
390 * @return User object.
393 function initUser( $u, $autocreate ) {
398 if ( $wgAuth->allowPasswordChange() ) {
399 $u->setPassword( $this->mPassword
);
402 $u->setEmail( $this->mEmail
);
403 $u->setRealName( $this->mRealName
);
406 $wgAuth->initUser( $u, $autocreate );
408 if ( $this->mExtUser
) {
409 $this->mExtUser
->linkToLocal( $u->getId() );
410 $email = $this->mExtUser
->getPref( 'emailaddress' );
411 if ( $email && !$this->mEmail
) {
412 $u->setEmail( $email );
416 $u->setOption( 'rememberpassword', $this->mRemember ?
1 : 0 );
420 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
421 $ssUpdate->doUpdate();
427 * Internally authenticate the login request.
429 * This may create a local account as a side effect if the
430 * authentication plugin allows transparent local account
433 public function authenticateUserData() {
434 global $wgUser, $wgAuth, $wgMemc;
436 if ( $this->mName
== '' ) {
437 return self
::NO_NAME
;
440 // We require a login token to prevent login CSRF
441 // Handle part of this before incrementing the throttle so
442 // token-less login attempts don't count towards the throttle
443 // but wrong-token attempts do.
445 // If the user doesn't have a login token yet, set one.
446 if ( !self
::getLoginToken() ) {
447 self
::setLoginToken();
448 return self
::NEED_TOKEN
;
450 // If the user didn't pass a login token, tell them we need one
451 if ( !$this->mToken
) {
452 return self
::NEED_TOKEN
;
455 global $wgPasswordAttemptThrottle;
458 if ( is_array( $wgPasswordAttemptThrottle ) ) {
459 $throttleKey = wfMemcKey( 'password-throttle', wfGetIP(), md5( $this->mName
) );
460 $count = $wgPasswordAttemptThrottle['count'];
461 $period = $wgPasswordAttemptThrottle['seconds'];
463 $throttleCount = $wgMemc->get( $throttleKey );
464 if ( !$throttleCount ) {
465 $wgMemc->add( $throttleKey, 1, $period ); // start counter
466 } elseif ( $throttleCount < $count ) {
467 $wgMemc->incr( $throttleKey );
468 } elseif ( $throttleCount >= $count ) {
469 return self
::THROTTLED
;
473 // Validate the login token
474 if ( $this->mToken
!== self
::getLoginToken() ) {
475 return self
::WRONG_TOKEN
;
478 // Load $wgUser now, and check to see if we're logging in as the same
479 // name. This is necessary because loading $wgUser (say by calling
480 // getName()) calls the UserLoadFromSession hook, which potentially
481 // creates the user in the database. Until we load $wgUser, checking
482 // for user existence using User::newFromName($name)->getId() below
483 // will effectively be using stale data.
484 if ( $wgUser->getName() === $this->mName
) {
485 wfDebug( __METHOD__
. ": already logged in as {$this->mName}\n" );
486 return self
::SUCCESS
;
489 $this->mExtUser
= ExternalUser
::newFromName( $this->mName
);
491 # TODO: Allow some magic here for invalid external names, e.g., let the
492 # user choose a different wiki name.
493 $u = User
::newFromName( $this->mName
);
494 if( !( $u instanceof User
) ||
!User
::isUsableName( $u->getName() ) ) {
495 return self
::ILLEGAL
;
498 $isAutoCreated = false;
499 if ( 0 == $u->getID() ) {
500 $status = $this->attemptAutoCreate( $u );
501 if ( $status !== self
::SUCCESS
) {
504 $isAutoCreated = true;
507 global $wgExternalAuthType, $wgAutocreatePolicy;
508 if ( $wgExternalAuthType && $wgAutocreatePolicy != 'never'
509 && is_object( $this->mExtUser
)
510 && $this->mExtUser
->authenticate( $this->mPassword
) ) {
511 # The external user and local user have the same name and
512 # password, so we assume they're the same.
513 $this->mExtUser
->linkToLocal( $u->getID() );
519 // Give general extensions, such as a captcha, a chance to abort logins
520 $abort = self
::ABORTED
;
521 if( !wfRunHooks( 'AbortLogin', array( $u, $this->mPassword
, &$abort ) ) ) {
525 global $wgBlockDisablesLogin;
526 if ( !$u->checkPassword( $this->mPassword
) ) {
527 if( $u->checkTemporaryPassword( $this->mPassword
) ) {
528 // The e-mailed temporary password should not be used for actu-
529 // al logins; that's a very sloppy habit, and insecure if an
530 // attacker has a few seconds to click "search" on someone's o-
533 // Allow it to be used only to reset the password a single time
534 // to a new value, which won't be in the user's e-mail ar-
537 // For backwards compatibility, we'll still recognize it at the
538 // login form to minimize surprises for people who have been
539 // logging in with a temporary password for some time.
541 // As a side-effect, we can authenticate the user's e-mail ad-
542 // dress if it's not already done, since the temporary password
543 // was sent via e-mail.
544 if( !$u->isEmailConfirmed() ) {
549 // At this point we just return an appropriate code/ indicating
550 // that the UI should show a password reset form; bot inter-
551 // faces etc will probably just fail cleanly here.
552 $retval = self
::RESET_PASS
;
554 $retval = ( $this->mPassword
== '' ) ? self
::EMPTY_PASS
: self
::WRONG_PASS
;
556 } elseif ( $wgBlockDisablesLogin && $u->isBlocked() ) {
557 // If we've enabled it, make it so that a blocked user cannot login
558 $retval = self
::USER_BLOCKED
;
560 $wgAuth->updateUser( $u );
563 // Please reset throttle for successful logins, thanks!
564 if( $throttleCount ) {
565 $wgMemc->delete( $throttleKey );
568 if ( $isAutoCreated ) {
569 // Must be run after $wgUser is set, for correct new user log
570 wfRunHooks( 'AuthPluginAutoCreate', array( $wgUser ) );
573 $retval = self
::SUCCESS
;
575 wfRunHooks( 'LoginAuthenticateAudit', array( $u, $this->mPassword
, $retval ) );
580 * Attempt to automatically create a user on login. Only succeeds if there
581 * is an external authentication method which allows it.
582 * @return integer Status code
584 function attemptAutoCreate( $user ) {
585 global $wgAuth, $wgUser, $wgAutocreatePolicy;
587 if ( $wgUser->isBlockedFromCreateAccount() ) {
588 wfDebug( __METHOD__
. ": user is blocked from account creation\n" );
589 return self
::CREATE_BLOCKED
;
593 * If the external authentication plugin allows it, automatically cre-
594 * ate a new account for users that are externally defined but have not
597 if ( $this->mExtUser
) {
598 # mExtUser is neither null nor false, so use the new ExternalAuth
600 if ( $wgAutocreatePolicy == 'never' ) {
601 return self
::NOT_EXISTS
;
603 if ( !$this->mExtUser
->authenticate( $this->mPassword
) ) {
604 return self
::WRONG_PLUGIN_PASS
;
608 if ( !$wgAuth->autoCreate() ) {
609 return self
::NOT_EXISTS
;
611 if ( !$wgAuth->userExists( $user->getName() ) ) {
612 wfDebug( __METHOD__
. ": user does not exist\n" );
613 return self
::NOT_EXISTS
;
615 if ( !$wgAuth->authenticate( $user->getName(), $this->mPassword
) ) {
616 wfDebug( __METHOD__
. ": \$wgAuth->authenticate() returned false, aborting\n" );
617 return self
::WRONG_PLUGIN_PASS
;
621 wfDebug( __METHOD__
. ": creating account\n" );
622 $this->initUser( $user, true );
623 return self
::SUCCESS
;
626 function processLogin() {
629 switch ( $this->authenticateUserData() ) {
631 # We've verified now, update the real record
632 if( (bool)$this->mRemember
!= (bool)$wgUser->getOption( 'rememberpassword' ) ) {
633 $wgUser->setOption( 'rememberpassword', $this->mRemember ?
1 : 0 );
634 $wgUser->saveSettings();
636 $wgUser->invalidateCache();
638 $wgUser->setCookies();
639 self
::clearLoginToken();
641 // Reset the throttle
642 $key = wfMemcKey( 'password-throttle', wfGetIP(), md5( $this->mName
) );
644 $wgMemc->delete( $key );
646 if( $this->hasSessionCookie() ||
$this->mSkipCookieCheck
) {
647 /* Replace the language object to provide user interface in
648 * correct language immediately on this first page load.
650 global $wgLang, $wgRequest;
651 $code = $wgRequest->getVal( 'uselang', $wgUser->getOption( 'language' ) );
652 $wgLang = Language
::factory( $code );
653 return $this->successfulLogin();
655 return $this->cookieRedirectCheck( 'login' );
659 case self
::NEED_TOKEN
:
660 $this->mainLoginForm( wfMsgExt( 'nocookieslogin', array( 'parseinline' ) ) );
662 case self
::WRONG_TOKEN
:
663 $this->mainLoginForm( wfMsg( 'sessionfailure' ) );
667 $this->mainLoginForm( wfMsg( 'noname' ) );
669 case self
::WRONG_PLUGIN_PASS
:
670 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
672 case self
::NOT_EXISTS
:
673 if( $wgUser->isAllowed( 'createaccount' ) ) {
674 $this->mainLoginForm( wfMsgWikiHtml( 'nosuchuser', htmlspecialchars( $this->mName
) ) );
676 $this->mainLoginForm( wfMsg( 'nosuchusershort', htmlspecialchars( $this->mName
) ) );
679 case self
::WRONG_PASS
:
680 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
682 case self
::EMPTY_PASS
:
683 $this->mainLoginForm( wfMsg( 'wrongpasswordempty' ) );
685 case self
::RESET_PASS
:
686 $this->resetLoginForm( wfMsg( 'resetpass_announce' ) );
688 case self
::CREATE_BLOCKED
:
689 $this->userBlockedMessage();
691 case self
::THROTTLED
:
692 $this->mainLoginForm( wfMsg( 'login-throttled' ) );
694 case self
::USER_BLOCKED
:
695 $this->mainLoginForm( wfMsgExt( 'login-userblocked',
696 array( 'parsemag', 'escape' ), $this->mName
) );
699 throw new MWException( 'Unhandled case value' );
703 function resetLoginForm( $error ) {
705 $wgOut->addHTML( Xml
::element('p', array( 'class' => 'error' ), $error ) );
706 $reset = new SpecialResetpass();
707 $reset->execute( null );
713 function mailPassword() {
714 global $wgUser, $wgOut, $wgAuth;
716 if ( wfReadOnly() ) {
717 $wgOut->readOnlyPage();
721 if( !$wgAuth->allowPasswordChange() ) {
722 $this->mainLoginForm( wfMsg( 'resetpass_forbidden' ) );
726 # Check against blocked IPs so blocked users can't flood admins
727 # with password resets
728 if( $wgUser->isBlocked() ) {
729 $this->mainLoginForm( wfMsg( 'blocked-mailpassword' ) );
735 if ( !wfRunHooks( 'UserLoginMailPassword', array( $this->mName
, &$error ) ) ) {
736 $this->mainLoginForm( $error );
740 # If the user doesn't have a login token yet, set one.
741 if ( !self
::getLoginToken() ) {
742 self
::setLoginToken();
743 $this->mainLoginForm( wfMsg( 'sessionfailure' ) );
747 # If the user didn't pass a login token, tell them we need one
748 if ( !$this->mToken
) {
749 $this->mainLoginForm( wfMsg( 'sessionfailure' ) );
753 # Check against the rate limiter
754 if( $wgUser->pingLimiter( 'mailpassword' ) ) {
755 $wgOut->rateLimited();
759 if ( $this->mName
== '' ) {
760 $this->mainLoginForm( wfMsg( 'noname' ) );
763 $u = User
::newFromName( $this->mName
);
764 if( !$u instanceof User
) {
765 $this->mainLoginForm( wfMsg( 'noname' ) );
768 if ( 0 == $u->getID() ) {
769 $this->mainLoginForm( wfMsgWikiHtml( 'nosuchuser', htmlspecialchars( $u->getName() ) ) );
773 # Validate the login token
774 if ( $this->mToken
!== self
::getLoginToken() ) {
775 $this->mainLoginForm( wfMsg( 'sessionfailure' ) );
779 # Check against password throttle
780 if ( $u->isPasswordReminderThrottled() ) {
781 global $wgPasswordReminderResendTime;
782 # Round the time in hours to 3 d.p., in case someone is specifying
783 # minutes or seconds.
784 $this->mainLoginForm( wfMsgExt( 'throttled-mailpassword', array( 'parsemag' ),
785 round( $wgPasswordReminderResendTime, 3 ) ) );
789 $result = $this->mailPasswordInternal( $u, true, 'passwordremindertitle', 'passwordremindertext' );
790 if( $result->isGood() ) {
791 $this->mainLoginForm( wfMsg( 'passwordsent', $u->getName() ), 'success' );
792 self
::clearLoginToken();
794 $this->mainLoginForm( $result->getWikiText( 'mailerror' ) );
800 * @param $u User object
801 * @param $throttle Boolean
802 * @param $emailTitle String: message name of email title
803 * @param $emailText String: message name of email text
804 * @return Status object
807 function mailPasswordInternal( $u, $throttle = true, $emailTitle = 'passwordremindertitle', $emailText = 'passwordremindertext' ) {
808 global $wgServer, $wgScript, $wgUser, $wgNewPasswordExpiry;
810 if ( $u->getEmail() == '' ) {
811 return Status
::newFatal( 'noemail', $u->getName() );
815 return Status
::newFatal( 'badipaddress' );
818 wfRunHooks( 'User::mailPasswordInternal', array( &$wgUser, &$ip, &$u ) );
820 $np = $u->randomPassword();
821 $u->setNewpassword( $np, $throttle );
823 $userLanguage = $u->getOption( 'language' );
824 $m = wfMsgExt( $emailText, array( 'parsemag', 'language' => $userLanguage ), $ip, $u->getName(), $np,
825 $wgServer . $wgScript, round( $wgNewPasswordExpiry / 86400 ) );
826 $result = $u->sendMail( wfMsgExt( $emailTitle, array( 'parsemag', 'language' => $userLanguage ) ), $m );
833 * Run any hooks registered for logins, then HTTP redirect to
834 * $this->mReturnTo (or Main Page if that's undefined). Formerly we had a
835 * nice message here, but that's really not as useful as just being sent to
836 * wherever you logged in from. It should be clear that the action was
837 * successful, given the lack of error messages plus the appearance of your
838 * name in the upper right.
842 function successfulLogin() {
843 global $wgUser, $wgOut;
845 # Run any hooks; display injected HTML if any, else redirect
847 wfRunHooks( 'UserLoginComplete', array( &$wgUser, &$injected_html ) );
849 if( $injected_html !== '' ) {
850 $this->displaySuccessfulLogin( 'loginsuccess', $injected_html );
852 $titleObj = Title
::newFromText( $this->mReturnTo
);
853 if ( !$titleObj instanceof Title
) {
854 $titleObj = Title
::newMainPage();
856 $redirectUrl = $titleObj->getFullURL( $this->mReturnToQuery
);
857 global $wgSecureLogin;
858 if( $wgSecureLogin && !$this->mStickHTTPS
) {
859 $redirectUrl = preg_replace( '/^https:/', 'http:', $redirectUrl );
861 $wgOut->redirect( $redirectUrl );
866 * Run any hooks registered for logins, then display a message welcoming
871 function successfulCreation() {
873 # Run any hooks; display injected HTML
875 wfRunHooks( 'UserLoginComplete', array( &$wgUser, &$injected_html ) );
877 $this->displaySuccessfulLogin( 'welcomecreation', $injected_html );
881 * Display a "login successful" page.
883 private function displaySuccessfulLogin( $msgname, $injected_html ) {
884 global $wgOut, $wgUser;
886 $wgOut->setPageTitle( wfMsg( 'loginsuccesstitle' ) );
887 $wgOut->setRobotPolicy( 'noindex,nofollow' );
888 $wgOut->setArticleRelated( false );
889 $wgOut->addWikiMsg( $msgname, $wgUser->getName() );
890 $wgOut->addHTML( $injected_html );
892 if ( !empty( $this->mReturnTo
) ) {
893 $wgOut->returnToMain( null, $this->mReturnTo
, $this->mReturnToQuery
);
895 $wgOut->returnToMain( null );
900 function userBlockedMessage() {
901 global $wgOut, $wgUser;
903 # Let's be nice about this, it's likely that this feature will be used
904 # for blocking large numbers of innocent people, e.g. range blocks on
905 # schools. Don't blame it on the user. There's a small chance that it
906 # really is the user's fault, i.e. the username is blocked and they
907 # haven't bothered to log out before trying to create an account to
908 # evade it, but we'll leave that to their guilty conscience to figure
911 $wgOut->setPageTitle( wfMsg( 'cantcreateaccounttitle' ) );
912 $wgOut->setRobotPolicy( 'noindex,nofollow' );
913 $wgOut->setArticleRelated( false );
916 $blocker = User
::whoIs( $wgUser->mBlock
->mBy
);
917 $block_reason = $wgUser->mBlock
->mReason
;
919 if ( strval( $block_reason ) === '' ) {
920 $block_reason = wfMsg( 'blockednoreason' );
922 $wgOut->addWikiMsg( 'cantcreateaccount-text', $ip, $block_reason, $blocker );
923 $wgOut->returnToMain( false );
929 function mainLoginForm( $msg, $msgtype = 'error' ) {
930 global $wgUser, $wgOut, $wgHiddenPrefs, $wgEnableEmail;
931 global $wgRequest, $wgLoginLanguageSelector;
932 global $wgAuth, $wgEmailConfirmToEdit, $wgCookieExpiration;
933 global $wgSecureLogin;
935 $titleObj = SpecialPage
::getTitleFor( 'Userlogin' );
937 if ( $this->mType
== 'signup' ) {
938 // Block signup here if in readonly. Keeps user from
939 // going through the process (filling out data, etc)
940 // and being informed later.
941 if ( wfReadOnly() ) {
942 $wgOut->readOnlyPage();
944 } elseif ( $wgUser->isBlockedFromCreateAccount() ) {
945 $this->userBlockedMessage();
947 } elseif ( count( $permErrors = $titleObj->getUserPermissionsErrors( 'createaccount', $wgUser, true ) )>0 ) {
948 $wgOut->showPermissionsErrorPage( $permErrors, 'createaccount' );
953 if ( $this->mName
== '' ) {
954 if ( $wgUser->isLoggedIn() ) {
955 $this->mName
= $wgUser->getName();
957 $this->mName
= $wgRequest->getCookie( 'UserName' );
961 if ( $this->mType
== 'signup' ) {
962 global $wgLivePasswordStrengthChecks;
963 if ( $wgLivePasswordStrengthChecks ) {
964 $wgOut->addPasswordSecurity( 'wpPassword2', 'wpRetype' );
966 $template = new UsercreateTemplate();
967 $q = 'action=submitlogin&type=signup';
968 $linkq = 'type=login';
969 $linkmsg = 'gotaccount';
971 $template = new UserloginTemplate();
972 $q = 'action=submitlogin&type=login';
973 $linkq = 'type=signup';
974 $linkmsg = 'nologin';
977 if ( !empty( $this->mReturnTo
) ) {
978 $returnto = '&returnto=' . wfUrlencode( $this->mReturnTo
);
979 if ( !empty( $this->mReturnToQuery
) ) {
980 $returnto .= '&returntoquery=' .
981 wfUrlencode( $this->mReturnToQuery
);
987 # Pass any language selection on to the mode switch link
988 if( $wgLoginLanguageSelector && $this->mLanguage
) {
989 $linkq .= '&uselang=' . $this->mLanguage
;
992 $link = '<a href="' . htmlspecialchars ( $titleObj->getLocalURL( $linkq ) ) . '">';
993 $link .= wfMsgHtml( $linkmsg . 'link' ); # Calling either 'gotaccountlink' or 'nologinlink'
996 # Don't show a "create account" link if the user can't
997 if( $this->showCreateOrLoginLink( $wgUser ) ) {
998 $template->set( 'link', wfMsgExt( $linkmsg, array( 'parseinline', 'replaceafter' ), $link ) );
1000 $template->set( 'link', '' );
1003 $template->set( 'header', '' );
1004 $template->set( 'name', $this->mName
);
1005 $template->set( 'password', $this->mPassword
);
1006 $template->set( 'retype', $this->mRetype
);
1007 $template->set( 'email', $this->mEmail
);
1008 $template->set( 'realname', $this->mRealName
);
1009 $template->set( 'domain', $this->mDomain
);
1010 $template->set( 'reason', $this->mReason
);
1012 $template->set( 'action', $titleObj->getLocalURL( $q ) );
1013 $template->set( 'message', $msg );
1014 $template->set( 'messagetype', $msgtype );
1015 $template->set( 'createemail', $wgEnableEmail && $wgUser->isLoggedIn() );
1016 $template->set( 'userealname', !in_array( 'realname', $wgHiddenPrefs ) );
1017 $template->set( 'useemail', $wgEnableEmail );
1018 $template->set( 'emailrequired', $wgEmailConfirmToEdit );
1019 $template->set( 'canreset', $wgAuth->allowPasswordChange() );
1020 $template->set( 'canremember', ( $wgCookieExpiration > 0 ) );
1021 $template->set( 'usereason', $wgUser->isLoggedIn() );
1022 $template->set( 'remember', $wgUser->getOption( 'rememberpassword' ) ||
$this->mRemember
);
1023 $template->set( 'cansecurelogin', ( $wgSecureLogin === true ) );
1024 $template->set( 'stickHTTPS', $this->mStickHTTPS
);
1026 if ( $this->mType
== 'signup' ) {
1027 if ( !self
::getCreateaccountToken() ) {
1028 self
::setCreateaccountToken();
1030 $template->set( 'token', self
::getCreateaccountToken() );
1032 if ( !self
::getLoginToken() ) {
1033 self
::setLoginToken();
1035 $template->set( 'token', self
::getLoginToken() );
1038 # Prepare language selection links as needed
1039 if( $wgLoginLanguageSelector ) {
1040 $template->set( 'languages', $this->makeLanguageSelector() );
1041 if( $this->mLanguage
)
1042 $template->set( 'uselang', $this->mLanguage
);
1045 // Give authentication and captcha plugins a chance to modify the form
1046 $wgAuth->modifyUITemplate( $template, $this->mType
);
1047 if ( $this->mType
== 'signup' ) {
1048 wfRunHooks( 'UserCreateForm', array( &$template ) );
1050 wfRunHooks( 'UserLoginForm', array( &$template ) );
1053 // Changes the title depending on permissions for creating account
1054 if ( $wgUser->isAllowed( 'createaccount' ) ) {
1055 $wgOut->setPageTitle( wfMsg( 'userlogin' ) );
1057 $wgOut->setPageTitle( wfMsg( 'userloginnocreate' ) );
1060 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1061 $wgOut->setArticleRelated( false );
1062 $wgOut->disallowUserJs(); // just in case...
1063 $wgOut->addTemplate( $template );
1069 function showCreateOrLoginLink( &$user ) {
1070 if( $this->mType
== 'signup' ) {
1072 } elseif( $user->isAllowed( 'createaccount' ) ) {
1080 * Check if a session cookie is present.
1082 * This will not pick up a cookie set during _this_ request, but is meant
1083 * to ensure that the client is returning the cookie which was set on a
1084 * previous pass through the system.
1088 function hasSessionCookie() {
1089 global $wgDisableCookieCheck, $wgRequest;
1090 return $wgDisableCookieCheck ?
true : $wgRequest->checkSessionCookie();
1094 * Get the login token from the current session
1096 public static function getLoginToken() {
1098 return $wgRequest->getSessionData( 'wsLoginToken' );
1102 * Randomly generate a new login token and attach it to the current session
1104 public static function setLoginToken() {
1106 // Use User::generateToken() instead of $user->editToken()
1107 // because the latter reuses $_SESSION['wsEditToken']
1108 $wgRequest->setSessionData( 'wsLoginToken', User
::generateToken() );
1112 * Remove any login token attached to the current session
1114 public static function clearLoginToken() {
1116 $wgRequest->setSessionData( 'wsLoginToken', null );
1120 * Get the createaccount token from the current session
1122 public static function getCreateaccountToken() {
1124 return $wgRequest->getSessionData( 'wsCreateaccountToken' );
1128 * Randomly generate a new createaccount token and attach it to the current session
1130 public static function setCreateaccountToken() {
1132 $wgRequest->setSessionData( 'wsCreateaccountToken', User
::generateToken() );
1136 * Remove any createaccount token attached to the current session
1138 public static function clearCreateaccountToken() {
1140 $wgRequest->setSessionData( 'wsCreateaccountToken', null );
1146 function cookieRedirectCheck( $type ) {
1149 $titleObj = SpecialPage
::getTitleFor( 'Userlogin' );
1150 $query = array( 'wpCookieCheck' => $type );
1151 if ( $this->mReturnTo
) {
1152 $query['returnto'] = $this->mReturnTo
;
1154 $check = $titleObj->getFullURL( $query );
1156 return $wgOut->redirect( $check );
1162 function onCookieRedirectCheck( $type ) {
1163 if ( !$this->hasSessionCookie() ) {
1164 if ( $type == 'new' ) {
1165 return $this->mainLoginForm( wfMsgExt( 'nocookiesnew', array( 'parseinline' ) ) );
1166 } elseif ( $type == 'login' ) {
1167 return $this->mainLoginForm( wfMsgExt( 'nocookieslogin', array( 'parseinline' ) ) );
1170 return $this->mainLoginForm( wfMsg( 'error' ) );
1173 return $this->successfulLogin();
1180 function throttleHit( $limit ) {
1181 $this->mainLoginForm( wfMsgExt( 'acct_creation_throttle_hit', array( 'parseinline' ), $limit ) );
1185 * Produce a bar of links which allow the user to select another language
1186 * during login/registration but retain "returnto"
1190 function makeLanguageSelector() {
1193 $msg = wfMsgForContent( 'loginlanguagelinks' );
1194 if( $msg != '' && !wfEmptyMsg( 'loginlanguagelinks', $msg ) ) {
1195 $langs = explode( "\n", $msg );
1197 foreach( $langs as $lang ) {
1198 $lang = trim( $lang, '* ' );
1199 $parts = explode( '|', $lang );
1200 if ( count( $parts ) >= 2 ) {
1201 $links[] = $this->makeLanguageSelectorLink( $parts[0], $parts[1] );
1204 return count( $links ) > 0 ?
wfMsgHtml( 'loginlanguagelabel', $wgLang->pipeList( $links ) ) : '';
1211 * Create a language selector link for a particular language
1212 * Links back to this page preserving type and returnto
1214 * @param $text Link text
1215 * @param $lang Language code
1217 function makeLanguageSelectorLink( $text, $lang ) {
1219 $self = SpecialPage
::getTitleFor( 'Userlogin' );
1220 $attr = array( 'uselang' => $lang );
1221 if( $this->mType
== 'signup' ) {
1222 $attr['type'] = 'signup';
1224 if( $this->mReturnTo
) {
1225 $attr['returnto'] = $this->mReturnTo
;
1227 $skin = $wgUser->getSkin();
1228 return $skin->linkKnown(
1230 htmlspecialchars( $text ),