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