4 * @addtogroup SpecialPage
10 function wfSpecialUserlogin() {
11 global $wgCommandLineMode;
13 if( session_id() == '' ) {
17 $form = new LoginForm( $wgRequest );
23 * @addtogroup SpecialPage
31 const WRONG_PLUGIN_PASS
= 3;
37 var $mName, $mPassword, $mRetype, $mReturnTo, $mCookieCheck, $mPosted;
38 var $mAction, $mCreateaccount, $mCreateaccountMail, $mMailmypassword;
39 var $mLoginattempt, $mRemember, $mEmail, $mDomain, $mLanguage;
43 * @param webrequest $request A webrequest object passed by reference
45 function LoginForm( &$request ) {
46 global $wgLang, $wgAllowRealName, $wgEnableEmail;
49 $this->mType
= $request->getText( 'type' );
50 $this->mName
= $request->getText( 'wpName' );
51 $this->mPassword
= $request->getText( 'wpPassword' );
52 $this->mRetype
= $request->getText( 'wpRetype' );
53 $this->mDomain
= $request->getText( 'wpDomain' );
54 $this->mReturnTo
= $request->getVal( 'returnto' );
55 $this->mCookieCheck
= $request->getVal( 'wpCookieCheck' );
56 $this->mPosted
= $request->wasPosted();
57 $this->mCreateaccount
= $request->getCheck( 'wpCreateaccount' );
58 $this->mCreateaccountMail
= $request->getCheck( 'wpCreateaccountMail' )
60 $this->mMailmypassword
= $request->getCheck( 'wpMailmypassword' )
62 $this->mLoginattempt
= $request->getCheck( 'wpLoginattempt' );
63 $this->mAction
= $request->getVal( 'action' );
64 $this->mRemember
= $request->getCheck( 'wpRemember' );
65 $this->mLanguage
= $request->getText( 'uselang' );
67 if( $wgEnableEmail ) {
68 $this->mEmail
= $request->getText( 'wpEmail' );
72 if( $wgAllowRealName ) {
73 $this->mRealName
= $request->getText( 'wpRealName' );
75 $this->mRealName
= '';
78 if( !$wgAuth->validDomain( $this->mDomain
) ) {
79 $this->mDomain
= 'invaliddomain';
81 $wgAuth->setDomain( $this->mDomain
);
83 # When switching accounts, it sucks to get automatically logged out
84 if( $this->mReturnTo
== $wgLang->specialPage( 'Userlogout' ) ) {
85 $this->mReturnTo
= '';
90 if ( !is_null( $this->mCookieCheck
) ) {
91 $this->onCookieRedirectCheck( $this->mCookieCheck
);
93 } else if( $this->mPosted
) {
94 if( $this->mCreateaccount
) {
95 return $this->addNewAccount();
96 } else if ( $this->mCreateaccountMail
) {
97 return $this->addNewAccountMailPassword();
98 } else if ( $this->mMailmypassword
) {
99 return $this->mailPassword();
100 } else if ( ( 'submitlogin' == $this->mAction
) ||
$this->mLoginattempt
) {
101 return $this->processLogin();
104 $this->mainLoginForm( '' );
110 function addNewAccountMailPassword() {
113 if ('' == $this->mEmail
) {
114 $this->mainLoginForm( wfMsg( 'noemail', htmlspecialchars( $this->mName
) ) );
118 $u = $this->addNewaccountInternal();
124 // Wipe the initial password and mail a temporary one
125 $u->setPassword( null );
127 $result = $this->mailPasswordInternal( $u, false );
129 wfRunHooks( 'AddNewAccount', array( $u ) );
131 $wgOut->setPageTitle( wfMsg( 'accmailtitle' ) );
132 $wgOut->setRobotpolicy( 'noindex,nofollow' );
133 $wgOut->setArticleRelated( false );
135 if( WikiError
::isError( $result ) ) {
136 $this->mainLoginForm( wfMsg( 'mailerror', $result->getMessage() ) );
138 $wgOut->addWikiText( wfMsg( 'accmailtext', $u->getName(), $u->getEmail() ) );
139 $wgOut->returnToMain( false );
148 function addNewAccount() {
149 global $wgUser, $wgEmailAuthentication;
151 # Create the account and abort if there's a problem doing so
152 $u = $this->addNewAccountInternal();
156 # If we showed up language selection links, and one was in use, be
157 # smart (and sensible) and save that language as the user's preference
158 global $wgLoginLanguageSelector;
159 if( $wgLoginLanguageSelector && $this->mLanguage
)
160 $u->setOption( 'language', $this->mLanguage
);
162 # Save user settings and send out an email authentication message if needed
164 if( $wgEmailAuthentication && User
::isValidEmailAddr( $u->getEmail() ) ) {
166 $error = $u->sendConfirmationMail();
167 if( WikiError
::isError( $error ) ) {
168 $wgOut->addWikiText( wfMsg( 'confirmemail_sendfailed', $error->getMessage() ) );
170 $wgOut->addWikiText( wfMsg( 'confirmemail_oncreate' ) );
174 # If not logged in, assume the new account as the current one and set session cookies
175 # then show a "welcome" message or a "need cookies" message as needed
176 if( $wgUser->isAnon() ) {
178 $wgUser->setCookies();
179 wfRunHooks( 'AddNewAccount', array( $wgUser ) );
180 if( $this->hasSessionCookie() ) {
181 return $this->successfulLogin( wfMsg( 'welcomecreation', $wgUser->getName() ), false );
183 return $this->cookieRedirectCheck( 'new' );
186 # Confirm that the account was created
188 $self = SpecialPage
::getTitleFor( 'Userlogin' );
189 $wgOut->setPageTitle( wfMsgHtml( 'accountcreated' ) );
190 $wgOut->setArticleRelated( false );
191 $wgOut->setRobotPolicy( 'noindex,nofollow' );
192 $wgOut->addHtml( wfMsgWikiHtml( 'accountcreatedtext', $u->getName() ) );
193 $wgOut->returnToMain( $self->getPrefixedText() );
194 wfRunHooks( 'AddNewAccount', array( $u ) );
202 function addNewAccountInternal() {
203 global $wgUser, $wgOut;
204 global $wgEnableSorbs, $wgProxyWhitelist;
205 global $wgMemc, $wgAccountCreationThrottle;
206 global $wgAuth, $wgMinimalPasswordLength;
208 // If the user passes an invalid domain, something is fishy
209 if( !$wgAuth->validDomain( $this->mDomain
) ) {
210 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
214 // If we are not allowing users to login locally, we should
215 // be checking to see if the user is actually able to
216 // authenticate to the authentication server before they
217 // create an account (otherwise, they can create a local account
218 // and login as any domain user). We only need to check this for
219 // domains that aren't local.
220 if( 'local' != $this->mDomain
&& '' != $this->mDomain
) {
221 if( !$wgAuth->canCreateAccounts() && ( !$wgAuth->userExists( $this->mName
) ||
!$wgAuth->authenticate( $this->mName
, $this->mPassword
) ) ) {
222 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
227 if ( wfReadOnly() ) {
228 $wgOut->readOnlyPage();
232 if (!$wgUser->isAllowedToCreateAccount()) {
233 $this->userNotPrivilegedMessage();
238 if ( $wgEnableSorbs && !in_array( $ip, $wgProxyWhitelist ) &&
239 $wgUser->inSorbsBlacklist( $ip ) )
241 $this->mainLoginForm( wfMsg( 'sorbs_create_account_reason' ) . ' (' . htmlspecialchars( $ip ) . ')' );
245 $name = trim( $this->mName
);
246 $u = User
::newFromName( $name, 'creatable' );
247 if ( is_null( $u ) ) {
248 $this->mainLoginForm( wfMsg( 'noname' ) );
252 if ( 0 != $u->idForName() ) {
253 $this->mainLoginForm( wfMsg( 'userexists' ) );
257 if ( 0 != strcmp( $this->mPassword
, $this->mRetype
) ) {
258 $this->mainLoginForm( wfMsg( 'badretype' ) );
262 if ( !$wgUser->isValidPassword( $this->mPassword
) ) {
263 $this->mainLoginForm( wfMsg( 'passwordtooshort', $wgMinimalPasswordLength ) );
268 if( !wfRunHooks( 'AbortNewAccount', array( $u, &$abortError ) ) ) {
269 // Hook point to add extra creation throttles and blocks
270 wfDebug( "LoginForm::addNewAccountInternal: a hook blocked creation\n" );
271 $this->mainLoginForm( $abortError );
275 if ( $wgAccountCreationThrottle ) {
276 $key = wfMemcKey( 'acctcreate', 'ip', $ip );
277 $value = $wgMemc->incr( $key );
279 $wgMemc->set( $key, 1, 86400 );
281 if ( $value > $wgAccountCreationThrottle ) {
282 $this->throttleHit( $wgAccountCreationThrottle );
287 if( !$wgAuth->addUser( $u, $this->mPassword
, $this->mEmail
, $this->mRealName
) ) {
288 $this->mainLoginForm( wfMsg( 'externaldberror' ) );
292 return $this->initUser( $u );
296 * Actually add a user to the database.
297 * Give it a User object that has been initialised with a name.
299 * @param $u User object.
300 * @return User object.
303 function initUser( $u ) {
305 $u->setPassword( $this->mPassword
);
306 $u->setEmail( $this->mEmail
);
307 $u->setRealName( $this->mRealName
);
311 $wgAuth->initUser( $u );
313 $u->setOption( 'rememberpassword', $this->mRemember ?
1 : 0 );
317 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
318 $ssUpdate->doUpdate();
324 * Internally authenticate the login request.
326 * This may create a local account as a side effect if the
327 * authentication plugin allows transparent local account
332 function authenticateUserData() {
333 global $wgUser, $wgAuth;
334 if ( '' == $this->mName
) {
335 return self
::NO_NAME
;
337 $u = User
::newFromName( $this->mName
);
338 if( is_null( $u ) ||
!User
::isUsableName( $u->getName() ) ) {
339 return self
::ILLEGAL
;
341 if ( 0 == $u->getID() ) {
344 * If the external authentication plugin allows it,
345 * automatically create a new account for users that
346 * are externally defined but have not yet logged in.
348 if ( $wgAuth->autoCreate() && $wgAuth->userExists( $u->getName() ) ) {
349 if ( $wgAuth->authenticate( $u->getName(), $this->mPassword
) ) {
350 $u = $this->initUser( $u );
352 return self
::WRONG_PLUGIN_PASS
;
355 return self
::NOT_EXISTS
;
361 if (!$u->checkPassword( $this->mPassword
)) {
362 if( $u->checkTemporaryPassword( $this->mPassword
) ) {
363 // The e-mailed temporary password should not be used
364 // for actual logins; that's a very sloppy habit,
365 // and insecure if an attacker has a few seconds to
366 // click "search" on someone's open mail reader.
368 // Allow it to be used only to reset the password
369 // a single time to a new value, which won't be in
370 // the user's e-mail archives.
372 // For backwards compatibility, we'll still recognize
373 // it at the login form to minimize surprises for
374 // people who have been logging in with a temporary
375 // password for some time.
377 // As a side-effect, we can authenticate the user's
378 // e-mail address if it's not already done, since
379 // the temporary password was sent via e-mail.
381 if( !$u->isEmailConfirmed() ) {
385 // At this point we just return an appropriate code
386 // indicating that the UI should show a password
387 // reset form; bot interfaces etc will probably just
388 // fail cleanly here.
390 return self
::RESET_PASS
;
392 return '' == $this->mPassword ? self
::EMPTY_PASS
: self
::WRONG_PASS
;
395 $wgAuth->updateUser( $u );
398 return self
::SUCCESS
;
402 function processLogin() {
403 global $wgUser, $wgAuth;
405 switch ($this->authenticateUserData())
408 # We've verified now, update the real record
409 if( (bool)$this->mRemember
!= (bool)$wgUser->getOption( 'rememberpassword' ) ) {
410 $wgUser->setOption( 'rememberpassword', $this->mRemember ?
1 : 0 );
411 $wgUser->saveSettings();
413 $wgUser->invalidateCache();
415 $wgUser->setCookies();
417 if( $this->hasSessionCookie() ) {
418 return $this->successfulLogin( wfMsg( 'loginsuccess', $wgUser->getName() ) );
420 return $this->cookieRedirectCheck( 'login' );
426 $this->mainLoginForm( wfMsg( 'noname' ) );
428 case self
::WRONG_PLUGIN_PASS
:
429 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
431 case self
::NOT_EXISTS
:
432 $this->mainLoginForm( wfMsg( 'nosuchuser', htmlspecialchars( $this->mName
) ) );
434 case self
::WRONG_PASS
:
435 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
437 case self
::EMPTY_PASS
:
438 $this->mainLoginForm( wfMsg( 'wrongpasswordempty' ) );
440 case self
::RESET_PASS
:
441 $this->resetLoginForm( wfMsg( 'resetpass_announce' ) );
444 wfDebugDieBacktrace( "Unhandled case value" );
448 function resetLoginForm( $error ) {
450 $wgOut->addWikiText( "<div class=\"errorbox\">$error</div>" );
451 $reset = new PasswordResetForm( $this->mName
, $this->mPassword
);
458 function mailPassword() {
459 global $wgUser, $wgOut, $wgAuth;
461 if( !$wgAuth->allowPasswordChange() ) {
462 $this->mainLoginForm( wfMsg( 'resetpass_forbidden' ) );
466 # Check against blocked IPs
467 # fixme -- should we not?
468 if( $wgUser->isBlocked() ) {
469 $this->mainLoginForm( wfMsg( 'blocked-mailpassword' ) );
473 # Check against the rate limiter
474 if( $wgUser->pingLimiter( 'mailpassword' ) ) {
475 $wgOut->rateLimited();
479 if ( '' == $this->mName
) {
480 $this->mainLoginForm( wfMsg( 'noname' ) );
483 $u = User
::newFromName( $this->mName
);
484 if( is_null( $u ) ) {
485 $this->mainLoginForm( wfMsg( 'noname' ) );
488 if ( 0 == $u->getID() ) {
489 $this->mainLoginForm( wfMsg( 'nosuchuser', $u->getName() ) );
493 # Check against password throttle
494 if ( $u->isPasswordReminderThrottled() ) {
495 global $wgPasswordReminderResendTime;
496 # Round the time in hours to 3 d.p., in case someone is specifying minutes or seconds.
497 $this->mainLoginForm( wfMsg( 'throttled-mailpassword',
498 round( $wgPasswordReminderResendTime, 3 ) ) );
502 $result = $this->mailPasswordInternal( $u, true );
503 if( WikiError
::isError( $result ) ) {
504 $this->mainLoginForm( wfMsg( 'mailerror', $result->getMessage() ) );
506 $this->mainLoginForm( wfMsg( 'passwordsent', $u->getName() ), 'success' );
512 * @return mixed true on success, WikiError on failure
515 function mailPasswordInternal( $u, $throttle = true ) {
516 global $wgCookiePath, $wgCookieDomain, $wgCookiePrefix, $wgCookieSecure;
517 global $wgServer, $wgScript;
519 if ( '' == $u->getEmail() ) {
520 return new WikiError( wfMsg( 'noemail', $u->getName() ) );
523 $np = $u->randomPassword();
524 $u->setNewpassword( $np, $throttle );
526 setcookie( "{$wgCookiePrefix}Token", '', time() - 3600, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
531 if ( '' == $ip ) { $ip = '(Unknown)'; }
533 $m = wfMsg( 'passwordremindertext', $ip, $u->getName(), $np, $wgServer . $wgScript );
535 $result = $u->sendMail( wfMsg( 'passwordremindertitle' ), $m );
541 * @param string $msg Message that will be shown on success
542 * @param bool $auto Toggle auto-redirect to main page; default true
545 function successfulLogin( $msg, $auto = true ) {
549 # Run any hooks; ignore results
551 wfRunHooks('UserLoginComplete', array(&$wgUser));
553 $wgOut->setPageTitle( wfMsg( 'loginsuccesstitle' ) );
554 $wgOut->setRobotpolicy( 'noindex,nofollow' );
555 $wgOut->setArticleRelated( false );
556 $wgOut->addWikiText( $msg );
557 if ( !empty( $this->mReturnTo
) ) {
558 $wgOut->returnToMain( $auto, $this->mReturnTo
);
560 $wgOut->returnToMain( $auto );
565 function userNotPrivilegedMessage() {
568 $wgOut->setPageTitle( wfMsg( 'whitelistacctitle' ) );
569 $wgOut->setRobotpolicy( 'noindex,nofollow' );
570 $wgOut->setArticleRelated( false );
572 $wgOut->addWikiText( wfMsg( 'whitelistacctext' ) );
574 $wgOut->returnToMain( false );
578 function userBlockedMessage() {
581 # Let's be nice about this, it's likely that this feature will be used
582 # for blocking large numbers of innocent people, e.g. range blocks on
583 # schools. Don't blame it on the user. There's a small chance that it
584 # really is the user's fault, i.e. the username is blocked and they
585 # haven't bothered to log out before trying to create an account to
586 # evade it, but we'll leave that to their guilty conscience to figure
589 $wgOut->setPageTitle( wfMsg( 'cantcreateaccounttitle' ) );
590 $wgOut->setRobotpolicy( 'noindex,nofollow' );
591 $wgOut->setArticleRelated( false );
594 $wgOut->addWikiText( wfMsg( 'cantcreateaccounttext', $ip ) );
595 $wgOut->returnToMain( false );
601 function mainLoginForm( $msg, $msgtype = 'error' ) {
602 global $wgUser, $wgOut, $wgAllowRealName, $wgEnableEmail;
603 global $wgCookiePrefix, $wgAuth, $wgLoginLanguageSelector;
606 if ( $this->mType
== 'signup' ) {
607 if ( !$wgUser->isAllowed( 'createaccount' ) ) {
608 $this->userNotPrivilegedMessage();
610 } elseif ( $wgUser->isBlockedFromCreateAccount() ) {
611 $this->userBlockedMessage();
616 if ( '' == $this->mName
) {
617 if ( $wgUser->isLoggedIn() ) {
618 $this->mName
= $wgUser->getName();
620 $this->mName
= isset( $_COOKIE[$wgCookiePrefix.'UserName'] ) ?
$_COOKIE[$wgCookiePrefix.'UserName'] : null;
624 $titleObj = SpecialPage
::getTitleFor( 'Userlogin' );
626 if ( $this->mType
== 'signup' ) {
627 $template = new UsercreateTemplate();
628 $q = 'action=submitlogin&type=signup';
629 $linkq = 'type=login';
630 $linkmsg = 'gotaccount';
632 $template = new UserloginTemplate();
633 $q = 'action=submitlogin&type=login';
634 $linkq = 'type=signup';
635 $linkmsg = 'nologin';
638 if ( !empty( $this->mReturnTo
) ) {
639 $returnto = '&returnto=' . wfUrlencode( $this->mReturnTo
);
644 # Pass any language selection on to the mode switch link
645 if( $wgLoginLanguageSelector && $this->mLanguage
)
646 $linkq .= '&uselang=' . $this->mLanguage
;
648 $link = '<a href="' . htmlspecialchars ( $titleObj->getLocalUrl( $linkq ) ) . '">';
649 $link .= wfMsgHtml( $linkmsg . 'link' );
652 # Don't show a "create account" link if the user can't
653 if( $this->showCreateOrLoginLink( $wgUser ) )
654 $template->set( 'link', wfMsgHtml( $linkmsg, $link ) );
656 $template->set( 'link', '' );
658 $template->set( 'header', '' );
659 $template->set( 'name', $this->mName
);
660 $template->set( 'password', $this->mPassword
);
661 $template->set( 'retype', $this->mRetype
);
662 $template->set( 'email', $this->mEmail
);
663 $template->set( 'realname', $this->mRealName
);
664 $template->set( 'domain', $this->mDomain
);
666 $template->set( 'action', $titleObj->getLocalUrl( $q ) );
667 $template->set( 'message', $msg );
668 $template->set( 'messagetype', $msgtype );
669 $template->set( 'createemail', $wgEnableEmail && $wgUser->isLoggedIn() );
670 $template->set( 'userealname', $wgAllowRealName );
671 $template->set( 'useemail', $wgEnableEmail );
672 $template->set( 'canreset', $wgAuth->allowPasswordChange() );
673 $template->set( 'remember', $wgUser->getOption( 'rememberpassword' ) or $this->mRemember
);
675 # Prepare language selection links as needed
676 if( $wgLoginLanguageSelector ) {
677 $template->set( 'languages', $this->makeLanguageSelector() );
678 if( $this->mLanguage
)
679 $template->set( 'uselang', $this->mLanguage
);
682 // Give authentication and captcha plugins a chance to modify the form
683 $wgAuth->modifyUITemplate( $template );
684 if ( $this->mType
== 'signup' ) {
685 wfRunHooks( 'UserCreateForm', array( &$template ) );
687 wfRunHooks( 'UserLoginForm', array( &$template ) );
690 $wgOut->setPageTitle( wfMsg( 'userlogin' ) );
691 $wgOut->setRobotpolicy( 'noindex,nofollow' );
692 $wgOut->setArticleRelated( false );
693 $wgOut->addTemplate( $template );
699 function showCreateOrLoginLink( &$user ) {
700 if( $this->mType
== 'signup' ) {
702 } elseif( $user->isAllowed( 'createaccount' ) ) {
710 * Check if a session cookie is present.
712 * This will not pick up a cookie set during _this_ request, but is
713 * meant to ensure that the client is returning the cookie which was
714 * set on a previous pass through the system.
718 function hasSessionCookie() {
719 global $wgDisableCookieCheck, $wgRequest;
720 return $wgDisableCookieCheck ?
true : $wgRequest->checkSessionCookie();
726 function cookieRedirectCheck( $type ) {
729 $titleObj = SpecialPage
::getTitleFor( 'Userlogin' );
730 $check = $titleObj->getFullURL( 'wpCookieCheck='.$type );
732 return $wgOut->redirect( $check );
738 function onCookieRedirectCheck( $type ) {
741 if ( !$this->hasSessionCookie() ) {
742 if ( $type == 'new' ) {
743 return $this->mainLoginForm( wfMsg( 'nocookiesnew' ) );
744 } else if ( $type == 'login' ) {
745 return $this->mainLoginForm( wfMsg( 'nocookieslogin' ) );
748 return $this->mainLoginForm( wfMsg( 'error' ) );
751 return $this->successfulLogin( wfMsg( 'loginsuccess', $wgUser->getName() ) );
758 function throttleHit( $limit ) {
761 $wgOut->addWikiText( wfMsg( 'acct_creation_throttle_hit', $limit ) );
765 * Produce a bar of links which allow the user to select another language
766 * during login/registration but retain "returnto"
770 function makeLanguageSelector() {
771 $msg = wfMsgForContent( 'loginlanguagelinks' );
772 if( $msg != '' && !wfEmptyMsg( 'loginlanguagelinks', $msg ) ) {
773 $langs = explode( "\n", $msg );
775 foreach( $langs as $lang ) {
776 $lang = trim( $lang, '* ' );
777 $parts = explode( '|', $lang );
778 $links[] = $this->makeLanguageSelectorLink( $parts[0], $parts[1] );
780 return count( $links ) > 0 ?
wfMsgHtml( 'loginlanguagelabel', implode( ' | ', $links ) ) : '';
787 * Create a language selector link for a particular language
788 * Links back to this page preserving type and returnto
790 * @param $text Link text
791 * @param $lang Language code
793 function makeLanguageSelectorLink( $text, $lang ) {
795 $self = SpecialPage
::getTitleFor( 'Userlogin' );
796 $attr[] = 'uselang=' . $lang;
797 if( $this->mType
== 'signup' )
798 $attr[] = 'type=signup';
799 if( $this->mReturnTo
)
800 $attr[] = 'returnto=' . $this->mReturnTo
;
801 $skin = $wgUser->getSkin();
802 return $skin->makeKnownLinkObj( $self, htmlspecialchars( $text ), implode( '&', $attr ) );