Validate status codes returned from the AbortLogin hook
[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 use MediaWiki\Logger\LoggerFactory;
24
25 /**
26 * Implements Special:UserLogin
27 *
28 * @ingroup SpecialPage
29 */
30 class LoginForm extends SpecialPage {
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 const USER_MIGRATED = 14;
46
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',
63 );
64
65 /**
66 * Valid error and warning messages
67 *
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
70 * parameters.
71 *
72 * This array is the list of valid message keys. All other values will be
73 * ignored.
74 *
75 * @since 1.24
76 * @var string[]
77 */
78 public static $validErrorMessages = array(
79 'exception-nologin-text',
80 'watchlistanontext',
81 'changeemail-no-info',
82 'resetpass-no-info',
83 'confirmemail_needlogin',
84 'prefsnologintext2',
85 );
86
87 public $mAbortLoginErrorMsg = null;
88
89 protected $mUsername;
90 protected $mPassword;
91 protected $mRetype;
92 protected $mReturnTo;
93 protected $mCookieCheck;
94 protected $mPosted;
95 protected $mAction;
96 protected $mCreateaccount;
97 protected $mCreateaccountMail;
98 protected $mLoginattempt;
99 protected $mRemember;
100 protected $mEmail;
101 protected $mDomain;
102 protected $mLanguage;
103 protected $mSkipCookieCheck;
104 protected $mReturnToQuery;
105 protected $mToken;
106 protected $mStickHTTPS;
107 protected $mType;
108 protected $mReason;
109 protected $mRealName;
110 protected $mEntryError = '';
111 protected $mEntryErrorType = 'error';
112
113 private $mTempPasswordUsed;
114 private $mLoaded = false;
115 private $mSecureLoginUrl;
116
117 /** @var WebRequest */
118 private $mOverrideRequest = null;
119
120 /** @var WebRequest Effective request; set at the beginning of load */
121 private $mRequest = null;
122
123 /**
124 * @param WebRequest $request
125 */
126 public function __construct( $request = null ) {
127 global $wgUseMediaWikiUIEverywhere;
128 parent::__construct( 'Userlogin' );
129
130 $this->mOverrideRequest = $request;
131 // Override UseMediaWikiEverywhere to true, to force login and create form to use mw ui
132 $wgUseMediaWikiUIEverywhere = true;
133 }
134
135 /**
136 * Returns an array of all valid error messages.
137 *
138 * @return array
139 */
140 public static function getValidErrorMessages() {
141 static $messages = null;
142 if ( !$messages ) {
143 $messages = self::$validErrorMessages;
144 Hooks::run( 'LoginFormValidErrorMessages', array( &$messages ) );
145 }
146
147 return $messages;
148 }
149
150 /**
151 * Loader
152 */
153 function load() {
154 global $wgAuth, $wgHiddenPrefs, $wgEnableEmail;
155
156 if ( $this->mLoaded ) {
157 return;
158 }
159 $this->mLoaded = true;
160
161 if ( $this->mOverrideRequest === null ) {
162 $request = $this->getRequest();
163 } else {
164 $request = $this->mOverrideRequest;
165 }
166 $this->mRequest = $request;
167
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' )
177 && $wgEnableEmail;
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', '' );
193
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
198 // was not updated
199 $loginreqlink = Linker::linkKnown(
200 $this->getPageTitle(),
201 $this->msg( 'loginreqlink' )->escaped(),
202 array(),
203 array(
204 'returnto' => $this->mReturnTo,
205 'returntoquery' => $this->mReturnToQuery,
206 'uselang' => $this->mLanguage,
207 'fromhttp' => $this->mFromHTTP ? '1' : '0',
208 )
209 );
210
211 // Only show valid error or warning messages.
212 if ( $entryError->exists()
213 && in_array( $entryError->getKey(), self::getValidErrorMessages() )
214 ) {
215 $this->mEntryErrorType = 'error';
216 $this->mEntryError = $entryError->rawParams( $loginreqlink )->parse();
217
218 } elseif ( $entryWarning->exists()
219 && in_array( $entryWarning->getKey(), self::getValidErrorMessages() )
220 ) {
221 $this->mEntryErrorType = 'warning';
222 $this->mEntryError = $entryWarning->rawParams( $loginreqlink )->parse();
223 }
224
225 if ( $wgEnableEmail ) {
226 $this->mEmail = $request->getText( 'wpEmail' );
227 } else {
228 $this->mEmail = '';
229 }
230 if ( !in_array( 'realname', $wgHiddenPrefs ) ) {
231 $this->mRealName = $request->getText( 'wpRealName' );
232 } else {
233 $this->mRealName = '';
234 }
235
236 if ( !$wgAuth->validDomain( $this->mDomain ) ) {
237 $this->mDomain = $wgAuth->getDomain();
238 }
239 $wgAuth->setDomain( $this->mDomain );
240
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' ) )
248 ) {
249 $this->mReturnTo = '';
250 $this->mReturnToQuery = '';
251 }
252 }
253
254 function getDescription() {
255 if ( $this->mType === 'signup' ) {
256 return $this->msg( 'createaccount' )->text();
257 } else {
258 return $this->msg( 'login' )->text();
259 }
260 }
261
262 /**
263 * @param string|null $subPage
264 */
265 public function execute( $subPage ) {
266 if ( session_id() == '' ) {
267 wfSetupSession();
268 }
269
270 $this->load();
271
272 // Check for [[Special:Userlogin/signup]]. This affects form display and
273 // page title.
274 if ( $subPage == 'signup' ) {
275 $this->mType = 'signup';
276 }
277 $this->setHeaders();
278
279 /**
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.
285 *
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.
289 */
290 if (
291 $this->mType !== 'signup' &&
292 !$this->mPosted &&
293 $this->getUser()->isLoggedIn() &&
294 ( $this->mReturnTo !== '' || $this->mReturnToQuery !== '' )
295 ) {
296 $this->successfulLogin();
297 }
298
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();
303 $query = array(
304 'returnto' => $this->mReturnTo !== '' ? $this->mReturnTo : null,
305 'returntoquery' => $this->mReturnToQuery !== '' ?
306 $this->mReturnToQuery : null,
307 'title' => null,
308 ( $this->mEntryErrorType === 'error' ? 'error' : 'warning' ) => $this->mEntryError,
309 ) + $this->mRequest->getQueryValues();
310 $url = $title->getFullURL( $query, false, PROTO_HTTPS );
311 if ( $wgSecureLogin
312 && wfCanIPUseHTTPS( $this->getRequest()->getIP() )
313 && !$this->mFromHTTP ) // Avoid infinite redirect
314 {
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' );
319
320 return;
321 } else {
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;
327 }
328 }
329 }
330
331 if ( !is_null( $this->mCookieCheck ) ) {
332 $this->onCookieRedirectCheck( $this->mCookieCheck );
333
334 return;
335 } elseif ( $this->mPosted ) {
336 if ( $this->mCreateaccount ) {
337 $this->addNewAccount();
338
339 return;
340 } elseif ( $this->mCreateaccountMail ) {
341 $this->addNewAccountMailPassword();
342
343 return;
344 } elseif ( ( 'submitlogin' == $this->mAction ) || $this->mLoginattempt ) {
345 $this->processLogin();
346
347 return;
348 }
349 }
350 $this->mainLoginForm( $this->mEntryError, $this->mEntryErrorType );
351 }
352
353 /**
354 * @private
355 */
356 function addNewAccountMailPassword() {
357 if ( $this->mEmail == '' ) {
358 $this->mainLoginForm( $this->msg( 'noemailcreate' )->escaped() );
359
360 return;
361 }
362
363 $status = $this->addNewAccountInternal();
364 LoggerFactory::getInstance( 'authmanager' )->info(
365 'Account creation attempt with mailed password',
366 array( 'event' => 'accountcreation', 'status' => $status )
367 );
368 if ( !$status->isGood() ) {
369 $error = $status->getMessage();
370 $this->mainLoginForm( $error->toString() );
371
372 return;
373 }
374
375 $u = $status->getValue();
376
377 // Wipe the initial password and mail a temporary one
378 $u->setPassword( null );
379 $u->saveSettings();
380 $result = $this->mailPasswordInternal( $u, false, 'createaccount-title', 'createaccount-text' );
381
382 Hooks::run( 'AddNewAccount', array( $u, true ) );
383 $u->addNewUserLogEntry( 'byemail', $this->mReason );
384
385 $out = $this->getOutput();
386 $out->setPageTitle( $this->msg( 'accmailtitle' ) );
387
388 if ( !$result->isGood() ) {
389 $this->mainLoginForm( $this->msg( 'mailerror', $result->getWikiText() )->text() );
390 } else {
391 $out->addWikiMsg( 'accmailtext', $u->getName(), $u->getEmail() );
392 $this->executeReturnTo( 'success' );
393 }
394 }
395
396 /**
397 * @private
398 * @return bool
399 */
400 function addNewAccount() {
401 global $wgContLang, $wgUser, $wgEmailAuthentication, $wgLoginLanguageSelector;
402
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',
407 'status' => $status,
408 ) );
409
410 if ( !$status->isGood() ) {
411 $error = $status->getMessage();
412 $this->mainLoginForm( $error->toString() );
413
414 return false;
415 }
416
417 $u = $status->getValue();
418
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 );
425 } else {
426
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() );
431 }
432 if ( $wgContLang->hasVariants() ) {
433 $u->setOption( 'variant', $wgContLang->getPreferredVariant() );
434 }
435 }
436
437 $out = $this->getOutput();
438
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' );
444 } else {
445 $out->addWikiText( $status->getWikiText( 'confirmemail_sendfailed' ) );
446 }
447 }
448
449 # Save settings (including confirmation token)
450 $u->saveSettings();
451
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"
454 # message as needed
455 if ( $this->getUser()->isAnon() ) {
456 $u->setCookies();
457 $wgUser = $u;
458 // This should set it for OutputPage and the Skin
459 // which is needed or the personal links will be
460 // wrong.
461 $this->getContext()->setUser( $u );
462 Hooks::run( 'AddNewAccount', array( $u, false ) );
463 $u->addNewUserLogEntry( 'create' );
464 if ( $this->hasSessionCookie() ) {
465 $this->successfulCreation();
466 } else {
467 $this->cookieRedirectCheck( 'new' );
468 }
469 } else {
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 );
476 }
477
478 return true;
479 }
480
481 /**
482 * Make a new user account using the loaded data.
483 * @private
484 * @throws PermissionsError|ReadOnlyError
485 * @return Status
486 */
487 public function addNewAccountInternal() {
488 global $wgAuth, $wgMemc, $wgAccountCreationThrottle, $wgEmailConfirmToEdit;
489
490 // If the user passes an invalid domain, something is fishy
491 if ( !$wgAuth->validDomain( $this->mDomain ) ) {
492 return Status::newFatal( 'wrongpassword' );
493 }
494
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 != '' ) {
501 if (
502 !$wgAuth->canCreateAccounts() &&
503 (
504 !$wgAuth->userExists( $this->mUsername ) ||
505 !$wgAuth->authenticate( $this->mUsername, $this->mPassword )
506 )
507 ) {
508 return Status::newFatal( 'wrongpassword' );
509 }
510 }
511
512 if ( wfReadOnly() ) {
513 throw new ReadOnlyError;
514 }
515
516 # Request forgery checks.
517 if ( !self::getCreateaccountToken() ) {
518 self::setCreateaccountToken();
519
520 return Status::newFatal( 'nocookiesfornew' );
521 }
522
523 # The user didn't pass a createaccount token
524 if ( !$this->mToken ) {
525 return Status::newFatal( 'sessionfailure' );
526 }
527
528 # Validate the createaccount token
529 if ( $this->mToken !== self::getCreateaccountToken() ) {
530 return Status::newFatal( 'sessionfailure' );
531 }
532
533 # Check permissions
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 );
541
542 // This should never be reached.
543 return false;
544 }
545
546 # Include checks that will include GlobalBlocking (Bug 38333)
547 $permErrors = $this->getPageTitle()->getUserPermissionsErrors(
548 'createaccount',
549 $currentUser,
550 true
551 );
552
553 if ( count( $permErrors ) ) {
554 throw new PermissionsError( 'createaccount', $permErrors );
555 }
556
557 $ip = $this->getRequest()->getIP();
558 if ( $currentUser->isDnsBlacklisted( $ip, true /* check $wgProxyWhitelist */ ) ) {
559 return Status::newFatal( 'sorbs_create_account_reason' );
560 }
561
562 # Now create a dummy user ($u) and check if it is valid
563 $u = User::newFromName( $this->mUsername, 'creatable' );
564 if ( !$u ) {
565 return Status::newFatal( 'noname' );
566 }
567
568 # Make sure the user does not exist already
569 $lock = $wgMemc->getScopedLock( wfGlobalCacheKey( 'account', md5( $this->mUsername ) ) );
570 if ( !$lock ) {
571 return Status::newFatal( 'usernameinprogress' );
572 } elseif ( $u->idForName( User::READ_LOCKING ) ) {
573 return Status::newFatal( 'userexists' );
574 }
575
576 if ( $this->mCreateaccountMail ) {
577 # do not force a password for account creation by email
578 # set invalid password, it will be replaced later by a random generated password
579 $this->mPassword = null;
580 } else {
581 if ( $this->mPassword !== $this->mRetype ) {
582 return Status::newFatal( 'badretype' );
583 }
584
585 # check for password validity, return a fatal Status if invalid
586 $validity = $u->checkPasswordValidity( $this->mPassword, 'create' );
587 if ( !$validity->isGood() ) {
588 $validity->ok = false; // make sure this Status is fatal
589 return $validity;
590 }
591 }
592
593 # if you need a confirmed email address to edit, then obviously you
594 # need an email address.
595 if ( $wgEmailConfirmToEdit && strval( $this->mEmail ) === '' ) {
596 return Status::newFatal( 'noemailtitle' );
597 }
598
599 if ( strval( $this->mEmail ) !== '' && !Sanitizer::validateEmail( $this->mEmail ) ) {
600 return Status::newFatal( 'invalidemailaddress' );
601 }
602
603 # Set some additional data so the AbortNewAccount hook can be used for
604 # more than just username validation
605 $u->setEmail( $this->mEmail );
606 $u->setRealName( $this->mRealName );
607
608 $abortError = '';
609 $abortStatus = null;
610 if ( !Hooks::run( 'AbortNewAccount', array( $u, &$abortError, &$abortStatus ) ) ) {
611 // Hook point to add extra creation throttles and blocks
612 wfDebug( "LoginForm::addNewAccountInternal: a hook blocked creation\n" );
613 if ( $abortStatus === null ) {
614 // Report back the old string as a raw message status.
615 // This will report the error back as 'createaccount-hook-aborted'
616 // with the given string as the message.
617 // To return a different error code, return a Status object.
618 $abortError = new Message( 'createaccount-hook-aborted', array( $abortError ) );
619 $abortError->text();
620
621 return Status::newFatal( $abortError );
622 } else {
623 // For MediaWiki 1.23+ and updated hooks, return the Status object
624 // returned from the hook.
625 return $abortStatus;
626 }
627 }
628
629 // Hook point to check for exempt from account creation throttle
630 if ( !Hooks::run( 'ExemptFromAccountCreationThrottle', array( $ip ) ) ) {
631 wfDebug( "LoginForm::exemptFromAccountCreationThrottle: a hook " .
632 "allowed account creation w/o throttle\n" );
633 } else {
634 if ( ( $wgAccountCreationThrottle && $currentUser->isPingLimitable() ) ) {
635 $key = wfMemcKey( 'acctcreate', 'ip', $ip );
636 $value = $wgMemc->get( $key );
637 if ( !$value ) {
638 $wgMemc->set( $key, 0, 86400 );
639 }
640 if ( $value >= $wgAccountCreationThrottle ) {
641 return Status::newFatal( 'acct_creation_throttle_hit', $wgAccountCreationThrottle );
642 }
643 $wgMemc->incr( $key );
644 }
645 }
646
647 if ( !$wgAuth->addUser( $u, $this->mPassword, $this->mEmail, $this->mRealName ) ) {
648 return Status::newFatal( 'externaldberror' );
649 }
650
651 self::clearCreateaccountToken();
652
653 return $this->initUser( $u, false );
654 }
655
656 /**
657 * Actually add a user to the database.
658 * Give it a User object that has been initialised with a name.
659 *
660 * @param User $u
661 * @param bool $autocreate True if this is an autocreation via auth plugin
662 * @return Status Status object, with the User object in the value member on success
663 * @private
664 */
665 function initUser( $u, $autocreate ) {
666 global $wgAuth;
667
668 $status = $u->addToDatabase();
669 if ( !$status->isOK() ) {
670 return $status;
671 }
672
673 if ( $wgAuth->allowPasswordChange() ) {
674 $u->setPassword( $this->mPassword );
675 }
676
677 $u->setEmail( $this->mEmail );
678 $u->setRealName( $this->mRealName );
679 $u->setToken();
680
681 Hooks::run( 'LocalUserCreated', array( $u, $autocreate ) );
682 $oldUser = $u;
683 $wgAuth->initUser( $u, $autocreate );
684 if ( $oldUser !== $u ) {
685 wfWarn( get_class( $wgAuth ) . '::initUser() replaced the user object' );
686 }
687
688 $u->saveSettings();
689
690 // Update user count
691 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 0, 0, 0, 1 ) );
692
693 // Watch user's userpage and talk page
694 $u->addWatch( $u->getUserPage(), WatchedItem::IGNORE_USER_RIGHTS );
695
696 return Status::newGood( $u );
697 }
698
699 /**
700 * Internally authenticate the login request.
701 *
702 * This may create a local account as a side effect if the
703 * authentication plugin allows transparent local account
704 * creation.
705 * @return int
706 */
707 public function authenticateUserData() {
708 global $wgUser, $wgAuth;
709
710 $this->load();
711
712 if ( $this->mUsername == '' ) {
713 return self::NO_NAME;
714 }
715
716 // We require a login token to prevent login CSRF
717 // Handle part of this before incrementing the throttle so
718 // token-less login attempts don't count towards the throttle
719 // but wrong-token attempts do.
720
721 // If the user doesn't have a login token yet, set one.
722 if ( !self::getLoginToken() ) {
723 self::setLoginToken();
724
725 return self::NEED_TOKEN;
726 }
727 // If the user didn't pass a login token, tell them we need one
728 if ( !$this->mToken ) {
729 return self::NEED_TOKEN;
730 }
731
732 $throttleCount = self::incLoginThrottle( $this->mUsername );
733 if ( $throttleCount === true ) {
734 return self::THROTTLED;
735 }
736
737 // Validate the login token
738 if ( $this->mToken !== self::getLoginToken() ) {
739 return self::WRONG_TOKEN;
740 }
741
742 // Load the current user now, and check to see if we're logging in as
743 // the same name. This is necessary because loading the current user
744 // (say by calling getName()) calls the UserLoadFromSession hook, which
745 // potentially creates the user in the database. Until we load $wgUser,
746 // checking for user existence using User::newFromName($name)->getId() below
747 // will effectively be using stale data.
748 if ( $this->getUser()->getName() === $this->mUsername ) {
749 wfDebug( __METHOD__ . ": already logged in as {$this->mUsername}\n" );
750
751 return self::SUCCESS;
752 }
753
754 $u = User::newFromName( $this->mUsername );
755 if ( $u === false ) {
756 return self::ILLEGAL;
757 }
758
759 $msg = null;
760 // Give extensions a way to indicate the username has been updated,
761 // rather than telling the user the account doesn't exist.
762 if ( !Hooks::run( 'LoginUserMigrated', array( $u, &$msg ) ) ) {
763 $this->mAbortLoginErrorMsg = $msg;
764 return self::USER_MIGRATED;
765 }
766
767 if ( !User::isUsableName( $u->getName() ) ) {
768 return self::ILLEGAL;
769 }
770
771 $isAutoCreated = false;
772 if ( $u->getID() == 0 ) {
773 $status = $this->attemptAutoCreate( $u );
774 if ( $status !== self::SUCCESS ) {
775 return $status;
776 } else {
777 $isAutoCreated = true;
778 }
779 } else {
780 $u->load();
781 }
782
783 // Give general extensions, such as a captcha, a chance to abort logins
784 $abort = self::ABORTED;
785 if ( !Hooks::run( 'AbortLogin', array( $u, $this->mPassword, &$abort, &$msg ) ) ) {
786 if ( !in_array( $abort, self::$statusCodes, true ) ) {
787 throw new Exception( 'Invalid status code returned from AbortLogin hook: ' . $abort );
788 }
789 $this->mAbortLoginErrorMsg = $msg;
790 return $abort;
791 }
792
793 global $wgBlockDisablesLogin;
794 if ( !$u->checkPassword( $this->mPassword ) ) {
795 if ( $u->checkTemporaryPassword( $this->mPassword ) ) {
796 /**
797 * The e-mailed temporary password should not be used for actu-
798 * al logins; that's a very sloppy habit, and insecure if an
799 * attacker has a few seconds to click "search" on someone's
800 * open mail reader.
801 *
802 * Allow it to be used only to reset the password a single time
803 * to a new value, which won't be in the user's e-mail ar-
804 * chives.
805 *
806 * For backwards compatibility, we'll still recognize it at the
807 * login form to minimize surprises for people who have been
808 * logging in with a temporary password for some time.
809 *
810 * As a side-effect, we can authenticate the user's e-mail ad-
811 * dress if it's not already done, since the temporary password
812 * was sent via e-mail.
813 */
814 if ( !$u->isEmailConfirmed() && !wfReadOnly() ) {
815 $u->confirmEmail();
816 $u->saveSettings();
817 }
818
819 // At this point we just return an appropriate code/ indicating
820 // that the UI should show a password reset form; bot inter-
821 // faces etc will probably just fail cleanly here.
822 $this->mAbortLoginErrorMsg = 'resetpass-temp-emailed';
823 $this->mTempPasswordUsed = true;
824 $retval = self::RESET_PASS;
825 } else {
826 $retval = ( $this->mPassword == '' ) ? self::EMPTY_PASS : self::WRONG_PASS;
827 }
828 } elseif ( $wgBlockDisablesLogin && $u->isBlocked() ) {
829 // If we've enabled it, make it so that a blocked user cannot login
830 $retval = self::USER_BLOCKED;
831 } elseif ( $this->checkUserPasswordExpired( $u ) == 'hard' ) {
832 // Force reset now, without logging in
833 $retval = self::RESET_PASS;
834 $this->mAbortLoginErrorMsg = 'resetpass-expired';
835 } else {
836 Hooks::run( 'UserLoggedIn', array( $u ) );
837 $oldUser = $u;
838 $wgAuth->updateUser( $u );
839 if ( $oldUser !== $u ) {
840 wfWarn( get_class( $wgAuth ) . '::updateUser() replaced the user object' );
841 }
842 $wgUser = $u;
843 // This should set it for OutputPage and the Skin
844 // which is needed or the personal links will be
845 // wrong.
846 $this->getContext()->setUser( $u );
847
848 // Please reset throttle for successful logins, thanks!
849 if ( $throttleCount ) {
850 self::clearLoginThrottle( $this->mUsername );
851 }
852
853 if ( $isAutoCreated ) {
854 // Must be run after $wgUser is set, for correct new user log
855 Hooks::run( 'AuthPluginAutoCreate', array( $u ) );
856 }
857
858 $retval = self::SUCCESS;
859 }
860 Hooks::run( 'LoginAuthenticateAudit', array( $u, $this->mPassword, $retval ) );
861
862 return $retval;
863 }
864
865 /**
866 * Increment the login attempt throttle hit count for the (username,current IP)
867 * tuple unless the throttle was already reached.
868 * @param string $username The user name
869 * @return bool|int The integer hit count or True if it is already at the limit
870 */
871 public static function incLoginThrottle( $username ) {
872 global $wgPasswordAttemptThrottle, $wgMemc, $wgRequest;
873 $username = trim( $username ); // sanity
874
875 $throttleCount = 0;
876 if ( is_array( $wgPasswordAttemptThrottle ) ) {
877 $throttleKey = wfMemcKey( 'password-throttle', $wgRequest->getIP(), md5( $username ) );
878 $count = $wgPasswordAttemptThrottle['count'];
879 $period = $wgPasswordAttemptThrottle['seconds'];
880
881 $throttleCount = $wgMemc->get( $throttleKey );
882 if ( !$throttleCount ) {
883 $wgMemc->add( $throttleKey, 1, $period ); // start counter
884 } elseif ( $throttleCount < $count ) {
885 $wgMemc->incr( $throttleKey );
886 } elseif ( $throttleCount >= $count ) {
887 return true;
888 }
889 }
890
891 return $throttleCount;
892 }
893
894 /**
895 * Clear the login attempt throttle hit count for the (username,current IP) tuple.
896 * @param string $username The user name
897 * @return void
898 */
899 public static function clearLoginThrottle( $username ) {
900 global $wgMemc, $wgRequest;
901 $username = trim( $username ); // sanity
902
903 $throttleKey = wfMemcKey( 'password-throttle', $wgRequest->getIP(), md5( $username ) );
904 $wgMemc->delete( $throttleKey );
905 }
906
907 /**
908 * Attempt to automatically create a user on login. Only succeeds if there
909 * is an external authentication method which allows it.
910 *
911 * @param User $user
912 *
913 * @return int Status code
914 */
915 function attemptAutoCreate( $user ) {
916 global $wgAuth;
917
918 if ( $this->getUser()->isBlockedFromCreateAccount() ) {
919 wfDebug( __METHOD__ . ": user is blocked from account creation\n" );
920
921 return self::CREATE_BLOCKED;
922 }
923
924 if ( !$wgAuth->autoCreate() ) {
925 return self::NOT_EXISTS;
926 }
927
928 if ( !$wgAuth->userExists( $user->getName() ) ) {
929 wfDebug( __METHOD__ . ": user does not exist\n" );
930
931 return self::NOT_EXISTS;
932 }
933
934 if ( !$wgAuth->authenticate( $user->getName(), $this->mPassword ) ) {
935 wfDebug( __METHOD__ . ": \$wgAuth->authenticate() returned false, aborting\n" );
936
937 return self::WRONG_PLUGIN_PASS;
938 }
939
940 $abortError = '';
941 if ( !Hooks::run( 'AbortAutoAccount', array( $user, &$abortError ) ) ) {
942 // Hook point to add extra creation throttles and blocks
943 wfDebug( "LoginForm::attemptAutoCreate: a hook blocked creation: $abortError\n" );
944 $this->mAbortLoginErrorMsg = $abortError;
945
946 return self::ABORTED;
947 }
948
949 wfDebug( __METHOD__ . ": creating account\n" );
950 $status = $this->initUser( $user, true );
951
952 if ( !$status->isOK() ) {
953 $errors = $status->getErrorsByType( 'error' );
954 $this->mAbortLoginErrorMsg = $errors[0]['message'];
955
956 return self::ABORTED;
957 }
958
959 return self::SUCCESS;
960 }
961
962 function processLogin() {
963 global $wgMemc, $wgLang, $wgSecureLogin, $wgPasswordAttemptThrottle,
964 $wgInvalidPasswordReset;
965
966 $authRes = $this->authenticateUserData();
967 switch ( $authRes ) {
968 case self::SUCCESS:
969 # We've verified now, update the real record
970 $user = $this->getUser();
971 $user->touch();
972
973 if ( $user->requiresHTTPS() ) {
974 $this->mStickHTTPS = true;
975 }
976
977 if ( $wgSecureLogin && !$this->mStickHTTPS ) {
978 $user->setCookies( $this->mRequest, false, $this->mRemember );
979 } else {
980 $user->setCookies( $this->mRequest, null, $this->mRemember );
981 }
982 self::clearLoginToken();
983
984 // Reset the throttle
985 $request = $this->getRequest();
986 $key = wfMemcKey( 'password-throttle', $request->getIP(), md5( $this->mUsername ) );
987 $wgMemc->delete( $key );
988
989 if ( $this->hasSessionCookie() || $this->mSkipCookieCheck ) {
990 /* Replace the language object to provide user interface in
991 * correct language immediately on this first page load.
992 */
993 $code = $request->getVal( 'uselang', $user->getOption( 'language' ) );
994 $userLang = Language::factory( $code );
995 $wgLang = $userLang;
996 $this->getContext()->setLanguage( $userLang );
997 // Reset SessionID on Successful login (bug 40995)
998 $this->renewSessionId();
999 if ( $this->checkUserPasswordExpired( $this->getUser() ) == 'soft' ) {
1000 $this->resetLoginForm( $this->msg( 'resetpass-expired-soft' ) );
1001 } elseif ( $wgInvalidPasswordReset
1002 && !$user->isValidPassword( $this->mPassword )
1003 ) {
1004 $status = $user->checkPasswordValidity(
1005 $this->mPassword,
1006 'login'
1007 );
1008 $this->resetLoginForm(
1009 $status->getMessage( 'resetpass-validity-soft' )
1010 );
1011 } else {
1012 $this->successfulLogin();
1013 }
1014 } else {
1015 $this->cookieRedirectCheck( 'login' );
1016 }
1017 break;
1018
1019 case self::NEED_TOKEN:
1020 $error = $this->mAbortLoginErrorMsg ?: 'nocookiesforlogin';
1021 $this->mainLoginForm( $this->msg( $error )->parse() );
1022 break;
1023 case self::WRONG_TOKEN:
1024 $error = $this->mAbortLoginErrorMsg ?: 'sessionfailure';
1025 $this->mainLoginForm( $this->msg( $error )->text() );
1026 break;
1027 case self::NO_NAME:
1028 case self::ILLEGAL:
1029 $error = $this->mAbortLoginErrorMsg ?: 'noname';
1030 $this->mainLoginForm( $this->msg( $error )->text() );
1031 break;
1032 case self::WRONG_PLUGIN_PASS:
1033 $error = $this->mAbortLoginErrorMsg ?: 'wrongpassword';
1034 $this->mainLoginForm( $this->msg( $error )->text() );
1035 break;
1036 case self::NOT_EXISTS:
1037 if ( $this->getUser()->isAllowed( 'createaccount' ) ) {
1038 $error = $this->mAbortLoginErrorMsg ?: 'nosuchuser';
1039 $this->mainLoginForm( $this->msg( $error,
1040 wfEscapeWikiText( $this->mUsername ) )->parse() );
1041 } else {
1042 $error = $this->mAbortLoginErrorMsg ?: 'nosuchusershort';
1043 $this->mainLoginForm( $this->msg( $error,
1044 wfEscapeWikiText( $this->mUsername ) )->text() );
1045 }
1046 break;
1047 case self::WRONG_PASS:
1048 $error = $this->mAbortLoginErrorMsg ?: 'wrongpassword';
1049 $this->mainLoginForm( $this->msg( $error )->text() );
1050 break;
1051 case self::EMPTY_PASS:
1052 $error = $this->mAbortLoginErrorMsg ?: 'wrongpasswordempty';
1053 $this->mainLoginForm( $this->msg( $error )->text() );
1054 break;
1055 case self::RESET_PASS:
1056 $error = $this->mAbortLoginErrorMsg ?: 'resetpass_announce';
1057 $this->resetLoginForm( $this->msg( $error ) );
1058 break;
1059 case self::CREATE_BLOCKED:
1060 $this->userBlockedMessage( $this->getUser()->isBlockedFromCreateAccount() );
1061 break;
1062 case self::THROTTLED:
1063 $error = $this->mAbortLoginErrorMsg ?: 'login-throttled';
1064 $this->mainLoginForm( $this->msg( $error )
1065 ->params( $this->getLanguage()->formatDuration( $wgPasswordAttemptThrottle['seconds'] ) )
1066 ->text()
1067 );
1068 break;
1069 case self::USER_BLOCKED:
1070 $error = $this->mAbortLoginErrorMsg ?: 'login-userblocked';
1071 $this->mainLoginForm( $this->msg( $error, $this->mUsername )->escaped() );
1072 break;
1073 case self::ABORTED:
1074 $error = $this->mAbortLoginErrorMsg ?: 'login-abort-generic';
1075 $this->mainLoginForm( $this->msg( $error,
1076 wfEscapeWikiText( $this->mUsername ) )->text() );
1077 break;
1078 case self::USER_MIGRATED:
1079 $error = $this->mAbortLoginErrorMsg ?: 'login-migrated-generic';
1080 $params = array();
1081 if ( is_array( $error ) ) {
1082 $error = array_shift( $this->mAbortLoginErrorMsg );
1083 $params = $this->mAbortLoginErrorMsg;
1084 }
1085 $this->mainLoginForm( $this->msg( $error, $params )->text() );
1086 break;
1087 default:
1088 throw new MWException( 'Unhandled case value' );
1089 }
1090
1091 LoggerFactory::getInstance( 'authmanager' )->info( 'Login attempt', array(
1092 'event' => 'login',
1093 'successful' => $authRes === self::SUCCESS,
1094 'status' => LoginForm::$statusCodes[$authRes],
1095 ) );
1096 }
1097
1098 /**
1099 * Show the Special:ChangePassword form, with custom message
1100 * @param Message $msg
1101 */
1102 protected function resetLoginForm( Message $msg ) {
1103 // Allow hooks to explain this password reset in more detail
1104 Hooks::run( 'LoginPasswordResetMessage', array( &$msg, $this->mUsername ) );
1105 $reset = new SpecialChangePassword();
1106 $derivative = new DerivativeContext( $this->getContext() );
1107 $derivative->setTitle( $reset->getPageTitle() );
1108 $reset->setContext( $derivative );
1109 if ( !$this->mTempPasswordUsed ) {
1110 $reset->setOldPasswordMessage( 'oldpassword' );
1111 }
1112 $reset->setChangeMessage( $msg );
1113 $reset->execute( null );
1114 }
1115
1116 /**
1117 * @param User $u
1118 * @param bool $throttle
1119 * @param string $emailTitle Message name of email title
1120 * @param string $emailText Message name of email text
1121 * @return Status
1122 */
1123 function mailPasswordInternal( $u, $throttle = true, $emailTitle = 'passwordremindertitle',
1124 $emailText = 'passwordremindertext'
1125 ) {
1126 global $wgNewPasswordExpiry, $wgMinimalPasswordLength;
1127
1128 if ( $u->getEmail() == '' ) {
1129 return Status::newFatal( 'noemail', $u->getName() );
1130 }
1131 $ip = $this->getRequest()->getIP();
1132 if ( !$ip ) {
1133 return Status::newFatal( 'badipaddress' );
1134 }
1135
1136 $currentUser = $this->getUser();
1137 Hooks::run( 'User::mailPasswordInternal', array( &$currentUser, &$ip, &$u ) );
1138
1139 $np = PasswordFactory::generateRandomPasswordString( $wgMinimalPasswordLength );
1140 $u->setNewpassword( $np, $throttle );
1141 $u->saveSettings();
1142 $userLanguage = $u->getOption( 'language' );
1143
1144 $mainPage = Title::newMainPage();
1145 $mainPageUrl = $mainPage->getCanonicalURL();
1146
1147 $m = $this->msg( $emailText, $ip, $u->getName(), $np, '<' . $mainPageUrl . '>',
1148 round( $wgNewPasswordExpiry / 86400 ) )->inLanguage( $userLanguage )->text();
1149 $result = $u->sendMail( $this->msg( $emailTitle )->inLanguage( $userLanguage )->text(), $m );
1150
1151 return $result;
1152 }
1153
1154 /**
1155 * Run any hooks registered for logins, then HTTP redirect to
1156 * $this->mReturnTo (or Main Page if that's undefined). Formerly we had a
1157 * nice message here, but that's really not as useful as just being sent to
1158 * wherever you logged in from. It should be clear that the action was
1159 * successful, given the lack of error messages plus the appearance of your
1160 * name in the upper right.
1161 *
1162 * @private
1163 */
1164 function successfulLogin() {
1165 # Run any hooks; display injected HTML if any, else redirect
1166 $currentUser = $this->getUser();
1167 $injected_html = '';
1168 Hooks::run( 'UserLoginComplete', array( &$currentUser, &$injected_html ) );
1169
1170 if ( $injected_html !== '' ) {
1171 $this->displaySuccessfulAction( 'success', $this->msg( 'loginsuccesstitle' ),
1172 'loginsuccess', $injected_html );
1173 } else {
1174 $this->executeReturnTo( 'successredirect' );
1175 }
1176 }
1177
1178 /**
1179 * Run any hooks registered for logins, then display a message welcoming
1180 * the user.
1181 *
1182 * @private
1183 */
1184 function successfulCreation() {
1185 # Run any hooks; display injected HTML
1186 $currentUser = $this->getUser();
1187 $injected_html = '';
1188 $welcome_creation_msg = 'welcomecreation-msg';
1189
1190 Hooks::run( 'UserLoginComplete', array( &$currentUser, &$injected_html ) );
1191
1192 /**
1193 * Let any extensions change what message is shown.
1194 * @see https://www.mediawiki.org/wiki/Manual:Hooks/BeforeWelcomeCreation
1195 * @since 1.18
1196 */
1197 Hooks::run( 'BeforeWelcomeCreation', array( &$welcome_creation_msg, &$injected_html ) );
1198
1199 $this->displaySuccessfulAction(
1200 'signup',
1201 $this->msg( 'welcomeuser', $this->getUser()->getName() ),
1202 $welcome_creation_msg, $injected_html
1203 );
1204 }
1205
1206 /**
1207 * Display a "successful action" page.
1208 *
1209 * @param string $type Condition of return to; see `executeReturnTo`
1210 * @param string|Message $title Page's title
1211 * @param string $msgname
1212 * @param string $injected_html
1213 */
1214 private function displaySuccessfulAction( $type, $title, $msgname, $injected_html ) {
1215 $out = $this->getOutput();
1216 $out->setPageTitle( $title );
1217 if ( $msgname ) {
1218 $out->addWikiMsg( $msgname, wfEscapeWikiText( $this->getUser()->getName() ) );
1219 }
1220
1221 $out->addHTML( $injected_html );
1222
1223 $this->executeReturnTo( $type );
1224 }
1225
1226 /**
1227 * Output a message that informs the user that they cannot create an account because
1228 * there is a block on them or their IP which prevents account creation. Note that
1229 * User::isBlockedFromCreateAccount(), which gets this block, ignores the 'hardblock'
1230 * setting on blocks (bug 13611).
1231 * @param Block $block The block causing this error
1232 * @throws ErrorPageError
1233 */
1234 function userBlockedMessage( Block $block ) {
1235 # Let's be nice about this, it's likely that this feature will be used
1236 # for blocking large numbers of innocent people, e.g. range blocks on
1237 # schools. Don't blame it on the user. There's a small chance that it
1238 # really is the user's fault, i.e. the username is blocked and they
1239 # haven't bothered to log out before trying to create an account to
1240 # evade it, but we'll leave that to their guilty conscience to figure
1241 # out.
1242 $errorParams = array(
1243 $block->getTarget(),
1244 $block->mReason ? $block->mReason : $this->msg( 'blockednoreason' )->text(),
1245 $block->getByName()
1246 );
1247
1248 if ( $block->getType() === Block::TYPE_RANGE ) {
1249 $errorMessage = 'cantcreateaccount-range-text';
1250 $errorParams[] = $this->getRequest()->getIP();
1251 } else {
1252 $errorMessage = 'cantcreateaccount-text';
1253 }
1254
1255 throw new ErrorPageError(
1256 'cantcreateaccounttitle',
1257 $errorMessage,
1258 $errorParams
1259 );
1260 }
1261
1262 /**
1263 * Add a "return to" link or redirect to it.
1264 * Extensions can use this to reuse the "return to" logic after
1265 * inject steps (such as redirection) into the login process.
1266 *
1267 * @param string $type One of the following:
1268 * - error: display a return to link ignoring $wgRedirectOnLogin
1269 * - signup: display a return to link using $wgRedirectOnLogin if needed
1270 * - success: display a return to link using $wgRedirectOnLogin if needed
1271 * - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
1272 * @param string $returnTo
1273 * @param array|string $returnToQuery
1274 * @param bool $stickHTTPs Keep redirect link on HTTPs
1275 * @since 1.22
1276 */
1277 public function showReturnToPage(
1278 $type, $returnTo = '', $returnToQuery = '', $stickHTTPs = false
1279 ) {
1280 $this->mReturnTo = $returnTo;
1281 $this->mReturnToQuery = $returnToQuery;
1282 $this->mStickHTTPS = $stickHTTPs;
1283 $this->executeReturnTo( $type );
1284 }
1285
1286 /**
1287 * Add a "return to" link or redirect to it.
1288 *
1289 * @param string $type One of the following:
1290 * - error: display a return to link ignoring $wgRedirectOnLogin
1291 * - signup: display a return to link using $wgRedirectOnLogin if needed
1292 * - success: display a return to link using $wgRedirectOnLogin if needed
1293 * - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
1294 */
1295 private function executeReturnTo( $type ) {
1296 global $wgRedirectOnLogin, $wgSecureLogin;
1297
1298 if ( $type != 'error' && $wgRedirectOnLogin !== null ) {
1299 $returnTo = $wgRedirectOnLogin;
1300 $returnToQuery = array();
1301 } else {
1302 $returnTo = $this->mReturnTo;
1303 $returnToQuery = wfCgiToArray( $this->mReturnToQuery );
1304 }
1305
1306 // Allow modification of redirect behavior
1307 Hooks::run( 'PostLoginRedirect', array( &$returnTo, &$returnToQuery, &$type ) );
1308
1309 $returnToTitle = Title::newFromText( $returnTo );
1310 if ( !$returnToTitle ) {
1311 $returnToTitle = Title::newMainPage();
1312 }
1313
1314 if ( $wgSecureLogin && !$this->mStickHTTPS ) {
1315 $options = array( 'http' );
1316 $proto = PROTO_HTTP;
1317 } elseif ( $wgSecureLogin ) {
1318 $options = array( 'https' );
1319 $proto = PROTO_HTTPS;
1320 } else {
1321 $options = array();
1322 $proto = PROTO_RELATIVE;
1323 }
1324
1325 if ( $type == 'successredirect' ) {
1326 $redirectUrl = $returnToTitle->getFullURL( $returnToQuery, false, $proto );
1327 $this->getOutput()->redirect( $redirectUrl );
1328 } else {
1329 $this->getOutput()->addReturnTo( $returnToTitle, $returnToQuery, null, $options );
1330 }
1331 }
1332
1333 /**
1334 * @param string $msg
1335 * @param string $msgtype
1336 * @throws ErrorPageError
1337 * @throws Exception
1338 * @throws FatalError
1339 * @throws MWException
1340 * @throws PermissionsError
1341 * @throws ReadOnlyError
1342 * @private
1343 */
1344 function mainLoginForm( $msg, $msgtype = 'error' ) {
1345 global $wgEnableEmail, $wgEnableUserEmail;
1346 global $wgHiddenPrefs, $wgLoginLanguageSelector;
1347 global $wgAuth, $wgEmailConfirmToEdit;
1348 global $wgSecureLogin, $wgPasswordResetRoutes;
1349 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
1350
1351 $titleObj = $this->getPageTitle();
1352 $user = $this->getUser();
1353 $out = $this->getOutput();
1354
1355 if ( $this->mType == 'signup' ) {
1356 // Block signup here if in readonly. Keeps user from
1357 // going through the process (filling out data, etc)
1358 // and being informed later.
1359 $permErrors = $titleObj->getUserPermissionsErrors( 'createaccount', $user, true );
1360 if ( count( $permErrors ) ) {
1361 throw new PermissionsError( 'createaccount', $permErrors );
1362 } elseif ( $user->isBlockedFromCreateAccount() ) {
1363 $this->userBlockedMessage( $user->isBlockedFromCreateAccount() );
1364
1365 return;
1366 } elseif ( wfReadOnly() ) {
1367 throw new ReadOnlyError;
1368 }
1369 }
1370
1371 // Pre-fill username (if not creating an account, bug 44775).
1372 if ( $this->mUsername == '' && $this->mType != 'signup' ) {
1373 if ( $user->isLoggedIn() ) {
1374 $this->mUsername = $user->getName();
1375 } else {
1376 $this->mUsername = $this->getRequest()->getCookie( 'UserName' );
1377 }
1378 }
1379
1380 // Generic styles and scripts for both login and signup form
1381 $out->addModuleStyles( array(
1382 'mediawiki.ui',
1383 'mediawiki.ui.button',
1384 'mediawiki.ui.checkbox',
1385 'mediawiki.ui.input',
1386 'mediawiki.special.userlogin.common.styles'
1387 ) );
1388
1389 if ( $this->mType == 'signup' ) {
1390 // Additional styles and scripts for signup form
1391 $out->addModules( array(
1392 'mediawiki.special.userlogin.signup.js'
1393 ) );
1394 $out->addModuleStyles( array(
1395 'mediawiki.special.userlogin.signup.styles'
1396 ) );
1397
1398 $template = new UsercreateTemplate( $this->getConfig() );
1399
1400 // Must match number of benefits defined in messages
1401 $template->set( 'benefitCount', 3 );
1402
1403 $q = 'action=submitlogin&type=signup';
1404 $linkq = 'type=login';
1405 } else {
1406 // Additional styles for login form
1407 $out->addModuleStyles( array(
1408 'mediawiki.special.userlogin.login.styles'
1409 ) );
1410
1411 $template = new UserloginTemplate( $this->getConfig() );
1412
1413 $q = 'action=submitlogin&type=login';
1414 $linkq = 'type=signup';
1415 }
1416
1417 if ( $this->mReturnTo !== '' ) {
1418 $returnto = '&returnto=' . wfUrlencode( $this->mReturnTo );
1419 if ( $this->mReturnToQuery !== '' ) {
1420 $returnto .= '&returntoquery=' .
1421 wfUrlencode( $this->mReturnToQuery );
1422 }
1423 $q .= $returnto;
1424 $linkq .= $returnto;
1425 }
1426
1427 # Don't show a "create account" link if the user can't.
1428 if ( $this->showCreateOrLoginLink( $user ) ) {
1429 # Pass any language selection on to the mode switch link
1430 if ( $wgLoginLanguageSelector && $this->mLanguage ) {
1431 $linkq .= '&uselang=' . $this->mLanguage;
1432 }
1433 // Supply URL, login template creates the button.
1434 $template->set( 'createOrLoginHref', $titleObj->getLocalURL( $linkq ) );
1435 } else {
1436 $template->set( 'link', '' );
1437 }
1438
1439 $resetLink = $this->mType == 'signup'
1440 ? null
1441 : is_array( $wgPasswordResetRoutes ) && in_array( true, array_values( $wgPasswordResetRoutes ) );
1442
1443 $template->set( 'header', '' );
1444 $template->set( 'formheader', '' );
1445 $template->set( 'skin', $this->getSkin() );
1446 $template->set( 'name', $this->mUsername );
1447 $template->set( 'password', $this->mPassword );
1448 $template->set( 'retype', $this->mRetype );
1449 $template->set( 'createemailset', $this->mCreateaccountMail );
1450 $template->set( 'email', $this->mEmail );
1451 $template->set( 'realname', $this->mRealName );
1452 $template->set( 'domain', $this->mDomain );
1453 $template->set( 'reason', $this->mReason );
1454
1455 $template->set( 'action', $titleObj->getLocalURL( $q ) );
1456 $template->set( 'message', $msg );
1457 $template->set( 'messagetype', $msgtype );
1458 $template->set( 'createemail', $wgEnableEmail && $user->isLoggedIn() );
1459 $template->set( 'userealname', !in_array( 'realname', $wgHiddenPrefs ) );
1460 $template->set( 'useemail', $wgEnableEmail );
1461 $template->set( 'emailrequired', $wgEmailConfirmToEdit );
1462 $template->set( 'emailothers', $wgEnableUserEmail );
1463 $template->set( 'canreset', $wgAuth->allowPasswordChange() );
1464 $template->set( 'resetlink', $resetLink );
1465 $template->set( 'canremember', $wgExtendedLoginCookieExpiration === null ?
1466 ( $wgCookieExpiration > 0 ) :
1467 ( $wgExtendedLoginCookieExpiration > 0 ) );
1468 $template->set( 'usereason', $user->isLoggedIn() );
1469 $template->set( 'remember', $this->mRemember );
1470 $template->set( 'cansecurelogin', ( $wgSecureLogin === true ) );
1471 $template->set( 'stickhttps', (int)$this->mStickHTTPS );
1472 $template->set( 'loggedin', $user->isLoggedIn() );
1473 $template->set( 'loggedinuser', $user->getName() );
1474
1475 if ( $this->mType == 'signup' ) {
1476 if ( !self::getCreateaccountToken() ) {
1477 self::setCreateaccountToken();
1478 }
1479 $template->set( 'token', self::getCreateaccountToken() );
1480 } else {
1481 if ( !self::getLoginToken() ) {
1482 self::setLoginToken();
1483 }
1484 $template->set( 'token', self::getLoginToken() );
1485 }
1486
1487 # Prepare language selection links as needed
1488 if ( $wgLoginLanguageSelector ) {
1489 $template->set( 'languages', $this->makeLanguageSelector() );
1490 if ( $this->mLanguage ) {
1491 $template->set( 'uselang', $this->mLanguage );
1492 }
1493 }
1494
1495 $template->set( 'secureLoginUrl', $this->mSecureLoginUrl );
1496 // Use signupend-https for HTTPS requests if it's not blank, signupend otherwise
1497 $usingHTTPS = $this->mRequest->getProtocol() == 'https';
1498 $signupendHTTPS = $this->msg( 'signupend-https' );
1499 if ( $usingHTTPS && !$signupendHTTPS->isBlank() ) {
1500 $template->set( 'signupend', $signupendHTTPS->parse() );
1501 } else {
1502 $template->set( 'signupend', $this->msg( 'signupend' )->parse() );
1503 }
1504
1505 // If using HTTPS coming from HTTP, then the 'fromhttp' parameter must be preserved
1506 if ( $usingHTTPS ) {
1507 $template->set( 'fromhttp', $this->mFromHTTP );
1508 }
1509
1510 // Give authentication and captcha plugins a chance to modify the form
1511 $wgAuth->modifyUITemplate( $template, $this->mType );
1512 if ( $this->mType == 'signup' ) {
1513 Hooks::run( 'UserCreateForm', array( &$template ) );
1514 } else {
1515 Hooks::run( 'UserLoginForm', array( &$template ) );
1516 }
1517
1518 $out->disallowUserJs(); // just in case...
1519 $out->addTemplate( $template );
1520 }
1521
1522 /**
1523 * Whether the login/create account form should display a link to the
1524 * other form (in addition to whatever the skin provides).
1525 *
1526 * @param User $user
1527 * @return bool
1528 */
1529 private function showCreateOrLoginLink( &$user ) {
1530 if ( $this->mType == 'signup' ) {
1531 return true;
1532 } elseif ( $user->isAllowed( 'createaccount' ) ) {
1533 return true;
1534 } else {
1535 return false;
1536 }
1537 }
1538
1539 /**
1540 * Check if a session cookie is present.
1541 *
1542 * This will not pick up a cookie set during _this_ request, but is meant
1543 * to ensure that the client is returning the cookie which was set on a
1544 * previous pass through the system.
1545 *
1546 * @private
1547 * @return bool
1548 */
1549 function hasSessionCookie() {
1550 global $wgDisableCookieCheck;
1551
1552 return $wgDisableCookieCheck ? true : $this->getRequest()->checkSessionCookie();
1553 }
1554
1555 /**
1556 * Get the login token from the current session
1557 * @return mixed
1558 */
1559 public static function getLoginToken() {
1560 global $wgRequest;
1561
1562 return $wgRequest->getSessionData( 'wsLoginToken' );
1563 }
1564
1565 /**
1566 * Randomly generate a new login token and attach it to the current session
1567 */
1568 public static function setLoginToken() {
1569 global $wgRequest;
1570 // Generate a token directly instead of using $user->getEditToken()
1571 // because the latter reuses $_SESSION['wsEditToken']
1572 $wgRequest->setSessionData( 'wsLoginToken', MWCryptRand::generateHex( 32 ) );
1573 }
1574
1575 /**
1576 * Remove any login token attached to the current session
1577 */
1578 public static function clearLoginToken() {
1579 global $wgRequest;
1580 $wgRequest->setSessionData( 'wsLoginToken', null );
1581 }
1582
1583 /**
1584 * Get the createaccount token from the current session
1585 * @return mixed
1586 */
1587 public static function getCreateaccountToken() {
1588 global $wgRequest;
1589 return $wgRequest->getSessionData( 'wsCreateaccountToken' );
1590 }
1591
1592 /**
1593 * Randomly generate a new createaccount token and attach it to the current session
1594 */
1595 public static function setCreateaccountToken() {
1596 global $wgRequest;
1597 $wgRequest->setSessionData( 'wsCreateaccountToken', MWCryptRand::generateHex( 32 ) );
1598 }
1599
1600 /**
1601 * Remove any createaccount token attached to the current session
1602 */
1603 public static function clearCreateaccountToken() {
1604 global $wgRequest;
1605 $wgRequest->setSessionData( 'wsCreateaccountToken', null );
1606 }
1607
1608 /**
1609 * Renew the user's session id, using strong entropy
1610 */
1611 private function renewSessionId() {
1612 global $wgSecureLogin, $wgCookieSecure;
1613 if ( $wgSecureLogin && !$this->mStickHTTPS ) {
1614 $wgCookieSecure = false;
1615 }
1616
1617 wfResetSessionID();
1618 }
1619
1620 /**
1621 * @param string $type
1622 * @private
1623 */
1624 function cookieRedirectCheck( $type ) {
1625 $titleObj = SpecialPage::getTitleFor( 'Userlogin' );
1626 $query = array( 'wpCookieCheck' => $type );
1627 if ( $this->mReturnTo !== '' ) {
1628 $query['returnto'] = $this->mReturnTo;
1629 $query['returntoquery'] = $this->mReturnToQuery;
1630 }
1631 $check = $titleObj->getFullURL( $query );
1632
1633 $this->getOutput()->redirect( $check );
1634 }
1635
1636 /**
1637 * @param string $type
1638 * @private
1639 */
1640 function onCookieRedirectCheck( $type ) {
1641 if ( !$this->hasSessionCookie() ) {
1642 if ( $type == 'new' ) {
1643 $this->mainLoginForm( $this->msg( 'nocookiesnew' )->parse() );
1644 } elseif ( $type == 'login' ) {
1645 $this->mainLoginForm( $this->msg( 'nocookieslogin' )->parse() );
1646 } else {
1647 # shouldn't happen
1648 $this->mainLoginForm( $this->msg( 'error' )->text() );
1649 }
1650 } else {
1651 $this->successfulLogin();
1652 }
1653 }
1654
1655 /**
1656 * Produce a bar of links which allow the user to select another language
1657 * during login/registration but retain "returnto"
1658 *
1659 * @return string
1660 */
1661 function makeLanguageSelector() {
1662 $msg = $this->msg( 'loginlanguagelinks' )->inContentLanguage();
1663 if ( $msg->isBlank() ) {
1664 return '';
1665 }
1666 $langs = explode( "\n", $msg->text() );
1667 $links = array();
1668 foreach ( $langs as $lang ) {
1669 $lang = trim( $lang, '* ' );
1670 $parts = explode( '|', $lang );
1671 if ( count( $parts ) >= 2 ) {
1672 $links[] = $this->makeLanguageSelectorLink( $parts[0], trim( $parts[1] ) );
1673 }
1674 }
1675
1676 return count( $links ) > 0 ? $this->msg( 'loginlanguagelabel' )->rawParams(
1677 $this->getLanguage()->pipeList( $links ) )->escaped() : '';
1678 }
1679
1680 /**
1681 * Create a language selector link for a particular language
1682 * Links back to this page preserving type and returnto
1683 *
1684 * @param string $text Link text
1685 * @param string $lang Language code
1686 * @return string
1687 */
1688 function makeLanguageSelectorLink( $text, $lang ) {
1689 if ( $this->getLanguage()->getCode() == $lang ) {
1690 // no link for currently used language
1691 return htmlspecialchars( $text );
1692 }
1693 $query = array( 'uselang' => $lang );
1694 if ( $this->mType == 'signup' ) {
1695 $query['type'] = 'signup';
1696 }
1697 if ( $this->mReturnTo !== '' ) {
1698 $query['returnto'] = $this->mReturnTo;
1699 $query['returntoquery'] = $this->mReturnToQuery;
1700 }
1701
1702 $attr = array();
1703 $targetLanguage = Language::factory( $lang );
1704 $attr['lang'] = $attr['hreflang'] = $targetLanguage->getHtmlCode();
1705
1706 return Linker::linkKnown(
1707 $this->getPageTitle(),
1708 htmlspecialchars( $text ),
1709 $attr,
1710 $query
1711 );
1712 }
1713
1714 protected function getGroupName() {
1715 return 'login';
1716 }
1717
1718 /**
1719 * Private function to check password expiration, until AuthManager comes
1720 * along to handle that.
1721 * @param User $user
1722 * @return string|bool
1723 */
1724 private function checkUserPasswordExpired( User $user ) {
1725 global $wgPasswordExpireGrace;
1726 $dbr = wfGetDB( DB_SLAVE );
1727 $ts = $dbr->selectField( 'user', 'user_password_expires', array( 'user_id' => $user->getId() ) );
1728
1729 $expired = false;
1730 $now = wfTimestamp();
1731 $expUnix = wfTimestamp( TS_UNIX, $ts );
1732 if ( $ts !== null && $expUnix < $now ) {
1733 $expired = ( $expUnix + $wgPasswordExpireGrace < $now ) ? 'hard' : 'soft';
1734 }
1735 return $expired;
1736 }
1737
1738 }