includes/specials/SpecialUserlogin.php

   1 <?php
   2 /**
   3  * Implements Special:UserLogin
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * Implements Special:UserLogin
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 class LoginForm extends SpecialPage {
  30         const SUCCESS = 0;
  31         const NO_NAME = 1;
  32         const ILLEGAL = 2;
  33         const WRONG_PLUGIN_PASS = 3;
  34         const NOT_EXISTS = 4;
  35         const WRONG_PASS = 5;
  36         const EMPTY_PASS = 6;
  37         const RESET_PASS = 7;
  38         const ABORTED = 8;
  39         const CREATE_BLOCKED = 9;
  40         const THROTTLED = 10;
  41         const USER_BLOCKED = 11;
  42         const NEED_TOKEN = 12;
  43         const WRONG_TOKEN = 13;
  44
  45         public $mAbortLoginErrorMsg = null;
  46
  47         protected $mUsername;
  48         protected $mPassword;
  49         protected $mRetype;
  50         protected $mReturnTo;
  51         protected $mCookieCheck;
  52         protected $mPosted;
  53         protected $mAction;
  54         protected $mCreateaccount;
  55         protected $mCreateaccountMail;
  56         protected $mLoginattempt;
  57         protected $mRemember;
  58         protected $mEmail;
  59         protected $mDomain;
  60         protected $mLanguage;
  61         protected $mSkipCookieCheck;
  62         protected $mReturnToQuery;
  63         protected $mToken;
  64         protected $mStickHTTPS;
  65         protected $mType;
  66         protected $mReason;
  67         protected $mRealName;
  68
  69         private $mTempPasswordUsed;
  70         private $mLoaded = false;
  71         private $mSecureLoginUrl;
  72
  73         /** @var WebRequest */
  74         private $mOverrideRequest = null;
  75
  76         /** @var WebRequest Effective request; set at the beginning of load */
  77         private $mRequest = null;
  78
  79         /**
  80          * @param WebRequest $request
  81          */
  82         public function __construct( $request = null ) {
  83                 parent::__construct( 'Userlogin' );
  84
  85                 $this->mOverrideRequest = $request;
  86         }
  87
  88         /**
  89          * Loader
  90          */
  91         function load() {
  92                 global $wgAuth, $wgHiddenPrefs, $wgEnableEmail;
  93
  94                 if ( $this->mLoaded ) {
  95                         return;
  96                 }
  97                 $this->mLoaded = true;
  98
  99                 if ( $this->mOverrideRequest === null ) {
 100                         $request = $this->getRequest();
 101                 } else {
 102                         $request = $this->mOverrideRequest;
 103                 }
 104                 $this->mRequest = $request;
 105
 106                 $this->mType = $request->getText( 'type' );
 107                 $this->mUsername = $request->getText( 'wpName' );
 108                 $this->mPassword = $request->getText( 'wpPassword' );
 109                 $this->mRetype = $request->getText( 'wpRetype' );
 110                 $this->mDomain = $request->getText( 'wpDomain' );
 111                 $this->mReason = $request->getText( 'wpReason' );
 112                 $this->mCookieCheck = $request->getVal( 'wpCookieCheck' );
 113                 $this->mPosted = $request->wasPosted();
 114                 $this->mCreateaccountMail = $request->getCheck( 'wpCreateaccountMail' )
 115                         && $wgEnableEmail;
 116                 $this->mCreateaccount = $request->getCheck( 'wpCreateaccount' ) && !$this->mCreateaccountMail;
 117                 $this->mLoginattempt = $request->getCheck( 'wpLoginattempt' );
 118                 $this->mAction = $request->getVal( 'action' );
 119                 $this->mRemember = $request->getCheck( 'wpRemember' );
 120                 $this->mFromHTTP = $request->getBool( 'fromhttp', false );
 121                 $this->mStickHTTPS = ( !$this->mFromHTTP && $request->getProtocol() === 'https' )
 122                         || $request->getBool( 'wpForceHttps', false );
 123                 $this->mLanguage = $request->getText( 'uselang' );
 124                 $this->mSkipCookieCheck = $request->getCheck( 'wpSkipCookieCheck' );
 125                 $this->mToken = $this->mType == 'signup'
 126                         ? $request->getVal( 'wpCreateaccountToken' )
 127                         : $request->getVal( 'wpLoginToken' );
 128                 $this->mReturnTo = $request->getVal( 'returnto', '' );
 129                 $this->mReturnToQuery = $request->getVal( 'returntoquery', '' );
 130
 131                 if ( $wgEnableEmail ) {
 132                         $this->mEmail = $request->getText( 'wpEmail' );
 133                 } else {
 134                         $this->mEmail = '';
 135                 }
 136                 if ( !in_array( 'realname', $wgHiddenPrefs ) ) {
 137                         $this->mRealName = $request->getText( 'wpRealName' );
 138                 } else {
 139                         $this->mRealName = '';
 140                 }
 141
 142                 if ( !$wgAuth->validDomain( $this->mDomain ) ) {
 143                         $this->mDomain = $wgAuth->getDomain();
 144                 }
 145                 $wgAuth->setDomain( $this->mDomain );
 146
 147                 # 1. When switching accounts, it sucks to get automatically logged out
 148                 # 2. Do not return to PasswordReset after a successful password change
 149                 #    but goto Wiki start page (Main_Page) instead ( bug 33997 )
 150                 $returnToTitle = Title::newFromText( $this->mReturnTo );
 151                 if ( is_object( $returnToTitle )
 152                         && ( $returnToTitle->isSpecial( 'Userlogout' )
 153                                 || $returnToTitle->isSpecial( 'PasswordReset' ) )
 154                 ) {
 155                         $this->mReturnTo = '';
 156                         $this->mReturnToQuery = '';
 157                 }
 158         }
 159
 160         function getDescription() {
 161                 if ( $this->mType === 'signup' ) {
 162                         return $this->msg( 'createaccount' )->text();
 163                 } else {
 164                         return $this->msg( 'login' )->text();
 165                 }
 166         }
 167
 168         /*
 169          * @param string|null $subPage
 170          */
 171         public function execute( $subPage ) {
 172                 if ( session_id() == '' ) {
 173                         wfSetupSession();
 174                 }
 175
 176                 $this->load();
 177
 178                 // Check for [[Special:Userlogin/signup]]. This affects form display and
 179                 // page title.
 180                 if ( $subPage == 'signup' ) {
 181                         $this->mType = 'signup';
 182                 }
 183                 $this->setHeaders();
 184
 185                 // If logging in and not on HTTPS, either redirect to it or offer a link.
 186                 global $wgSecureLogin;
 187                 if ( $this->mRequest->getProtocol() !== 'https' ) {
 188                         $title = $this->getFullTitle();
 189                         $query = array(
 190                                 'returnto' => $this->mReturnTo !== '' ? $this->mReturnTo : null,
 191                                 'returntoquery' => $this->mReturnToQuery !== '' ?
 192                                         $this->mReturnToQuery : null,
 193                                 'title' => null,
 194                         ) + $this->mRequest->getQueryValues();
 195                         $url = $title->getFullURL( $query, false, PROTO_HTTPS );
 196                         if ( $wgSecureLogin && wfCanIPUseHTTPS( $this->getRequest()->getIP() ) ) {
 197                                 $url = wfAppendQuery( $url, 'fromhttp=1' );
 198                                 $this->getOutput()->redirect( $url );
 199                                 // Since we only do this redir to change proto, always vary
 200                                 $this->getOutput()->addVaryHeader( 'X-Forwarded-Proto' );
 201
 202                                 return;
 203                         } else {
 204                                 // A wiki without HTTPS login support should set $wgServer to
 205                                 // http://somehost, in which case the secure URL generated
 206                                 // above won't actually start with https://
 207                                 if ( substr( $url, 0, 8 ) === 'https://' ) {
 208                                         $this->mSecureLoginUrl = $url;
 209                                 }
 210                         }
 211                 }
 212
 213                 if ( !is_null( $this->mCookieCheck ) ) {
 214                         $this->onCookieRedirectCheck( $this->mCookieCheck );
 215
 216                         return;
 217                 } elseif ( $this->mPosted ) {
 218                         if ( $this->mCreateaccount ) {
 219                                 $this->addNewAccount();
 220
 221                                 return;
 222                         } elseif ( $this->mCreateaccountMail ) {
 223                                 $this->addNewAccountMailPassword();
 224
 225                                 return;
 226                         } elseif ( ( 'submitlogin' == $this->mAction ) || $this->mLoginattempt ) {
 227                                 $this->processLogin();
 228
 229                                 return;
 230                         }
 231                 }
 232                 $this->mainLoginForm( '' );
 233         }
 234
 235         /**
 236          * @private
 237          */
 238         function addNewAccountMailPassword() {
 239                 if ( $this->mEmail == '' ) {
 240                         $this->mainLoginForm( $this->msg( 'noemailcreate' )->escaped() );
 241
 242                         return;
 243                 }
 244
 245                 $status = $this->addNewAccountInternal();
 246                 if ( !$status->isGood() ) {
 247                         $error = $status->getMessage();
 248                         $this->mainLoginForm( $error->toString() );
 249
 250                         return;
 251                 }
 252
 253                 $u = $status->getValue();
 254
 255                 // Wipe the initial password and mail a temporary one
 256                 $u->setPassword( null );
 257                 $u->saveSettings();
 258                 $result = $this->mailPasswordInternal( $u, false, 'createaccount-title', 'createaccount-text' );
 259
 260                 wfRunHooks( 'AddNewAccount', array( $u, true ) );
 261                 $u->addNewUserLogEntry( 'byemail', $this->mReason );
 262
 263                 $out = $this->getOutput();
 264                 $out->setPageTitle( $this->msg( 'accmailtitle' ) );
 265
 266                 if ( !$result->isGood() ) {
 267                         $this->mainLoginForm( $this->msg( 'mailerror', $result->getWikiText() )->text() );
 268                 } else {
 269                         $out->addWikiMsg( 'accmailtext', $u->getName(), $u->getEmail() );
 270                         $this->executeReturnTo( 'success' );
 271                 }
 272         }
 273
 274         /**
 275          * @private
 276          * @return bool
 277          */
 278         function addNewAccount() {
 279                 global $wgContLang, $wgUser, $wgEmailAuthentication, $wgLoginLanguageSelector;
 280
 281                 # Create the account and abort if there's a problem doing so
 282                 $status = $this->addNewAccountInternal();
 283                 if ( !$status->isGood() ) {
 284                         $error = $status->getMessage();
 285                         $this->mainLoginForm( $error->toString() );
 286
 287                         return false;
 288                 }
 289
 290                 $u = $status->getValue();
 291
 292                 # Only save preferences if the user is not creating an account for someone else.
 293                 if ( $this->getUser()->isAnon() ) {
 294                         # If we showed up language selection links, and one was in use, be
 295                         # smart (and sensible) and save that language as the user's preference
 296                         if ( $wgLoginLanguageSelector && $this->mLanguage ) {
 297                                 $u->setOption( 'language', $this->mLanguage );
 298                         } else {
 299
 300                                 # Otherwise the user's language preference defaults to $wgContLang,
 301                                 # but it may be better to set it to their preferred $wgContLang variant,
 302                                 # based on browser preferences or URL parameters.
 303                                 $u->setOption( 'language', $wgContLang->getPreferredVariant() );
 304                         }
 305                         if ( $wgContLang->hasVariants() ) {
 306                                 $u->setOption( 'variant', $wgContLang->getPreferredVariant() );
 307                         }
 308                 }
 309
 310                 $out = $this->getOutput();
 311
 312                 # Send out an email authentication message if needed
 313                 if ( $wgEmailAuthentication && Sanitizer::validateEmail( $u->getEmail() ) ) {
 314                         $status = $u->sendConfirmationMail();
 315                         if ( $status->isGood() ) {
 316                                 $out->addWikiMsg( 'confirmemail_oncreate' );
 317                         } else {
 318                                 $out->addWikiText( $status->getWikiText( 'confirmemail_sendfailed' ) );
 319                         }
 320                 }
 321
 322                 # Save settings (including confirmation token)
 323                 $u->saveSettings();
 324
 325                 # If not logged in, assume the new account as the current one and set
 326                 # session cookies then show a "welcome" message or a "need cookies"
 327                 # message as needed
 328                 if ( $this->getUser()->isAnon() ) {
 329                         $u->setCookies();
 330                         $wgUser = $u;
 331                         // This should set it for OutputPage and the Skin
 332                         // which is needed or the personal links will be
 333                         // wrong.
 334                         $this->getContext()->setUser( $u );
 335                         wfRunHooks( 'AddNewAccount', array( $u, false ) );
 336                         $u->addNewUserLogEntry( 'create' );
 337                         if ( $this->hasSessionCookie() ) {
 338                                 $this->successfulCreation();
 339                         } else {
 340                                 $this->cookieRedirectCheck( 'new' );
 341                         }
 342                 } else {
 343                         # Confirm that the account was created
 344                         $out->setPageTitle( $this->msg( 'accountcreated' ) );
 345                         $out->addWikiMsg( 'accountcreatedtext', $u->getName() );
 346                         $out->addReturnTo( $this->getPageTitle() );
 347                         wfRunHooks( 'AddNewAccount', array( $u, false ) );
 348                         $u->addNewUserLogEntry( 'create2', $this->mReason );
 349                 }
 350
 351                 return true;
 352         }
 353
 354         /**
 355          * Make a new user account using the loaded data.
 356          * @private
 357          * @throws PermissionsError|ReadOnlyError
 358          * @return Status
 359          */
 360         public function addNewAccountInternal() {
 361                 global $wgAuth, $wgMemc, $wgAccountCreationThrottle,
 362                         $wgMinimalPasswordLength, $wgEmailConfirmToEdit;
 363
 364                 // If the user passes an invalid domain, something is fishy
 365                 if ( !$wgAuth->validDomain( $this->mDomain ) ) {
 366                         return Status::newFatal( 'wrongpassword' );
 367                 }
 368
 369                 // If we are not allowing users to login locally, we should be checking
 370                 // to see if the user is actually able to authenticate to the authenti-
 371                 // cation server before they create an account (otherwise, they can
 372                 // create a local account and login as any domain user). We only need
 373                 // to check this for domains that aren't local.
 374                 if ( 'local' != $this->mDomain && $this->mDomain != '' ) {
 375                         if (
 376                                 !$wgAuth->canCreateAccounts() &&
 377                                 (
 378                                         !$wgAuth->userExists( $this->mUsername ) ||
 379                                         !$wgAuth->authenticate( $this->mUsername, $this->mPassword )
 380                                 )
 381                         ) {
 382                                 return Status::newFatal( 'wrongpassword' );
 383                         }
 384                 }
 385
 386                 if ( wfReadOnly() ) {
 387                         throw new ReadOnlyError;
 388                 }
 389
 390                 # Request forgery checks.
 391                 if ( !self::getCreateaccountToken() ) {
 392                         self::setCreateaccountToken();
 393
 394                         return Status::newFatal( 'nocookiesfornew' );
 395                 }
 396
 397                 # The user didn't pass a createaccount token
 398                 if ( !$this->mToken ) {
 399                         return Status::newFatal( 'sessionfailure' );
 400                 }
 401
 402                 # Validate the createaccount token
 403                 if ( $this->mToken !== self::getCreateaccountToken() ) {
 404                         return Status::newFatal( 'sessionfailure' );
 405                 }
 406
 407                 # Check permissions
 408                 $currentUser = $this->getUser();
 409                 $creationBlock = $currentUser->isBlockedFromCreateAccount();
 410                 if ( !$currentUser->isAllowed( 'createaccount' ) ) {
 411                         throw new PermissionsError( 'createaccount' );
 412                 } elseif ( $creationBlock instanceof Block ) {
 413                         // Throws an ErrorPageError.
 414                         $this->userBlockedMessage( $creationBlock );
 415
 416                         // This should never be reached.
 417                         return false;
 418                 }
 419
 420                 # Include checks that will include GlobalBlocking (Bug 38333)
 421                 $permErrors = $this->getPageTitle()->getUserPermissionsErrors(
 422                         'createaccount',
 423                         $currentUser,
 424                         true
 425                 );
 426
 427                 if ( count( $permErrors ) ) {
 428                         throw new PermissionsError( 'createaccount', $permErrors );
 429                 }
 430
 431                 $ip = $this->getRequest()->getIP();
 432                 if ( $currentUser->isDnsBlacklisted( $ip, true /* check $wgProxyWhitelist */ ) ) {
 433                         return Status::newFatal( 'sorbs_create_account_reason' );
 434                 }
 435
 436                 // Normalize the name so that silly things don't cause "invalid username"
 437                 // errors. User::newFromName does some rather strict checking, rejecting
 438                 // e.g. leading/trailing/multiple spaces.
 439                 $title = Title::makeTitleSafe( NS_USER, $this->mUsername );
 440                 if ( !is_object( $title ) ) {
 441                         return Status::newFatal( 'noname' );
 442                 }
 443
 444                 # Now create a dummy user ($u) and check if it is valid
 445                 $u = User::newFromName( $title->getText(), 'creatable' );
 446                 if ( !is_object( $u ) ) {
 447                         return Status::newFatal( 'noname' );
 448                 } elseif ( 0 != $u->idForName() ) {
 449                         return Status::newFatal( 'userexists' );
 450                 }
 451
 452                 if ( $this->mCreateaccountMail ) {
 453                         # do not force a password for account creation by email
 454                         # set invalid password, it will be replaced later by a random generated password
 455                         $this->mPassword = null;
 456                 } else {
 457                         if ( $this->mPassword !== $this->mRetype ) {
 458                                 return Status::newFatal( 'badretype' );
 459                         }
 460
 461                         # check for minimal password length
 462                         $valid = $u->getPasswordValidity( $this->mPassword );
 463                         if ( $valid !== true ) {
 464                                 if ( !is_array( $valid ) ) {
 465                                         $valid = array( $valid, $wgMinimalPasswordLength );
 466                                 }
 467
 468                                 return call_user_func_array( 'Status::newFatal', $valid );
 469                         }
 470                 }
 471
 472                 # if you need a confirmed email address to edit, then obviously you
 473                 # need an email address.
 474                 if ( $wgEmailConfirmToEdit && strval( $this->mEmail ) === '' ) {
 475                         return Status::newFatal( 'noemailtitle' );
 476                 }
 477
 478                 if ( strval( $this->mEmail ) !== '' && !Sanitizer::validateEmail( $this->mEmail ) ) {
 479                         return Status::newFatal( 'invalidemailaddress' );
 480                 }
 481
 482                 # Set some additional data so the AbortNewAccount hook can be used for
 483                 # more than just username validation
 484                 $u->setEmail( $this->mEmail );
 485                 $u->setRealName( $this->mRealName );
 486
 487                 $abortError = '';
 488                 $abortStatus = null;
 489                 if ( !wfRunHooks( 'AbortNewAccount', array( $u, &$abortError, &$abortStatus ) ) ) {
 490                         // Hook point to add extra creation throttles and blocks
 491                         wfDebug( "LoginForm::addNewAccountInternal: a hook blocked creation\n" );
 492                         if ( $abortStatus === null ) {
 493                                 // Report back the old string as a raw message status.
 494                                 // This will report the error back as 'createaccount-hook-aborted'
 495                                 // with the given string as the message.
 496                                 // To return a different error code, return a Status object.
 497                                 $abortError = new Message( 'createaccount-hook-aborted', array( $abortError ) );
 498                                 $abortError->text();
 499
 500                                 return Status::newFatal( $abortError );
 501                         } else {
 502                                 // For MediaWiki 1.23+ and updated hooks, return the Status object
 503                                 // returned from the hook.
 504                                 return $abortStatus;
 505                         }
 506                 }
 507
 508                 // Hook point to check for exempt from account creation throttle
 509                 if ( !wfRunHooks( 'ExemptFromAccountCreationThrottle', array( $ip ) ) ) {
 510                         wfDebug( "LoginForm::exemptFromAccountCreationThrottle: a hook " .
 511                                 "allowed account creation w/o throttle\n" );
 512                 } else {
 513                         if ( ( $wgAccountCreationThrottle && $currentUser->isPingLimitable() ) ) {
 514                                 $key = wfMemcKey( 'acctcreate', 'ip', $ip );
 515                                 $value = $wgMemc->get( $key );
 516                                 if ( !$value ) {
 517                                         $wgMemc->set( $key, 0, 86400 );
 518                                 }
 519                                 if ( $value >= $wgAccountCreationThrottle ) {
 520                                         return Status::newFatal( 'acct_creation_throttle_hit', $wgAccountCreationThrottle );
 521                                 }
 522                                 $wgMemc->incr( $key );
 523                         }
 524                 }
 525
 526                 if ( !$wgAuth->addUser( $u, $this->mPassword, $this->mEmail, $this->mRealName ) ) {
 527                         return Status::newFatal( 'externaldberror' );
 528                 }
 529
 530                 self::clearCreateaccountToken();
 531
 532                 return $this->initUser( $u, false );
 533         }
 534
 535         /**
 536          * Actually add a user to the database.
 537          * Give it a User object that has been initialised with a name.
 538          *
 539          * @param User $u
 540          * @param bool $autocreate True if this is an autocreation via auth plugin
 541          * @return Status Status object, with the User object in the value member on success
 542          * @private
 543          */
 544         function initUser( $u, $autocreate ) {
 545                 global $wgAuth;
 546
 547                 $status = $u->addToDatabase();
 548                 if ( !$status->isOK() ) {
 549                         return $status;
 550                 }
 551
 552                 if ( $wgAuth->allowPasswordChange() ) {
 553                         $u->setPassword( $this->mPassword );
 554                 }
 555
 556                 $u->setEmail( $this->mEmail );
 557                 $u->setRealName( $this->mRealName );
 558                 $u->setToken();
 559
 560                 $wgAuth->initUser( $u, $autocreate );
 561
 562                 $u->saveSettings();
 563
 564                 // Update user count
 565                 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 0, 0, 0, 1 ) );
 566
 567                 // Watch user's userpage and talk page
 568                 $u->addWatch( $u->getUserPage(), WatchedItem::IGNORE_USER_RIGHTS );
 569
 570                 return Status::newGood( $u );
 571         }
 572
 573         /**
 574          * Internally authenticate the login request.
 575          *
 576          * This may create a local account as a side effect if the
 577          * authentication plugin allows transparent local account
 578          * creation.
 579          * @return int
 580          */
 581         public function authenticateUserData() {
 582                 global $wgUser, $wgAuth;
 583
 584                 $this->load();
 585
 586                 if ( $this->mUsername == '' ) {
 587                         return self::NO_NAME;
 588                 }
 589
 590                 // We require a login token to prevent login CSRF
 591                 // Handle part of this before incrementing the throttle so
 592                 // token-less login attempts don't count towards the throttle
 593                 // but wrong-token attempts do.
 594
 595                 // If the user doesn't have a login token yet, set one.
 596                 if ( !self::getLoginToken() ) {
 597                         self::setLoginToken();
 598
 599                         return self::NEED_TOKEN;
 600                 }
 601                 // If the user didn't pass a login token, tell them we need one
 602                 if ( !$this->mToken ) {
 603                         return self::NEED_TOKEN;
 604                 }
 605
 606                 $throttleCount = self::incLoginThrottle( $this->mUsername );
 607                 if ( $throttleCount === true ) {
 608                         return self::THROTTLED;
 609                 }
 610
 611                 // Validate the login token
 612                 if ( $this->mToken !== self::getLoginToken() ) {
 613                         return self::WRONG_TOKEN;
 614                 }
 615
 616                 // Load the current user now, and check to see if we're logging in as
 617                 // the same name. This is necessary because loading the current user
 618                 // (say by calling getName()) calls the UserLoadFromSession hook, which
 619                 // potentially creates the user in the database. Until we load $wgUser,
 620                 // checking for user existence using User::newFromName($name)->getId() below
 621                 // will effectively be using stale data.
 622                 if ( $this->getUser()->getName() === $this->mUsername ) {
 623                         wfDebug( __METHOD__ . ": already logged in as {$this->mUsername}\n" );
 624
 625                         return self::SUCCESS;
 626                 }
 627
 628                 $u = User::newFromName( $this->mUsername );
 629                 if ( !( $u instanceof User ) || !User::isUsableName( $u->getName() ) ) {
 630                         return self::ILLEGAL;
 631                 }
 632
 633                 $isAutoCreated = false;
 634                 if ( $u->getID() == 0 ) {
 635                         $status = $this->attemptAutoCreate( $u );
 636                         if ( $status !== self::SUCCESS ) {
 637                                 return $status;
 638                         } else {
 639                                 $isAutoCreated = true;
 640                         }
 641                 } else {
 642                         $u->load();
 643                 }
 644
 645                 // Give general extensions, such as a captcha, a chance to abort logins
 646                 $abort = self::ABORTED;
 647                 $msg = null;
 648                 if ( !wfRunHooks( 'AbortLogin', array( $u, $this->mPassword, &$abort, &$msg ) ) ) {
 649                         $this->mAbortLoginErrorMsg = $msg;
 650
 651                         return $abort;
 652                 }
 653
 654                 global $wgBlockDisablesLogin;
 655                 if ( !$u->checkPassword( $this->mPassword ) ) {
 656                         if ( $u->checkTemporaryPassword( $this->mPassword ) ) {
 657                                 // The e-mailed temporary password should not be used for actu-
 658                                 // al logins; that's a very sloppy habit, and insecure if an
 659                                 // attacker has a few seconds to click "search" on someone's o-
 660                                 // pen mail reader.
 661                                 //
 662                                 // Allow it to be used only to reset the password a single time
 663                                 // to a new value, which won't be in the user's e-mail ar-
 664                                 // chives.
 665                                 //
 666                                 // For backwards compatibility, we'll still recognize it at the
 667                                 // login form to minimize surprises for people who have been
 668                                 // logging in with a temporary password for some time.
 669                                 //
 670                                 // As a side-effect, we can authenticate the user's e-mail ad-
 671                                 // dress if it's not already done, since the temporary password
 672                                 // was sent via e-mail.
 673                                 if ( !$u->isEmailConfirmed() ) {
 674                                         $u->confirmEmail();
 675                                         $u->saveSettings();
 676                                 }
 677
 678                                 // At this point we just return an appropriate code/ indicating
 679                                 // that the UI should show a password reset form; bot inter-
 680                                 // faces etc will probably just fail cleanly here.
 681                                 $this->mAbortLoginErrorMsg = 'resetpass-temp-emailed';
 682                                 $this->mTempPasswordUsed = true;
 683                                 $retval = self::RESET_PASS;
 684                         } else {
 685                                 $retval = ( $this->mPassword == '' ) ? self::EMPTY_PASS : self::WRONG_PASS;
 686                         }
 687                 } elseif ( $wgBlockDisablesLogin && $u->isBlocked() ) {
 688                         // If we've enabled it, make it so that a blocked user cannot login
 689                         $retval = self::USER_BLOCKED;
 690                 } elseif ( $u->getPasswordExpired() == 'hard' ) {
 691                         // Force reset now, without logging in
 692                         $retval = self::RESET_PASS;
 693                         $this->mAbortLoginErrorMsg = 'resetpass-expired';
 694                 } else {
 695                         $wgAuth->updateUser( $u );
 696                         $wgUser = $u;
 697                         // This should set it for OutputPage and the Skin
 698                         // which is needed or the personal links will be
 699                         // wrong.
 700                         $this->getContext()->setUser( $u );
 701
 702                         // Please reset throttle for successful logins, thanks!
 703                         if ( $throttleCount ) {
 704                                 self::clearLoginThrottle( $this->mUsername );
 705                         }
 706
 707                         if ( $isAutoCreated ) {
 708                                 // Must be run after $wgUser is set, for correct new user log
 709                                 wfRunHooks( 'AuthPluginAutoCreate', array( $u ) );
 710                         }
 711
 712                         $retval = self::SUCCESS;
 713                 }
 714                 wfRunHooks( 'LoginAuthenticateAudit', array( $u, $this->mPassword, $retval ) );
 715
 716                 return $retval;
 717         }
 718
 719         /**
 720          * Increment the login attempt throttle hit count for the (username,current IP)
 721          * tuple unless the throttle was already reached.
 722          * @param string $username The user name
 723          * @return bool|int The integer hit count or True if it is already at the limit
 724          */
 725         public static function incLoginThrottle( $username ) {
 726                 global $wgPasswordAttemptThrottle, $wgMemc, $wgRequest;
 727                 $username = trim( $username ); // sanity
 728
 729                 $throttleCount = 0;
 730                 if ( is_array( $wgPasswordAttemptThrottle ) ) {
 731                         $throttleKey = wfMemcKey( 'password-throttle', $wgRequest->getIP(), md5( $username ) );
 732                         $count = $wgPasswordAttemptThrottle['count'];
 733                         $period = $wgPasswordAttemptThrottle['seconds'];
 734
 735                         $throttleCount = $wgMemc->get( $throttleKey );
 736                         if ( !$throttleCount ) {
 737                                 $wgMemc->add( $throttleKey, 1, $period ); // start counter
 738                         } elseif ( $throttleCount < $count ) {
 739                                 $wgMemc->incr( $throttleKey );
 740                         } elseif ( $throttleCount >= $count ) {
 741                                 return true;
 742                         }
 743                 }
 744
 745                 return $throttleCount;
 746         }
 747
 748         /**
 749          * Clear the login attempt throttle hit count for the (username,current IP) tuple.
 750          * @param string $username The user name
 751          * @return void
 752          */
 753         public static function clearLoginThrottle( $username ) {
 754                 global $wgMemc, $wgRequest;
 755                 $username = trim( $username ); // sanity
 756
 757                 $throttleKey = wfMemcKey( 'password-throttle', $wgRequest->getIP(), md5( $username ) );
 758                 $wgMemc->delete( $throttleKey );
 759         }
 760
 761         /**
 762          * Attempt to automatically create a user on login. Only succeeds if there
 763          * is an external authentication method which allows it.
 764          *
 765          * @param User $user
 766          *
 767          * @return int Status code
 768          */
 769         function attemptAutoCreate( $user ) {
 770                 global $wgAuth;
 771
 772                 if ( $this->getUser()->isBlockedFromCreateAccount() ) {
 773                         wfDebug( __METHOD__ . ": user is blocked from account creation\n" );
 774
 775                         return self::CREATE_BLOCKED;
 776                 }
 777
 778                 if ( !$wgAuth->autoCreate() ) {
 779                         return self::NOT_EXISTS;
 780                 }
 781
 782                 if ( !$wgAuth->userExists( $user->getName() ) ) {
 783                         wfDebug( __METHOD__ . ": user does not exist\n" );
 784
 785                         return self::NOT_EXISTS;
 786                 }
 787
 788                 if ( !$wgAuth->authenticate( $user->getName(), $this->mPassword ) ) {
 789                         wfDebug( __METHOD__ . ": \$wgAuth->authenticate() returned false, aborting\n" );
 790
 791                         return self::WRONG_PLUGIN_PASS;
 792                 }
 793
 794                 $abortError = '';
 795                 if ( !wfRunHooks( 'AbortAutoAccount', array( $user, &$abortError ) ) ) {
 796                         // Hook point to add extra creation throttles and blocks
 797                         wfDebug( "LoginForm::attemptAutoCreate: a hook blocked creation: $abortError\n" );
 798                         $this->mAbortLoginErrorMsg = $abortError;
 799
 800                         return self::ABORTED;
 801                 }
 802
 803                 wfDebug( __METHOD__ . ": creating account\n" );
 804                 $status = $this->initUser( $user, true );
 805
 806                 if ( !$status->isOK() ) {
 807                         $errors = $status->getErrorsByType( 'error' );
 808                         $this->mAbortLoginErrorMsg = $errors[0]['message'];
 809
 810                         return self::ABORTED;
 811                 }
 812
 813                 return self::SUCCESS;
 814         }
 815
 816         function processLogin() {
 817                 global $wgMemc, $wgLang, $wgSecureLogin, $wgPasswordAttemptThrottle,
 818                         $wgInvalidPasswordReset;
 819
 820                 switch ( $this->authenticateUserData() ) {
 821                         case self::SUCCESS:
 822                                 # We've verified now, update the real record
 823                                 $user = $this->getUser();
 824                                 $user->invalidateCache();
 825
 826                                 if ( $user->requiresHTTPS() ) {
 827                                         $this->mStickHTTPS = true;
 828                                 }
 829
 830                                 if ( $wgSecureLogin && !$this->mStickHTTPS ) {
 831                                         $user->setCookies( $this->mRequest, false, $this->mRemember );
 832                                 } else {
 833                                         $user->setCookies( $this->mRequest, null, $this->mRemember );
 834                                 }
 835                                 self::clearLoginToken();
 836
 837                                 // Reset the throttle
 838                                 $request = $this->getRequest();
 839                                 $key = wfMemcKey( 'password-throttle', $request->getIP(), md5( $this->mUsername ) );
 840                                 $wgMemc->delete( $key );
 841
 842                                 if ( $this->hasSessionCookie() || $this->mSkipCookieCheck ) {
 843                                         /* Replace the language object to provide user interface in
 844                                          * correct language immediately on this first page load.
 845                                          */
 846                                         $code = $request->getVal( 'uselang', $user->getOption( 'language' ) );
 847                                         $userLang = Language::factory( $code );
 848                                         $wgLang = $userLang;
 849                                         $this->getContext()->setLanguage( $userLang );
 850                                         // Reset SessionID on Successful login (bug 40995)
 851                                         $this->renewSessionId();
 852                                         if ( $this->getUser()->getPasswordExpired() == 'soft' ) {
 853                                                 $this->resetLoginForm( $this->msg( 'resetpass-expired-soft' ) );
 854                                         } elseif ( $wgInvalidPasswordReset
 855                                                 && !$user->isValidPassword( $this->mPassword )
 856                                         ) {
 857                                                 $status = $user->checkPasswordValidity( $this->mPassword );
 858                                                 $this->resetLoginForm(
 859                                                         $status->getMessage( 'resetpass-validity-soft' )
 860                                                 );
 861                                         } else {
 862                                                 $this->successfulLogin();
 863                                         }
 864                                 } else {
 865                                         $this->cookieRedirectCheck( 'login' );
 866                                 }
 867                                 break;
 868
 869                         case self::NEED_TOKEN:
 870                                 $error = $this->mAbortLoginErrorMsg ?: 'nocookiesforlogin';
 871                                 $this->mainLoginForm( $this->msg( $error )->parse() );
 872                                 break;
 873                         case self::WRONG_TOKEN:
 874                                 $error = $this->mAbortLoginErrorMsg ?: 'sessionfailure';
 875                                 $this->mainLoginForm( $this->msg( $error )->text() );
 876                                 break;
 877                         case self::NO_NAME:
 878                         case self::ILLEGAL:
 879                                 $error = $this->mAbortLoginErrorMsg ?: 'noname';
 880                                 $this->mainLoginForm( $this->msg( $error )->text() );
 881                                 break;
 882                         case self::WRONG_PLUGIN_PASS:
 883                                 $error = $this->mAbortLoginErrorMsg ?: 'wrongpassword';
 884                                 $this->mainLoginForm( $this->msg( $error )->text() );
 885                                 break;
 886                         case self::NOT_EXISTS:
 887                                 if ( $this->getUser()->isAllowed( 'createaccount' ) ) {
 888                                         $error = $this->mAbortLoginErrorMsg ?: 'nosuchuser';
 889                                         $this->mainLoginForm( $this->msg( $error,
 890                                                 wfEscapeWikiText( $this->mUsername ) )->parse() );
 891                                 } else {
 892                                         $error = $this->mAbortLoginErrorMsg ?: 'nosuchusershort';
 893                                         $this->mainLoginForm( $this->msg( $error,
 894                                                 wfEscapeWikiText( $this->mUsername ) )->text() );
 895                                 }
 896                                 break;
 897                         case self::WRONG_PASS:
 898                                 $error = $this->mAbortLoginErrorMsg ?: 'wrongpassword';
 899                                 $this->mainLoginForm( $this->msg( $error )->text() );
 900                                 break;
 901                         case self::EMPTY_PASS:
 902                                 $error = $this->mAbortLoginErrorMsg ?: 'wrongpasswordempty';
 903                                 $this->mainLoginForm( $this->msg( $error )->text() );
 904                                 break;
 905                         case self::RESET_PASS:
 906                                 $error = $this->mAbortLoginErrorMsg ?: 'resetpass_announce';
 907                                 $this->resetLoginForm( $this->msg( $error ) );
 908                                 break;
 909                         case self::CREATE_BLOCKED:
 910                                 $this->userBlockedMessage( $this->getUser()->isBlockedFromCreateAccount() );
 911                                 break;
 912                         case self::THROTTLED:
 913                                 $error = $this->mAbortLoginErrorMsg ?: 'login-throttled';
 914                                 $this->mainLoginForm( $this->msg( $error )
 915                                         ->params( $this->getLanguage()->formatDuration( $wgPasswordAttemptThrottle['seconds'] ) )
 916                                         ->text()
 917                                 );
 918                                 break;
 919                         case self::USER_BLOCKED:
 920                                 $error = $this->mAbortLoginErrorMsg ?: 'login-userblocked';
 921                                 $this->mainLoginForm( $this->msg( $error, $this->mUsername )->escaped() );
 922                                 break;
 923                         case self::ABORTED:
 924                                 $error = $this->mAbortLoginErrorMsg ?: 'login-abort-generic';
 925                                 $this->mainLoginForm( $this->msg( $error )->text() );
 926                                 break;
 927                         default:
 928                                 throw new MWException( 'Unhandled case value' );
 929                 }
 930         }
 931
 932         /**
 933          * Show the Special:ChangePassword form, with custom message
 934          * @param Message $msg
 935          */
 936         protected function resetLoginForm( Message $msg ) {
 937                 // Allow hooks to explain this password reset in more detail
 938                 wfRunHooks( 'LoginPasswordResetMessage', array( &$msg, $this->mUsername ) );
 939                 $reset = new SpecialChangePassword();
 940                 $derivative = new DerivativeContext( $this->getContext() );
 941                 $derivative->setTitle( $reset->getPageTitle() );
 942                 $reset->setContext( $derivative );
 943                 if ( !$this->mTempPasswordUsed ) {
 944                         $reset->setOldPasswordMessage( 'oldpassword' );
 945                 }
 946                 $reset->setChangeMessage( $msg );
 947                 $reset->execute( null );
 948         }
 949
 950         /**
 951          * @param User $u
 952          * @param bool $throttle
 953          * @param string $emailTitle Message name of email title
 954          * @param string $emailText Message name of email text
 955          * @return Status
 956          */
 957         function mailPasswordInternal( $u, $throttle = true, $emailTitle = 'passwordremindertitle',
 958                 $emailText = 'passwordremindertext'
 959         ) {
 960                 global $wgNewPasswordExpiry;
 961
 962                 if ( $u->getEmail() == '' ) {
 963                         return Status::newFatal( 'noemail', $u->getName() );
 964                 }
 965                 $ip = $this->getRequest()->getIP();
 966                 if ( !$ip ) {
 967                         return Status::newFatal( 'badipaddress' );
 968                 }
 969
 970                 $currentUser = $this->getUser();
 971                 wfRunHooks( 'User::mailPasswordInternal', array( &$currentUser, &$ip, &$u ) );
 972
 973                 $np = $u->randomPassword();
 974                 $u->setNewpassword( $np, $throttle );
 975                 $u->saveSettings();
 976                 $userLanguage = $u->getOption( 'language' );
 977
 978                 $mainPage = Title::newMainPage();
 979                 $mainPageUrl = $mainPage->getCanonicalURL();
 980
 981                 $m = $this->msg( $emailText, $ip, $u->getName(), $np, '<' . $mainPageUrl . '>',
 982                         round( $wgNewPasswordExpiry / 86400 ) )->inLanguage( $userLanguage )->text();
 983                 $result = $u->sendMail( $this->msg( $emailTitle )->inLanguage( $userLanguage )->text(), $m );
 984
 985                 return $result;
 986         }
 987
 988         /**
 989          * Run any hooks registered for logins, then HTTP redirect to
 990          * $this->mReturnTo (or Main Page if that's undefined).  Formerly we had a
 991          * nice message here, but that's really not as useful as just being sent to
 992          * wherever you logged in from.  It should be clear that the action was
 993          * successful, given the lack of error messages plus the appearance of your
 994          * name in the upper right.
 995          *
 996          * @private
 997          */
 998         function successfulLogin() {
 999                 # Run any hooks; display injected HTML if any, else redirect
1000                 $currentUser = $this->getUser();
1001                 $injected_html = '';
1002                 wfRunHooks( 'UserLoginComplete', array( &$currentUser, &$injected_html ) );
1003
1004                 if ( $injected_html !== '' ) {
1005                         $this->displaySuccessfulAction( $this->msg( 'loginsuccesstitle' ),
1006                                 'loginsuccess', $injected_html );
1007                 } else {
1008                         $this->executeReturnTo( 'successredirect' );
1009                 }
1010         }
1011
1012         /**
1013          * Run any hooks registered for logins, then display a message welcoming
1014          * the user.
1015          *
1016          * @private
1017          */
1018         function successfulCreation() {
1019                 # Run any hooks; display injected HTML
1020                 $currentUser = $this->getUser();
1021                 $injected_html = '';
1022                 $welcome_creation_msg = 'welcomecreation-msg';
1023
1024                 wfRunHooks( 'UserLoginComplete', array( &$currentUser, &$injected_html ) );
1025
1026                 /**
1027                  * Let any extensions change what message is shown.
1028                  * @see https://www.mediawiki.org/wiki/Manual:Hooks/BeforeWelcomeCreation
1029                  * @since 1.18
1030                  */
1031                 wfRunHooks( 'BeforeWelcomeCreation', array( &$welcome_creation_msg, &$injected_html ) );
1032
1033                 $this->displaySuccessfulAction( $this->msg( 'welcomeuser', $this->getUser()->getName() ),
1034                         $welcome_creation_msg, $injected_html );
1035         }
1036
1037         /**
1038          * Display an "successful action" page.
1039          *
1040          * @param string|Message $title Page's title
1041          * @param string $msgname
1042          * @param string $injected_html
1043          */
1044         private function displaySuccessfulAction( $title, $msgname, $injected_html ) {
1045                 $out = $this->getOutput();
1046                 $out->setPageTitle( $title );
1047                 if ( $msgname ) {
1048                         $out->addWikiMsg( $msgname, wfEscapeWikiText( $this->getUser()->getName() ) );
1049                 }
1050
1051                 $out->addHTML( $injected_html );
1052
1053                 $this->executeReturnTo( 'success' );
1054         }
1055
1056         /**
1057          * Output a message that informs the user that they cannot create an account because
1058          * there is a block on them or their IP which prevents account creation.  Note that
1059          * User::isBlockedFromCreateAccount(), which gets this block, ignores the 'hardblock'
1060          * setting on blocks (bug 13611).
1061          * @param Block $block The block causing this error
1062          * @throws ErrorPageError
1063          */
1064         function userBlockedMessage( Block $block ) {
1065                 # Let's be nice about this, it's likely that this feature will be used
1066                 # for blocking large numbers of innocent people, e.g. range blocks on
1067                 # schools. Don't blame it on the user. There's a small chance that it
1068                 # really is the user's fault, i.e. the username is blocked and they
1069                 # haven't bothered to log out before trying to create an account to
1070                 # evade it, but we'll leave that to their guilty conscience to figure
1071                 # out.
1072                 $errorParams = array(
1073                         $block->getTarget(),
1074                         $block->mReason ? $block->mReason : $this->msg( 'blockednoreason' )->text(),
1075                         $block->getByName()
1076                 );
1077
1078                 if ( $block->getType() === Block::TYPE_RANGE ) {
1079                         $errorMessage = 'cantcreateaccount-range-text';
1080                         $errorParams[] = $this->getRequest()->getIP();
1081                 } else {
1082                         $errorMessage = 'cantcreateaccount-text';
1083                 }
1084
1085                 throw new ErrorPageError(
1086                         'cantcreateaccounttitle',
1087                         $errorMessage,
1088                         $errorParams
1089                 );
1090         }
1091
1092         /**
1093          * Add a "return to" link or redirect to it.
1094          * Extensions can use this to reuse the "return to" logic after
1095          * inject steps (such as redirection) into the login process.
1096          *
1097          * @param string $type One of the following:
1098          *    - error: display a return to link ignoring $wgRedirectOnLogin
1099          *    - success: display a return to link using $wgRedirectOnLogin if needed
1100          *    - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
1101          * @param string $returnTo
1102          * @param array|string $returnToQuery
1103          * @param bool $stickHTTPs Keep redirect link on HTTPs
1104          * @since 1.22
1105          */
1106         public function showReturnToPage(
1107                 $type, $returnTo = '', $returnToQuery = '', $stickHTTPs = false
1108         ) {
1109                 $this->mReturnTo = $returnTo;
1110                 $this->mReturnToQuery = $returnToQuery;
1111                 $this->mStickHTTPS = $stickHTTPs;
1112                 $this->executeReturnTo( $type );
1113         }
1114
1115         /**
1116          * Add a "return to" link or redirect to it.
1117          *
1118          * @param string $type One of the following:
1119          *    - error: display a return to link ignoring $wgRedirectOnLogin
1120          *    - success: display a return to link using $wgRedirectOnLogin if needed
1121          *    - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
1122          */
1123         private function executeReturnTo( $type ) {
1124                 global $wgRedirectOnLogin, $wgSecureLogin;
1125
1126                 if ( $type != 'error' && $wgRedirectOnLogin !== null ) {
1127                         $returnTo = $wgRedirectOnLogin;
1128                         $returnToQuery = array();
1129                 } else {
1130                         $returnTo = $this->mReturnTo;
1131                         $returnToQuery = wfCgiToArray( $this->mReturnToQuery );
1132                 }
1133
1134                 $returnToTitle = Title::newFromText( $returnTo );
1135                 if ( !$returnToTitle ) {
1136                         $returnToTitle = Title::newMainPage();
1137                 }
1138
1139                 if ( $wgSecureLogin && !$this->mStickHTTPS ) {
1140                         $options = array( 'http' );
1141                         $proto = PROTO_HTTP;
1142                 } elseif ( $wgSecureLogin ) {
1143                         $options = array( 'https' );
1144                         $proto = PROTO_HTTPS;
1145                 } else {
1146                         $options = array();
1147                         $proto = PROTO_RELATIVE;
1148                 }
1149
1150                 if ( $type == 'successredirect' ) {
1151                         $redirectUrl = $returnToTitle->getFullURL( $returnToQuery, false, $proto );
1152                         $this->getOutput()->redirect( $redirectUrl );
1153                 } else {
1154                         $this->getOutput()->addReturnTo( $returnToTitle, $returnToQuery, null, $options );
1155                 }
1156         }
1157
1158         /**
1159          * @private
1160          */
1161         function mainLoginForm( $msg, $msgtype = 'error' ) {
1162                 global $wgEnableEmail, $wgEnableUserEmail;
1163                 global $wgHiddenPrefs, $wgLoginLanguageSelector;
1164                 global $wgAuth, $wgEmailConfirmToEdit, $wgCookieExpiration;
1165                 global $wgSecureLogin, $wgPasswordResetRoutes;
1166
1167                 $titleObj = $this->getPageTitle();
1168                 $user = $this->getUser();
1169                 $out = $this->getOutput();
1170
1171                 if ( $this->mType == 'signup' ) {
1172                         // Block signup here if in readonly. Keeps user from
1173                         // going through the process (filling out data, etc)
1174                         // and being informed later.
1175                         $permErrors = $titleObj->getUserPermissionsErrors( 'createaccount', $user, true );
1176                         if ( count( $permErrors ) ) {
1177                                 throw new PermissionsError( 'createaccount', $permErrors );
1178                         } elseif ( $user->isBlockedFromCreateAccount() ) {
1179                                 $this->userBlockedMessage( $user->isBlockedFromCreateAccount() );
1180
1181                                 return;
1182                         } elseif ( wfReadOnly() ) {
1183                                 throw new ReadOnlyError;
1184                         }
1185                 }
1186
1187                 // Pre-fill username (if not creating an account, bug 44775).
1188                 if ( $this->mUsername == '' && $this->mType != 'signup' ) {
1189                         if ( $user->isLoggedIn() ) {
1190                                 $this->mUsername = $user->getName();
1191                         } else {
1192                                 $this->mUsername = $this->getRequest()->getCookie( 'UserName' );
1193                         }
1194                 }
1195
1196                 // Generic styles and scripts for both login and signup form
1197                 $out->addModuleStyles( array(
1198                         'mediawiki.ui',
1199                         'mediawiki.ui.button',
1200                         'mediawiki.special.userlogin.common.styles'
1201                 ) );
1202                 $out->addModules( array(
1203                         'mediawiki.special.userlogin.common.js'
1204                 ) );
1205
1206                 if ( $this->mType == 'signup' ) {
1207                         // XXX hack pending RL or JS parse() support for complex content messages
1208                         // https://bugzilla.wikimedia.org/show_bug.cgi?id=25349
1209                         $out->addJsConfigVars( 'wgCreateacctImgcaptchaHelp',
1210                                 $this->msg( 'createacct-imgcaptcha-help' )->parse() );
1211
1212                         // Additional styles and scripts for signup form
1213                         $out->addModules( array(
1214                                 'mediawiki.special.userlogin.signup.js'
1215                         ) );
1216                         $out->addModuleStyles( array(
1217                                 'mediawiki.special.userlogin.signup.styles'
1218                         ) );
1219
1220                         $template = new UsercreateTemplate();
1221
1222                         // Must match number of benefits defined in messages
1223                         $template->set( 'benefitCount', 3 );
1224
1225                         $q = 'action=submitlogin&type=signup';
1226                         $linkq = 'type=login';
1227                 } else {
1228                         // Additional styles for login form
1229                         $out->addModuleStyles( array(
1230                                 'mediawiki.special.userlogin.login.styles'
1231                         ) );
1232
1233                         $template = new UserloginTemplate();
1234
1235                         $q = 'action=submitlogin&type=login';
1236                         $linkq = 'type=signup';
1237                 }
1238
1239                 if ( $this->mReturnTo !== '' ) {
1240                         $returnto = '&returnto=' . wfUrlencode( $this->mReturnTo );
1241                         if ( $this->mReturnToQuery !== '' ) {
1242                                 $returnto .= '&returntoquery=' .
1243                                         wfUrlencode( $this->mReturnToQuery );
1244                         }
1245                         $q .= $returnto;
1246                         $linkq .= $returnto;
1247                 }
1248
1249                 # Don't show a "create account" link if the user can't.
1250                 if ( $this->showCreateOrLoginLink( $user ) ) {
1251                         # Pass any language selection on to the mode switch link
1252                         if ( $wgLoginLanguageSelector && $this->mLanguage ) {
1253                                 $linkq .= '&uselang=' . $this->mLanguage;
1254                         }
1255                         // Supply URL, login template creates the button.
1256                         $template->set( 'createOrLoginHref', $titleObj->getLocalURL( $linkq ) );
1257                 } else {
1258                         $template->set( 'link', '' );
1259                 }
1260
1261                 $resetLink = $this->mType == 'signup'
1262                         ? null
1263                         : is_array( $wgPasswordResetRoutes ) && in_array( true, array_values( $wgPasswordResetRoutes ) );
1264
1265                 $template->set( 'header', '' );
1266                 $template->set( 'skin', $this->getSkin() );
1267                 $template->set( 'name', $this->mUsername );
1268                 $template->set( 'password', $this->mPassword );
1269                 $template->set( 'retype', $this->mRetype );
1270                 $template->set( 'createemailset', $this->mCreateaccountMail );
1271                 $template->set( 'email', $this->mEmail );
1272                 $template->set( 'realname', $this->mRealName );
1273                 $template->set( 'domain', $this->mDomain );
1274                 $template->set( 'reason', $this->mReason );
1275
1276                 $template->set( 'action', $titleObj->getLocalURL( $q ) );
1277                 $template->set( 'message', $msg );
1278                 $template->set( 'messagetype', $msgtype );
1279                 $template->set( 'createemail', $wgEnableEmail && $user->isLoggedIn() );
1280                 $template->set( 'userealname', !in_array( 'realname', $wgHiddenPrefs ) );
1281                 $template->set( 'useemail', $wgEnableEmail );
1282                 $template->set( 'emailrequired', $wgEmailConfirmToEdit );
1283                 $template->set( 'emailothers', $wgEnableUserEmail );
1284                 $template->set( 'canreset', $wgAuth->allowPasswordChange() );
1285                 $template->set( 'resetlink', $resetLink );
1286                 $template->set( 'canremember', ( $wgCookieExpiration > 0 ) );
1287                 $template->set( 'usereason', $user->isLoggedIn() );
1288                 $template->set( 'remember', $this->mRemember );
1289                 $template->set( 'cansecurelogin', ( $wgSecureLogin === true ) );
1290                 $template->set( 'stickhttps', (int)$this->mStickHTTPS );
1291                 $template->set( 'loggedin', $user->isLoggedIn() );
1292                 $template->set( 'loggedinuser', $user->getName() );
1293
1294                 if ( $this->mType == 'signup' ) {
1295                         if ( !self::getCreateaccountToken() ) {
1296                                 self::setCreateaccountToken();
1297                         }
1298                         $template->set( 'token', self::getCreateaccountToken() );
1299                 } else {
1300                         if ( !self::getLoginToken() ) {
1301                                 self::setLoginToken();
1302                         }
1303                         $template->set( 'token', self::getLoginToken() );
1304                 }
1305
1306                 # Prepare language selection links as needed
1307                 if ( $wgLoginLanguageSelector ) {
1308                         $template->set( 'languages', $this->makeLanguageSelector() );
1309                         if ( $this->mLanguage ) {
1310                                 $template->set( 'uselang', $this->mLanguage );
1311                         }
1312                 }
1313
1314                 $template->set( 'secureLoginUrl', $this->mSecureLoginUrl );
1315                 // Use loginend-https for HTTPS requests if it's not blank, loginend otherwise
1316                 // Ditto for signupend.  New forms use neither.
1317                 $usingHTTPS = $this->mRequest->getProtocol() == 'https';
1318                 $loginendHTTPS = $this->msg( 'loginend-https' );
1319                 $signupendHTTPS = $this->msg( 'signupend-https' );
1320                 if ( $usingHTTPS && !$loginendHTTPS->isBlank() ) {
1321                         $template->set( 'loginend', $loginendHTTPS->parse() );
1322                 } else {
1323                         $template->set( 'loginend', $this->msg( 'loginend' )->parse() );
1324                 }
1325                 if ( $usingHTTPS && !$signupendHTTPS->isBlank() ) {
1326                         $template->set( 'signupend', $signupendHTTPS->parse() );
1327                 } else {
1328                         $template->set( 'signupend', $this->msg( 'signupend' )->parse() );
1329                 }
1330
1331                 // Give authentication and captcha plugins a chance to modify the form
1332                 $wgAuth->modifyUITemplate( $template, $this->mType );
1333                 if ( $this->mType == 'signup' ) {
1334                         wfRunHooks( 'UserCreateForm', array( &$template ) );
1335                 } else {
1336                         wfRunHooks( 'UserLoginForm', array( &$template ) );
1337                 }
1338
1339                 $out->disallowUserJs(); // just in case...
1340                 $out->addTemplate( $template );
1341         }
1342
1343         /**
1344          * Whether the login/create account form should display a link to the
1345          * other form (in addition to whatever the skin provides).
1346          *
1347          * @param User $user
1348          * @return bool
1349          */
1350         private function showCreateOrLoginLink( &$user ) {
1351                 if ( $this->mType == 'signup' ) {
1352                         return true;
1353                 } elseif ( $user->isAllowed( 'createaccount' ) ) {
1354                         return true;
1355                 } else {
1356                         return false;
1357                 }
1358         }
1359
1360         /**
1361          * Check if a session cookie is present.
1362          *
1363          * This will not pick up a cookie set during _this_ request, but is meant
1364          * to ensure that the client is returning the cookie which was set on a
1365          * previous pass through the system.
1366          *
1367          * @private
1368          * @return bool
1369          */
1370         function hasSessionCookie() {
1371                 global $wgDisableCookieCheck;
1372
1373                 return $wgDisableCookieCheck ? true : $this->getRequest()->checkSessionCookie();
1374         }
1375
1376         /**
1377          * Get the login token from the current session
1378          * @return mixed
1379          */
1380         public static function getLoginToken() {
1381                 global $wgRequest;
1382
1383                 return $wgRequest->getSessionData( 'wsLoginToken' );
1384         }
1385
1386         /**
1387          * Randomly generate a new login token and attach it to the current session
1388          */
1389         public static function setLoginToken() {
1390                 global $wgRequest;
1391                 // Generate a token directly instead of using $user->getEditToken()
1392                 // because the latter reuses $_SESSION['wsEditToken']
1393                 $wgRequest->setSessionData( 'wsLoginToken', MWCryptRand::generateHex( 32 ) );
1394         }
1395
1396         /**
1397          * Remove any login token attached to the current session
1398          */
1399         public static function clearLoginToken() {
1400                 global $wgRequest;
1401                 $wgRequest->setSessionData( 'wsLoginToken', null );
1402         }
1403
1404         /**
1405          * Get the createaccount token from the current session
1406          * @return mixed
1407          */
1408         public static function getCreateaccountToken() {
1409                 global $wgRequest;
1410
1411                 return $wgRequest->getSessionData( 'wsCreateaccountToken' );
1412         }
1413
1414         /**
1415          * Randomly generate a new createaccount token and attach it to the current session
1416          */
1417         public static function setCreateaccountToken() {
1418                 global $wgRequest;
1419                 $wgRequest->setSessionData( 'wsCreateaccountToken', MWCryptRand::generateHex( 32 ) );
1420         }
1421
1422         /**
1423          * Remove any createaccount token attached to the current session
1424          */
1425         public static function clearCreateaccountToken() {
1426                 global $wgRequest;
1427                 $wgRequest->setSessionData( 'wsCreateaccountToken', null );
1428         }
1429
1430         /**
1431          * Renew the user's session id, using strong entropy
1432          */
1433         private function renewSessionId() {
1434                 global $wgSecureLogin, $wgCookieSecure;
1435                 if ( $wgSecureLogin && !$this->mStickHTTPS ) {
1436                         $wgCookieSecure = false;
1437                 }
1438
1439                 wfResetSessionID();
1440         }
1441
1442         /**
1443          * @private
1444          */
1445         function cookieRedirectCheck( $type ) {
1446                 $titleObj = SpecialPage::getTitleFor( 'Userlogin' );
1447                 $query = array( 'wpCookieCheck' => $type );
1448                 if ( $this->mReturnTo !== '' ) {
1449                         $query['returnto'] = $this->mReturnTo;
1450                         $query['returntoquery'] = $this->mReturnToQuery;
1451                 }
1452                 $check = $titleObj->getFullURL( $query );
1453
1454                 $this->getOutput()->redirect( $check );
1455         }
1456
1457         /**
1458          * @private
1459          */
1460         function onCookieRedirectCheck( $type ) {
1461                 if ( !$this->hasSessionCookie() ) {
1462                         if ( $type == 'new' ) {
1463                                 $this->mainLoginForm( $this->msg( 'nocookiesnew' )->parse() );
1464                         } elseif ( $type == 'login' ) {
1465                                 $this->mainLoginForm( $this->msg( 'nocookieslogin' )->parse() );
1466                         } else {
1467                                 # shouldn't happen
1468                                 $this->mainLoginForm( $this->msg( 'error' )->text() );
1469                         }
1470                 } else {
1471                         $this->successfulLogin();
1472                 }
1473         }
1474
1475         /**
1476          * Produce a bar of links which allow the user to select another language
1477          * during login/registration but retain "returnto"
1478          *
1479          * @return string
1480          */
1481         function makeLanguageSelector() {
1482                 $msg = $this->msg( 'loginlanguagelinks' )->inContentLanguage();
1483                 if ( !$msg->isBlank() ) {
1484                         $langs = explode( "\n", $msg->text() );
1485                         $links = array();
1486                         foreach ( $langs as $lang ) {
1487                                 $lang = trim( $lang, '* ' );
1488                                 $parts = explode( '|', $lang );
1489                                 if ( count( $parts ) >= 2 ) {
1490                                         $links[] = $this->makeLanguageSelectorLink( $parts[0], trim( $parts[1] ) );
1491                                 }
1492                         }
1493
1494                         return count( $links ) > 0 ? $this->msg( 'loginlanguagelabel' )->rawParams(
1495                                 $this->getLanguage()->pipeList( $links ) )->escaped() : '';
1496                 } else {
1497                         return '';
1498                 }
1499         }
1500
1501         /**
1502          * Create a language selector link for a particular language
1503          * Links back to this page preserving type and returnto
1504          *
1505          * @param string $text Link text
1506          * @param string $lang Language code
1507          * @return string
1508          */
1509         function makeLanguageSelectorLink( $text, $lang ) {
1510                 if ( $this->getLanguage()->getCode() == $lang ) {
1511                         // no link for currently used language
1512                         return htmlspecialchars( $text );
1513                 }
1514                 $query = array( 'uselang' => $lang );
1515                 if ( $this->mType == 'signup' ) {
1516                         $query['type'] = 'signup';
1517                 }
1518                 if ( $this->mReturnTo !== '' ) {
1519                         $query['returnto'] = $this->mReturnTo;
1520                         $query['returntoquery'] = $this->mReturnToQuery;
1521                 }
1522
1523                 $attr = array();
1524                 $targetLanguage = Language::factory( $lang );
1525                 $attr['lang'] = $attr['hreflang'] = $targetLanguage->getHtmlCode();
1526
1527                 return Linker::linkKnown(
1528                         $this->getPageTitle(),
1529                         htmlspecialchars( $text ),
1530                         $attr,
1531                         $query
1532                 );
1533         }
1534
1535         protected function getGroupName() {
1536                 return 'login';
1537         }
1538 }