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
23 use MediaWiki\Logger\LoggerFactory
;
26 * Implements Special:UserLogin
28 * @ingroup SpecialPage
30 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;
45 const USER_MIGRATED
= 14;
47 public static $statusCodes = array(
48 self
::SUCCESS
=> 'success',
49 self
::NO_NAME
=> 'no_name',
50 self
::ILLEGAL
=> 'illegal',
51 self
::WRONG_PLUGIN_PASS
=> 'wrong_plugin_pass',
52 self
::NOT_EXISTS
=> 'not_exists',
53 self
::WRONG_PASS
=> 'wrong_pass',
54 self
::EMPTY_PASS
=> 'empty_pass',
55 self
::RESET_PASS
=> 'reset_pass',
56 self
::ABORTED
=> 'aborted',
57 self
::CREATE_BLOCKED
=> 'create_blocked',
58 self
::THROTTLED
=> 'throttled',
59 self
::USER_BLOCKED
=> 'user_blocked',
60 self
::NEED_TOKEN
=> 'need_token',
61 self
::WRONG_TOKEN
=> 'wrong_token',
62 self
::USER_MIGRATED
=> 'user_migrated',
66 * Valid error and warning messages
68 * Special:Userlogin can show an error or warning message on the form when
69 * coming from another page. This is done via the ?error= or ?warning= GET
72 * This array is the list of valid message keys. All other values will be
78 public static $validErrorMessages = array(
79 'exception-nologin-text',
81 'changeemail-no-info',
83 'confirmemail_needlogin',
87 public $mAbortLoginErrorMsg = null;
93 protected $mCookieCheck;
96 protected $mCreateaccount;
97 protected $mCreateaccountMail;
98 protected $mLoginattempt;
102 protected $mLanguage;
103 protected $mSkipCookieCheck;
104 protected $mReturnToQuery;
106 protected $mStickHTTPS;
109 protected $mRealName;
110 protected $mEntryError = '';
111 protected $mEntryErrorType = 'error';
113 private $mTempPasswordUsed;
114 private $mLoaded = false;
115 private $mSecureLoginUrl;
117 /** @var WebRequest */
118 private $mOverrideRequest = null;
120 /** @var WebRequest Effective request; set at the beginning of load */
121 private $mRequest = null;
124 * @param WebRequest $request
126 public function __construct( $request = null ) {
127 global $wgUseMediaWikiUIEverywhere;
128 parent
::__construct( 'Userlogin' );
130 $this->mOverrideRequest
= $request;
131 // Override UseMediaWikiEverywhere to true, to force login and create form to use mw ui
132 $wgUseMediaWikiUIEverywhere = true;
136 * Returns an array of all valid error messages.
140 public static function getValidErrorMessages() {
141 static $messages = null;
143 $messages = self
::$validErrorMessages;
144 Hooks
::run( 'LoginFormValidErrorMessages', array( &$messages ) );
154 global $wgAuth, $wgHiddenPrefs, $wgEnableEmail;
156 if ( $this->mLoaded
) {
159 $this->mLoaded
= true;
161 if ( $this->mOverrideRequest
=== null ) {
162 $request = $this->getRequest();
164 $request = $this->mOverrideRequest
;
166 $this->mRequest
= $request;
168 $this->mType
= $request->getText( 'type' );
169 $this->mUsername
= $request->getText( 'wpName' );
170 $this->mPassword
= $request->getText( 'wpPassword' );
171 $this->mRetype
= $request->getText( 'wpRetype' );
172 $this->mDomain
= $request->getText( 'wpDomain' );
173 $this->mReason
= $request->getText( 'wpReason' );
174 $this->mCookieCheck
= $request->getVal( 'wpCookieCheck' );
175 $this->mPosted
= $request->wasPosted();
176 $this->mCreateaccountMail
= $request->getCheck( 'wpCreateaccountMail' )
178 $this->mCreateaccount
= $request->getCheck( 'wpCreateaccount' ) && !$this->mCreateaccountMail
;
179 $this->mLoginattempt
= $request->getCheck( 'wpLoginattempt' );
180 $this->mAction
= $request->getVal( 'action' );
181 $this->mRemember
= $request->getCheck( 'wpRemember' );
182 $this->mFromHTTP
= $request->getBool( 'fromhttp', false )
183 ||
$request->getBool( 'wpFromhttp', false );
184 $this->mStickHTTPS
= ( !$this->mFromHTTP
&& $request->getProtocol() === 'https' )
185 ||
$request->getBool( 'wpForceHttps', false );
186 $this->mLanguage
= $request->getText( 'uselang' );
187 $this->mSkipCookieCheck
= $request->getCheck( 'wpSkipCookieCheck' );
188 $this->mToken
= $this->mType
== 'signup'
189 ?
$request->getVal( 'wpCreateaccountToken' )
190 : $request->getVal( 'wpLoginToken' );
191 $this->mReturnTo
= $request->getVal( 'returnto', '' );
192 $this->mReturnToQuery
= $request->getVal( 'returntoquery', '' );
194 // Show an error or warning passed on from a previous page
195 $entryError = $this->msg( $request->getVal( 'error', '' ) );
196 $entryWarning = $this->msg( $request->getVal( 'warning', '' ) );
197 // bc: provide login link as a parameter for messages where the translation
199 $loginreqlink = Linker
::linkKnown(
200 $this->getPageTitle(),
201 $this->msg( 'loginreqlink' )->escaped(),
204 'returnto' => $this->mReturnTo
,
205 'returntoquery' => $this->mReturnToQuery
,
206 'uselang' => $this->mLanguage
,
207 'fromhttp' => $this->mFromHTTP ?
'1' : '0',
211 // Only show valid error or warning messages.
212 if ( $entryError->exists()
213 && in_array( $entryError->getKey(), self
::getValidErrorMessages() )
215 $this->mEntryErrorType
= 'error';
216 $this->mEntryError
= $entryError->rawParams( $loginreqlink )->parse();
218 } elseif ( $entryWarning->exists()
219 && in_array( $entryWarning->getKey(), self
::getValidErrorMessages() )
221 $this->mEntryErrorType
= 'warning';
222 $this->mEntryError
= $entryWarning->rawParams( $loginreqlink )->parse();
225 if ( $wgEnableEmail ) {
226 $this->mEmail
= $request->getText( 'wpEmail' );
230 if ( !in_array( 'realname', $wgHiddenPrefs ) ) {
231 $this->mRealName
= $request->getText( 'wpRealName' );
233 $this->mRealName
= '';
236 if ( !$wgAuth->validDomain( $this->mDomain
) ) {
237 $this->mDomain
= $wgAuth->getDomain();
239 $wgAuth->setDomain( $this->mDomain
);
241 # 1. When switching accounts, it sucks to get automatically logged out
242 # 2. Do not return to PasswordReset after a successful password change
243 # but goto Wiki start page (Main_Page) instead ( bug 33997 )
244 $returnToTitle = Title
::newFromText( $this->mReturnTo
);
245 if ( is_object( $returnToTitle )
246 && ( $returnToTitle->isSpecial( 'Userlogout' )
247 ||
$returnToTitle->isSpecial( 'PasswordReset' ) )
249 $this->mReturnTo
= '';
250 $this->mReturnToQuery
= '';
254 function getDescription() {
255 if ( $this->mType
=== 'signup' ) {
256 return $this->msg( 'createaccount' )->text();
258 return $this->msg( 'login' )->text();
263 * @param string|null $subPage
265 public function execute( $subPage ) {
266 if ( session_id() == '' ) {
272 // Check for [[Special:Userlogin/signup]]. This affects form display and
274 if ( $subPage == 'signup' ) {
275 $this->mType
= 'signup';
280 * In the case where the user is already logged in, and was redirected to
281 * the login form from a page that requires login, do not show the login
282 * page. The use case scenario for this is when a user opens a large number
283 * of tabs, is redirected to the login page on all of them, and then logs
284 * in on one, expecting all the others to work properly.
286 * However, do show the form if it was visited intentionally (no 'returnto'
287 * is present). People who often switch between several accounts have grown
288 * accustomed to this behavior.
291 $this->mType
!== 'signup' &&
293 $this->getUser()->isLoggedIn() &&
294 ( $this->mReturnTo
!== '' ||
$this->mReturnToQuery
!== '' )
296 $this->successfulLogin();
299 // If logging in and not on HTTPS, either redirect to it or offer a link.
300 global $wgSecureLogin;
301 if ( $this->mRequest
->getProtocol() !== 'https' ) {
302 $title = $this->getFullTitle();
304 'returnto' => $this->mReturnTo
!== '' ?
$this->mReturnTo
: null,
305 'returntoquery' => $this->mReturnToQuery
!== '' ?
306 $this->mReturnToQuery
: null,
308 ( $this->mEntryErrorType
=== 'error' ?
'error' : 'warning' ) => $this->mEntryError
,
309 ) +
$this->mRequest
->getQueryValues();
310 $url = $title->getFullURL( $query, false, PROTO_HTTPS
);
312 && wfCanIPUseHTTPS( $this->getRequest()->getIP() )
313 && !$this->mFromHTTP
) // Avoid infinite redirect
315 $url = wfAppendQuery( $url, 'fromhttp=1' );
316 $this->getOutput()->redirect( $url );
317 // Since we only do this redir to change proto, always vary
318 $this->getOutput()->addVaryHeader( 'X-Forwarded-Proto' );
322 // A wiki without HTTPS login support should set $wgServer to
323 // http://somehost, in which case the secure URL generated
324 // above won't actually start with https://
325 if ( substr( $url, 0, 8 ) === 'https://' ) {
326 $this->mSecureLoginUrl
= $url;
331 if ( !is_null( $this->mCookieCheck
) ) {
332 $this->onCookieRedirectCheck( $this->mCookieCheck
);
335 } elseif ( $this->mPosted
) {
336 if ( $this->mCreateaccount
) {
337 $this->addNewAccount();
340 } elseif ( $this->mCreateaccountMail
) {
341 $this->addNewAccountMailPassword();
344 } elseif ( ( 'submitlogin' == $this->mAction
) ||
$this->mLoginattempt
) {
345 $this->processLogin();
350 $this->mainLoginForm( $this->mEntryError
, $this->mEntryErrorType
);
356 function addNewAccountMailPassword() {
357 if ( $this->mEmail
== '' ) {
358 $this->mainLoginForm( $this->msg( 'noemailcreate' )->escaped() );
363 $status = $this->addNewAccountInternal();
364 LoggerFactory
::getInstance( 'authmanager' )->info(
365 'Account creation attempt with mailed password',
366 array( 'event' => 'accountcreation', 'status' => $status )
368 if ( !$status->isGood() ) {
369 $error = $status->getMessage();
370 $this->mainLoginForm( $error->toString() );
375 $u = $status->getValue();
377 // Wipe the initial password and mail a temporary one
378 $u->setPassword( null );
380 $result = $this->mailPasswordInternal( $u, false, 'createaccount-title', 'createaccount-text' );
382 Hooks
::run( 'AddNewAccount', array( $u, true ) );
383 $u->addNewUserLogEntry( 'byemail', $this->mReason
);
385 $out = $this->getOutput();
386 $out->setPageTitle( $this->msg( 'accmailtitle' ) );
388 if ( !$result->isGood() ) {
389 $this->mainLoginForm( $this->msg( 'mailerror', $result->getWikiText() )->text() );
391 $out->addWikiMsg( 'accmailtext', $u->getName(), $u->getEmail() );
392 $this->executeReturnTo( 'success' );
400 function addNewAccount() {
401 global $wgContLang, $wgUser, $wgEmailAuthentication, $wgLoginLanguageSelector;
403 # Create the account and abort if there's a problem doing so
404 $status = $this->addNewAccountInternal();
405 LoggerFactory
::getInstance( 'authmanager' )->info( 'Account creation attempt', array(
406 'event' => 'accountcreation',
410 if ( !$status->isGood() ) {
411 $error = $status->getMessage();
412 $this->mainLoginForm( $error->toString() );
417 $u = $status->getValue();
419 # Only save preferences if the user is not creating an account for someone else.
420 if ( $this->getUser()->isAnon() ) {
421 # If we showed up language selection links, and one was in use, be
422 # smart (and sensible) and save that language as the user's preference
423 if ( $wgLoginLanguageSelector && $this->mLanguage
) {
424 $u->setOption( 'language', $this->mLanguage
);
427 # Otherwise the user's language preference defaults to $wgContLang,
428 # but it may be better to set it to their preferred $wgContLang variant,
429 # based on browser preferences or URL parameters.
430 $u->setOption( 'language', $wgContLang->getPreferredVariant() );
432 if ( $wgContLang->hasVariants() ) {
433 $u->setOption( 'variant', $wgContLang->getPreferredVariant() );
437 $out = $this->getOutput();
439 # Send out an email authentication message if needed
440 if ( $wgEmailAuthentication && Sanitizer
::validateEmail( $u->getEmail() ) ) {
441 $status = $u->sendConfirmationMail();
442 if ( $status->isGood() ) {
443 $out->addWikiMsg( 'confirmemail_oncreate' );
445 $out->addWikiText( $status->getWikiText( 'confirmemail_sendfailed' ) );
449 # Save settings (including confirmation token)
452 # If not logged in, assume the new account as the current one and set
453 # session cookies then show a "welcome" message or a "need cookies"
455 if ( $this->getUser()->isAnon() ) {
458 // This should set it for OutputPage and the Skin
459 // which is needed or the personal links will be
461 $this->getContext()->setUser( $u );
462 Hooks
::run( 'AddNewAccount', array( $u, false ) );
463 $u->addNewUserLogEntry( 'create' );
464 if ( $this->hasSessionCookie() ) {
465 $this->successfulCreation();
467 $this->cookieRedirectCheck( 'new' );
470 # Confirm that the account was created
471 $out->setPageTitle( $this->msg( 'accountcreated' ) );
472 $out->addWikiMsg( 'accountcreatedtext', $u->getName() );
473 $out->addReturnTo( $this->getPageTitle() );
474 Hooks
::run( 'AddNewAccount', array( $u, false ) );
475 $u->addNewUserLogEntry( 'create2', $this->mReason
);
482 * Make a new user account using the loaded data.
484 * @throws PermissionsError|ReadOnlyError
487 public function addNewAccountInternal() {
488 global $wgAuth, $wgAccountCreationThrottle, $wgEmailConfirmToEdit;
490 // If the user passes an invalid domain, something is fishy
491 if ( !$wgAuth->validDomain( $this->mDomain
) ) {
492 return Status
::newFatal( 'wrongpassword' );
495 // If we are not allowing users to login locally, we should be checking
496 // to see if the user is actually able to authenticate to the authenti-
497 // cation server before they create an account (otherwise, they can
498 // create a local account and login as any domain user). We only need
499 // to check this for domains that aren't local.
500 if ( 'local' != $this->mDomain
&& $this->mDomain
!= '' ) {
502 !$wgAuth->canCreateAccounts() &&
504 !$wgAuth->userExists( $this->mUsername
) ||
505 !$wgAuth->authenticate( $this->mUsername
, $this->mPassword
)
508 return Status
::newFatal( 'wrongpassword' );
512 if ( wfReadOnly() ) {
513 throw new ReadOnlyError
;
516 # Request forgery checks.
517 if ( !self
::getCreateaccountToken() ) {
518 self
::setCreateaccountToken();
520 return Status
::newFatal( 'nocookiesfornew' );
523 # The user didn't pass a createaccount token
524 if ( !$this->mToken
) {
525 return Status
::newFatal( 'sessionfailure' );
528 # Validate the createaccount token
529 if ( $this->mToken
!== self
::getCreateaccountToken() ) {
530 return Status
::newFatal( 'sessionfailure' );
534 $currentUser = $this->getUser();
535 $creationBlock = $currentUser->isBlockedFromCreateAccount();
536 if ( !$currentUser->isAllowed( 'createaccount' ) ) {
537 throw new PermissionsError( 'createaccount' );
538 } elseif ( $creationBlock instanceof Block
) {
539 // Throws an ErrorPageError.
540 $this->userBlockedMessage( $creationBlock );
542 // This should never be reached.
546 # Include checks that will include GlobalBlocking (Bug 38333)
547 $permErrors = $this->getPageTitle()->getUserPermissionsErrors(
553 if ( count( $permErrors ) ) {
554 throw new PermissionsError( 'createaccount', $permErrors );
557 $ip = $this->getRequest()->getIP();
558 if ( $currentUser->isDnsBlacklisted( $ip, true /* check $wgProxyWhitelist */ ) ) {
559 return Status
::newFatal( 'sorbs_create_account_reason' );
562 # Now create a dummy user ($u) and check if it is valid
563 $u = User
::newFromName( $this->mUsername
, 'creatable' );
565 return Status
::newFatal( 'noname' );
568 $cache = ObjectCache
::getLocalClusterInstance();
569 # Make sure the user does not exist already
570 $lock = $cache->getScopedLock( wfGlobalCacheKey( 'account', md5( $this->mUsername
) ) );
572 return Status
::newFatal( 'usernameinprogress' );
573 } elseif ( $u->idForName( User
::READ_LOCKING
) ) {
574 return Status
::newFatal( 'userexists' );
577 if ( $this->mCreateaccountMail
) {
578 # do not force a password for account creation by email
579 # set invalid password, it will be replaced later by a random generated password
580 $this->mPassword
= null;
582 if ( $this->mPassword
!== $this->mRetype
) {
583 return Status
::newFatal( 'badretype' );
586 # check for password validity, return a fatal Status if invalid
587 $validity = $u->checkPasswordValidity( $this->mPassword
, 'create' );
588 if ( !$validity->isGood() ) {
589 $validity->ok
= false; // make sure this Status is fatal
594 # if you need a confirmed email address to edit, then obviously you
595 # need an email address.
596 if ( $wgEmailConfirmToEdit && strval( $this->mEmail
) === '' ) {
597 return Status
::newFatal( 'noemailtitle' );
600 if ( strval( $this->mEmail
) !== '' && !Sanitizer
::validateEmail( $this->mEmail
) ) {
601 return Status
::newFatal( 'invalidemailaddress' );
604 # Set some additional data so the AbortNewAccount hook can be used for
605 # more than just username validation
606 $u->setEmail( $this->mEmail
);
607 $u->setRealName( $this->mRealName
);
611 if ( !Hooks
::run( 'AbortNewAccount', array( $u, &$abortError, &$abortStatus ) ) ) {
612 // Hook point to add extra creation throttles and blocks
613 wfDebug( "LoginForm::addNewAccountInternal: a hook blocked creation\n" );
614 if ( $abortStatus === null ) {
615 // Report back the old string as a raw message status.
616 // This will report the error back as 'createaccount-hook-aborted'
617 // with the given string as the message.
618 // To return a different error code, return a Status object.
619 $abortError = new Message( 'createaccount-hook-aborted', array( $abortError ) );
622 return Status
::newFatal( $abortError );
624 // For MediaWiki 1.23+ and updated hooks, return the Status object
625 // returned from the hook.
630 // Hook point to check for exempt from account creation throttle
631 if ( !Hooks
::run( 'ExemptFromAccountCreationThrottle', array( $ip ) ) ) {
632 wfDebug( "LoginForm::exemptFromAccountCreationThrottle: a hook " .
633 "allowed account creation w/o throttle\n" );
635 if ( ( $wgAccountCreationThrottle && $currentUser->isPingLimitable() ) ) {
636 $key = wfMemcKey( 'acctcreate', 'ip', $ip );
637 $value = $cache->get( $key );
639 $cache->set( $key, 0, 86400 );
641 if ( $value >= $wgAccountCreationThrottle ) {
642 return Status
::newFatal( 'acct_creation_throttle_hit', $wgAccountCreationThrottle );
644 $cache->incr( $key );
648 if ( !$wgAuth->addUser( $u, $this->mPassword
, $this->mEmail
, $this->mRealName
) ) {
649 return Status
::newFatal( 'externaldberror' );
652 self
::clearCreateaccountToken();
654 return $this->initUser( $u, false );
658 * Actually add a user to the database.
659 * Give it a User object that has been initialised with a name.
662 * @param bool $autocreate True if this is an autocreation via auth plugin
663 * @return Status Status object, with the User object in the value member on success
666 function initUser( $u, $autocreate ) {
669 $status = $u->addToDatabase();
670 if ( !$status->isOK() ) {
674 if ( $wgAuth->allowPasswordChange() ) {
675 $u->setPassword( $this->mPassword
);
678 $u->setEmail( $this->mEmail
);
679 $u->setRealName( $this->mRealName
);
682 Hooks
::run( 'LocalUserCreated', array( $u, $autocreate ) );
684 $wgAuth->initUser( $u, $autocreate );
685 if ( $oldUser !== $u ) {
686 wfWarn( get_class( $wgAuth ) . '::initUser() replaced the user object' );
692 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 0, 0, 0, 1 ) );
694 // Watch user's userpage and talk page
695 $u->addWatch( $u->getUserPage(), WatchedItem
::IGNORE_USER_RIGHTS
);
697 return Status
::newGood( $u );
701 * Internally authenticate the login request.
703 * This may create a local account as a side effect if the
704 * authentication plugin allows transparent local account
708 public function authenticateUserData() {
709 global $wgUser, $wgAuth;
713 if ( $this->mUsername
== '' ) {
714 return self
::NO_NAME
;
717 // We require a login token to prevent login CSRF
718 // Handle part of this before incrementing the throttle so
719 // token-less login attempts don't count towards the throttle
720 // but wrong-token attempts do.
722 // If the user doesn't have a login token yet, set one.
723 if ( !self
::getLoginToken() ) {
724 self
::setLoginToken();
726 return self
::NEED_TOKEN
;
728 // If the user didn't pass a login token, tell them we need one
729 if ( !$this->mToken
) {
730 return self
::NEED_TOKEN
;
733 $throttleCount = self
::incLoginThrottle( $this->mUsername
);
734 if ( $throttleCount === true ) {
735 return self
::THROTTLED
;
738 // Validate the login token
739 if ( $this->mToken
!== self
::getLoginToken() ) {
740 return self
::WRONG_TOKEN
;
743 // Load the current user now, and check to see if we're logging in as
744 // the same name. This is necessary because loading the current user
745 // (say by calling getName()) calls the UserLoadFromSession hook, which
746 // potentially creates the user in the database. Until we load $wgUser,
747 // checking for user existence using User::newFromName($name)->getId() below
748 // will effectively be using stale data.
749 if ( $this->getUser()->getName() === $this->mUsername
) {
750 wfDebug( __METHOD__
. ": already logged in as {$this->mUsername}\n" );
752 return self
::SUCCESS
;
755 $u = User
::newFromName( $this->mUsername
);
756 if ( $u === false ) {
757 return self
::ILLEGAL
;
761 // Give extensions a way to indicate the username has been updated,
762 // rather than telling the user the account doesn't exist.
763 if ( !Hooks
::run( 'LoginUserMigrated', array( $u, &$msg ) ) ) {
764 $this->mAbortLoginErrorMsg
= $msg;
765 return self
::USER_MIGRATED
;
768 if ( !User
::isUsableName( $u->getName() ) ) {
769 return self
::ILLEGAL
;
772 $isAutoCreated = false;
773 if ( $u->getID() == 0 ) {
774 $status = $this->attemptAutoCreate( $u );
775 if ( $status !== self
::SUCCESS
) {
778 $isAutoCreated = true;
784 // Give general extensions, such as a captcha, a chance to abort logins
785 $abort = self
::ABORTED
;
786 if ( !Hooks
::run( 'AbortLogin', array( $u, $this->mPassword
, &$abort, &$msg ) ) ) {
787 if ( !in_array( $abort, self
::$statusCodes, true ) ) {
788 throw new Exception( 'Invalid status code returned from AbortLogin hook: ' . $abort );
790 $this->mAbortLoginErrorMsg
= $msg;
794 global $wgBlockDisablesLogin;
795 if ( !$u->checkPassword( $this->mPassword
) ) {
796 if ( $u->checkTemporaryPassword( $this->mPassword
) ) {
798 * The e-mailed temporary password should not be used for actu-
799 * al logins; that's a very sloppy habit, and insecure if an
800 * attacker has a few seconds to click "search" on someone's
803 * Allow it to be used only to reset the password a single time
804 * to a new value, which won't be in the user's e-mail ar-
807 * For backwards compatibility, we'll still recognize it at the
808 * login form to minimize surprises for people who have been
809 * logging in with a temporary password for some time.
811 * As a side-effect, we can authenticate the user's e-mail ad-
812 * dress if it's not already done, since the temporary password
813 * was sent via e-mail.
815 if ( !$u->isEmailConfirmed() && !wfReadOnly() ) {
820 // At this point we just return an appropriate code/ indicating
821 // that the UI should show a password reset form; bot inter-
822 // faces etc will probably just fail cleanly here.
823 $this->mAbortLoginErrorMsg
= 'resetpass-temp-emailed';
824 $this->mTempPasswordUsed
= true;
825 $retval = self
::RESET_PASS
;
827 $retval = ( $this->mPassword
== '' ) ? self
::EMPTY_PASS
: self
::WRONG_PASS
;
829 } elseif ( $wgBlockDisablesLogin && $u->isBlocked() ) {
830 // If we've enabled it, make it so that a blocked user cannot login
831 $retval = self
::USER_BLOCKED
;
832 } elseif ( $this->checkUserPasswordExpired( $u ) == 'hard' ) {
833 // Force reset now, without logging in
834 $retval = self
::RESET_PASS
;
835 $this->mAbortLoginErrorMsg
= 'resetpass-expired';
837 Hooks
::run( 'UserLoggedIn', array( $u ) );
839 $wgAuth->updateUser( $u );
840 if ( $oldUser !== $u ) {
841 wfWarn( get_class( $wgAuth ) . '::updateUser() replaced the user object' );
844 // This should set it for OutputPage and the Skin
845 // which is needed or the personal links will be
847 $this->getContext()->setUser( $u );
849 // Please reset throttle for successful logins, thanks!
850 if ( $throttleCount ) {
851 self
::clearLoginThrottle( $this->mUsername
);
854 if ( $isAutoCreated ) {
855 // Must be run after $wgUser is set, for correct new user log
856 Hooks
::run( 'AuthPluginAutoCreate', array( $u ) );
859 $retval = self
::SUCCESS
;
861 Hooks
::run( 'LoginAuthenticateAudit', array( $u, $this->mPassword
, $retval ) );
867 * Increment the login attempt throttle hit count for the (username,current IP)
868 * tuple unless the throttle was already reached.
869 * @param string $username The user name
870 * @return bool|int The integer hit count or True if it is already at the limit
872 public static function incLoginThrottle( $username ) {
873 global $wgPasswordAttemptThrottle, $wgRequest;
874 $username = trim( $username ); // sanity
877 if ( is_array( $wgPasswordAttemptThrottle ) ) {
878 $throttleKey = wfMemcKey( 'password-throttle', $wgRequest->getIP(), md5( $username ) );
879 $count = $wgPasswordAttemptThrottle['count'];
880 $period = $wgPasswordAttemptThrottle['seconds'];
882 $cache = ObjectCache
::getLocalClusterInstance();
883 $throttleCount = $cache->get( $throttleKey );
884 if ( !$throttleCount ) {
885 $cache->add( $throttleKey, 1, $period ); // start counter
886 } elseif ( $throttleCount < $count ) {
887 $cache->incr( $throttleKey );
888 } elseif ( $throttleCount >= $count ) {
893 return $throttleCount;
897 * Clear the login attempt throttle hit count for the (username,current IP) tuple.
898 * @param string $username The user name
901 public static function clearLoginThrottle( $username ) {
903 $username = trim( $username ); // sanity
905 $throttleKey = wfMemcKey( 'password-throttle', $wgRequest->getIP(), md5( $username ) );
906 ObjectCache
::getLocalClusterInstance()->delete( $throttleKey );
910 * Attempt to automatically create a user on login. Only succeeds if there
911 * is an external authentication method which allows it.
915 * @return int Status code
917 function attemptAutoCreate( $user ) {
920 if ( $this->getUser()->isBlockedFromCreateAccount() ) {
921 wfDebug( __METHOD__
. ": user is blocked from account creation\n" );
923 return self
::CREATE_BLOCKED
;
926 if ( !$wgAuth->autoCreate() ) {
927 return self
::NOT_EXISTS
;
930 if ( !$wgAuth->userExists( $user->getName() ) ) {
931 wfDebug( __METHOD__
. ": user does not exist\n" );
933 return self
::NOT_EXISTS
;
936 if ( !$wgAuth->authenticate( $user->getName(), $this->mPassword
) ) {
937 wfDebug( __METHOD__
. ": \$wgAuth->authenticate() returned false, aborting\n" );
939 return self
::WRONG_PLUGIN_PASS
;
943 if ( !Hooks
::run( 'AbortAutoAccount', array( $user, &$abortError ) ) ) {
944 // Hook point to add extra creation throttles and blocks
945 wfDebug( "LoginForm::attemptAutoCreate: a hook blocked creation: $abortError\n" );
946 $this->mAbortLoginErrorMsg
= $abortError;
948 return self
::ABORTED
;
951 wfDebug( __METHOD__
. ": creating account\n" );
952 $status = $this->initUser( $user, true );
954 if ( !$status->isOK() ) {
955 $errors = $status->getErrorsByType( 'error' );
956 $this->mAbortLoginErrorMsg
= $errors[0]['message'];
958 return self
::ABORTED
;
961 return self
::SUCCESS
;
964 function processLogin() {
965 global $wgLang, $wgSecureLogin, $wgPasswordAttemptThrottle, $wgInvalidPasswordReset;
967 $cache = ObjectCache
::getLocalClusterInstance();
968 $authRes = $this->authenticateUserData();
969 switch ( $authRes ) {
971 # We've verified now, update the real record
972 $user = $this->getUser();
975 if ( $user->requiresHTTPS() ) {
976 $this->mStickHTTPS
= true;
979 if ( $wgSecureLogin && !$this->mStickHTTPS
) {
980 $user->setCookies( $this->mRequest
, false, $this->mRemember
);
982 $user->setCookies( $this->mRequest
, null, $this->mRemember
);
984 self
::clearLoginToken();
986 // Reset the throttle
987 $request = $this->getRequest();
988 $key = wfMemcKey( 'password-throttle', $request->getIP(), md5( $this->mUsername
) );
989 $cache->delete( $key );
991 if ( $this->hasSessionCookie() ||
$this->mSkipCookieCheck
) {
992 /* Replace the language object to provide user interface in
993 * correct language immediately on this first page load.
995 $code = $request->getVal( 'uselang', $user->getOption( 'language' ) );
996 $userLang = Language
::factory( $code );
998 $this->getContext()->setLanguage( $userLang );
999 // Reset SessionID on Successful login (bug 40995)
1000 $this->renewSessionId();
1001 if ( $this->checkUserPasswordExpired( $this->getUser() ) == 'soft' ) {
1002 $this->resetLoginForm( $this->msg( 'resetpass-expired-soft' ) );
1003 } elseif ( $wgInvalidPasswordReset
1004 && !$user->isValidPassword( $this->mPassword
)
1006 $status = $user->checkPasswordValidity(
1010 $this->resetLoginForm(
1011 $status->getMessage( 'resetpass-validity-soft' )
1014 $this->successfulLogin();
1017 $this->cookieRedirectCheck( 'login' );
1021 case self
::NEED_TOKEN
:
1022 $error = $this->mAbortLoginErrorMsg ?
: 'nocookiesforlogin';
1023 $this->mainLoginForm( $this->msg( $error )->parse() );
1025 case self
::WRONG_TOKEN
:
1026 $error = $this->mAbortLoginErrorMsg ?
: 'sessionfailure';
1027 $this->mainLoginForm( $this->msg( $error )->text() );
1031 $error = $this->mAbortLoginErrorMsg ?
: 'noname';
1032 $this->mainLoginForm( $this->msg( $error )->text() );
1034 case self
::WRONG_PLUGIN_PASS
:
1035 $error = $this->mAbortLoginErrorMsg ?
: 'wrongpassword';
1036 $this->mainLoginForm( $this->msg( $error )->text() );
1038 case self
::NOT_EXISTS
:
1039 if ( $this->getUser()->isAllowed( 'createaccount' ) ) {
1040 $error = $this->mAbortLoginErrorMsg ?
: 'nosuchuser';
1041 $this->mainLoginForm( $this->msg( $error,
1042 wfEscapeWikiText( $this->mUsername
) )->parse() );
1044 $error = $this->mAbortLoginErrorMsg ?
: 'nosuchusershort';
1045 $this->mainLoginForm( $this->msg( $error,
1046 wfEscapeWikiText( $this->mUsername
) )->text() );
1049 case self
::WRONG_PASS
:
1050 $error = $this->mAbortLoginErrorMsg ?
: 'wrongpassword';
1051 $this->mainLoginForm( $this->msg( $error )->text() );
1053 case self
::EMPTY_PASS
:
1054 $error = $this->mAbortLoginErrorMsg ?
: 'wrongpasswordempty';
1055 $this->mainLoginForm( $this->msg( $error )->text() );
1057 case self
::RESET_PASS
:
1058 $error = $this->mAbortLoginErrorMsg ?
: 'resetpass_announce';
1059 $this->resetLoginForm( $this->msg( $error ) );
1061 case self
::CREATE_BLOCKED
:
1062 $this->userBlockedMessage( $this->getUser()->isBlockedFromCreateAccount() );
1064 case self
::THROTTLED
:
1065 $error = $this->mAbortLoginErrorMsg ?
: 'login-throttled';
1066 $this->mainLoginForm( $this->msg( $error )
1067 ->params( $this->getLanguage()->formatDuration( $wgPasswordAttemptThrottle['seconds'] ) )
1071 case self
::USER_BLOCKED
:
1072 $error = $this->mAbortLoginErrorMsg ?
: 'login-userblocked';
1073 $this->mainLoginForm( $this->msg( $error, $this->mUsername
)->escaped() );
1076 $error = $this->mAbortLoginErrorMsg ?
: 'login-abort-generic';
1077 $this->mainLoginForm( $this->msg( $error,
1078 wfEscapeWikiText( $this->mUsername
) )->text() );
1080 case self
::USER_MIGRATED
:
1081 $error = $this->mAbortLoginErrorMsg ?
: 'login-migrated-generic';
1083 if ( is_array( $error ) ) {
1084 $error = array_shift( $this->mAbortLoginErrorMsg
);
1085 $params = $this->mAbortLoginErrorMsg
;
1087 $this->mainLoginForm( $this->msg( $error, $params )->text() );
1090 throw new MWException( 'Unhandled case value' );
1093 LoggerFactory
::getInstance( 'authmanager' )->info( 'Login attempt', array(
1095 'successful' => $authRes === self
::SUCCESS
,
1096 'status' => LoginForm
::$statusCodes[$authRes],
1101 * Show the Special:ChangePassword form, with custom message
1102 * @param Message $msg
1104 protected function resetLoginForm( Message
$msg ) {
1105 // Allow hooks to explain this password reset in more detail
1106 Hooks
::run( 'LoginPasswordResetMessage', array( &$msg, $this->mUsername
) );
1107 $reset = new SpecialChangePassword();
1108 $derivative = new DerivativeContext( $this->getContext() );
1109 $derivative->setTitle( $reset->getPageTitle() );
1110 $reset->setContext( $derivative );
1111 if ( !$this->mTempPasswordUsed
) {
1112 $reset->setOldPasswordMessage( 'oldpassword' );
1114 $reset->setChangeMessage( $msg );
1115 $reset->execute( null );
1120 * @param bool $throttle
1121 * @param string $emailTitle Message name of email title
1122 * @param string $emailText Message name of email text
1125 function mailPasswordInternal( $u, $throttle = true, $emailTitle = 'passwordremindertitle',
1126 $emailText = 'passwordremindertext'
1128 global $wgNewPasswordExpiry, $wgMinimalPasswordLength;
1130 if ( $u->getEmail() == '' ) {
1131 return Status
::newFatal( 'noemail', $u->getName() );
1133 $ip = $this->getRequest()->getIP();
1135 return Status
::newFatal( 'badipaddress' );
1138 $currentUser = $this->getUser();
1139 Hooks
::run( 'User::mailPasswordInternal', array( &$currentUser, &$ip, &$u ) );
1141 $np = PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1142 $u->setNewpassword( $np, $throttle );
1144 $userLanguage = $u->getOption( 'language' );
1146 $mainPage = Title
::newMainPage();
1147 $mainPageUrl = $mainPage->getCanonicalURL();
1149 $m = $this->msg( $emailText, $ip, $u->getName(), $np, '<' . $mainPageUrl . '>',
1150 round( $wgNewPasswordExpiry / 86400 ) )->inLanguage( $userLanguage )->text();
1151 $result = $u->sendMail( $this->msg( $emailTitle )->inLanguage( $userLanguage )->text(), $m );
1157 * Run any hooks registered for logins, then HTTP redirect to
1158 * $this->mReturnTo (or Main Page if that's undefined). Formerly we had a
1159 * nice message here, but that's really not as useful as just being sent to
1160 * wherever you logged in from. It should be clear that the action was
1161 * successful, given the lack of error messages plus the appearance of your
1162 * name in the upper right.
1166 function successfulLogin() {
1167 # Run any hooks; display injected HTML if any, else redirect
1168 $currentUser = $this->getUser();
1169 $injected_html = '';
1170 Hooks
::run( 'UserLoginComplete', array( &$currentUser, &$injected_html ) );
1172 if ( $injected_html !== '' ) {
1173 $this->displaySuccessfulAction( 'success', $this->msg( 'loginsuccesstitle' ),
1174 'loginsuccess', $injected_html );
1176 $this->executeReturnTo( 'successredirect' );
1181 * Run any hooks registered for logins, then display a message welcoming
1186 function successfulCreation() {
1187 # Run any hooks; display injected HTML
1188 $currentUser = $this->getUser();
1189 $injected_html = '';
1190 $welcome_creation_msg = 'welcomecreation-msg';
1192 Hooks
::run( 'UserLoginComplete', array( &$currentUser, &$injected_html ) );
1195 * Let any extensions change what message is shown.
1196 * @see https://www.mediawiki.org/wiki/Manual:Hooks/BeforeWelcomeCreation
1199 Hooks
::run( 'BeforeWelcomeCreation', array( &$welcome_creation_msg, &$injected_html ) );
1201 $this->displaySuccessfulAction(
1203 $this->msg( 'welcomeuser', $this->getUser()->getName() ),
1204 $welcome_creation_msg, $injected_html
1209 * Display a "successful action" page.
1211 * @param string $type Condition of return to; see `executeReturnTo`
1212 * @param string|Message $title Page's title
1213 * @param string $msgname
1214 * @param string $injected_html
1216 private function displaySuccessfulAction( $type, $title, $msgname, $injected_html ) {
1217 $out = $this->getOutput();
1218 $out->setPageTitle( $title );
1220 $out->addWikiMsg( $msgname, wfEscapeWikiText( $this->getUser()->getName() ) );
1223 $out->addHTML( $injected_html );
1225 $this->executeReturnTo( $type );
1229 * Output a message that informs the user that they cannot create an account because
1230 * there is a block on them or their IP which prevents account creation. Note that
1231 * User::isBlockedFromCreateAccount(), which gets this block, ignores the 'hardblock'
1232 * setting on blocks (bug 13611).
1233 * @param Block $block The block causing this error
1234 * @throws ErrorPageError
1236 function userBlockedMessage( Block
$block ) {
1237 # Let's be nice about this, it's likely that this feature will be used
1238 # for blocking large numbers of innocent people, e.g. range blocks on
1239 # schools. Don't blame it on the user. There's a small chance that it
1240 # really is the user's fault, i.e. the username is blocked and they
1241 # haven't bothered to log out before trying to create an account to
1242 # evade it, but we'll leave that to their guilty conscience to figure
1244 $errorParams = array(
1245 $block->getTarget(),
1246 $block->mReason ?
$block->mReason
: $this->msg( 'blockednoreason' )->text(),
1250 if ( $block->getType() === Block
::TYPE_RANGE
) {
1251 $errorMessage = 'cantcreateaccount-range-text';
1252 $errorParams[] = $this->getRequest()->getIP();
1254 $errorMessage = 'cantcreateaccount-text';
1257 throw new ErrorPageError(
1258 'cantcreateaccounttitle',
1265 * Add a "return to" link or redirect to it.
1266 * Extensions can use this to reuse the "return to" logic after
1267 * inject steps (such as redirection) into the login process.
1269 * @param string $type One of the following:
1270 * - error: display a return to link ignoring $wgRedirectOnLogin
1271 * - signup: display a return to link using $wgRedirectOnLogin if needed
1272 * - success: display a return to link using $wgRedirectOnLogin if needed
1273 * - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
1274 * @param string $returnTo
1275 * @param array|string $returnToQuery
1276 * @param bool $stickHTTPs Keep redirect link on HTTPs
1279 public function showReturnToPage(
1280 $type, $returnTo = '', $returnToQuery = '', $stickHTTPs = false
1282 $this->mReturnTo
= $returnTo;
1283 $this->mReturnToQuery
= $returnToQuery;
1284 $this->mStickHTTPS
= $stickHTTPs;
1285 $this->executeReturnTo( $type );
1289 * Add a "return to" link or redirect to it.
1291 * @param string $type One of the following:
1292 * - error: display a return to link ignoring $wgRedirectOnLogin
1293 * - signup: display a return to link using $wgRedirectOnLogin if needed
1294 * - success: display a return to link using $wgRedirectOnLogin if needed
1295 * - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
1297 private function executeReturnTo( $type ) {
1298 global $wgRedirectOnLogin, $wgSecureLogin;
1300 if ( $type != 'error' && $wgRedirectOnLogin !== null ) {
1301 $returnTo = $wgRedirectOnLogin;
1302 $returnToQuery = array();
1304 $returnTo = $this->mReturnTo
;
1305 $returnToQuery = wfCgiToArray( $this->mReturnToQuery
);
1308 // Allow modification of redirect behavior
1309 Hooks
::run( 'PostLoginRedirect', array( &$returnTo, &$returnToQuery, &$type ) );
1311 $returnToTitle = Title
::newFromText( $returnTo );
1312 if ( !$returnToTitle ) {
1313 $returnToTitle = Title
::newMainPage();
1316 if ( $wgSecureLogin && !$this->mStickHTTPS
) {
1317 $options = array( 'http' );
1318 $proto = PROTO_HTTP
;
1319 } elseif ( $wgSecureLogin ) {
1320 $options = array( 'https' );
1321 $proto = PROTO_HTTPS
;
1324 $proto = PROTO_RELATIVE
;
1327 if ( $type == 'successredirect' ) {
1328 $redirectUrl = $returnToTitle->getFullURL( $returnToQuery, false, $proto );
1329 $this->getOutput()->redirect( $redirectUrl );
1331 $this->getOutput()->addReturnTo( $returnToTitle, $returnToQuery, null, $options );
1336 * @param string $msg
1337 * @param string $msgtype
1338 * @throws ErrorPageError
1340 * @throws FatalError
1341 * @throws MWException
1342 * @throws PermissionsError
1343 * @throws ReadOnlyError
1346 function mainLoginForm( $msg, $msgtype = 'error' ) {
1347 global $wgEnableEmail, $wgEnableUserEmail;
1348 global $wgHiddenPrefs, $wgLoginLanguageSelector;
1349 global $wgAuth, $wgEmailConfirmToEdit;
1350 global $wgSecureLogin, $wgPasswordResetRoutes;
1351 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
1353 $titleObj = $this->getPageTitle();
1354 $user = $this->getUser();
1355 $out = $this->getOutput();
1357 if ( $this->mType
== 'signup' ) {
1358 // Block signup here if in readonly. Keeps user from
1359 // going through the process (filling out data, etc)
1360 // and being informed later.
1361 $permErrors = $titleObj->getUserPermissionsErrors( 'createaccount', $user, true );
1362 if ( count( $permErrors ) ) {
1363 throw new PermissionsError( 'createaccount', $permErrors );
1364 } elseif ( $user->isBlockedFromCreateAccount() ) {
1365 $this->userBlockedMessage( $user->isBlockedFromCreateAccount() );
1368 } elseif ( wfReadOnly() ) {
1369 throw new ReadOnlyError
;
1373 // Pre-fill username (if not creating an account, bug 44775).
1374 if ( $this->mUsername
== '' && $this->mType
!= 'signup' ) {
1375 if ( $user->isLoggedIn() ) {
1376 $this->mUsername
= $user->getName();
1378 $this->mUsername
= $this->getRequest()->getCookie( 'UserName' );
1382 // Generic styles and scripts for both login and signup form
1383 $out->addModuleStyles( array(
1385 'mediawiki.ui.button',
1386 'mediawiki.ui.checkbox',
1387 'mediawiki.ui.input',
1388 'mediawiki.special.userlogin.common.styles'
1391 if ( $this->mType
== 'signup' ) {
1392 // Additional styles and scripts for signup form
1393 $out->addModules( array(
1394 'mediawiki.special.userlogin.signup.js'
1396 $out->addModuleStyles( array(
1397 'mediawiki.special.userlogin.signup.styles'
1400 $template = new UsercreateTemplate( $this->getConfig() );
1402 // Must match number of benefits defined in messages
1403 $template->set( 'benefitCount', 3 );
1405 $q = 'action=submitlogin&type=signup';
1406 $linkq = 'type=login';
1408 // Additional styles for login form
1409 $out->addModuleStyles( array(
1410 'mediawiki.special.userlogin.login.styles'
1413 $template = new UserloginTemplate( $this->getConfig() );
1415 $q = 'action=submitlogin&type=login';
1416 $linkq = 'type=signup';
1419 if ( $this->mReturnTo
!== '' ) {
1420 $returnto = '&returnto=' . wfUrlencode( $this->mReturnTo
);
1421 if ( $this->mReturnToQuery
!== '' ) {
1422 $returnto .= '&returntoquery=' .
1423 wfUrlencode( $this->mReturnToQuery
);
1426 $linkq .= $returnto;
1429 # Don't show a "create account" link if the user can't.
1430 if ( $this->showCreateOrLoginLink( $user ) ) {
1431 # Pass any language selection on to the mode switch link
1432 if ( $wgLoginLanguageSelector && $this->mLanguage
) {
1433 $linkq .= '&uselang=' . $this->mLanguage
;
1435 // Supply URL, login template creates the button.
1436 $template->set( 'createOrLoginHref', $titleObj->getLocalURL( $linkq ) );
1438 $template->set( 'link', '' );
1441 $resetLink = $this->mType
== 'signup'
1443 : is_array( $wgPasswordResetRoutes ) && in_array( true, array_values( $wgPasswordResetRoutes ) );
1445 $template->set( 'header', '' );
1446 $template->set( 'formheader', '' );
1447 $template->set( 'skin', $this->getSkin() );
1448 $template->set( 'name', $this->mUsername
);
1449 $template->set( 'password', $this->mPassword
);
1450 $template->set( 'retype', $this->mRetype
);
1451 $template->set( 'createemailset', $this->mCreateaccountMail
);
1452 $template->set( 'email', $this->mEmail
);
1453 $template->set( 'realname', $this->mRealName
);
1454 $template->set( 'domain', $this->mDomain
);
1455 $template->set( 'reason', $this->mReason
);
1457 $template->set( 'action', $titleObj->getLocalURL( $q ) );
1458 $template->set( 'message', $msg );
1459 $template->set( 'messagetype', $msgtype );
1460 $template->set( 'createemail', $wgEnableEmail && $user->isLoggedIn() );
1461 $template->set( 'userealname', !in_array( 'realname', $wgHiddenPrefs ) );
1462 $template->set( 'useemail', $wgEnableEmail );
1463 $template->set( 'emailrequired', $wgEmailConfirmToEdit );
1464 $template->set( 'emailothers', $wgEnableUserEmail );
1465 $template->set( 'canreset', $wgAuth->allowPasswordChange() );
1466 $template->set( 'resetlink', $resetLink );
1467 $template->set( 'canremember', $wgExtendedLoginCookieExpiration === null ?
1468 ( $wgCookieExpiration > 0 ) :
1469 ( $wgExtendedLoginCookieExpiration > 0 ) );
1470 $template->set( 'usereason', $user->isLoggedIn() );
1471 $template->set( 'remember', $this->mRemember
);
1472 $template->set( 'cansecurelogin', ( $wgSecureLogin === true ) );
1473 $template->set( 'stickhttps', (int)$this->mStickHTTPS
);
1474 $template->set( 'loggedin', $user->isLoggedIn() );
1475 $template->set( 'loggedinuser', $user->getName() );
1477 if ( $this->mType
== 'signup' ) {
1478 if ( !self
::getCreateaccountToken() ) {
1479 self
::setCreateaccountToken();
1481 $template->set( 'token', self
::getCreateaccountToken() );
1483 if ( !self
::getLoginToken() ) {
1484 self
::setLoginToken();
1486 $template->set( 'token', self
::getLoginToken() );
1489 # Prepare language selection links as needed
1490 if ( $wgLoginLanguageSelector ) {
1491 $template->set( 'languages', $this->makeLanguageSelector() );
1492 if ( $this->mLanguage
) {
1493 $template->set( 'uselang', $this->mLanguage
);
1497 $template->set( 'secureLoginUrl', $this->mSecureLoginUrl
);
1498 // Use signupend-https for HTTPS requests if it's not blank, signupend otherwise
1499 $usingHTTPS = $this->mRequest
->getProtocol() == 'https';
1500 $signupendHTTPS = $this->msg( 'signupend-https' );
1501 if ( $usingHTTPS && !$signupendHTTPS->isBlank() ) {
1502 $template->set( 'signupend', $signupendHTTPS->parse() );
1504 $template->set( 'signupend', $this->msg( 'signupend' )->parse() );
1507 // If using HTTPS coming from HTTP, then the 'fromhttp' parameter must be preserved
1508 if ( $usingHTTPS ) {
1509 $template->set( 'fromhttp', $this->mFromHTTP
);
1512 // Give authentication and captcha plugins a chance to modify the form
1513 $wgAuth->modifyUITemplate( $template, $this->mType
);
1514 if ( $this->mType
== 'signup' ) {
1515 Hooks
::run( 'UserCreateForm', array( &$template ) );
1517 Hooks
::run( 'UserLoginForm', array( &$template ) );
1520 $out->disallowUserJs(); // just in case...
1521 $out->addTemplate( $template );
1525 * Whether the login/create account form should display a link to the
1526 * other form (in addition to whatever the skin provides).
1531 private function showCreateOrLoginLink( &$user ) {
1532 if ( $this->mType
== 'signup' ) {
1534 } elseif ( $user->isAllowed( 'createaccount' ) ) {
1542 * Check if a session cookie is present.
1544 * This will not pick up a cookie set during _this_ request, but is meant
1545 * to ensure that the client is returning the cookie which was set on a
1546 * previous pass through the system.
1551 function hasSessionCookie() {
1552 global $wgDisableCookieCheck;
1554 return $wgDisableCookieCheck ?
true : $this->getRequest()->checkSessionCookie();
1558 * Get the login token from the current session
1561 public static function getLoginToken() {
1564 return $wgRequest->getSessionData( 'wsLoginToken' );
1568 * Randomly generate a new login token and attach it to the current session
1570 public static function setLoginToken() {
1572 // Generate a token directly instead of using $user->getEditToken()
1573 // because the latter reuses $_SESSION['wsEditToken']
1574 $wgRequest->setSessionData( 'wsLoginToken', MWCryptRand
::generateHex( 32 ) );
1578 * Remove any login token attached to the current session
1580 public static function clearLoginToken() {
1582 $wgRequest->setSessionData( 'wsLoginToken', null );
1586 * Get the createaccount token from the current session
1589 public static function getCreateaccountToken() {
1591 return $wgRequest->getSessionData( 'wsCreateaccountToken' );
1595 * Randomly generate a new createaccount token and attach it to the current session
1597 public static function setCreateaccountToken() {
1599 $wgRequest->setSessionData( 'wsCreateaccountToken', MWCryptRand
::generateHex( 32 ) );
1603 * Remove any createaccount token attached to the current session
1605 public static function clearCreateaccountToken() {
1607 $wgRequest->setSessionData( 'wsCreateaccountToken', null );
1611 * Renew the user's session id, using strong entropy
1613 private function renewSessionId() {
1614 global $wgSecureLogin, $wgCookieSecure;
1615 if ( $wgSecureLogin && !$this->mStickHTTPS
) {
1616 $wgCookieSecure = false;
1623 * @param string $type
1626 function cookieRedirectCheck( $type ) {
1627 $titleObj = SpecialPage
::getTitleFor( 'Userlogin' );
1628 $query = array( 'wpCookieCheck' => $type );
1629 if ( $this->mReturnTo
!== '' ) {
1630 $query['returnto'] = $this->mReturnTo
;
1631 $query['returntoquery'] = $this->mReturnToQuery
;
1633 $check = $titleObj->getFullURL( $query );
1635 $this->getOutput()->redirect( $check );
1639 * @param string $type
1642 function onCookieRedirectCheck( $type ) {
1643 if ( !$this->hasSessionCookie() ) {
1644 if ( $type == 'new' ) {
1645 $this->mainLoginForm( $this->msg( 'nocookiesnew' )->parse() );
1646 } elseif ( $type == 'login' ) {
1647 $this->mainLoginForm( $this->msg( 'nocookieslogin' )->parse() );
1650 $this->mainLoginForm( $this->msg( 'error' )->text() );
1653 $this->successfulLogin();
1658 * Produce a bar of links which allow the user to select another language
1659 * during login/registration but retain "returnto"
1663 function makeLanguageSelector() {
1664 $msg = $this->msg( 'loginlanguagelinks' )->inContentLanguage();
1665 if ( $msg->isBlank() ) {
1668 $langs = explode( "\n", $msg->text() );
1670 foreach ( $langs as $lang ) {
1671 $lang = trim( $lang, '* ' );
1672 $parts = explode( '|', $lang );
1673 if ( count( $parts ) >= 2 ) {
1674 $links[] = $this->makeLanguageSelectorLink( $parts[0], trim( $parts[1] ) );
1678 return count( $links ) > 0 ?
$this->msg( 'loginlanguagelabel' )->rawParams(
1679 $this->getLanguage()->pipeList( $links ) )->escaped() : '';
1683 * Create a language selector link for a particular language
1684 * Links back to this page preserving type and returnto
1686 * @param string $text Link text
1687 * @param string $lang Language code
1690 function makeLanguageSelectorLink( $text, $lang ) {
1691 if ( $this->getLanguage()->getCode() == $lang ) {
1692 // no link for currently used language
1693 return htmlspecialchars( $text );
1695 $query = array( 'uselang' => $lang );
1696 if ( $this->mType
== 'signup' ) {
1697 $query['type'] = 'signup';
1699 if ( $this->mReturnTo
!== '' ) {
1700 $query['returnto'] = $this->mReturnTo
;
1701 $query['returntoquery'] = $this->mReturnToQuery
;
1705 $targetLanguage = Language
::factory( $lang );
1706 $attr['lang'] = $attr['hreflang'] = $targetLanguage->getHtmlCode();
1708 return Linker
::linkKnown(
1709 $this->getPageTitle(),
1710 htmlspecialchars( $text ),
1716 protected function getGroupName() {
1721 * Private function to check password expiration, until AuthManager comes
1722 * along to handle that.
1724 * @return string|bool
1726 private function checkUserPasswordExpired( User
$user ) {
1727 global $wgPasswordExpireGrace;
1728 $dbr = wfGetDB( DB_SLAVE
);
1729 $ts = $dbr->selectField( 'user', 'user_password_expires', array( 'user_id' => $user->getId() ) );
1732 $now = wfTimestamp();
1733 $expUnix = wfTimestamp( TS_UNIX
, $ts );
1734 if ( $ts !== null && $expUnix < $now ) {
1735 $expired = ( $expUnix +
$wgPasswordExpireGrace < $now ) ?
'hard' : 'soft';