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 = null;
52 private $mLoaded = false;
53 private $mSecureLoginUrl;
58 private $mOverrideRequest = null;
61 * Effective request; set at the beginning of load
63 * @var WebRequest $mRequest
65 private $mRequest = null;
68 * @param WebRequest $request
70 public function __construct( $request = null ) {
71 parent
::__construct( 'Userlogin' );
73 $this->mOverrideRequest
= $request;
80 global $wgAuth, $wgHiddenPrefs, $wgEnableEmail;
82 if ( $this->mLoaded
) {
85 $this->mLoaded
= true;
87 if ( $this->mOverrideRequest
=== null ) {
88 $request = $this->getRequest();
90 $request = $this->mOverrideRequest
;
92 $this->mRequest
= $request;
94 $this->mType
= $request->getText( 'type' );
95 $this->mUsername
= $request->getText( 'wpName' );
96 $this->mPassword
= $request->getText( 'wpPassword' );
97 $this->mRetype
= $request->getText( 'wpRetype' );
98 $this->mDomain
= $request->getText( 'wpDomain' );
99 $this->mReason
= $request->getText( 'wpReason' );
100 $this->mCookieCheck
= $request->getVal( 'wpCookieCheck' );
101 $this->mPosted
= $request->wasPosted();
102 $this->mCreateaccountMail
= $request->getCheck( 'wpCreateaccountMail' )
104 $this->mCreateaccount
= $request->getCheck( 'wpCreateaccount' ) && !$this->mCreateaccountMail
;
105 $this->mLoginattempt
= $request->getCheck( 'wpLoginattempt' );
106 $this->mAction
= $request->getVal( 'action' );
107 $this->mRemember
= $request->getCheck( 'wpRemember' );
108 $this->mFromHTTP
= $request->getBool( 'fromhttp', false );
109 $this->mStickHTTPS
= ( !$this->mFromHTTP
&& $request->getProtocol() === 'https' ) ||
$request->getBool( 'wpForceHttps', false );
110 $this->mLanguage
= $request->getText( 'uselang' );
111 $this->mSkipCookieCheck
= $request->getCheck( 'wpSkipCookieCheck' );
112 $this->mToken
= ( $this->mType
== 'signup' ) ?
$request->getVal( 'wpCreateaccountToken' ) : $request->getVal( 'wpLoginToken' );
113 $this->mReturnTo
= $request->getVal( 'returnto', '' );
114 $this->mReturnToQuery
= $request->getVal( 'returntoquery', '' );
116 if ( $wgEnableEmail ) {
117 $this->mEmail
= $request->getText( 'wpEmail' );
121 if ( !in_array( 'realname', $wgHiddenPrefs ) ) {
122 $this->mRealName
= $request->getText( 'wpRealName' );
124 $this->mRealName
= '';
127 if ( !$wgAuth->validDomain( $this->mDomain
) ) {
128 $this->mDomain
= $wgAuth->getDomain();
130 $wgAuth->setDomain( $this->mDomain
);
132 # 1. When switching accounts, it sucks to get automatically logged out
133 # 2. Do not return to PasswordReset after a successful password change
134 # but goto Wiki start page (Main_Page) instead ( bug 33997 )
135 $returnToTitle = Title
::newFromText( $this->mReturnTo
);
136 if ( is_object( $returnToTitle ) && (
137 $returnToTitle->isSpecial( 'Userlogout' )
138 ||
$returnToTitle->isSpecial( 'PasswordReset' ) ) ) {
139 $this->mReturnTo
= '';
140 $this->mReturnToQuery
= '';
144 function getDescription() {
145 if ( $this->mType
=== 'signup' ) {
146 return $this->msg( 'createaccount' )->text();
148 return $this->msg( 'login' )->text();
153 * @param $subPage string|null
155 public function execute( $subPage ) {
156 if ( session_id() == '' ) {
162 // Check for [[Special:Userlogin/signup]]. This affects form display and
164 if ( $subPage == 'signup' ) {
165 $this->mType
= 'signup';
169 // If logging in and not on HTTPS, either redirect to it or offer a link.
170 global $wgSecureLogin;
171 if ( $this->mRequest
->getProtocol() !== 'https' ) {
172 $title = $this->getFullTitle();
174 'returnto' => $this->mReturnTo
,
175 'returntoquery' => $this->mReturnToQuery
,
177 ) +
$this->mRequest
->getQueryValues();
178 $url = $title->getFullURL( $query, false, PROTO_HTTPS
);
179 if ( $wgSecureLogin && wfCanIPUseHTTPS( $this->getRequest()->getIP() ) ) {
180 $url = wfAppendQuery( $url, 'fromhttp=1' );
181 $this->getOutput()->redirect( $url );
182 // Since we only do this redir to change proto, always vary
183 $this->getOutput()->addVaryHeader( 'X-Forwarded-Proto' );
186 // A wiki without HTTPS login support should set $wgServer to
187 // http://somehost, in which case the secure URL generated
188 // above won't actually start with https://
189 if ( substr( $url, 0, 8 ) === 'https://' ) {
190 $this->mSecureLoginUrl
= $url;
195 if ( !is_null( $this->mCookieCheck
) ) {
196 $this->onCookieRedirectCheck( $this->mCookieCheck
);
198 } elseif ( $this->mPosted
) {
199 if ( $this->mCreateaccount
) {
200 $this->addNewAccount();
202 } elseif ( $this->mCreateaccountMail
) {
203 $this->addNewAccountMailPassword();
205 } elseif ( ( 'submitlogin' == $this->mAction
) ||
$this->mLoginattempt
) {
206 $this->processLogin();
210 $this->mainLoginForm( '' );
216 function addNewAccountMailPassword() {
217 if ( $this->mEmail
== '' ) {
218 $this->mainLoginForm( $this->msg( 'noemailcreate' )->escaped() );
222 $status = $this->addNewAccountInternal();
223 if ( !$status->isGood() ) {
224 $error = $status->getMessage();
225 $this->mainLoginForm( $error->toString() );
229 $u = $status->getValue();
231 // Wipe the initial password and mail a temporary one
232 $u->setPassword( null );
234 $result = $this->mailPasswordInternal( $u, false, 'createaccount-title', 'createaccount-text' );
236 wfRunHooks( 'AddNewAccount', array( $u, true ) );
237 $u->addNewUserLogEntry( 'byemail', $this->mReason
);
239 $out = $this->getOutput();
240 $out->setPageTitle( $this->msg( 'accmailtitle' ) );
242 if ( !$result->isGood() ) {
243 $this->mainLoginForm( $this->msg( 'mailerror', $result->getWikiText() )->text() );
245 $out->addWikiMsg( 'accmailtext', $u->getName(), $u->getEmail() );
246 $this->executeReturnTo( 'success' );
254 function addNewAccount() {
255 global $wgContLang, $wgUser, $wgEmailAuthentication, $wgLoginLanguageSelector;
257 # Create the account and abort if there's a problem doing so
258 $status = $this->addNewAccountInternal();
259 if ( !$status->isGood() ) {
260 $error = $status->getMessage();
261 $this->mainLoginForm( $error->toString() );
265 $u = $status->getValue();
267 # Only save preferences if the user is not creating an account for someone else.
268 if ( $this->getUser()->isAnon() ) {
269 # If we showed up language selection links, and one was in use, be
270 # smart (and sensible) and save that language as the user's preference
271 if ( $wgLoginLanguageSelector && $this->mLanguage
) {
272 $u->setOption( 'language', $this->mLanguage
);
275 # Otherwise the user's language preference defaults to $wgContLang,
276 # but it may be better to set it to their preferred $wgContLang variant,
277 # based on browser preferences or URL parameters.
278 $u->setOption( 'language', $wgContLang->getPreferredVariant() );
280 if ( $wgContLang->hasVariants() ) {
281 $u->setOption( 'variant', $wgContLang->getPreferredVariant() );
285 $out = $this->getOutput();
287 # Send out an email authentication message if needed
288 if ( $wgEmailAuthentication && Sanitizer
::validateEmail( $u->getEmail() ) ) {
289 $status = $u->sendConfirmationMail();
290 if ( $status->isGood() ) {
291 $out->addWikiMsg( 'confirmemail_oncreate' );
293 $out->addWikiText( $status->getWikiText( 'confirmemail_sendfailed' ) );
297 # Save settings (including confirmation token)
300 # If not logged in, assume the new account as the current one and set
301 # session cookies then show a "welcome" message or a "need cookies"
303 if ( $this->getUser()->isAnon() ) {
306 // This should set it for OutputPage and the Skin
307 // which is needed or the personal links will be
309 $this->getContext()->setUser( $u );
310 wfRunHooks( 'AddNewAccount', array( $u, false ) );
311 $u->addNewUserLogEntry( 'create' );
312 if ( $this->hasSessionCookie() ) {
313 $this->successfulCreation();
315 $this->cookieRedirectCheck( 'new' );
318 # Confirm that the account was created
319 $out->setPageTitle( $this->msg( 'accountcreated' ) );
320 $out->addWikiMsg( 'accountcreatedtext', $u->getName() );
321 $out->addReturnTo( $this->getPageTitle() );
322 wfRunHooks( 'AddNewAccount', array( $u, false ) );
323 $u->addNewUserLogEntry( 'create2', $this->mReason
);
329 * Make a new user account using the loaded data.
331 * @throws PermissionsError|ReadOnlyError
334 public function addNewAccountInternal() {
335 global $wgAuth, $wgMemc, $wgAccountCreationThrottle,
336 $wgMinimalPasswordLength, $wgEmailConfirmToEdit;
338 // If the user passes an invalid domain, something is fishy
339 if ( !$wgAuth->validDomain( $this->mDomain
) ) {
340 return Status
::newFatal( 'wrongpassword' );
343 // If we are not allowing users to login locally, we should be checking
344 // to see if the user is actually able to authenticate to the authenti-
345 // cation server before they create an account (otherwise, they can
346 // create a local account and login as any domain user). We only need
347 // to check this for domains that aren't local.
348 if ( 'local' != $this->mDomain
&& $this->mDomain
!= '' ) {
350 !$wgAuth->canCreateAccounts() &&
352 !$wgAuth->userExists( $this->mUsername
) ||
353 !$wgAuth->authenticate( $this->mUsername
, $this->mPassword
)
356 return Status
::newFatal( 'wrongpassword' );
360 if ( wfReadOnly() ) {
361 throw new ReadOnlyError
;
364 # Request forgery checks.
365 if ( !self
::getCreateaccountToken() ) {
366 self
::setCreateaccountToken();
367 return Status
::newFatal( 'nocookiesfornew' );
370 # The user didn't pass a createaccount token
371 if ( !$this->mToken
) {
372 return Status
::newFatal( 'sessionfailure' );
375 # Validate the createaccount token
376 if ( $this->mToken
!== self
::getCreateaccountToken() ) {
377 return Status
::newFatal( 'sessionfailure' );
381 $currentUser = $this->getUser();
382 $creationBlock = $currentUser->isBlockedFromCreateAccount();
383 if ( !$currentUser->isAllowed( 'createaccount' ) ) {
384 throw new PermissionsError( 'createaccount' );
385 } elseif ( $creationBlock instanceof Block
) {
386 // Throws an ErrorPageError.
387 $this->userBlockedMessage( $creationBlock );
388 // This should never be reached.
392 # Include checks that will include GlobalBlocking (Bug 38333)
393 $permErrors = $this->getPageTitle()->getUserPermissionsErrors( 'createaccount', $currentUser, true );
394 if ( count( $permErrors ) ) {
395 throw new PermissionsError( 'createaccount', $permErrors );
398 $ip = $this->getRequest()->getIP();
399 if ( $currentUser->isDnsBlacklisted( $ip, true /* check $wgProxyWhitelist */ ) ) {
400 return Status
::newFatal( 'sorbs_create_account_reason' );
403 # Now create a dummy user ($u) and check if it is valid
404 $name = trim( $this->mUsername
);
405 $u = User
::newFromName( $name, 'creatable' );
406 if ( !is_object( $u ) ) {
407 return Status
::newFatal( 'noname' );
408 } elseif ( 0 != $u->idForName() ) {
409 return Status
::newFatal( 'userexists' );
412 if ( $this->mCreateaccountMail
) {
413 # do not force a password for account creation by email
414 # set invalid password, it will be replaced later by a random generated password
415 $this->mPassword
= null;
417 if ( $this->mPassword
!== $this->mRetype
) {
418 return Status
::newFatal( 'badretype' );
421 # check for minimal password length
422 $valid = $u->getPasswordValidity( $this->mPassword
);
423 if ( $valid !== true ) {
424 if ( !is_array( $valid ) ) {
425 $valid = array( $valid, $wgMinimalPasswordLength );
427 return call_user_func_array( 'Status::newFatal', $valid );
431 # if you need a confirmed email address to edit, then obviously you
432 # need an email address.
433 if ( $wgEmailConfirmToEdit && strval( $this->mEmail
) === '' ) {
434 return Status
::newFatal( 'noemailtitle' );
437 if ( strval( $this->mEmail
) !== '' && !Sanitizer
::validateEmail( $this->mEmail
) ) {
438 return Status
::newFatal( 'invalidemailaddress' );
441 # Set some additional data so the AbortNewAccount hook can be used for
442 # more than just username validation
443 $u->setEmail( $this->mEmail
);
444 $u->setRealName( $this->mRealName
);
447 if ( !wfRunHooks( 'AbortNewAccount', array( $u, &$abortError ) ) ) {
448 // Hook point to add extra creation throttles and blocks
449 wfDebug( "LoginForm::addNewAccountInternal: a hook blocked creation\n" );
450 $abortError = new RawMessage( $abortError );
452 return Status
::newFatal( $abortError );
455 // Hook point to check for exempt from account creation throttle
456 if ( !wfRunHooks( 'ExemptFromAccountCreationThrottle', array( $ip ) ) ) {
457 wfDebug( "LoginForm::exemptFromAccountCreationThrottle: a hook allowed account creation w/o throttle\n" );
459 if ( ( $wgAccountCreationThrottle && $currentUser->isPingLimitable() ) ) {
460 $key = wfMemcKey( 'acctcreate', 'ip', $ip );
461 $value = $wgMemc->get( $key );
463 $wgMemc->set( $key, 0, 86400 );
465 if ( $value >= $wgAccountCreationThrottle ) {
466 return Status
::newFatal( 'acct_creation_throttle_hit', $wgAccountCreationThrottle );
468 $wgMemc->incr( $key );
472 if ( !$wgAuth->addUser( $u, $this->mPassword
, $this->mEmail
, $this->mRealName
) ) {
473 return Status
::newFatal( 'externaldberror' );
476 self
::clearCreateaccountToken();
477 return $this->initUser( $u, false );
481 * Actually add a user to the database.
482 * Give it a User object that has been initialised with a name.
484 * @param $u User object.
485 * @param $autocreate boolean -- true if this is an autocreation via auth plugin
486 * @return Status object, with the User object in the value member on success
489 function initUser( $u, $autocreate ) {
492 $status = $u->addToDatabase();
493 if ( !$status->isOK() ) {
497 if ( $wgAuth->allowPasswordChange() ) {
498 $u->setPassword( $this->mPassword
);
501 $u->setEmail( $this->mEmail
);
502 $u->setRealName( $this->mRealName
);
505 $wgAuth->initUser( $u, $autocreate );
507 $u->setOption( 'rememberpassword', $this->mRemember ?
1 : 0 );
511 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 0, 0, 0, 1 ) );
513 // Watch user's userpage and talk page
514 $u->addWatch( $u->getUserPage(), WatchedItem
::IGNORE_USER_RIGHTS
);
516 return Status
::newGood( $u );
520 * Internally authenticate the login request.
522 * This may create a local account as a side effect if the
523 * authentication plugin allows transparent local account
527 public function authenticateUserData() {
528 global $wgUser, $wgAuth;
532 if ( $this->mUsername
== '' ) {
533 return self
::NO_NAME
;
536 // We require a login token to prevent login CSRF
537 // Handle part of this before incrementing the throttle so
538 // token-less login attempts don't count towards the throttle
539 // but wrong-token attempts do.
541 // If the user doesn't have a login token yet, set one.
542 if ( !self
::getLoginToken() ) {
543 self
::setLoginToken();
544 return self
::NEED_TOKEN
;
546 // If the user didn't pass a login token, tell them we need one
547 if ( !$this->mToken
) {
548 return self
::NEED_TOKEN
;
551 $throttleCount = self
::incLoginThrottle( $this->mUsername
);
552 if ( $throttleCount === true ) {
553 return self
::THROTTLED
;
556 // Validate the login token
557 if ( $this->mToken
!== self
::getLoginToken() ) {
558 return self
::WRONG_TOKEN
;
561 // Load the current user now, and check to see if we're logging in as
562 // the same name. This is necessary because loading the current user
563 // (say by calling getName()) calls the UserLoadFromSession hook, which
564 // potentially creates the user in the database. Until we load $wgUser,
565 // checking for user existence using User::newFromName($name)->getId() below
566 // will effectively be using stale data.
567 if ( $this->getUser()->getName() === $this->mUsername
) {
568 wfDebug( __METHOD__
. ": already logged in as {$this->mUsername}\n" );
569 return self
::SUCCESS
;
572 $u = User
::newFromName( $this->mUsername
);
573 if ( !( $u instanceof User
) ||
!User
::isUsableName( $u->getName() ) ) {
574 return self
::ILLEGAL
;
577 $isAutoCreated = false;
578 if ( $u->getID() == 0 ) {
579 $status = $this->attemptAutoCreate( $u );
580 if ( $status !== self
::SUCCESS
) {
583 $isAutoCreated = true;
589 // Give general extensions, such as a captcha, a chance to abort logins
590 $abort = self
::ABORTED
;
592 if ( !wfRunHooks( 'AbortLogin', array( $u, $this->mPassword
, &$abort, &$msg ) ) ) {
593 $this->mAbortLoginErrorMsg
= $msg;
597 global $wgBlockDisablesLogin;
598 if ( !$u->checkPassword( $this->mPassword
) ) {
599 if ( $u->checkTemporaryPassword( $this->mPassword
) ) {
600 // The e-mailed temporary password should not be used for actu-
601 // al logins; that's a very sloppy habit, and insecure if an
602 // attacker has a few seconds to click "search" on someone's o-
605 // Allow it to be used only to reset the password a single time
606 // to a new value, which won't be in the user's e-mail ar-
609 // For backwards compatibility, we'll still recognize it at the
610 // login form to minimize surprises for people who have been
611 // logging in with a temporary password for some time.
613 // As a side-effect, we can authenticate the user's e-mail ad-
614 // dress if it's not already done, since the temporary password
615 // was sent via e-mail.
616 if ( !$u->isEmailConfirmed() ) {
621 // At this point we just return an appropriate code/ indicating
622 // that the UI should show a password reset form; bot inter-
623 // faces etc will probably just fail cleanly here.
624 $retval = self
::RESET_PASS
;
626 $retval = ( $this->mPassword
== '' ) ? self
::EMPTY_PASS
: self
::WRONG_PASS
;
628 } elseif ( $wgBlockDisablesLogin && $u->isBlocked() ) {
629 // If we've enabled it, make it so that a blocked user cannot login
630 $retval = self
::USER_BLOCKED
;
632 $wgAuth->updateUser( $u );
634 // This should set it for OutputPage and the Skin
635 // which is needed or the personal links will be
637 $this->getContext()->setUser( $u );
639 // Please reset throttle for successful logins, thanks!
640 if ( $throttleCount ) {
641 self
::clearLoginThrottle( $this->mUsername
);
644 if ( $isAutoCreated ) {
645 // Must be run after $wgUser is set, for correct new user log
646 wfRunHooks( 'AuthPluginAutoCreate', array( $u ) );
649 $retval = self
::SUCCESS
;
651 wfRunHooks( 'LoginAuthenticateAudit', array( $u, $this->mPassword
, $retval ) );
656 * Increment the login attempt throttle hit count for the (username,current IP)
657 * tuple unless the throttle was already reached.
658 * @param string $username The user name
659 * @return Bool|Integer The integer hit count or True if it is already at the limit
661 public static function incLoginThrottle( $username ) {
662 global $wgPasswordAttemptThrottle, $wgMemc, $wgRequest;
663 $username = trim( $username ); // sanity
666 if ( is_array( $wgPasswordAttemptThrottle ) ) {
667 $throttleKey = wfMemcKey( 'password-throttle', $wgRequest->getIP(), md5( $username ) );
668 $count = $wgPasswordAttemptThrottle['count'];
669 $period = $wgPasswordAttemptThrottle['seconds'];
671 $throttleCount = $wgMemc->get( $throttleKey );
672 if ( !$throttleCount ) {
673 $wgMemc->add( $throttleKey, 1, $period ); // start counter
674 } elseif ( $throttleCount < $count ) {
675 $wgMemc->incr( $throttleKey );
676 } elseif ( $throttleCount >= $count ) {
681 return $throttleCount;
685 * Clear the login attempt throttle hit count for the (username,current IP) tuple.
686 * @param string $username The user name
689 public static function clearLoginThrottle( $username ) {
690 global $wgMemc, $wgRequest;
691 $username = trim( $username ); // sanity
693 $throttleKey = wfMemcKey( 'password-throttle', $wgRequest->getIP(), md5( $username ) );
694 $wgMemc->delete( $throttleKey );
698 * Attempt to automatically create a user on login. Only succeeds if there
699 * is an external authentication method which allows it.
703 * @return integer Status code
705 function attemptAutoCreate( $user ) {
708 if ( $this->getUser()->isBlockedFromCreateAccount() ) {
709 wfDebug( __METHOD__
. ": user is blocked from account creation\n" );
710 return self
::CREATE_BLOCKED
;
712 if ( !$wgAuth->autoCreate() ) {
713 return self
::NOT_EXISTS
;
715 if ( !$wgAuth->userExists( $user->getName() ) ) {
716 wfDebug( __METHOD__
. ": user does not exist\n" );
717 return self
::NOT_EXISTS
;
719 if ( !$wgAuth->authenticate( $user->getName(), $this->mPassword
) ) {
720 wfDebug( __METHOD__
. ": \$wgAuth->authenticate() returned false, aborting\n" );
721 return self
::WRONG_PLUGIN_PASS
;
725 if ( !wfRunHooks( 'AbortAutoAccount', array( $user, &$abortError ) ) ) {
726 // Hook point to add extra creation throttles and blocks
727 wfDebug( "LoginForm::attemptAutoCreate: a hook blocked creation: $abortError\n" );
728 $this->mAbortLoginErrorMsg
= $abortError;
729 return self
::ABORTED
;
732 wfDebug( __METHOD__
. ": creating account\n" );
733 $status = $this->initUser( $user, true );
735 if ( !$status->isOK() ) {
736 $errors = $status->getErrorsByType( 'error' );
737 $this->mAbortLoginErrorMsg
= $errors[0]['message'];
738 return self
::ABORTED
;
741 return self
::SUCCESS
;
744 function processLogin() {
745 global $wgMemc, $wgLang, $wgSecureLogin, $wgPasswordAttemptThrottle;
747 switch ( $this->authenticateUserData() ) {
749 # We've verified now, update the real record
750 $user = $this->getUser();
751 if ( (bool)$this->mRemember
!= $user->getBoolOption( 'rememberpassword' ) ) {
752 $user->setOption( 'rememberpassword', $this->mRemember ?
1 : 0 );
753 $user->saveSettings();
755 $user->invalidateCache();
758 if ( $user->requiresHTTPS() ) {
759 $this->mStickHTTPS
= true;
762 if ( $wgSecureLogin && !$this->mStickHTTPS
) {
763 $user->setCookies( null, false );
767 self
::clearLoginToken();
769 // Reset the throttle
770 $request = $this->getRequest();
771 $key = wfMemcKey( 'password-throttle', $request->getIP(), md5( $this->mUsername
) );
772 $wgMemc->delete( $key );
774 if ( $this->hasSessionCookie() ||
$this->mSkipCookieCheck
) {
775 /* Replace the language object to provide user interface in
776 * correct language immediately on this first page load.
778 $code = $request->getVal( 'uselang', $user->getOption( 'language' ) );
779 $userLang = Language
::factory( $code );
781 $this->getContext()->setLanguage( $userLang );
782 // Reset SessionID on Successful login (bug 40995)
783 $this->renewSessionId();
784 $this->successfulLogin();
786 $this->cookieRedirectCheck( 'login' );
790 case self
::NEED_TOKEN
:
791 $error = $this->mAbortLoginErrorMsg ?
: 'nocookiesforlogin';
792 $this->mainLoginForm( $this->msg( $error )->parse() );
794 case self
::WRONG_TOKEN
:
795 $error = $this->mAbortLoginErrorMsg ?
: 'sessionfailure';
796 $this->mainLoginForm( $this->msg( $error )->text() );
800 $error = $this->mAbortLoginErrorMsg ?
: 'noname';
801 $this->mainLoginForm( $this->msg( $error )->text() );
803 case self
::WRONG_PLUGIN_PASS
:
804 $error = $this->mAbortLoginErrorMsg ?
: 'wrongpassword';
805 $this->mainLoginForm( $this->msg( $error )->text() );
807 case self
::NOT_EXISTS
:
808 if ( $this->getUser()->isAllowed( 'createaccount' ) ) {
809 $error = $this->mAbortLoginErrorMsg ?
: 'nosuchuser';
810 $this->mainLoginForm( $this->msg( $error,
811 wfEscapeWikiText( $this->mUsername
) )->parse() );
813 $error = $this->mAbortLoginErrorMsg ?
: 'nosuchusershort';
814 $this->mainLoginForm( $this->msg( $error,
815 wfEscapeWikiText( $this->mUsername
) )->text() );
818 case self
::WRONG_PASS
:
819 $error = $this->mAbortLoginErrorMsg ?
: 'wrongpassword';
820 $this->mainLoginForm( $this->msg( $error )->text() );
822 case self
::EMPTY_PASS
:
823 $error = $this->mAbortLoginErrorMsg ?
: 'wrongpasswordempty';
824 $this->mainLoginForm( $this->msg( $error )->text() );
826 case self
::RESET_PASS
:
827 $error = $this->mAbortLoginErrorMsg ?
: 'resetpass_announce';
828 $this->resetLoginForm( $this->msg( $error )->text() );
830 case self
::CREATE_BLOCKED
:
831 $this->userBlockedMessage( $this->getUser()->isBlockedFromCreateAccount() );
833 case self
::THROTTLED
:
834 $error = $this->mAbortLoginErrorMsg ?
: 'login-throttled';
835 $this->mainLoginForm( $this->msg( $error )
836 ->params ( $this->getLanguage()->formatDuration( $wgPasswordAttemptThrottle['seconds'] ) )
840 case self
::USER_BLOCKED
:
841 $error = $this->mAbortLoginErrorMsg ?
: 'login-userblocked';
842 $this->mainLoginForm( $this->msg( $error, $this->mUsername
)->escaped() );
845 $error = $this->mAbortLoginErrorMsg ?
: 'login-abort-generic';
846 $this->mainLoginForm( $this->msg( $error )->text() );
849 throw new MWException( 'Unhandled case value' );
854 * @param $error string
856 function resetLoginForm( $error ) {
857 $this->getOutput()->addHTML( Xml
::element( 'p', array( 'class' => 'error' ), $error ) );
858 $reset = new SpecialChangePassword();
859 $derivative = new DerivativeContext( $this->getContext() );
860 $derivative->setTitle( $reset->getPageTitle() );
861 $reset->setContext( $derivative );
862 $reset->execute( null );
866 * @param $u User object
867 * @param $throttle Boolean
868 * @param string $emailTitle message name of email title
869 * @param string $emailText message name of email text
870 * @return Status object
872 function mailPasswordInternal( $u, $throttle = true, $emailTitle = 'passwordremindertitle', $emailText = 'passwordremindertext' ) {
873 global $wgNewPasswordExpiry;
875 if ( $u->getEmail() == '' ) {
876 return Status
::newFatal( 'noemail', $u->getName() );
878 $ip = $this->getRequest()->getIP();
880 return Status
::newFatal( 'badipaddress' );
883 $currentUser = $this->getUser();
884 wfRunHooks( 'User::mailPasswordInternal', array( &$currentUser, &$ip, &$u ) );
886 $np = $u->randomPassword();
887 $u->setNewpassword( $np, $throttle );
889 $userLanguage = $u->getOption( 'language' );
891 $mainPage = Title
::newMainPage();
892 $mainPageUrl = $mainPage->getCanonicalURL();
894 $m = $this->msg( $emailText, $ip, $u->getName(), $np, '<' . $mainPageUrl . '>',
895 round( $wgNewPasswordExpiry / 86400 ) )->inLanguage( $userLanguage )->text();
896 $result = $u->sendMail( $this->msg( $emailTitle )->inLanguage( $userLanguage )->text(), $m );
902 * Run any hooks registered for logins, then HTTP redirect to
903 * $this->mReturnTo (or Main Page if that's undefined). Formerly we had a
904 * nice message here, but that's really not as useful as just being sent to
905 * wherever you logged in from. It should be clear that the action was
906 * successful, given the lack of error messages plus the appearance of your
907 * name in the upper right.
911 function successfulLogin() {
912 # Run any hooks; display injected HTML if any, else redirect
913 $currentUser = $this->getUser();
915 wfRunHooks( 'UserLoginComplete', array( &$currentUser, &$injected_html ) );
917 if ( $injected_html !== '' ) {
918 $this->displaySuccessfulAction( $this->msg( 'loginsuccesstitle' ),
919 'loginsuccess', $injected_html );
921 $this->executeReturnTo( 'successredirect' );
926 * Run any hooks registered for logins, then display a message welcoming
931 function successfulCreation() {
932 # Run any hooks; display injected HTML
933 $currentUser = $this->getUser();
935 $welcome_creation_msg = 'welcomecreation-msg';
937 wfRunHooks( 'UserLoginComplete', array( &$currentUser, &$injected_html ) );
940 * Let any extensions change what message is shown.
941 * @see https://www.mediawiki.org/wiki/Manual:Hooks/BeforeWelcomeCreation
944 wfRunHooks( 'BeforeWelcomeCreation', array( &$welcome_creation_msg, &$injected_html ) );
946 $this->displaySuccessfulAction( $this->msg( 'welcomeuser', $this->getUser()->getName() ),
947 $welcome_creation_msg, $injected_html );
951 * Display an "successful action" page.
953 * @param string|Message $title page's title
954 * @param $msgname string
955 * @param $injected_html string
957 private function displaySuccessfulAction( $title, $msgname, $injected_html ) {
958 $out = $this->getOutput();
959 $out->setPageTitle( $title );
961 $out->addWikiMsg( $msgname, wfEscapeWikiText( $this->getUser()->getName() ) );
964 $out->addHTML( $injected_html );
966 $this->executeReturnTo( 'success' );
970 * Output a message that informs the user that they cannot create an account because
971 * there is a block on them or their IP which prevents account creation. Note that
972 * User::isBlockedFromCreateAccount(), which gets this block, ignores the 'hardblock'
973 * setting on blocks (bug 13611).
974 * @param $block Block the block causing this error
975 * @throws ErrorPageError
977 function userBlockedMessage( Block
$block ) {
978 # Let's be nice about this, it's likely that this feature will be used
979 # for blocking large numbers of innocent people, e.g. range blocks on
980 # schools. Don't blame it on the user. There's a small chance that it
981 # really is the user's fault, i.e. the username is blocked and they
982 # haven't bothered to log out before trying to create an account to
983 # evade it, but we'll leave that to their guilty conscience to figure
985 $errorParams = array(
987 $block->mReason ?
$block->mReason
: $this->msg( 'blockednoreason' )->text(),
991 if ( $block->getType() === Block
::TYPE_RANGE
) {
992 $errorMessage = 'cantcreateaccount-range-text';
993 $errorParams[] = $this->getRequest()->getIP();
995 $errorMessage = 'cantcreateaccount-text';
998 throw new ErrorPageError(
999 'cantcreateaccounttitle',
1006 * Add a "return to" link or redirect to it.
1007 * Extensions can use this to reuse the "return to" logic after
1008 * inject steps (such as redirection) into the login process.
1010 * @param $type string, one of the following:
1011 * - error: display a return to link ignoring $wgRedirectOnLogin
1012 * - success: display a return to link using $wgRedirectOnLogin if needed
1013 * - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
1014 * @param string $returnTo
1015 * @param array|string $returnToQuery
1016 * @param bool $stickHTTPs Keep redirect link on HTTPs
1019 public function showReturnToPage(
1020 $type, $returnTo = '', $returnToQuery = '', $stickHTTPs = false
1022 $this->mReturnTo
= $returnTo;
1023 $this->mReturnToQuery
= $returnToQuery;
1024 $this->mStickHTTPS
= $stickHTTPs;
1025 $this->executeReturnTo( $type );
1029 * Add a "return to" link or redirect to it.
1031 * @param $type string, one of the following:
1032 * - error: display a return to link ignoring $wgRedirectOnLogin
1033 * - success: display a return to link using $wgRedirectOnLogin if needed
1034 * - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
1036 private function executeReturnTo( $type ) {
1037 global $wgRedirectOnLogin, $wgSecureLogin;
1039 if ( $type != 'error' && $wgRedirectOnLogin !== null ) {
1040 $returnTo = $wgRedirectOnLogin;
1041 $returnToQuery = array();
1043 $returnTo = $this->mReturnTo
;
1044 $returnToQuery = wfCgiToArray( $this->mReturnToQuery
);
1047 $returnToTitle = Title
::newFromText( $returnTo );
1048 if ( !$returnToTitle ) {
1049 $returnToTitle = Title
::newMainPage();
1052 if ( $wgSecureLogin && !$this->mStickHTTPS
) {
1053 $options = array( 'http' );
1054 $proto = PROTO_HTTP
;
1055 } elseif ( $wgSecureLogin ) {
1056 $options = array( 'https' );
1057 $proto = PROTO_HTTPS
;
1060 $proto = PROTO_RELATIVE
;
1063 if ( $type == 'successredirect' ) {
1064 $redirectUrl = $returnToTitle->getFullURL( $returnToQuery, false, $proto );
1065 $this->getOutput()->redirect( $redirectUrl );
1067 $this->getOutput()->addReturnTo( $returnToTitle, $returnToQuery, null, $options );
1074 function mainLoginForm( $msg, $msgtype = 'error' ) {
1075 global $wgEnableEmail, $wgEnableUserEmail;
1076 global $wgHiddenPrefs, $wgLoginLanguageSelector;
1077 global $wgAuth, $wgEmailConfirmToEdit, $wgCookieExpiration;
1078 global $wgSecureLogin, $wgPasswordResetRoutes;
1080 $titleObj = $this->getPageTitle();
1081 $user = $this->getUser();
1082 $out = $this->getOutput();
1084 if ( $this->mType
== 'signup' ) {
1085 // Block signup here if in readonly. Keeps user from
1086 // going through the process (filling out data, etc)
1087 // and being informed later.
1088 $permErrors = $titleObj->getUserPermissionsErrors( 'createaccount', $user, true );
1089 if ( count( $permErrors ) ) {
1090 throw new PermissionsError( 'createaccount', $permErrors );
1091 } elseif ( $user->isBlockedFromCreateAccount() ) {
1092 $this->userBlockedMessage( $user->isBlockedFromCreateAccount() );
1094 } elseif ( wfReadOnly() ) {
1095 throw new ReadOnlyError
;
1099 // Pre-fill username (if not creating an account, bug 44775).
1100 if ( $this->mUsername
== '' && $this->mType
!= 'signup' ) {
1101 if ( $user->isLoggedIn() ) {
1102 $this->mUsername
= $user->getName();
1104 $this->mUsername
= $this->getRequest()->getCookie( 'UserName' );
1108 // Generic styles and scripts for both login and signup form
1109 $out->addModuleStyles( array(
1111 'mediawiki.ui.button',
1112 'mediawiki.special.userlogin.common.styles'
1114 $out->addModules( array(
1115 'mediawiki.special.userlogin.common.js'
1118 if ( $this->mType
== 'signup' ) {
1119 // XXX hack pending RL or JS parse() support for complex content messages
1120 // https://bugzilla.wikimedia.org/show_bug.cgi?id=25349
1121 $out->addJsConfigVars( 'wgCreateacctImgcaptchaHelp',
1122 $this->msg( 'createacct-imgcaptcha-help' )->parse() );
1124 // Additional styles and scripts for signup form
1125 $out->addModules( array(
1126 'mediawiki.special.userlogin.signup.js'
1128 $out->addModuleStyles( array(
1129 'mediawiki.special.userlogin.signup.styles'
1132 $template = new UsercreateTemplate();
1134 // Must match number of benefits defined in messages
1135 $template->set( 'benefitCount', 3 );
1137 $q = 'action=submitlogin&type=signup';
1138 $linkq = 'type=login';
1140 // Additional styles for login form
1141 $out->addModuleStyles( array(
1142 'mediawiki.special.userlogin.login.styles'
1145 $template = new UserloginTemplate();
1147 $q = 'action=submitlogin&type=login';
1148 $linkq = 'type=signup';
1151 if ( $this->mReturnTo
!== '' ) {
1152 $returnto = '&returnto=' . wfUrlencode( $this->mReturnTo
);
1153 if ( $this->mReturnToQuery
!== '' ) {
1154 $returnto .= '&returntoquery=' .
1155 wfUrlencode( $this->mReturnToQuery
);
1158 $linkq .= $returnto;
1161 # Don't show a "create account" link if the user can't.
1162 if ( $this->showCreateOrLoginLink( $user ) ) {
1163 # Pass any language selection on to the mode switch link
1164 if ( $wgLoginLanguageSelector && $this->mLanguage
) {
1165 $linkq .= '&uselang=' . $this->mLanguage
;
1167 // Supply URL, login template creates the button.
1168 $template->set( 'createOrLoginHref', $titleObj->getLocalURL( $linkq ) );
1170 $template->set( 'link', '' );
1173 $resetLink = $this->mType
== 'signup'
1175 : is_array( $wgPasswordResetRoutes ) && in_array( true, array_values( $wgPasswordResetRoutes ) );
1177 $template->set( 'header', '' );
1178 $template->set( 'skin', $this->getSkin() );
1179 $template->set( 'name', $this->mUsername
);
1180 $template->set( 'password', $this->mPassword
);
1181 $template->set( 'retype', $this->mRetype
);
1182 $template->set( 'createemailset', $this->mCreateaccountMail
);
1183 $template->set( 'email', $this->mEmail
);
1184 $template->set( 'realname', $this->mRealName
);
1185 $template->set( 'domain', $this->mDomain
);
1186 $template->set( 'reason', $this->mReason
);
1188 $template->set( 'action', $titleObj->getLocalURL( $q ) );
1189 $template->set( 'message', $msg );
1190 $template->set( 'messagetype', $msgtype );
1191 $template->set( 'createemail', $wgEnableEmail && $user->isLoggedIn() );
1192 $template->set( 'userealname', !in_array( 'realname', $wgHiddenPrefs ) );
1193 $template->set( 'useemail', $wgEnableEmail );
1194 $template->set( 'emailrequired', $wgEmailConfirmToEdit );
1195 $template->set( 'emailothers', $wgEnableUserEmail );
1196 $template->set( 'canreset', $wgAuth->allowPasswordChange() );
1197 $template->set( 'resetlink', $resetLink );
1198 $template->set( 'canremember', ( $wgCookieExpiration > 0 ) );
1199 $template->set( 'usereason', $user->isLoggedIn() );
1200 $template->set( 'remember', $user->getOption( 'rememberpassword' ) ||
$this->mRemember
);
1201 $template->set( 'cansecurelogin', ( $wgSecureLogin === true ) );
1202 $template->set( 'stickhttps', (int)$this->mStickHTTPS
);
1203 $template->set( 'loggedin', $user->isLoggedIn() );
1204 $template->set( 'loggedinuser', $user->getName() );
1206 if ( $this->mType
== 'signup' ) {
1207 if ( !self
::getCreateaccountToken() ) {
1208 self
::setCreateaccountToken();
1210 $template->set( 'token', self
::getCreateaccountToken() );
1212 if ( !self
::getLoginToken() ) {
1213 self
::setLoginToken();
1215 $template->set( 'token', self
::getLoginToken() );
1218 # Prepare language selection links as needed
1219 if ( $wgLoginLanguageSelector ) {
1220 $template->set( 'languages', $this->makeLanguageSelector() );
1221 if ( $this->mLanguage
) {
1222 $template->set( 'uselang', $this->mLanguage
);
1226 $template->set( 'secureLoginUrl', $this->mSecureLoginUrl
);
1227 // Use loginend-https for HTTPS requests if it's not blank, loginend otherwise
1228 // Ditto for signupend. New forms use neither.
1229 $usingHTTPS = $this->mRequest
->getProtocol() == 'https';
1230 $loginendHTTPS = $this->msg( 'loginend-https' );
1231 $signupendHTTPS = $this->msg( 'signupend-https' );
1232 if ( $usingHTTPS && !$loginendHTTPS->isBlank() ) {
1233 $template->set( 'loginend', $loginendHTTPS->parse() );
1235 $template->set( 'loginend', $this->msg( 'loginend' )->parse() );
1237 if ( $usingHTTPS && !$signupendHTTPS->isBlank() ) {
1238 $template->set( 'signupend', $signupendHTTPS->parse() );
1240 $template->set( 'signupend', $this->msg( 'signupend' )->parse() );
1243 // Give authentication and captcha plugins a chance to modify the form
1244 $wgAuth->modifyUITemplate( $template, $this->mType
);
1245 if ( $this->mType
== 'signup' ) {
1246 wfRunHooks( 'UserCreateForm', array( &$template ) );
1248 wfRunHooks( 'UserLoginForm', array( &$template ) );
1251 $out->disallowUserJs(); // just in case...
1252 $out->addTemplate( $template );
1256 * Whether the login/create account form should display a link to the
1257 * other form (in addition to whatever the skin provides).
1262 private function showCreateOrLoginLink( &$user ) {
1263 if ( $this->mType
== 'signup' ) {
1265 } elseif ( $user->isAllowed( 'createaccount' ) ) {
1273 * Check if a session cookie is present.
1275 * This will not pick up a cookie set during _this_ request, but is meant
1276 * to ensure that the client is returning the cookie which was set on a
1277 * previous pass through the system.
1282 function hasSessionCookie() {
1283 global $wgDisableCookieCheck;
1284 return $wgDisableCookieCheck ?
true : $this->getRequest()->checkSessionCookie();
1288 * Get the login token from the current session
1291 public static function getLoginToken() {
1293 return $wgRequest->getSessionData( 'wsLoginToken' );
1297 * Randomly generate a new login token and attach it to the current session
1299 public static function setLoginToken() {
1301 // Generate a token directly instead of using $user->getEditToken()
1302 // because the latter reuses $_SESSION['wsEditToken']
1303 $wgRequest->setSessionData( 'wsLoginToken', MWCryptRand
::generateHex( 32 ) );
1307 * Remove any login token attached to the current session
1309 public static function clearLoginToken() {
1311 $wgRequest->setSessionData( 'wsLoginToken', null );
1315 * Get the createaccount token from the current session
1318 public static function getCreateaccountToken() {
1320 return $wgRequest->getSessionData( 'wsCreateaccountToken' );
1324 * Randomly generate a new createaccount token and attach it to the current session
1326 public static function setCreateaccountToken() {
1328 $wgRequest->setSessionData( 'wsCreateaccountToken', MWCryptRand
::generateHex( 32 ) );
1332 * Remove any createaccount token attached to the current session
1334 public static function clearCreateaccountToken() {
1336 $wgRequest->setSessionData( 'wsCreateaccountToken', null );
1340 * Renew the user's session id, using strong entropy
1342 private function renewSessionId() {
1343 global $wgSecureLogin, $wgCookieSecure;
1344 if ( $wgSecureLogin && !$this->mStickHTTPS
) {
1345 $wgCookieSecure = false;
1354 function cookieRedirectCheck( $type ) {
1355 $titleObj = SpecialPage
::getTitleFor( 'Userlogin' );
1356 $query = array( 'wpCookieCheck' => $type );
1357 if ( $this->mReturnTo
!== '' ) {
1358 $query['returnto'] = $this->mReturnTo
;
1359 $query['returntoquery'] = $this->mReturnToQuery
;
1361 $check = $titleObj->getFullURL( $query );
1363 $this->getOutput()->redirect( $check );
1369 function onCookieRedirectCheck( $type ) {
1370 if ( !$this->hasSessionCookie() ) {
1371 if ( $type == 'new' ) {
1372 $this->mainLoginForm( $this->msg( 'nocookiesnew' )->parse() );
1373 } elseif ( $type == 'login' ) {
1374 $this->mainLoginForm( $this->msg( 'nocookieslogin' )->parse() );
1377 $this->mainLoginForm( $this->msg( 'error' )->text() );
1380 $this->successfulLogin();
1385 * Produce a bar of links which allow the user to select another language
1386 * during login/registration but retain "returnto"
1390 function makeLanguageSelector() {
1391 $msg = $this->msg( 'loginlanguagelinks' )->inContentLanguage();
1392 if ( !$msg->isBlank() ) {
1393 $langs = explode( "\n", $msg->text() );
1395 foreach ( $langs as $lang ) {
1396 $lang = trim( $lang, '* ' );
1397 $parts = explode( '|', $lang );
1398 if ( count( $parts ) >= 2 ) {
1399 $links[] = $this->makeLanguageSelectorLink( $parts[0], trim( $parts[1] ) );
1402 return count( $links ) > 0 ?
$this->msg( 'loginlanguagelabel' )->rawParams(
1403 $this->getLanguage()->pipeList( $links ) )->escaped() : '';
1410 * Create a language selector link for a particular language
1411 * Links back to this page preserving type and returnto
1413 * @param string $text Link text
1414 * @param string $lang Language code
1417 function makeLanguageSelectorLink( $text, $lang ) {
1418 if ( $this->getLanguage()->getCode() == $lang ) {
1419 // no link for currently used language
1420 return htmlspecialchars( $text );
1422 $query = array( 'uselang' => $lang );
1423 if ( $this->mType
== 'signup' ) {
1424 $query['type'] = 'signup';
1426 if ( $this->mReturnTo
!== '' ) {
1427 $query['returnto'] = $this->mReturnTo
;
1428 $query['returntoquery'] = $this->mReturnToQuery
;
1432 $targetLanguage = Language
::factory( $lang );
1433 $attr['lang'] = $attr['hreflang'] = $targetLanguage->getHtmlCode();
1435 return Linker
::linkKnown(
1436 $this->getPageTitle(),
1437 htmlspecialchars( $text ),
1443 protected function getGroupName() {