Use makeGlobalKey() directly instead of wfGlobalCacheKey()
[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, $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 $cache = ObjectCache::getLocalClusterInstance();
569 # Make sure the user does not exist already
570 $lock = $cache->getScopedLock( $cache->makeGlobalKey( 'account', md5( $this->mUsername ) ) );
571 if ( !$lock ) {
572 return Status::newFatal( 'usernameinprogress' );
573 } elseif ( $u->idForName( User::READ_LOCKING ) ) {
574 return Status::newFatal( 'userexists' );
575 }
576
577 if ( $this->mCreateaccountMail ) {
578 # do not force a password for account creation by email
579 # set invalid password, it will be replaced later by a random generated password
580 $this->mPassword = null;
581 } else {
582 if ( $this->mPassword !== $this->mRetype ) {
583 return Status::newFatal( 'badretype' );
584 }
585
586 # check for password validity, return a fatal Status if invalid
587 $validity = $u->checkPasswordValidity( $this->mPassword, 'create' );
588 if ( !$validity->isGood() ) {
589 $validity->ok = false; // make sure this Status is fatal
590 return $validity;
591 }
592 }
593
594 # if you need a confirmed email address to edit, then obviously you
595 # need an email address.
596 if ( $wgEmailConfirmToEdit && strval( $this->mEmail ) === '' ) {
597 return Status::newFatal( 'noemailtitle' );
598 }
599
600 if ( strval( $this->mEmail ) !== '' && !Sanitizer::validateEmail( $this->mEmail ) ) {
601 return Status::newFatal( 'invalidemailaddress' );
602 }
603
604 # Set some additional data so the AbortNewAccount hook can be used for
605 # more than just username validation
606 $u->setEmail( $this->mEmail );
607 $u->setRealName( $this->mRealName );
608
609 $abortError = '';
610 $abortStatus = null;
611 if ( !Hooks::run( 'AbortNewAccount', array( $u, &$abortError, &$abortStatus ) ) ) {
612 // Hook point to add extra creation throttles and blocks
613 wfDebug( "LoginForm::addNewAccountInternal: a hook blocked creation\n" );
614 if ( $abortStatus === null ) {
615 // Report back the old string as a raw message status.
616 // This will report the error back as 'createaccount-hook-aborted'
617 // with the given string as the message.
618 // To return a different error code, return a Status object.
619 $abortError = new Message( 'createaccount-hook-aborted', array( $abortError ) );
620 $abortError->text();
621
622 return Status::newFatal( $abortError );
623 } else {
624 // For MediaWiki 1.23+ and updated hooks, return the Status object
625 // returned from the hook.
626 return $abortStatus;
627 }
628 }
629
630 // Hook point to check for exempt from account creation throttle
631 if ( !Hooks::run( 'ExemptFromAccountCreationThrottle', array( $ip ) ) ) {
632 wfDebug( "LoginForm::exemptFromAccountCreationThrottle: a hook " .
633 "allowed account creation w/o throttle\n" );
634 } else {
635 if ( ( $wgAccountCreationThrottle && $currentUser->isPingLimitable() ) ) {
636 $key = wfMemcKey( 'acctcreate', 'ip', $ip );
637 $value = $cache->get( $key );
638 if ( !$value ) {
639 $cache->set( $key, 0, $cache::TTL_DAY );
640 }
641 if ( $value >= $wgAccountCreationThrottle ) {
642 return Status::newFatal( 'acct_creation_throttle_hit', $wgAccountCreationThrottle );
643 }
644 $cache->incr( $key );
645 }
646 }
647
648 if ( !$wgAuth->addUser( $u, $this->mPassword, $this->mEmail, $this->mRealName ) ) {
649 return Status::newFatal( 'externaldberror' );
650 }
651
652 self::clearCreateaccountToken();
653
654 return $this->initUser( $u, false );
655 }
656
657 /**
658 * Actually add a user to the database.
659 * Give it a User object that has been initialised with a name.
660 *
661 * @param User $u
662 * @param bool $autocreate True if this is an autocreation via auth plugin
663 * @return Status Status object, with the User object in the value member on success
664 * @private
665 */
666 function initUser( $u, $autocreate ) {
667 global $wgAuth;
668
669 $status = $u->addToDatabase();
670 if ( !$status->isOK() ) {
671 return $status;
672 }
673
674 if ( $wgAuth->allowPasswordChange() ) {
675 $u->setPassword( $this->mPassword );
676 }
677
678 $u->setEmail( $this->mEmail );
679 $u->setRealName( $this->mRealName );
680 $u->setToken();
681
682 Hooks::run( 'LocalUserCreated', array( $u, $autocreate ) );
683 $oldUser = $u;
684 $wgAuth->initUser( $u, $autocreate );
685 if ( $oldUser !== $u ) {
686 wfWarn( get_class( $wgAuth ) . '::initUser() replaced the user object' );
687 }
688
689 $u->saveSettings();
690
691 // Update user count
692 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 0, 0, 0, 1 ) );
693
694 // Watch user's userpage and talk page
695 $u->addWatch( $u->getUserPage(), WatchedItem::IGNORE_USER_RIGHTS );
696
697 return Status::newGood( $u );
698 }
699
700 /**
701 * Internally authenticate the login request.
702 *
703 * This may create a local account as a side effect if the
704 * authentication plugin allows transparent local account
705 * creation.
706 * @return int
707 */
708 public function authenticateUserData() {
709 global $wgUser, $wgAuth;
710
711 $this->load();
712
713 if ( $this->mUsername == '' ) {
714 return self::NO_NAME;
715 }
716
717 // We require a login token to prevent login CSRF
718 // Handle part of this before incrementing the throttle so
719 // token-less login attempts don't count towards the throttle
720 // but wrong-token attempts do.
721
722 // If the user doesn't have a login token yet, set one.
723 if ( !self::getLoginToken() ) {
724 self::setLoginToken();
725
726 return self::NEED_TOKEN;
727 }
728 // If the user didn't pass a login token, tell them we need one
729 if ( !$this->mToken ) {
730 return self::NEED_TOKEN;
731 }
732
733 $throttleCount = self::incLoginThrottle( $this->mUsername );
734 if ( $throttleCount === true ) {
735 return self::THROTTLED;
736 }
737
738 // Validate the login token
739 if ( $this->mToken !== self::getLoginToken() ) {
740 return self::WRONG_TOKEN;
741 }
742
743 // Load the current user now, and check to see if we're logging in as
744 // the same name. This is necessary because loading the current user
745 // (say by calling getName()) calls the UserLoadFromSession hook, which
746 // potentially creates the user in the database. Until we load $wgUser,
747 // checking for user existence using User::newFromName($name)->getId() below
748 // will effectively be using stale data.
749 if ( $this->getUser()->getName() === $this->mUsername ) {
750 wfDebug( __METHOD__ . ": already logged in as {$this->mUsername}\n" );
751
752 return self::SUCCESS;
753 }
754
755 $u = User::newFromName( $this->mUsername );
756 if ( $u === false ) {
757 return self::ILLEGAL;
758 }
759
760 $msg = null;
761 // Give extensions a way to indicate the username has been updated,
762 // rather than telling the user the account doesn't exist.
763 if ( !Hooks::run( 'LoginUserMigrated', array( $u, &$msg ) ) ) {
764 $this->mAbortLoginErrorMsg = $msg;
765 return self::USER_MIGRATED;
766 }
767
768 if ( !User::isUsableName( $u->getName() ) ) {
769 return self::ILLEGAL;
770 }
771
772 $isAutoCreated = false;
773 if ( $u->getID() == 0 ) {
774 $status = $this->attemptAutoCreate( $u );
775 if ( $status !== self::SUCCESS ) {
776 return $status;
777 } else {
778 $isAutoCreated = true;
779 }
780 } else {
781 $u->load();
782 }
783
784 // Give general extensions, such as a captcha, a chance to abort logins
785 $abort = self::ABORTED;
786 if ( !Hooks::run( 'AbortLogin', array( $u, $this->mPassword, &$abort, &$msg ) ) ) {
787 if ( !in_array( $abort, array_keys( self::$statusCodes ), true ) ) {
788 throw new Exception( 'Invalid status code returned from AbortLogin hook: ' . $abort );
789 }
790 $this->mAbortLoginErrorMsg = $msg;
791 return $abort;
792 }
793
794 global $wgBlockDisablesLogin;
795 if ( !$u->checkPassword( $this->mPassword ) ) {
796 if ( $u->checkTemporaryPassword( $this->mPassword ) ) {
797 /**
798 * The e-mailed temporary password should not be used for actu-
799 * al logins; that's a very sloppy habit, and insecure if an
800 * attacker has a few seconds to click "search" on someone's
801 * open mail reader.
802 *
803 * Allow it to be used only to reset the password a single time
804 * to a new value, which won't be in the user's e-mail ar-
805 * chives.
806 *
807 * For backwards compatibility, we'll still recognize it at the
808 * login form to minimize surprises for people who have been
809 * logging in with a temporary password for some time.
810 *
811 * As a side-effect, we can authenticate the user's e-mail ad-
812 * dress if it's not already done, since the temporary password
813 * was sent via e-mail.
814 */
815 if ( !$u->isEmailConfirmed() && !wfReadOnly() ) {
816 $u->confirmEmail();
817 $u->saveSettings();
818 }
819
820 // At this point we just return an appropriate code/ indicating
821 // that the UI should show a password reset form; bot inter-
822 // faces etc will probably just fail cleanly here.
823 $this->mAbortLoginErrorMsg = 'resetpass-temp-emailed';
824 $this->mTempPasswordUsed = true;
825 $retval = self::RESET_PASS;
826 } else {
827 $retval = ( $this->mPassword == '' ) ? self::EMPTY_PASS : self::WRONG_PASS;
828 }
829 } elseif ( $wgBlockDisablesLogin && $u->isBlocked() ) {
830 // If we've enabled it, make it so that a blocked user cannot login
831 $retval = self::USER_BLOCKED;
832 } elseif ( $this->checkUserPasswordExpired( $u ) == 'hard' ) {
833 // Force reset now, without logging in
834 $retval = self::RESET_PASS;
835 $this->mAbortLoginErrorMsg = 'resetpass-expired';
836 } else {
837 Hooks::run( 'UserLoggedIn', array( $u ) );
838 $oldUser = $u;
839 $wgAuth->updateUser( $u );
840 if ( $oldUser !== $u ) {
841 wfWarn( get_class( $wgAuth ) . '::updateUser() replaced the user object' );
842 }
843 $wgUser = $u;
844 // This should set it for OutputPage and the Skin
845 // which is needed or the personal links will be
846 // wrong.
847 $this->getContext()->setUser( $u );
848
849 // Please reset throttle for successful logins, thanks!
850 if ( $throttleCount ) {
851 self::clearLoginThrottle( $this->mUsername );
852 }
853
854 if ( $isAutoCreated ) {
855 // Must be run after $wgUser is set, for correct new user log
856 Hooks::run( 'AuthPluginAutoCreate', array( $u ) );
857 }
858
859 $retval = self::SUCCESS;
860 }
861 Hooks::run( 'LoginAuthenticateAudit', array( $u, $this->mPassword, $retval ) );
862
863 return $retval;
864 }
865
866 /**
867 * Increment the login attempt throttle hit count for the (username,current IP)
868 * tuple unless the throttle was already reached.
869 * @param string $username The user name
870 * @return bool|int The integer hit count or True if it is already at the limit
871 */
872 public static function incLoginThrottle( $username ) {
873 global $wgPasswordAttemptThrottle, $wgRequest;
874 $username = trim( $username ); // sanity
875
876 $throttleCount = 0;
877 if ( is_array( $wgPasswordAttemptThrottle ) ) {
878 $throttleKey = wfMemcKey( 'password-throttle', $wgRequest->getIP(), md5( $username ) );
879 $count = $wgPasswordAttemptThrottle['count'];
880 $period = $wgPasswordAttemptThrottle['seconds'];
881
882 $cache = ObjectCache::getLocalClusterInstance();
883 $throttleCount = $cache->get( $throttleKey );
884 if ( !$throttleCount ) {
885 $cache->add( $throttleKey, 1, $period ); // start counter
886 } elseif ( $throttleCount < $count ) {
887 $cache->incr( $throttleKey );
888 } elseif ( $throttleCount >= $count ) {
889 return true;
890 }
891 }
892
893 return $throttleCount;
894 }
895
896 /**
897 * Clear the login attempt throttle hit count for the (username,current IP) tuple.
898 * @param string $username The user name
899 * @return void
900 */
901 public static function clearLoginThrottle( $username ) {
902 global $wgRequest;
903 $username = trim( $username ); // sanity
904
905 $throttleKey = wfMemcKey( 'password-throttle', $wgRequest->getIP(), md5( $username ) );
906 ObjectCache::getLocalClusterInstance()->delete( $throttleKey );
907 }
908
909 /**
910 * Attempt to automatically create a user on login. Only succeeds if there
911 * is an external authentication method which allows it.
912 *
913 * @param User $user
914 *
915 * @return int Status code
916 */
917 function attemptAutoCreate( $user ) {
918 global $wgAuth;
919
920 if ( $this->getUser()->isBlockedFromCreateAccount() ) {
921 wfDebug( __METHOD__ . ": user is blocked from account creation\n" );
922
923 return self::CREATE_BLOCKED;
924 }
925
926 if ( !$wgAuth->autoCreate() ) {
927 return self::NOT_EXISTS;
928 }
929
930 if ( !$wgAuth->userExists( $user->getName() ) ) {
931 wfDebug( __METHOD__ . ": user does not exist\n" );
932
933 return self::NOT_EXISTS;
934 }
935
936 if ( !$wgAuth->authenticate( $user->getName(), $this->mPassword ) ) {
937 wfDebug( __METHOD__ . ": \$wgAuth->authenticate() returned false, aborting\n" );
938
939 return self::WRONG_PLUGIN_PASS;
940 }
941
942 $abortError = '';
943 if ( !Hooks::run( 'AbortAutoAccount', array( $user, &$abortError ) ) ) {
944 // Hook point to add extra creation throttles and blocks
945 wfDebug( "LoginForm::attemptAutoCreate: a hook blocked creation: $abortError\n" );
946 $this->mAbortLoginErrorMsg = $abortError;
947
948 return self::ABORTED;
949 }
950
951 wfDebug( __METHOD__ . ": creating account\n" );
952 $status = $this->initUser( $user, true );
953
954 if ( !$status->isOK() ) {
955 $errors = $status->getErrorsByType( 'error' );
956 $this->mAbortLoginErrorMsg = $errors[0]['message'];
957
958 return self::ABORTED;
959 }
960
961 return self::SUCCESS;
962 }
963
964 function processLogin() {
965 global $wgLang, $wgSecureLogin, $wgPasswordAttemptThrottle, $wgInvalidPasswordReset;
966
967 $cache = ObjectCache::getLocalClusterInstance();
968 $authRes = $this->authenticateUserData();
969 switch ( $authRes ) {
970 case self::SUCCESS:
971 # We've verified now, update the real record
972 $user = $this->getUser();
973 $user->touch();
974
975 if ( $user->requiresHTTPS() ) {
976 $this->mStickHTTPS = true;
977 }
978
979 if ( $wgSecureLogin && !$this->mStickHTTPS ) {
980 $user->setCookies( $this->mRequest, false, $this->mRemember );
981 } else {
982 $user->setCookies( $this->mRequest, null, $this->mRemember );
983 }
984 self::clearLoginToken();
985
986 // Reset the throttle
987 $request = $this->getRequest();
988 $key = wfMemcKey( 'password-throttle', $request->getIP(), md5( $this->mUsername ) );
989 $cache->delete( $key );
990
991 if ( $this->hasSessionCookie() || $this->mSkipCookieCheck ) {
992 /* Replace the language object to provide user interface in
993 * correct language immediately on this first page load.
994 */
995 $code = $request->getVal( 'uselang', $user->getOption( 'language' ) );
996 $userLang = Language::factory( $code );
997 $wgLang = $userLang;
998 $this->getContext()->setLanguage( $userLang );
999 // Reset SessionID on Successful login (bug 40995)
1000 $this->renewSessionId();
1001 if ( $this->checkUserPasswordExpired( $this->getUser() ) == 'soft' ) {
1002 $this->resetLoginForm( $this->msg( 'resetpass-expired-soft' ) );
1003 } elseif ( $wgInvalidPasswordReset
1004 && !$user->isValidPassword( $this->mPassword )
1005 ) {
1006 $status = $user->checkPasswordValidity(
1007 $this->mPassword,
1008 'login'
1009 );
1010 $this->resetLoginForm(
1011 $status->getMessage( 'resetpass-validity-soft' )
1012 );
1013 } else {
1014 $this->successfulLogin();
1015 }
1016 } else {
1017 $this->cookieRedirectCheck( 'login' );
1018 }
1019 break;
1020
1021 case self::NEED_TOKEN:
1022 $error = $this->mAbortLoginErrorMsg ?: 'nocookiesforlogin';
1023 $this->mainLoginForm( $this->msg( $error )->parse() );
1024 break;
1025 case self::WRONG_TOKEN:
1026 $error = $this->mAbortLoginErrorMsg ?: 'sessionfailure';
1027 $this->mainLoginForm( $this->msg( $error )->text() );
1028 break;
1029 case self::NO_NAME:
1030 case self::ILLEGAL:
1031 $error = $this->mAbortLoginErrorMsg ?: 'noname';
1032 $this->mainLoginForm( $this->msg( $error )->text() );
1033 break;
1034 case self::WRONG_PLUGIN_PASS:
1035 $error = $this->mAbortLoginErrorMsg ?: 'wrongpassword';
1036 $this->mainLoginForm( $this->msg( $error )->text() );
1037 break;
1038 case self::NOT_EXISTS:
1039 if ( $this->getUser()->isAllowed( 'createaccount' ) ) {
1040 $error = $this->mAbortLoginErrorMsg ?: 'nosuchuser';
1041 $this->mainLoginForm( $this->msg( $error,
1042 wfEscapeWikiText( $this->mUsername ) )->parse() );
1043 } else {
1044 $error = $this->mAbortLoginErrorMsg ?: 'nosuchusershort';
1045 $this->mainLoginForm( $this->msg( $error,
1046 wfEscapeWikiText( $this->mUsername ) )->text() );
1047 }
1048 break;
1049 case self::WRONG_PASS:
1050 $error = $this->mAbortLoginErrorMsg ?: 'wrongpassword';
1051 $this->mainLoginForm( $this->msg( $error )->text() );
1052 break;
1053 case self::EMPTY_PASS:
1054 $error = $this->mAbortLoginErrorMsg ?: 'wrongpasswordempty';
1055 $this->mainLoginForm( $this->msg( $error )->text() );
1056 break;
1057 case self::RESET_PASS:
1058 $error = $this->mAbortLoginErrorMsg ?: 'resetpass_announce';
1059 $this->resetLoginForm( $this->msg( $error ) );
1060 break;
1061 case self::CREATE_BLOCKED:
1062 $this->userBlockedMessage( $this->getUser()->isBlockedFromCreateAccount() );
1063 break;
1064 case self::THROTTLED:
1065 $error = $this->mAbortLoginErrorMsg ?: 'login-throttled';
1066 $this->mainLoginForm( $this->msg( $error )
1067 ->params( $this->getLanguage()->formatDuration( $wgPasswordAttemptThrottle['seconds'] ) )
1068 ->text()
1069 );
1070 break;
1071 case self::USER_BLOCKED:
1072 $error = $this->mAbortLoginErrorMsg ?: 'login-userblocked';
1073 $this->mainLoginForm( $this->msg( $error, $this->mUsername )->escaped() );
1074 break;
1075 case self::ABORTED:
1076 $error = $this->mAbortLoginErrorMsg ?: 'login-abort-generic';
1077 $this->mainLoginForm( $this->msg( $error,
1078 wfEscapeWikiText( $this->mUsername ) )->text() );
1079 break;
1080 case self::USER_MIGRATED:
1081 $error = $this->mAbortLoginErrorMsg ?: 'login-migrated-generic';
1082 $params = array();
1083 if ( is_array( $error ) ) {
1084 $error = array_shift( $this->mAbortLoginErrorMsg );
1085 $params = $this->mAbortLoginErrorMsg;
1086 }
1087 $this->mainLoginForm( $this->msg( $error, $params )->text() );
1088 break;
1089 default:
1090 throw new MWException( 'Unhandled case value' );
1091 }
1092
1093 LoggerFactory::getInstance( 'authmanager' )->info( 'Login attempt', array(
1094 'event' => 'login',
1095 'successful' => $authRes === self::SUCCESS,
1096 'status' => LoginForm::$statusCodes[$authRes],
1097 ) );
1098 }
1099
1100 /**
1101 * Show the Special:ChangePassword form, with custom message
1102 * @param Message $msg
1103 */
1104 protected function resetLoginForm( Message $msg ) {
1105 // Allow hooks to explain this password reset in more detail
1106 Hooks::run( 'LoginPasswordResetMessage', array( &$msg, $this->mUsername ) );
1107 $reset = new SpecialChangePassword();
1108 $derivative = new DerivativeContext( $this->getContext() );
1109 $derivative->setTitle( $reset->getPageTitle() );
1110 $reset->setContext( $derivative );
1111 if ( !$this->mTempPasswordUsed ) {
1112 $reset->setOldPasswordMessage( 'oldpassword' );
1113 }
1114 $reset->setChangeMessage( $msg );
1115 $reset->execute( null );
1116 }
1117
1118 /**
1119 * @param User $u
1120 * @param bool $throttle
1121 * @param string $emailTitle Message name of email title
1122 * @param string $emailText Message name of email text
1123 * @return Status
1124 */
1125 function mailPasswordInternal( $u, $throttle = true, $emailTitle = 'passwordremindertitle',
1126 $emailText = 'passwordremindertext'
1127 ) {
1128 global $wgNewPasswordExpiry, $wgMinimalPasswordLength;
1129
1130 if ( $u->getEmail() == '' ) {
1131 return Status::newFatal( 'noemail', $u->getName() );
1132 }
1133 $ip = $this->getRequest()->getIP();
1134 if ( !$ip ) {
1135 return Status::newFatal( 'badipaddress' );
1136 }
1137
1138 $currentUser = $this->getUser();
1139 Hooks::run( 'User::mailPasswordInternal', array( &$currentUser, &$ip, &$u ) );
1140
1141 $np = PasswordFactory::generateRandomPasswordString( $wgMinimalPasswordLength );
1142 $u->setNewpassword( $np, $throttle );
1143 $u->saveSettings();
1144 $userLanguage = $u->getOption( 'language' );
1145
1146 $mainPage = Title::newMainPage();
1147 $mainPageUrl = $mainPage->getCanonicalURL();
1148
1149 $m = $this->msg( $emailText, $ip, $u->getName(), $np, '<' . $mainPageUrl . '>',
1150 round( $wgNewPasswordExpiry / 86400 ) )->inLanguage( $userLanguage )->text();
1151 $result = $u->sendMail( $this->msg( $emailTitle )->inLanguage( $userLanguage )->text(), $m );
1152
1153 return $result;
1154 }
1155
1156 /**
1157 * Run any hooks registered for logins, then HTTP redirect to
1158 * $this->mReturnTo (or Main Page if that's undefined). Formerly we had a
1159 * nice message here, but that's really not as useful as just being sent to
1160 * wherever you logged in from. It should be clear that the action was
1161 * successful, given the lack of error messages plus the appearance of your
1162 * name in the upper right.
1163 *
1164 * @private
1165 */
1166 function successfulLogin() {
1167 # Run any hooks; display injected HTML if any, else redirect
1168 $currentUser = $this->getUser();
1169 $injected_html = '';
1170 Hooks::run( 'UserLoginComplete', array( &$currentUser, &$injected_html ) );
1171
1172 if ( $injected_html !== '' ) {
1173 $this->displaySuccessfulAction( 'success', $this->msg( 'loginsuccesstitle' ),
1174 'loginsuccess', $injected_html );
1175 } else {
1176 $this->executeReturnTo( 'successredirect' );
1177 }
1178 }
1179
1180 /**
1181 * Run any hooks registered for logins, then display a message welcoming
1182 * the user.
1183 *
1184 * @private
1185 */
1186 function successfulCreation() {
1187 # Run any hooks; display injected HTML
1188 $currentUser = $this->getUser();
1189 $injected_html = '';
1190 $welcome_creation_msg = 'welcomecreation-msg';
1191
1192 Hooks::run( 'UserLoginComplete', array( &$currentUser, &$injected_html ) );
1193
1194 /**
1195 * Let any extensions change what message is shown.
1196 * @see https://www.mediawiki.org/wiki/Manual:Hooks/BeforeWelcomeCreation
1197 * @since 1.18
1198 */
1199 Hooks::run( 'BeforeWelcomeCreation', array( &$welcome_creation_msg, &$injected_html ) );
1200
1201 $this->displaySuccessfulAction(
1202 'signup',
1203 $this->msg( 'welcomeuser', $this->getUser()->getName() ),
1204 $welcome_creation_msg, $injected_html
1205 );
1206 }
1207
1208 /**
1209 * Display a "successful action" page.
1210 *
1211 * @param string $type Condition of return to; see `executeReturnTo`
1212 * @param string|Message $title Page's title
1213 * @param string $msgname
1214 * @param string $injected_html
1215 */
1216 private function displaySuccessfulAction( $type, $title, $msgname, $injected_html ) {
1217 $out = $this->getOutput();
1218 $out->setPageTitle( $title );
1219 if ( $msgname ) {
1220 $out->addWikiMsg( $msgname, wfEscapeWikiText( $this->getUser()->getName() ) );
1221 }
1222
1223 $out->addHTML( $injected_html );
1224
1225 $this->executeReturnTo( $type );
1226 }
1227
1228 /**
1229 * Output a message that informs the user that they cannot create an account because
1230 * there is a block on them or their IP which prevents account creation. Note that
1231 * User::isBlockedFromCreateAccount(), which gets this block, ignores the 'hardblock'
1232 * setting on blocks (bug 13611).
1233 * @param Block $block The block causing this error
1234 * @throws ErrorPageError
1235 */
1236 function userBlockedMessage( Block $block ) {
1237 # Let's be nice about this, it's likely that this feature will be used
1238 # for blocking large numbers of innocent people, e.g. range blocks on
1239 # schools. Don't blame it on the user. There's a small chance that it
1240 # really is the user's fault, i.e. the username is blocked and they
1241 # haven't bothered to log out before trying to create an account to
1242 # evade it, but we'll leave that to their guilty conscience to figure
1243 # out.
1244 $errorParams = array(
1245 $block->getTarget(),
1246 $block->mReason ? $block->mReason : $this->msg( 'blockednoreason' )->text(),
1247 $block->getByName()
1248 );
1249
1250 if ( $block->getType() === Block::TYPE_RANGE ) {
1251 $errorMessage = 'cantcreateaccount-range-text';
1252 $errorParams[] = $this->getRequest()->getIP();
1253 } else {
1254 $errorMessage = 'cantcreateaccount-text';
1255 }
1256
1257 throw new ErrorPageError(
1258 'cantcreateaccounttitle',
1259 $errorMessage,
1260 $errorParams
1261 );
1262 }
1263
1264 /**
1265 * Add a "return to" link or redirect to it.
1266 * Extensions can use this to reuse the "return to" logic after
1267 * inject steps (such as redirection) into the login process.
1268 *
1269 * @param string $type One of the following:
1270 * - error: display a return to link ignoring $wgRedirectOnLogin
1271 * - signup: display a return to link using $wgRedirectOnLogin if needed
1272 * - success: display a return to link using $wgRedirectOnLogin if needed
1273 * - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
1274 * @param string $returnTo
1275 * @param array|string $returnToQuery
1276 * @param bool $stickHTTPs Keep redirect link on HTTPs
1277 * @since 1.22
1278 */
1279 public function showReturnToPage(
1280 $type, $returnTo = '', $returnToQuery = '', $stickHTTPs = false
1281 ) {
1282 $this->mReturnTo = $returnTo;
1283 $this->mReturnToQuery = $returnToQuery;
1284 $this->mStickHTTPS = $stickHTTPs;
1285 $this->executeReturnTo( $type );
1286 }
1287
1288 /**
1289 * Add a "return to" link or redirect to it.
1290 *
1291 * @param string $type One of the following:
1292 * - error: display a return to link ignoring $wgRedirectOnLogin
1293 * - signup: display a return to link using $wgRedirectOnLogin if needed
1294 * - success: display a return to link using $wgRedirectOnLogin if needed
1295 * - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
1296 */
1297 private function executeReturnTo( $type ) {
1298 global $wgRedirectOnLogin, $wgSecureLogin;
1299
1300 if ( $type != 'error' && $wgRedirectOnLogin !== null ) {
1301 $returnTo = $wgRedirectOnLogin;
1302 $returnToQuery = array();
1303 } else {
1304 $returnTo = $this->mReturnTo;
1305 $returnToQuery = wfCgiToArray( $this->mReturnToQuery );
1306 }
1307
1308 // Allow modification of redirect behavior
1309 Hooks::run( 'PostLoginRedirect', array( &$returnTo, &$returnToQuery, &$type ) );
1310
1311 $returnToTitle = Title::newFromText( $returnTo );
1312 if ( !$returnToTitle ) {
1313 $returnToTitle = Title::newMainPage();
1314 }
1315
1316 if ( $wgSecureLogin && !$this->mStickHTTPS ) {
1317 $options = array( 'http' );
1318 $proto = PROTO_HTTP;
1319 } elseif ( $wgSecureLogin ) {
1320 $options = array( 'https' );
1321 $proto = PROTO_HTTPS;
1322 } else {
1323 $options = array();
1324 $proto = PROTO_RELATIVE;
1325 }
1326
1327 if ( $type == 'successredirect' ) {
1328 $redirectUrl = $returnToTitle->getFullURL( $returnToQuery, false, $proto );
1329 $this->getOutput()->redirect( $redirectUrl );
1330 } else {
1331 $this->getOutput()->addReturnTo( $returnToTitle, $returnToQuery, null, $options );
1332 }
1333 }
1334
1335 /**
1336 * @param string $msg
1337 * @param string $msgtype
1338 * @throws ErrorPageError
1339 * @throws Exception
1340 * @throws FatalError
1341 * @throws MWException
1342 * @throws PermissionsError
1343 * @throws ReadOnlyError
1344 * @private
1345 */
1346 function mainLoginForm( $msg, $msgtype = 'error' ) {
1347 global $wgEnableEmail, $wgEnableUserEmail;
1348 global $wgHiddenPrefs, $wgLoginLanguageSelector;
1349 global $wgAuth, $wgEmailConfirmToEdit;
1350 global $wgSecureLogin, $wgPasswordResetRoutes;
1351 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
1352
1353 $titleObj = $this->getPageTitle();
1354 $user = $this->getUser();
1355 $out = $this->getOutput();
1356
1357 if ( $this->mType == 'signup' ) {
1358 // Block signup here if in readonly. Keeps user from
1359 // going through the process (filling out data, etc)
1360 // and being informed later.
1361 $permErrors = $titleObj->getUserPermissionsErrors( 'createaccount', $user, true );
1362 if ( count( $permErrors ) ) {
1363 throw new PermissionsError( 'createaccount', $permErrors );
1364 } elseif ( $user->isBlockedFromCreateAccount() ) {
1365 $this->userBlockedMessage( $user->isBlockedFromCreateAccount() );
1366
1367 return;
1368 } elseif ( wfReadOnly() ) {
1369 throw new ReadOnlyError;
1370 }
1371 }
1372
1373 // Pre-fill username (if not creating an account, bug 44775).
1374 if ( $this->mUsername == '' && $this->mType != 'signup' ) {
1375 if ( $user->isLoggedIn() ) {
1376 $this->mUsername = $user->getName();
1377 } else {
1378 $this->mUsername = $this->getRequest()->getCookie( 'UserName' );
1379 }
1380 }
1381
1382 // Generic styles and scripts for both login and signup form
1383 $out->addModuleStyles( array(
1384 'mediawiki.ui',
1385 'mediawiki.ui.button',
1386 'mediawiki.ui.checkbox',
1387 'mediawiki.ui.input',
1388 'mediawiki.special.userlogin.common.styles'
1389 ) );
1390
1391 if ( $this->mType == 'signup' ) {
1392 // Additional styles and scripts for signup form
1393 $out->addModules( array(
1394 'mediawiki.special.userlogin.signup.js'
1395 ) );
1396 $out->addModuleStyles( array(
1397 'mediawiki.special.userlogin.signup.styles'
1398 ) );
1399
1400 $template = new UsercreateTemplate( $this->getConfig() );
1401
1402 // Must match number of benefits defined in messages
1403 $template->set( 'benefitCount', 3 );
1404
1405 $q = 'action=submitlogin&type=signup';
1406 $linkq = 'type=login';
1407 } else {
1408 // Additional styles for login form
1409 $out->addModuleStyles( array(
1410 'mediawiki.special.userlogin.login.styles'
1411 ) );
1412
1413 $template = new UserloginTemplate( $this->getConfig() );
1414
1415 $q = 'action=submitlogin&type=login';
1416 $linkq = 'type=signup';
1417 }
1418
1419 if ( $this->mReturnTo !== '' ) {
1420 $returnto = '&returnto=' . wfUrlencode( $this->mReturnTo );
1421 if ( $this->mReturnToQuery !== '' ) {
1422 $returnto .= '&returntoquery=' .
1423 wfUrlencode( $this->mReturnToQuery );
1424 }
1425 $q .= $returnto;
1426 $linkq .= $returnto;
1427 }
1428
1429 # Don't show a "create account" link if the user can't.
1430 if ( $this->showCreateOrLoginLink( $user ) ) {
1431 # Pass any language selection on to the mode switch link
1432 if ( $wgLoginLanguageSelector && $this->mLanguage ) {
1433 $linkq .= '&uselang=' . $this->mLanguage;
1434 }
1435 // Supply URL, login template creates the button.
1436 $template->set( 'createOrLoginHref', $titleObj->getLocalURL( $linkq ) );
1437 } else {
1438 $template->set( 'link', '' );
1439 }
1440
1441 $resetLink = $this->mType == 'signup'
1442 ? null
1443 : is_array( $wgPasswordResetRoutes ) && in_array( true, array_values( $wgPasswordResetRoutes ) );
1444
1445 $template->set( 'header', '' );
1446 $template->set( 'formheader', '' );
1447 $template->set( 'skin', $this->getSkin() );
1448 $template->set( 'name', $this->mUsername );
1449 $template->set( 'password', $this->mPassword );
1450 $template->set( 'retype', $this->mRetype );
1451 $template->set( 'createemailset', $this->mCreateaccountMail );
1452 $template->set( 'email', $this->mEmail );
1453 $template->set( 'realname', $this->mRealName );
1454 $template->set( 'domain', $this->mDomain );
1455 $template->set( 'reason', $this->mReason );
1456
1457 $template->set( 'action', $titleObj->getLocalURL( $q ) );
1458 $template->set( 'message', $msg );
1459 $template->set( 'messagetype', $msgtype );
1460 $template->set( 'createemail', $wgEnableEmail && $user->isLoggedIn() );
1461 $template->set( 'userealname', !in_array( 'realname', $wgHiddenPrefs ) );
1462 $template->set( 'useemail', $wgEnableEmail );
1463 $template->set( 'emailrequired', $wgEmailConfirmToEdit );
1464 $template->set( 'emailothers', $wgEnableUserEmail );
1465 $template->set( 'canreset', $wgAuth->allowPasswordChange() );
1466 $template->set( 'resetlink', $resetLink );
1467 $template->set( 'canremember', $wgExtendedLoginCookieExpiration === null ?
1468 ( $wgCookieExpiration > 0 ) :
1469 ( $wgExtendedLoginCookieExpiration > 0 ) );
1470 $template->set( 'usereason', $user->isLoggedIn() );
1471 $template->set( 'remember', $this->mRemember );
1472 $template->set( 'cansecurelogin', ( $wgSecureLogin === true ) );
1473 $template->set( 'stickhttps', (int)$this->mStickHTTPS );
1474 $template->set( 'loggedin', $user->isLoggedIn() );
1475 $template->set( 'loggedinuser', $user->getName() );
1476
1477 if ( $this->mType == 'signup' ) {
1478 if ( !self::getCreateaccountToken() ) {
1479 self::setCreateaccountToken();
1480 }
1481 $template->set( 'token', self::getCreateaccountToken() );
1482 } else {
1483 if ( !self::getLoginToken() ) {
1484 self::setLoginToken();
1485 }
1486 $template->set( 'token', self::getLoginToken() );
1487 }
1488
1489 # Prepare language selection links as needed
1490 if ( $wgLoginLanguageSelector ) {
1491 $template->set( 'languages', $this->makeLanguageSelector() );
1492 if ( $this->mLanguage ) {
1493 $template->set( 'uselang', $this->mLanguage );
1494 }
1495 }
1496
1497 $template->set( 'secureLoginUrl', $this->mSecureLoginUrl );
1498 // Use signupend-https for HTTPS requests if it's not blank, signupend otherwise
1499 $usingHTTPS = $this->mRequest->getProtocol() == 'https';
1500 $signupendHTTPS = $this->msg( 'signupend-https' );
1501 if ( $usingHTTPS && !$signupendHTTPS->isBlank() ) {
1502 $template->set( 'signupend', $signupendHTTPS->parse() );
1503 } else {
1504 $template->set( 'signupend', $this->msg( 'signupend' )->parse() );
1505 }
1506
1507 // If using HTTPS coming from HTTP, then the 'fromhttp' parameter must be preserved
1508 if ( $usingHTTPS ) {
1509 $template->set( 'fromhttp', $this->mFromHTTP );
1510 }
1511
1512 // Give authentication and captcha plugins a chance to modify the form
1513 $wgAuth->modifyUITemplate( $template, $this->mType );
1514 if ( $this->mType == 'signup' ) {
1515 Hooks::run( 'UserCreateForm', array( &$template ) );
1516 } else {
1517 Hooks::run( 'UserLoginForm', array( &$template ) );
1518 }
1519
1520 $out->disallowUserJs(); // just in case...
1521 $out->addTemplate( $template );
1522 }
1523
1524 /**
1525 * Whether the login/create account form should display a link to the
1526 * other form (in addition to whatever the skin provides).
1527 *
1528 * @param User $user
1529 * @return bool
1530 */
1531 private function showCreateOrLoginLink( &$user ) {
1532 if ( $this->mType == 'signup' ) {
1533 return true;
1534 } elseif ( $user->isAllowed( 'createaccount' ) ) {
1535 return true;
1536 } else {
1537 return false;
1538 }
1539 }
1540
1541 /**
1542 * Check if a session cookie is present.
1543 *
1544 * This will not pick up a cookie set during _this_ request, but is meant
1545 * to ensure that the client is returning the cookie which was set on a
1546 * previous pass through the system.
1547 *
1548 * @private
1549 * @return bool
1550 */
1551 function hasSessionCookie() {
1552 global $wgDisableCookieCheck;
1553
1554 return $wgDisableCookieCheck ? true : $this->getRequest()->checkSessionCookie();
1555 }
1556
1557 /**
1558 * Get the login token from the current session
1559 * @return mixed
1560 */
1561 public static function getLoginToken() {
1562 global $wgRequest;
1563
1564 return $wgRequest->getSessionData( 'wsLoginToken' );
1565 }
1566
1567 /**
1568 * Randomly generate a new login token and attach it to the current session
1569 */
1570 public static function setLoginToken() {
1571 global $wgRequest;
1572 // Generate a token directly instead of using $user->getEditToken()
1573 // because the latter reuses $_SESSION['wsEditToken']
1574 $wgRequest->setSessionData( 'wsLoginToken', MWCryptRand::generateHex( 32 ) );
1575 }
1576
1577 /**
1578 * Remove any login token attached to the current session
1579 */
1580 public static function clearLoginToken() {
1581 global $wgRequest;
1582 $wgRequest->setSessionData( 'wsLoginToken', null );
1583 }
1584
1585 /**
1586 * Get the createaccount token from the current session
1587 * @return mixed
1588 */
1589 public static function getCreateaccountToken() {
1590 global $wgRequest;
1591 return $wgRequest->getSessionData( 'wsCreateaccountToken' );
1592 }
1593
1594 /**
1595 * Randomly generate a new createaccount token and attach it to the current session
1596 */
1597 public static function setCreateaccountToken() {
1598 global $wgRequest;
1599 $wgRequest->setSessionData( 'wsCreateaccountToken', MWCryptRand::generateHex( 32 ) );
1600 }
1601
1602 /**
1603 * Remove any createaccount token attached to the current session
1604 */
1605 public static function clearCreateaccountToken() {
1606 global $wgRequest;
1607 $wgRequest->setSessionData( 'wsCreateaccountToken', null );
1608 }
1609
1610 /**
1611 * Renew the user's session id, using strong entropy
1612 */
1613 private function renewSessionId() {
1614 global $wgSecureLogin, $wgCookieSecure;
1615 if ( $wgSecureLogin && !$this->mStickHTTPS ) {
1616 $wgCookieSecure = false;
1617 }
1618
1619 wfResetSessionID();
1620 }
1621
1622 /**
1623 * @param string $type
1624 * @private
1625 */
1626 function cookieRedirectCheck( $type ) {
1627 $titleObj = SpecialPage::getTitleFor( 'Userlogin' );
1628 $query = array( 'wpCookieCheck' => $type );
1629 if ( $this->mReturnTo !== '' ) {
1630 $query['returnto'] = $this->mReturnTo;
1631 $query['returntoquery'] = $this->mReturnToQuery;
1632 }
1633 $check = $titleObj->getFullURL( $query );
1634
1635 $this->getOutput()->redirect( $check );
1636 }
1637
1638 /**
1639 * @param string $type
1640 * @private
1641 */
1642 function onCookieRedirectCheck( $type ) {
1643 if ( !$this->hasSessionCookie() ) {
1644 if ( $type == 'new' ) {
1645 $this->mainLoginForm( $this->msg( 'nocookiesnew' )->parse() );
1646 } elseif ( $type == 'login' ) {
1647 $this->mainLoginForm( $this->msg( 'nocookieslogin' )->parse() );
1648 } else {
1649 # shouldn't happen
1650 $this->mainLoginForm( $this->msg( 'error' )->text() );
1651 }
1652 } else {
1653 $this->successfulLogin();
1654 }
1655 }
1656
1657 /**
1658 * Produce a bar of links which allow the user to select another language
1659 * during login/registration but retain "returnto"
1660 *
1661 * @return string
1662 */
1663 function makeLanguageSelector() {
1664 $msg = $this->msg( 'loginlanguagelinks' )->inContentLanguage();
1665 if ( $msg->isBlank() ) {
1666 return '';
1667 }
1668 $langs = explode( "\n", $msg->text() );
1669 $links = array();
1670 foreach ( $langs as $lang ) {
1671 $lang = trim( $lang, '* ' );
1672 $parts = explode( '|', $lang );
1673 if ( count( $parts ) >= 2 ) {
1674 $links[] = $this->makeLanguageSelectorLink( $parts[0], trim( $parts[1] ) );
1675 }
1676 }
1677
1678 return count( $links ) > 0 ? $this->msg( 'loginlanguagelabel' )->rawParams(
1679 $this->getLanguage()->pipeList( $links ) )->escaped() : '';
1680 }
1681
1682 /**
1683 * Create a language selector link for a particular language
1684 * Links back to this page preserving type and returnto
1685 *
1686 * @param string $text Link text
1687 * @param string $lang Language code
1688 * @return string
1689 */
1690 function makeLanguageSelectorLink( $text, $lang ) {
1691 if ( $this->getLanguage()->getCode() == $lang ) {
1692 // no link for currently used language
1693 return htmlspecialchars( $text );
1694 }
1695 $query = array( 'uselang' => $lang );
1696 if ( $this->mType == 'signup' ) {
1697 $query['type'] = 'signup';
1698 }
1699 if ( $this->mReturnTo !== '' ) {
1700 $query['returnto'] = $this->mReturnTo;
1701 $query['returntoquery'] = $this->mReturnToQuery;
1702 }
1703
1704 $attr = array();
1705 $targetLanguage = Language::factory( $lang );
1706 $attr['lang'] = $attr['hreflang'] = $targetLanguage->getHtmlCode();
1707
1708 return Linker::linkKnown(
1709 $this->getPageTitle(),
1710 htmlspecialchars( $text ),
1711 $attr,
1712 $query
1713 );
1714 }
1715
1716 protected function getGroupName() {
1717 return 'login';
1718 }
1719
1720 /**
1721 * Private function to check password expiration, until AuthManager comes
1722 * along to handle that.
1723 * @param User $user
1724 * @return string|bool
1725 */
1726 private function checkUserPasswordExpired( User $user ) {
1727 global $wgPasswordExpireGrace;
1728 $dbr = wfGetDB( DB_SLAVE );
1729 $ts = $dbr->selectField( 'user', 'user_password_expires', array( 'user_id' => $user->getId() ) );
1730
1731 $expired = false;
1732 $now = wfTimestamp();
1733 $expUnix = wfTimestamp( TS_UNIX, $ts );
1734 if ( $ts !== null && $expUnix < $now ) {
1735 $expired = ( $expUnix + $wgPasswordExpireGrace < $now ) ? 'hard' : 'soft';
1736 }
1737 return $expired;
1738 }
1739
1740 }