Follow-up r84814: revert redundant summary message addition.
[lhc/web/wiklou.git] / includes / specials / SpecialUserlogin.php
1 <?php
2 /**
3 * Implements Special:UserLogin
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 * @ingroup SpecialPage
22 */
23
24 /**
25 * Implements Special:UserLogin
26 *
27 * @ingroup SpecialPage
28 */
29 class LoginForm extends SpecialPage {
30
31 const SUCCESS = 0;
32 const NO_NAME = 1;
33 const ILLEGAL = 2;
34 const WRONG_PLUGIN_PASS = 3;
35 const NOT_EXISTS = 4;
36 const WRONG_PASS = 5;
37 const EMPTY_PASS = 6;
38 const RESET_PASS = 7;
39 const ABORTED = 8;
40 const CREATE_BLOCKED = 9;
41 const THROTTLED = 10;
42 const USER_BLOCKED = 11;
43 const NEED_TOKEN = 12;
44 const WRONG_TOKEN = 13;
45
46 var $mUsername, $mPassword, $mRetype, $mReturnTo, $mCookieCheck, $mPosted;
47 var $mAction, $mCreateaccount, $mCreateaccountMail, $mMailmypassword;
48 var $mLoginattempt, $mRemember, $mEmail, $mDomain, $mLanguage;
49 var $mSkipCookieCheck, $mReturnToQuery, $mToken, $mStickHTTPS;
50 var $mType, $mReason, $mRealName;
51 var $mAbortLoginErrorMsg = 'login-abort-generic';
52
53 /**
54 * @var ExternalUser
55 */
56 private $mExtUser = null;
57
58 /**
59 * @param WebRequest $request
60 */
61 public function __construct( $request = null ) {
62 parent::__construct( 'Userlogin' );
63
64 if ( $request === null ) {
65 global $wgRequest;
66 $this->load( $wgRequest );
67 } else {
68 $this->load( $request );
69 }
70 }
71
72 /**
73 * Loader
74 *
75 * @param $request WebRequest object
76 */
77 function load( $request ) {
78 global $wgAuth, $wgHiddenPrefs, $wgEnableEmail, $wgRedirectOnLogin;
79
80 $this->mType = $request->getText( 'type' );
81 $this->mUsername = $request->getText( 'wpName' );
82 $this->mPassword = $request->getText( 'wpPassword' );
83 $this->mRetype = $request->getText( 'wpRetype' );
84 $this->mDomain = $request->getText( 'wpDomain' );
85 $this->mReason = $request->getText( 'wpReason' );
86 $this->mReturnTo = $request->getVal( 'returnto' );
87 $this->mReturnToQuery = $request->getVal( 'returntoquery' );
88 $this->mCookieCheck = $request->getVal( 'wpCookieCheck' );
89 $this->mPosted = $request->wasPosted();
90 $this->mCreateaccount = $request->getCheck( 'wpCreateaccount' );
91 $this->mCreateaccountMail = $request->getCheck( 'wpCreateaccountMail' )
92 && $wgEnableEmail;
93 $this->mMailmypassword = $request->getCheck( 'wpMailmypassword' )
94 && $wgEnableEmail;
95 $this->mLoginattempt = $request->getCheck( 'wpLoginattempt' );
96 $this->mAction = $request->getVal( 'action' );
97 $this->mRemember = $request->getCheck( 'wpRemember' );
98 $this->mStickHTTPS = $request->getCheck( 'wpStickHTTPS' );
99 $this->mLanguage = $request->getText( 'uselang' );
100 $this->mSkipCookieCheck = $request->getCheck( 'wpSkipCookieCheck' );
101 $this->mToken = ( $this->mType == 'signup' ) ? $request->getVal( 'wpCreateaccountToken' ) : $request->getVal( 'wpLoginToken' );
102
103 if ( $wgRedirectOnLogin ) {
104 $this->mReturnTo = $wgRedirectOnLogin;
105 $this->mReturnToQuery = '';
106 }
107
108 if( $wgEnableEmail ) {
109 $this->mEmail = $request->getText( 'wpEmail' );
110 } else {
111 $this->mEmail = '';
112 }
113 if( !in_array( 'realname', $wgHiddenPrefs ) ) {
114 $this->mRealName = $request->getText( 'wpRealName' );
115 } else {
116 $this->mRealName = '';
117 }
118
119 if( !$wgAuth->validDomain( $this->mDomain ) ) {
120 $this->mDomain = 'invaliddomain';
121 }
122 $wgAuth->setDomain( $this->mDomain );
123
124 # When switching accounts, it sucks to get automatically logged out
125 $returnToTitle = Title::newFromText( $this->mReturnTo );
126 if( is_object( $returnToTitle ) && $returnToTitle->isSpecial( 'Userlogout' ) ) {
127 $this->mReturnTo = '';
128 $this->mReturnToQuery = '';
129 }
130 }
131
132 public function execute( $par ) {
133 if ( session_id() == '' ) {
134 wfSetupSession();
135 }
136
137 if ( $par == 'signup' ) { # Check for [[Special:Userlogin/signup]]
138 $this->mType = 'signup';
139 }
140
141 if ( !is_null( $this->mCookieCheck ) ) {
142 $this->onCookieRedirectCheck( $this->mCookieCheck );
143 return;
144 } elseif( $this->mPosted ) {
145 if( $this->mCreateaccount ) {
146 return $this->addNewAccount();
147 } elseif ( $this->mCreateaccountMail ) {
148 return $this->addNewAccountMailPassword();
149 } elseif ( $this->mMailmypassword ) {
150 return $this->mailPassword();
151 } elseif ( ( 'submitlogin' == $this->mAction ) || $this->mLoginattempt ) {
152 return $this->processLogin();
153 }
154 }
155 $this->mainLoginForm( '' );
156 }
157
158 /**
159 * @private
160 */
161 function addNewAccountMailPassword() {
162 global $wgOut;
163
164 if ( $this->mEmail == '' ) {
165 $this->mainLoginForm( wfMsgExt( 'noemail', array( 'parsemag', 'escape' ), $this->mUsername ) );
166 return;
167 }
168
169 $u = $this->addNewaccountInternal();
170
171 if ( $u == null ) {
172 return;
173 }
174
175 // Wipe the initial password and mail a temporary one
176 $u->setPassword( null );
177 $u->saveSettings();
178 $result = $this->mailPasswordInternal( $u, false, 'createaccount-title', 'createaccount-text' );
179
180 wfRunHooks( 'AddNewAccount', array( $u, true ) );
181 $u->addNewUserLogEntry( true, $this->mReason );
182
183 $wgOut->setPageTitle( wfMsg( 'accmailtitle' ) );
184
185 if( !$result->isGood() ) {
186 $this->mainLoginForm( wfMsg( 'mailerror', $result->getWikiText() ) );
187 } else {
188 $wgOut->addWikiMsg( 'accmailtext', $u->getName(), $u->getEmail() );
189 $wgOut->returnToMain( false );
190 }
191 }
192
193 /**
194 * @private
195 */
196 function addNewAccount() {
197 global $wgUser, $wgEmailAuthentication, $wgOut;
198
199 # Create the account and abort if there's a problem doing so
200 $u = $this->addNewAccountInternal();
201 if( $u == null ) {
202 return;
203 }
204
205 # If we showed up language selection links, and one was in use, be
206 # smart (and sensible) and save that language as the user's preference
207 global $wgLoginLanguageSelector;
208 if( $wgLoginLanguageSelector && $this->mLanguage ) {
209 $u->setOption( 'language', $this->mLanguage );
210 }
211
212 # Send out an email authentication message if needed
213 if( $wgEmailAuthentication && User::isValidEmailAddr( $u->getEmail() ) ) {
214 $status = $u->sendConfirmationMail();
215 if( $status->isGood() ) {
216 $wgOut->addWikiMsg( 'confirmemail_oncreate' );
217 } else {
218 $wgOut->addWikiText( $status->getWikiText( 'confirmemail_sendfailed' ) );
219 }
220 }
221
222 # Save settings (including confirmation token)
223 $u->saveSettings();
224
225 # If not logged in, assume the new account as the current one and set
226 # session cookies then show a "welcome" message or a "need cookies"
227 # message as needed
228 if( $wgUser->isAnon() ) {
229 $wgUser = $u;
230 $wgUser->setCookies();
231 wfRunHooks( 'AddNewAccount', array( $wgUser, false ) );
232 $wgUser->addNewUserLogEntry();
233 if( $this->hasSessionCookie() ) {
234 return $this->successfulCreation();
235 } else {
236 return $this->cookieRedirectCheck( 'new' );
237 }
238 } else {
239 # Confirm that the account was created
240 $self = SpecialPage::getTitleFor( 'Userlogin' );
241 $wgOut->setPageTitle( wfMsgHtml( 'accountcreated' ) );
242 $wgOut->addWikiMsg( 'accountcreatedtext', $u->getName() );
243 $wgOut->returnToMain( false, $self );
244 wfRunHooks( 'AddNewAccount', array( $u, false ) );
245 $u->addNewUserLogEntry( false, $this->mReason );
246 return true;
247 }
248 }
249
250 /**
251 * @private
252 */
253 function addNewAccountInternal() {
254 global $wgUser, $wgOut;
255 global $wgMemc, $wgAccountCreationThrottle;
256 global $wgAuth, $wgMinimalPasswordLength;
257 global $wgEmailConfirmToEdit;
258
259 // If the user passes an invalid domain, something is fishy
260 if( !$wgAuth->validDomain( $this->mDomain ) ) {
261 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
262 return false;
263 }
264
265 // If we are not allowing users to login locally, we should be checking
266 // to see if the user is actually able to authenticate to the authenti-
267 // cation server before they create an account (otherwise, they can
268 // create a local account and login as any domain user). We only need
269 // to check this for domains that aren't local.
270 if( 'local' != $this->mDomain && $this->mDomain != '' ) {
271 if( !$wgAuth->canCreateAccounts() && ( !$wgAuth->userExists( $this->mUsername )
272 || !$wgAuth->authenticate( $this->mUsername, $this->mPassword ) ) ) {
273 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
274 return false;
275 }
276 }
277
278 if ( wfReadOnly() ) {
279 $wgOut->readOnlyPage();
280 return false;
281 }
282
283 # Request forgery checks.
284 if ( !self::getCreateaccountToken() ) {
285 self::setCreateaccountToken();
286 $this->mainLoginForm( wfMsgExt( 'nocookiesfornew', array( 'parseinline' ) ) );
287 return false;
288 }
289
290 # The user didn't pass a createaccount token
291 if ( !$this->mToken ) {
292 $this->mainLoginForm( wfMsg( 'sessionfailure' ) );
293 return false;
294 }
295
296 # Validate the createaccount token
297 if ( $this->mToken !== self::getCreateaccountToken() ) {
298 $this->mainLoginForm( wfMsg( 'sessionfailure' ) );
299 return false;
300 }
301
302 # Check permissions
303 if ( !$wgUser->isAllowed( 'createaccount' ) ) {
304 $wgOut->permissionRequired( 'createaccount' );
305 return false;
306 } elseif ( $wgUser->isBlockedFromCreateAccount() ) {
307 $this->userBlockedMessage( $wgUser->isBlockedFromCreateAccount() );
308 return false;
309 }
310
311 $ip = wfGetIP();
312 if ( $wgUser->isDnsBlacklisted( $ip, true /* check $wgProxyWhitelist */ ) ) {
313 $this->mainLoginForm( wfMsg( 'sorbs_create_account_reason' ) . ' (' . htmlspecialchars( $ip ) . ')' );
314 return false;
315 }
316
317 # Now create a dummy user ($u) and check if it is valid
318 $name = trim( $this->mUsername );
319 $u = User::newFromName( $name, 'creatable' );
320 if ( !is_object( $u ) ) {
321 $this->mainLoginForm( wfMsg( 'noname' ) );
322 return false;
323 }
324
325 if ( 0 != $u->idForName() ) {
326 $this->mainLoginForm( wfMsg( 'userexists' ) );
327 return false;
328 }
329
330 if ( 0 != strcmp( $this->mPassword, $this->mRetype ) ) {
331 $this->mainLoginForm( wfMsg( 'badretype' ) );
332 return false;
333 }
334
335 # check for minimal password length
336 $valid = $u->getPasswordValidity( $this->mPassword );
337 if ( $valid !== true ) {
338 if ( !$this->mCreateaccountMail ) {
339 if ( is_array( $valid ) ) {
340 $message = array_shift( $valid );
341 $params = $valid;
342 } else {
343 $message = $valid;
344 $params = array( $wgMinimalPasswordLength );
345 }
346 $this->mainLoginForm( wfMsgExt( $message, array( 'parsemag' ), $params ) );
347 return false;
348 } else {
349 # do not force a password for account creation by email
350 # set invalid password, it will be replaced later by a random generated password
351 $this->mPassword = null;
352 }
353 }
354
355 # if you need a confirmed email address to edit, then obviously you
356 # need an email address.
357 if ( $wgEmailConfirmToEdit && empty( $this->mEmail ) ) {
358 $this->mainLoginForm( wfMsg( 'noemailtitle' ) );
359 return false;
360 }
361
362 if( !empty( $this->mEmail ) && !User::isValidEmailAddr( $this->mEmail ) ) {
363 $this->mainLoginForm( wfMsg( 'invalidemailaddress' ) );
364 return false;
365 }
366
367 # Set some additional data so the AbortNewAccount hook can be used for
368 # more than just username validation
369 $u->setEmail( $this->mEmail );
370 $u->setRealName( $this->mRealName );
371
372 $abortError = '';
373 if( !wfRunHooks( 'AbortNewAccount', array( $u, &$abortError ) ) ) {
374 // Hook point to add extra creation throttles and blocks
375 wfDebug( "LoginForm::addNewAccountInternal: a hook blocked creation\n" );
376 $this->mainLoginForm( $abortError );
377 return false;
378 }
379
380 if ( $wgAccountCreationThrottle && $wgUser->isPingLimitable() ) {
381 $key = wfMemcKey( 'acctcreate', 'ip', $ip );
382 $value = $wgMemc->get( $key );
383 if ( !$value ) {
384 $wgMemc->set( $key, 0, 86400 );
385 }
386 if ( $value >= $wgAccountCreationThrottle ) {
387 $this->throttleHit( $wgAccountCreationThrottle );
388 return false;
389 }
390 $wgMemc->incr( $key );
391 }
392
393 if( !$wgAuth->addUser( $u, $this->mPassword, $this->mEmail, $this->mRealName ) ) {
394 $this->mainLoginForm( wfMsg( 'externaldberror' ) );
395 return false;
396 }
397
398 self::clearCreateaccountToken();
399 return $this->initUser( $u, false );
400 }
401
402 /**
403 * Actually add a user to the database.
404 * Give it a User object that has been initialised with a name.
405 *
406 * @param $u User object.
407 * @param $autocreate boolean -- true if this is an autocreation via auth plugin
408 * @return User object.
409 * @private
410 */
411 function initUser( $u, $autocreate ) {
412 global $wgAuth;
413
414 $u->addToDatabase();
415
416 if ( $wgAuth->allowPasswordChange() ) {
417 $u->setPassword( $this->mPassword );
418 }
419
420 $u->setEmail( $this->mEmail );
421 $u->setRealName( $this->mRealName );
422 $u->setToken();
423
424 $wgAuth->initUser( $u, $autocreate );
425
426 if ( $this->mExtUser ) {
427 $this->mExtUser->linkToLocal( $u->getId() );
428 $email = $this->mExtUser->getPref( 'emailaddress' );
429 if ( $email && !$this->mEmail ) {
430 $u->setEmail( $email );
431 }
432 }
433
434 $u->setOption( 'rememberpassword', $this->mRemember ? 1 : 0 );
435 $u->saveSettings();
436
437 # Update user count
438 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
439 $ssUpdate->doUpdate();
440
441 return $u;
442 }
443
444 /**
445 * Internally authenticate the login request.
446 *
447 * This may create a local account as a side effect if the
448 * authentication plugin allows transparent local account
449 * creation.
450 */
451 public function authenticateUserData() {
452 global $wgUser, $wgAuth, $wgMemc;
453
454 if ( $this->mUsername == '' ) {
455 return self::NO_NAME;
456 }
457
458 // We require a login token to prevent login CSRF
459 // Handle part of this before incrementing the throttle so
460 // token-less login attempts don't count towards the throttle
461 // but wrong-token attempts do.
462
463 // If the user doesn't have a login token yet, set one.
464 if ( !self::getLoginToken() ) {
465 self::setLoginToken();
466 return self::NEED_TOKEN;
467 }
468 // If the user didn't pass a login token, tell them we need one
469 if ( !$this->mToken ) {
470 return self::NEED_TOKEN;
471 }
472
473 global $wgPasswordAttemptThrottle;
474
475 $throttleCount = 0;
476 if ( is_array( $wgPasswordAttemptThrottle ) ) {
477 $throttleKey = wfMemcKey( 'password-throttle', wfGetIP(), md5( $this->mUsername ) );
478 $count = $wgPasswordAttemptThrottle['count'];
479 $period = $wgPasswordAttemptThrottle['seconds'];
480
481 $throttleCount = $wgMemc->get( $throttleKey );
482 if ( !$throttleCount ) {
483 $wgMemc->add( $throttleKey, 1, $period ); // start counter
484 } elseif ( $throttleCount < $count ) {
485 $wgMemc->incr( $throttleKey );
486 } elseif ( $throttleCount >= $count ) {
487 return self::THROTTLED;
488 }
489 }
490
491 // Validate the login token
492 if ( $this->mToken !== self::getLoginToken() ) {
493 return self::WRONG_TOKEN;
494 }
495
496 // Load $wgUser now, and check to see if we're logging in as the same
497 // name. This is necessary because loading $wgUser (say by calling
498 // getName()) calls the UserLoadFromSession hook, which potentially
499 // creates the user in the database. Until we load $wgUser, checking
500 // for user existence using User::newFromName($name)->getId() below
501 // will effectively be using stale data.
502 if ( $wgUser->getName() === $this->mUsername ) {
503 wfDebug( __METHOD__ . ": already logged in as {$this->mUsername}\n" );
504 return self::SUCCESS;
505 }
506
507 $this->mExtUser = ExternalUser::newFromName( $this->mUsername );
508
509 # TODO: Allow some magic here for invalid external names, e.g., let the
510 # user choose a different wiki name.
511 $u = User::newFromName( $this->mUsername );
512 if( !( $u instanceof User ) || !User::isUsableName( $u->getName() ) ) {
513 return self::ILLEGAL;
514 }
515
516 $isAutoCreated = false;
517 if ( 0 == $u->getID() ) {
518 $status = $this->attemptAutoCreate( $u );
519 if ( $status !== self::SUCCESS ) {
520 return $status;
521 } else {
522 $isAutoCreated = true;
523 }
524 } else {
525 global $wgExternalAuthType, $wgAutocreatePolicy;
526 if ( $wgExternalAuthType && $wgAutocreatePolicy != 'never'
527 && is_object( $this->mExtUser )
528 && $this->mExtUser->authenticate( $this->mPassword ) ) {
529 # The external user and local user have the same name and
530 # password, so we assume they're the same.
531 $this->mExtUser->linkToLocal( $u->getID() );
532 }
533
534 $u->load();
535 }
536
537 // Give general extensions, such as a captcha, a chance to abort logins
538 $abort = self::ABORTED;
539 if( !wfRunHooks( 'AbortLogin', array( $u, $this->mPassword, &$abort, &$this->mAbortLoginErrorMsg ) ) ) {
540 return $abort;
541 }
542
543 global $wgBlockDisablesLogin;
544 if ( !$u->checkPassword( $this->mPassword ) ) {
545 if( $u->checkTemporaryPassword( $this->mPassword ) ) {
546 // The e-mailed temporary password should not be used for actu-
547 // al logins; that's a very sloppy habit, and insecure if an
548 // attacker has a few seconds to click "search" on someone's o-
549 // pen mail reader.
550 //
551 // Allow it to be used only to reset the password a single time
552 // to a new value, which won't be in the user's e-mail ar-
553 // chives.
554 //
555 // For backwards compatibility, we'll still recognize it at the
556 // login form to minimize surprises for people who have been
557 // logging in with a temporary password for some time.
558 //
559 // As a side-effect, we can authenticate the user's e-mail ad-
560 // dress if it's not already done, since the temporary password
561 // was sent via e-mail.
562 if( !$u->isEmailConfirmed() ) {
563 $u->confirmEmail();
564 $u->saveSettings();
565 }
566
567 // At this point we just return an appropriate code/ indicating
568 // that the UI should show a password reset form; bot inter-
569 // faces etc will probably just fail cleanly here.
570 $retval = self::RESET_PASS;
571 } else {
572 $retval = ( $this->mPassword == '' ) ? self::EMPTY_PASS : self::WRONG_PASS;
573 }
574 } elseif ( $wgBlockDisablesLogin && $u->isBlocked() ) {
575 // If we've enabled it, make it so that a blocked user cannot login
576 $retval = self::USER_BLOCKED;
577 } else {
578 $wgAuth->updateUser( $u );
579 $wgUser = $u;
580
581 // Please reset throttle for successful logins, thanks!
582 if( $throttleCount ) {
583 $wgMemc->delete( $throttleKey );
584 }
585
586 if ( $isAutoCreated ) {
587 // Must be run after $wgUser is set, for correct new user log
588 wfRunHooks( 'AuthPluginAutoCreate', array( $wgUser ) );
589 }
590
591 $retval = self::SUCCESS;
592 }
593 wfRunHooks( 'LoginAuthenticateAudit', array( $u, $this->mPassword, $retval ) );
594 return $retval;
595 }
596
597 /**
598 * Attempt to automatically create a user on login. Only succeeds if there
599 * is an external authentication method which allows it.
600 *
601 * @param $user User
602 *
603 * @return integer Status code
604 */
605 function attemptAutoCreate( $user ) {
606 global $wgAuth, $wgUser, $wgAutocreatePolicy;
607
608 if ( $wgUser->isBlockedFromCreateAccount() ) {
609 wfDebug( __METHOD__ . ": user is blocked from account creation\n" );
610 return self::CREATE_BLOCKED;
611 }
612
613 /**
614 * If the external authentication plugin allows it, automatically cre-
615 * ate a new account for users that are externally defined but have not
616 * yet logged in.
617 */
618 if ( $this->mExtUser ) {
619 # mExtUser is neither null nor false, so use the new ExternalAuth
620 # system.
621 if ( $wgAutocreatePolicy == 'never' ) {
622 return self::NOT_EXISTS;
623 }
624 if ( !$this->mExtUser->authenticate( $this->mPassword ) ) {
625 return self::WRONG_PLUGIN_PASS;
626 }
627 } else {
628 # Old AuthPlugin.
629 if ( !$wgAuth->autoCreate() ) {
630 return self::NOT_EXISTS;
631 }
632 if ( !$wgAuth->userExists( $user->getName() ) ) {
633 wfDebug( __METHOD__ . ": user does not exist\n" );
634 return self::NOT_EXISTS;
635 }
636 if ( !$wgAuth->authenticate( $user->getName(), $this->mPassword ) ) {
637 wfDebug( __METHOD__ . ": \$wgAuth->authenticate() returned false, aborting\n" );
638 return self::WRONG_PLUGIN_PASS;
639 }
640 }
641
642 wfDebug( __METHOD__ . ": creating account\n" );
643 $this->initUser( $user, true );
644 return self::SUCCESS;
645 }
646
647 function processLogin() {
648 global $wgUser;
649
650 switch ( $this->authenticateUserData() ) {
651 case self::SUCCESS:
652 # We've verified now, update the real record
653 if( (bool)$this->mRemember != (bool)$wgUser->getOption( 'rememberpassword' ) ) {
654 $wgUser->setOption( 'rememberpassword', $this->mRemember ? 1 : 0 );
655 $wgUser->saveSettings();
656 } else {
657 $wgUser->invalidateCache();
658 }
659 $wgUser->setCookies();
660 self::clearLoginToken();
661
662 // Reset the throttle
663 $key = wfMemcKey( 'password-throttle', wfGetIP(), md5( $this->mUsername ) );
664 global $wgMemc;
665 $wgMemc->delete( $key );
666
667 if( $this->hasSessionCookie() || $this->mSkipCookieCheck ) {
668 /* Replace the language object to provide user interface in
669 * correct language immediately on this first page load.
670 */
671 global $wgLang, $wgRequest;
672 $code = $wgRequest->getVal( 'uselang', $wgUser->getOption( 'language' ) );
673 $wgLang = Language::factory( $code );
674 return $this->successfulLogin();
675 } else {
676 return $this->cookieRedirectCheck( 'login' );
677 }
678 break;
679
680 case self::NEED_TOKEN:
681 $this->mainLoginForm( wfMsgExt( 'nocookiesforlogin', array( 'parseinline' ) ) );
682 break;
683 case self::WRONG_TOKEN:
684 $this->mainLoginForm( wfMsg( 'sessionfailure' ) );
685 break;
686 case self::NO_NAME:
687 case self::ILLEGAL:
688 $this->mainLoginForm( wfMsg( 'noname' ) );
689 break;
690 case self::WRONG_PLUGIN_PASS:
691 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
692 break;
693 case self::NOT_EXISTS:
694 if( $wgUser->isAllowed( 'createaccount' ) ) {
695 $this->mainLoginForm( wfMsgExt( 'nosuchuser', 'parseinline', $this->mUsername ) );
696 } else {
697 $this->mainLoginForm( wfMsg( 'nosuchusershort', htmlspecialchars( $this->mUsername ) ) );
698 }
699 break;
700 case self::WRONG_PASS:
701 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
702 break;
703 case self::EMPTY_PASS:
704 $this->mainLoginForm( wfMsg( 'wrongpasswordempty' ) );
705 break;
706 case self::RESET_PASS:
707 $this->resetLoginForm( wfMsg( 'resetpass_announce' ) );
708 break;
709 case self::CREATE_BLOCKED:
710 $this->userBlockedMessage();
711 break;
712 case self::THROTTLED:
713 $this->mainLoginForm( wfMsg( 'login-throttled' ) );
714 break;
715 case self::USER_BLOCKED:
716 $this->mainLoginForm( wfMsgExt( 'login-userblocked',
717 array( 'parsemag', 'escape' ), $this->mUsername ) );
718 break;
719 case self::ABORTED:
720 $this->mainLoginForm( wfMsg( $this->mAbortLoginErrorMsg ) );
721 break;
722 default:
723 throw new MWException( 'Unhandled case value' );
724 }
725 }
726
727 function resetLoginForm( $error ) {
728 global $wgOut;
729 $wgOut->addHTML( Xml::element('p', array( 'class' => 'error' ), $error ) );
730 $reset = new SpecialResetpass();
731 $reset->execute( null );
732 }
733
734 /**
735 * @private
736 */
737 function mailPassword() {
738 global $wgUser, $wgOut, $wgAuth;
739
740 if ( wfReadOnly() ) {
741 $wgOut->readOnlyPage();
742 return false;
743 }
744
745 if( !$wgAuth->allowPasswordChange() ) {
746 $this->mainLoginForm( wfMsg( 'resetpass_forbidden' ) );
747 return;
748 }
749
750 # Check against blocked IPs so blocked users can't flood admins
751 # with password resets
752 if( $wgUser->isBlocked() ) {
753 $this->mainLoginForm( wfMsg( 'blocked-mailpassword' ) );
754 return;
755 }
756
757 # Check for hooks
758 $error = null;
759 if ( !wfRunHooks( 'UserLoginMailPassword', array( $this->mUsername, &$error ) ) ) {
760 $this->mainLoginForm( $error );
761 return;
762 }
763
764 # If the user doesn't have a login token yet, set one.
765 if ( !self::getLoginToken() ) {
766 self::setLoginToken();
767 $this->mainLoginForm( wfMsg( 'sessionfailure' ) );
768 return;
769 }
770
771 # If the user didn't pass a login token, tell them we need one
772 if ( !$this->mToken ) {
773 $this->mainLoginForm( wfMsg( 'sessionfailure' ) );
774 return;
775 }
776
777 # Check against the rate limiter
778 if( $wgUser->pingLimiter( 'mailpassword' ) ) {
779 $wgOut->rateLimited();
780 return;
781 }
782
783 if ( $this->mUsername == '' ) {
784 $this->mainLoginForm( wfMsg( 'noname' ) );
785 return;
786 }
787 $u = User::newFromName( $this->mUsername );
788 if( !$u instanceof User ) {
789 $this->mainLoginForm( wfMsg( 'noname' ) );
790 return;
791 }
792 if ( 0 == $u->getID() ) {
793 $this->mainLoginForm( wfMsgExt( 'nosuchuser', 'parseinline', $u->getName() ) );
794 return;
795 }
796
797 # Validate the login token
798 if ( $this->mToken !== self::getLoginToken() ) {
799 $this->mainLoginForm( wfMsg( 'sessionfailure' ) );
800 return;
801 }
802
803 # Check against password throttle
804 if ( $u->isPasswordReminderThrottled() ) {
805 global $wgPasswordReminderResendTime;
806 # Round the time in hours to 3 d.p., in case someone is specifying
807 # minutes or seconds.
808 $this->mainLoginForm( wfMsgExt( 'throttled-mailpassword', array( 'parsemag' ),
809 round( $wgPasswordReminderResendTime, 3 ) ) );
810 return;
811 }
812
813 $result = $this->mailPasswordInternal( $u, true, 'passwordremindertitle', 'passwordremindertext' );
814 if( $result->isGood() ) {
815 $this->mainLoginForm( wfMsg( 'passwordsent', $u->getName() ), 'success' );
816 self::clearLoginToken();
817 } else {
818 $this->mainLoginForm( $result->getWikiText( 'mailerror' ) );
819 }
820 }
821
822
823 /**
824 * @param $u User object
825 * @param $throttle Boolean
826 * @param $emailTitle String: message name of email title
827 * @param $emailText String: message name of email text
828 * @return Status object
829 * @private
830 */
831 function mailPasswordInternal( $u, $throttle = true, $emailTitle = 'passwordremindertitle', $emailText = 'passwordremindertext' ) {
832 global $wgServer, $wgScript, $wgUser, $wgNewPasswordExpiry;
833
834 if ( $u->getEmail() == '' ) {
835 return Status::newFatal( 'noemail', $u->getName() );
836 }
837 $ip = wfGetIP();
838 if( !$ip ) {
839 return Status::newFatal( 'badipaddress' );
840 }
841
842 wfRunHooks( 'User::mailPasswordInternal', array( &$wgUser, &$ip, &$u ) );
843
844 $np = $u->randomPassword();
845 $u->setNewpassword( $np, $throttle );
846 $u->saveSettings();
847 $userLanguage = $u->getOption( 'language' );
848 $m = wfMsgExt( $emailText, array( 'parsemag', 'language' => $userLanguage ), $ip, $u->getName(), $np,
849 $wgServer . $wgScript, round( $wgNewPasswordExpiry / 86400 ) );
850 $result = $u->sendMail( wfMsgExt( $emailTitle, array( 'parsemag', 'language' => $userLanguage ) ), $m );
851
852 return $result;
853 }
854
855
856 /**
857 * Run any hooks registered for logins, then HTTP redirect to
858 * $this->mReturnTo (or Main Page if that's undefined). Formerly we had a
859 * nice message here, but that's really not as useful as just being sent to
860 * wherever you logged in from. It should be clear that the action was
861 * successful, given the lack of error messages plus the appearance of your
862 * name in the upper right.
863 *
864 * @private
865 */
866 function successfulLogin() {
867 global $wgUser, $wgOut;
868
869 # Run any hooks; display injected HTML if any, else redirect
870 $injected_html = '';
871 wfRunHooks( 'UserLoginComplete', array( &$wgUser, &$injected_html ) );
872
873 if( $injected_html !== '' ) {
874 $this->displaySuccessfulLogin( 'loginsuccess', $injected_html );
875 } else {
876 $titleObj = Title::newFromText( $this->mReturnTo );
877 if ( !$titleObj instanceof Title ) {
878 $titleObj = Title::newMainPage();
879 }
880 $redirectUrl = $titleObj->getFullURL( $this->mReturnToQuery );
881 global $wgSecureLogin;
882 if( $wgSecureLogin && !$this->mStickHTTPS ) {
883 $redirectUrl = preg_replace( '/^https:/', 'http:', $redirectUrl );
884 }
885 $wgOut->redirect( $redirectUrl );
886 }
887 }
888
889 /**
890 * Run any hooks registered for logins, then display a message welcoming
891 * the user.
892 *
893 * @private
894 */
895 function successfulCreation() {
896 global $wgUser;
897 # Run any hooks; display injected HTML
898 $injected_html = '';
899 wfRunHooks( 'UserLoginComplete', array( &$wgUser, &$injected_html ) );
900
901 $this->displaySuccessfulLogin( 'welcomecreation', $injected_html );
902 }
903
904 /**
905 * Display a "login successful" page.
906 */
907 private function displaySuccessfulLogin( $msgname, $injected_html ) {
908 global $wgOut, $wgUser;
909
910 $wgOut->setPageTitle( wfMsg( 'loginsuccesstitle' ) );
911 $wgOut->addWikiMsg( $msgname, $wgUser->getName() );
912 $wgOut->addHTML( $injected_html );
913
914 if ( !empty( $this->mReturnTo ) ) {
915 $wgOut->returnToMain( null, $this->mReturnTo, $this->mReturnToQuery );
916 } else {
917 $wgOut->returnToMain( null );
918 }
919 }
920
921 /**
922 * Output a message that informs the user that they cannot create an account because
923 * there is a block on them or their IP which prevents account creation. Note that
924 * User::isBlockedFromCreateAccount(), which gets this block, ignores the 'hardblock'
925 * setting on blocks (bug 13611).
926 * @param $block Block the block causing this error
927 */
928 function userBlockedMessage( Block $block ) {
929 global $wgOut;
930
931 # Let's be nice about this, it's likely that this feature will be used
932 # for blocking large numbers of innocent people, e.g. range blocks on
933 # schools. Don't blame it on the user. There's a small chance that it
934 # really is the user's fault, i.e. the username is blocked and they
935 # haven't bothered to log out before trying to create an account to
936 # evade it, but we'll leave that to their guilty conscience to figure
937 # out.
938
939 $wgOut->setPageTitle( wfMsg( 'cantcreateaccounttitle' ) );
940
941 $block_reason = $block->mReason;
942 if ( strval( $block_reason ) === '' ) {
943 $block_reason = wfMsg( 'blockednoreason' );
944 }
945
946 $wgOut->addWikiMsg(
947 'cantcreateaccount-text',
948 $block->getTarget(),
949 $block_reason,
950 $block->getBlocker()->getName()
951 );
952
953 $wgOut->returnToMain( false );
954 }
955
956 /**
957 * @private
958 */
959 function mainLoginForm( $msg, $msgtype = 'error' ) {
960 global $wgUser, $wgOut, $wgHiddenPrefs;
961 global $wgEnableEmail, $wgEnableUserEmail;
962 global $wgRequest, $wgLoginLanguageSelector;
963 global $wgAuth, $wgEmailConfirmToEdit, $wgCookieExpiration;
964 global $wgSecureLogin;
965
966 $titleObj = SpecialPage::getTitleFor( 'Userlogin' );
967
968 if ( $this->mType == 'signup' ) {
969 // Block signup here if in readonly. Keeps user from
970 // going through the process (filling out data, etc)
971 // and being informed later.
972 if ( wfReadOnly() ) {
973 $wgOut->readOnlyPage();
974 return;
975 } elseif ( $wgUser->isBlockedFromCreateAccount() ) {
976 $this->userBlockedMessage( $wgUser->isBlockedFromCreateAccount() );
977 return;
978 } elseif ( count( $permErrors = $titleObj->getUserPermissionsErrors( 'createaccount', $wgUser, true ) )>0 ) {
979 $wgOut->showPermissionsErrorPage( $permErrors, 'createaccount' );
980 return;
981 }
982 }
983
984 if ( $this->mUsername == '' ) {
985 if ( $wgUser->isLoggedIn() ) {
986 $this->mUsername = $wgUser->getName();
987 } else {
988 $this->mUsername = $wgRequest->getCookie( 'UserName' );
989 }
990 }
991
992 if ( $this->mType == 'signup' ) {
993 global $wgLivePasswordStrengthChecks;
994 if ( $wgLivePasswordStrengthChecks ) {
995 $wgOut->addPasswordSecurity( 'wpPassword2', 'wpRetype' );
996 }
997 $template = new UsercreateTemplate();
998 $q = 'action=submitlogin&type=signup';
999 $linkq = 'type=login';
1000 $linkmsg = 'gotaccount';
1001 } else {
1002 $template = new UserloginTemplate();
1003 $q = 'action=submitlogin&type=login';
1004 $linkq = 'type=signup';
1005 $linkmsg = 'nologin';
1006 }
1007
1008 if ( !empty( $this->mReturnTo ) ) {
1009 $returnto = '&returnto=' . wfUrlencode( $this->mReturnTo );
1010 if ( !empty( $this->mReturnToQuery ) ) {
1011 $returnto .= '&returntoquery=' .
1012 wfUrlencode( $this->mReturnToQuery );
1013 }
1014 $q .= $returnto;
1015 $linkq .= $returnto;
1016 }
1017
1018 # Pass any language selection on to the mode switch link
1019 if( $wgLoginLanguageSelector && $this->mLanguage ) {
1020 $linkq .= '&uselang=' . $this->mLanguage;
1021 }
1022
1023 $link = '<a href="' . htmlspecialchars ( $titleObj->getLocalURL( $linkq ) ) . '">';
1024 $link .= wfMsgHtml( $linkmsg . 'link' ); # Calling either 'gotaccountlink' or 'nologinlink'
1025 $link .= '</a>';
1026
1027 # Don't show a "create account" link if the user can't
1028 if( $this->showCreateOrLoginLink( $wgUser ) ) {
1029 $template->set( 'link', wfMsgExt( $linkmsg, array( 'parseinline', 'replaceafter' ), $link ) );
1030 } else {
1031 $template->set( 'link', '' );
1032 }
1033
1034 $template->set( 'header', '' );
1035 $template->set( 'name', $this->mUsername );
1036 $template->set( 'password', $this->mPassword );
1037 $template->set( 'retype', $this->mRetype );
1038 $template->set( 'email', $this->mEmail );
1039 $template->set( 'realname', $this->mRealName );
1040 $template->set( 'domain', $this->mDomain );
1041 $template->set( 'reason', $this->mReason );
1042
1043 $template->set( 'action', $titleObj->getLocalURL( $q ) );
1044 $template->set( 'message', $msg );
1045 $template->set( 'messagetype', $msgtype );
1046 $template->set( 'createemail', $wgEnableEmail && $wgUser->isLoggedIn() );
1047 $template->set( 'userealname', !in_array( 'realname', $wgHiddenPrefs ) );
1048 $template->set( 'useemail', $wgEnableEmail );
1049 $template->set( 'emailrequired', $wgEmailConfirmToEdit );
1050 $template->set( 'emailothers', $wgEnableUserEmail );
1051 $template->set( 'canreset', $wgAuth->allowPasswordChange() );
1052 $template->set( 'canremember', ( $wgCookieExpiration > 0 ) );
1053 $template->set( 'usereason', $wgUser->isLoggedIn() );
1054 $template->set( 'remember', $wgUser->getOption( 'rememberpassword' ) || $this->mRemember );
1055 $template->set( 'cansecurelogin', ( $wgSecureLogin === true ) );
1056 $template->set( 'stickHTTPS', $this->mStickHTTPS );
1057
1058 if ( $this->mType == 'signup' ) {
1059 if ( !self::getCreateaccountToken() ) {
1060 self::setCreateaccountToken();
1061 }
1062 $template->set( 'token', self::getCreateaccountToken() );
1063 } else {
1064 if ( !self::getLoginToken() ) {
1065 self::setLoginToken();
1066 }
1067 $template->set( 'token', self::getLoginToken() );
1068 }
1069
1070 # Prepare language selection links as needed
1071 if( $wgLoginLanguageSelector ) {
1072 $template->set( 'languages', $this->makeLanguageSelector() );
1073 if( $this->mLanguage )
1074 $template->set( 'uselang', $this->mLanguage );
1075 }
1076
1077 // Give authentication and captcha plugins a chance to modify the form
1078 $wgAuth->modifyUITemplate( $template, $this->mType );
1079 if ( $this->mType == 'signup' ) {
1080 wfRunHooks( 'UserCreateForm', array( &$template ) );
1081 } else {
1082 wfRunHooks( 'UserLoginForm', array( &$template ) );
1083 }
1084
1085 // Changes the title depending on permissions for creating account
1086 if ( $wgUser->isAllowed( 'createaccount' ) ) {
1087 $wgOut->setPageTitle( wfMsg( 'userlogin' ) );
1088 } else {
1089 $wgOut->setPageTitle( wfMsg( 'userloginnocreate' ) );
1090 }
1091
1092 $wgOut->disallowUserJs(); // just in case...
1093 $wgOut->addTemplate( $template );
1094 }
1095
1096 /**
1097 * @private
1098 *
1099 * @param $user User
1100 *
1101 * @return Boolean
1102 */
1103 function showCreateOrLoginLink( &$user ) {
1104 if( $this->mType == 'signup' ) {
1105 return true;
1106 } elseif( $user->isAllowed( 'createaccount' ) ) {
1107 return true;
1108 } else {
1109 return false;
1110 }
1111 }
1112
1113 /**
1114 * Check if a session cookie is present.
1115 *
1116 * This will not pick up a cookie set during _this_ request, but is meant
1117 * to ensure that the client is returning the cookie which was set on a
1118 * previous pass through the system.
1119 *
1120 * @private
1121 */
1122 function hasSessionCookie() {
1123 global $wgDisableCookieCheck, $wgRequest;
1124 return $wgDisableCookieCheck ? true : $wgRequest->checkSessionCookie();
1125 }
1126
1127 /**
1128 * Get the login token from the current session
1129 */
1130 public static function getLoginToken() {
1131 global $wgRequest;
1132 return $wgRequest->getSessionData( 'wsLoginToken' );
1133 }
1134
1135 /**
1136 * Randomly generate a new login token and attach it to the current session
1137 */
1138 public static function setLoginToken() {
1139 global $wgRequest;
1140 // Use User::generateToken() instead of $user->editToken()
1141 // because the latter reuses $_SESSION['wsEditToken']
1142 $wgRequest->setSessionData( 'wsLoginToken', User::generateToken() );
1143 }
1144
1145 /**
1146 * Remove any login token attached to the current session
1147 */
1148 public static function clearLoginToken() {
1149 global $wgRequest;
1150 $wgRequest->setSessionData( 'wsLoginToken', null );
1151 }
1152
1153 /**
1154 * Get the createaccount token from the current session
1155 */
1156 public static function getCreateaccountToken() {
1157 global $wgRequest;
1158 return $wgRequest->getSessionData( 'wsCreateaccountToken' );
1159 }
1160
1161 /**
1162 * Randomly generate a new createaccount token and attach it to the current session
1163 */
1164 public static function setCreateaccountToken() {
1165 global $wgRequest;
1166 $wgRequest->setSessionData( 'wsCreateaccountToken', User::generateToken() );
1167 }
1168
1169 /**
1170 * Remove any createaccount token attached to the current session
1171 */
1172 public static function clearCreateaccountToken() {
1173 global $wgRequest;
1174 $wgRequest->setSessionData( 'wsCreateaccountToken', null );
1175 }
1176
1177 /**
1178 * @private
1179 */
1180 function cookieRedirectCheck( $type ) {
1181 global $wgOut;
1182
1183 $titleObj = SpecialPage::getTitleFor( 'Userlogin' );
1184 $query = array( 'wpCookieCheck' => $type );
1185 if ( $this->mReturnTo ) {
1186 $query['returnto'] = $this->mReturnTo;
1187 }
1188 $check = $titleObj->getFullURL( $query );
1189
1190 return $wgOut->redirect( $check );
1191 }
1192
1193 /**
1194 * @private
1195 */
1196 function onCookieRedirectCheck( $type ) {
1197 if ( !$this->hasSessionCookie() ) {
1198 if ( $type == 'new' ) {
1199 return $this->mainLoginForm( wfMsgExt( 'nocookiesnew', array( 'parseinline' ) ) );
1200 } elseif ( $type == 'login' ) {
1201 return $this->mainLoginForm( wfMsgExt( 'nocookieslogin', array( 'parseinline' ) ) );
1202 } else {
1203 # shouldn't happen
1204 return $this->mainLoginForm( wfMsg( 'error' ) );
1205 }
1206 } else {
1207 return $this->successfulLogin();
1208 }
1209 }
1210
1211 /**
1212 * @private
1213 */
1214 function throttleHit( $limit ) {
1215 $this->mainLoginForm( wfMsgExt( 'acct_creation_throttle_hit', array( 'parseinline' ), $limit ) );
1216 }
1217
1218 /**
1219 * Produce a bar of links which allow the user to select another language
1220 * during login/registration but retain "returnto"
1221 *
1222 * @return string
1223 */
1224 function makeLanguageSelector() {
1225 global $wgLang;
1226
1227 $msg = wfMessage( 'loginlanguagelinks' )->inContentLanguage();
1228 if( !$msg->isBlank() ) {
1229 $langs = explode( "\n", $msg->text() );
1230 $links = array();
1231 foreach( $langs as $lang ) {
1232 $lang = trim( $lang, '* ' );
1233 $parts = explode( '|', $lang );
1234 if ( count( $parts ) >= 2 ) {
1235 $links[] = $this->makeLanguageSelectorLink( $parts[0], $parts[1] );
1236 }
1237 }
1238 return count( $links ) > 0 ? wfMsgHtml( 'loginlanguagelabel', $wgLang->pipeList( $links ) ) : '';
1239 } else {
1240 return '';
1241 }
1242 }
1243
1244 /**
1245 * Create a language selector link for a particular language
1246 * Links back to this page preserving type and returnto
1247 *
1248 * @param $text Link text
1249 * @param $lang Language code
1250 */
1251 function makeLanguageSelectorLink( $text, $lang ) {
1252 global $wgUser;
1253 $self = SpecialPage::getTitleFor( 'Userlogin' );
1254 $attr = array( 'uselang' => $lang );
1255 if( $this->mType == 'signup' ) {
1256 $attr['type'] = 'signup';
1257 }
1258 if( $this->mReturnTo ) {
1259 $attr['returnto'] = $this->mReturnTo;
1260 }
1261 $skin = $wgUser->getSkin();
1262 return $skin->linkKnown(
1263 $self,
1264 htmlspecialchars( $text ),
1265 array(),
1266 $attr
1267 );
1268 }
1269 }