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