includes/specialpage/LoginSignupSpecialPage.php

   1 <?php
   2 /**
   3  * Holds shared logic for login and account creation pages.
   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 use MediaWiki\Auth\AuthenticationRequest;
  25 use MediaWiki\Auth\AuthenticationResponse;
  26 use MediaWiki\Auth\AuthManager;
  27 use MediaWiki\Auth\Throttler;
  28 use MediaWiki\Logger\LoggerFactory;
  29 use MediaWiki\Session\SessionManager;
  30
  31 /**
  32  * Holds shared logic for login and account creation pages.
  33  *
  34  * @ingroup SpecialPage
  35  */
  36 abstract class LoginSignupSpecialPage extends AuthManagerSpecialPage {
  37         protected $mReturnTo;
  38         protected $mPosted;
  39         protected $mAction;
  40         protected $mLanguage;
  41         protected $mReturnToQuery;
  42         protected $mToken;
  43         protected $mStickHTTPS;
  44         protected $mFromHTTP;
  45         protected $mEntryError = '';
  46         protected $mEntryErrorType = 'error';
  47
  48         protected $mLoaded = false;
  49         protected $mLoadedRequest = false;
  50         protected $mSecureLoginUrl;
  51
  52         /** @var string */
  53         protected $securityLevel;
  54
  55         /** @var bool True if the user if creating an account for someone else. Flag used for internal
  56          * communication, only set at the very end. */
  57         protected $proxyAccountCreation;
  58         /** @var User FIXME another flag for passing data. */
  59         protected $targetUser;
  60
  61         /** @var HTMLForm */
  62         protected $authForm;
  63
  64         /** @var FakeAuthTemplate */
  65         protected $fakeTemplate;
  66
  67         abstract protected function isSignup();
  68
  69         /**
  70          * @param bool $direct True if the action was successful just now; false if that happened
  71          *    pre-redirection (so this handler was called already)
  72          * @param StatusValue|null $extraMessages
  73          * @return void
  74          */
  75         abstract protected function successfulAction( $direct = false, $extraMessages = null );
  76
  77         /**
  78          * Logs to the authmanager-stats channel.
  79          * @param bool $success
  80          * @param string|null $status Error message key
  81          */
  82         abstract protected function logAuthResult( $success, $status = null );
  83
  84         public function __construct( $name ) {
  85                 global $wgUseMediaWikiUIEverywhere;
  86                 parent::__construct( $name );
  87
  88                 // Override UseMediaWikiEverywhere to true, to force login and create form to use mw ui
  89                 $wgUseMediaWikiUIEverywhere = true;
  90         }
  91
  92         protected function setRequest( array $data, $wasPosted = null ) {
  93                 parent::setRequest( $data, $wasPosted );
  94                 $this->mLoadedRequest = false;
  95         }
  96
  97         /**
  98          * Load basic request parameters for this Special page.
  99          * @param $subPage
 100          */
 101         private function loadRequestParameters( $subPage ) {
 102                 if ( $this->mLoadedRequest ) {
 103                         return;
 104                 }
 105                 $this->mLoadedRequest = true;
 106                 $request = $this->getRequest();
 107
 108                 $this->mPosted = $request->wasPosted();
 109                 $this->mIsReturn = $subPage === 'return';
 110                 $this->mAction = $request->getVal( 'action' );
 111                 $this->mFromHTTP = $request->getBool( 'fromhttp', false )
 112                         || $request->getBool( 'wpFromhttp', false );
 113                 $this->mStickHTTPS = ( !$this->mFromHTTP && $request->getProtocol() === 'https' )
 114                         || $request->getBool( 'wpForceHttps', false );
 115                 $this->mLanguage = $request->getText( 'uselang' );
 116                 $this->mReturnTo = $request->getVal( 'returnto', '' );
 117                 $this->mReturnToQuery = $request->getVal( 'returntoquery', '' );
 118         }
 119
 120         /**
 121          * Load data from request.
 122          * @private
 123          * @param string $subPage Subpage of Special:Userlogin
 124          */
 125         protected function load( $subPage ) {
 126                 global $wgSecureLogin;
 127
 128                 $this->loadRequestParameters( $subPage );
 129                 if ( $this->mLoaded ) {
 130                         return;
 131                 }
 132                 $this->mLoaded = true;
 133                 $request = $this->getRequest();
 134
 135                 $securityLevel = $this->getRequest()->getText( 'force' );
 136                 if (
 137                         $securityLevel && AuthManager::singleton()->securitySensitiveOperationStatus(
 138                                 $securityLevel ) === AuthManager::SEC_REAUTH
 139                 ) {
 140                         $this->securityLevel = $securityLevel;
 141                 }
 142
 143                 $this->loadAuth( $subPage );
 144
 145                 $this->mToken = $request->getVal( $this->getTokenName() );
 146
 147                 // Show an error or warning passed on from a previous page
 148                 $entryError = $this->msg( $request->getVal( 'error', '' ) );
 149                 $entryWarning = $this->msg( $request->getVal( 'warning', '' ) );
 150                 // bc: provide login link as a parameter for messages where the translation
 151                 // was not updated
 152                 $loginreqlink = Linker::linkKnown(
 153                         $this->getPageTitle(),
 154                         $this->msg( 'loginreqlink' )->escaped(),
 155                         [],
 156                         [
 157                                 'returnto' => $this->mReturnTo,
 158                                 'returntoquery' => $this->mReturnToQuery,
 159                                 'uselang' => $this->mLanguage,
 160                                 'fromhttp' => $wgSecureLogin && $this->mFromHTTP ? '1' : null,
 161                         ]
 162                 );
 163
 164                 // Only show valid error or warning messages.
 165                 if ( $entryError->exists()
 166                         && in_array( $entryError->getKey(), LoginHelper::getValidErrorMessages(), true )
 167                 ) {
 168                         $this->mEntryErrorType = 'error';
 169                         $this->mEntryError = $entryError->rawParams( $loginreqlink )->parse();
 170
 171                 } elseif ( $entryWarning->exists()
 172                         && in_array( $entryWarning->getKey(), LoginHelper::getValidErrorMessages(), true )
 173                 ) {
 174                         $this->mEntryErrorType = 'warning';
 175                         $this->mEntryError = $entryWarning->rawParams( $loginreqlink )->parse();
 176                 }
 177
 178                 # 1. When switching accounts, it sucks to get automatically logged out
 179                 # 2. Do not return to PasswordReset after a successful password change
 180                 #    but goto Wiki start page (Main_Page) instead ( bug 33997 )
 181                 $returnToTitle = Title::newFromText( $this->mReturnTo );
 182                 if ( is_object( $returnToTitle )
 183                         && ( $returnToTitle->isSpecial( 'Userlogout' )
 184                                 || $returnToTitle->isSpecial( 'PasswordReset' ) )
 185                 ) {
 186                         $this->mReturnTo = '';
 187                         $this->mReturnToQuery = '';
 188                 }
 189         }
 190
 191         protected function getPreservedParams( $withToken = false ) {
 192                 global $wgSecureLogin;
 193
 194                 $params = parent::getPreservedParams( $withToken );
 195                 $params += [
 196                         'returnto' => $this->mReturnTo ?: null,
 197                         'returntoquery' => $this->mReturnToQuery ?: null,
 198                 ];
 199                 if ( $wgSecureLogin && !$this->isSignup() ) {
 200                         $params['fromhttp'] = $this->mFromHTTP ? '1' : null;
 201                 }
 202                 return $params;
 203         }
 204
 205         protected function beforeExecute( $subPage ) {
 206                 // finish initializing the class before processing the request - T135924
 207                 $this->loadRequestParameters( $subPage );
 208                 return parent::beforeExecute( $subPage );
 209         }
 210
 211         /**
 212          * @param string|null $subPage
 213          */
 214         public function execute( $subPage ) {
 215                 $authManager = AuthManager::singleton();
 216                 $session = SessionManager::getGlobalSession();
 217
 218                 // Session data is used for various things in the authentication process, so we must make
 219                 // sure a session cookie or some equivalent mechanism is set.
 220                 $session->persist();
 221
 222                 $this->load( $subPage );
 223                 $this->setHeaders();
 224                 $this->checkPermissions();
 225
 226                 // Make sure it's possible to log in
 227                 if ( !$this->isSignup() && !$session->canSetUser() ) {
 228                         throw new ErrorPageError( 'cannotloginnow-title', 'cannotloginnow-text', [
 229                                         $session->getProvider()->describe( RequestContext::getMain()->getLanguage() )
 230                                 ] );
 231                 }
 232
 233                 /*
 234                  * In the case where the user is already logged in, and was redirected to
 235                  * the login form from a page that requires login, do not show the login
 236                  * page. The use case scenario for this is when a user opens a large number
 237                  * of tabs, is redirected to the login page on all of them, and then logs
 238                  * in on one, expecting all the others to work properly.
 239                  *
 240                  * However, do show the form if it was visited intentionally (no 'returnto'
 241                  * is present). People who often switch between several accounts have grown
 242                  * accustomed to this behavior.
 243                  *
 244                  * Also make an exception when force=<level> is set in the URL, which means the user must
 245                  * reauthenticate for security reasons.
 246                  */
 247                 if ( !$this->isSignup() && !$this->mPosted && !$this->securityLevel &&
 248                          ( $this->mReturnTo !== '' || $this->mReturnToQuery !== '' ) &&
 249                          $this->getUser()->isLoggedIn()
 250                 ) {
 251                         $this->successfulAction();
 252                 }
 253
 254                 // If logging in and not on HTTPS, either redirect to it or offer a link.
 255                 global $wgSecureLogin;
 256                 if ( $this->getRequest()->getProtocol() !== 'https' ) {
 257                         $title = $this->getFullTitle();
 258                         $query = $this->getPreservedParams( false ) + [
 259                                         'title' => null,
 260                                         ( $this->mEntryErrorType === 'error' ? 'error'
 261                                                 : 'warning' ) => $this->mEntryError,
 262                                 ] + $this->getRequest()->getQueryValues();
 263                         $url = $title->getFullURL( $query, false, PROTO_HTTPS );
 264                         if ( $wgSecureLogin && !$this->mFromHTTP &&
 265                                  wfCanIPUseHTTPS( $this->getRequest()->getIP() )
 266                         ) {
 267                                 // Avoid infinite redirect
 268                                 $url = wfAppendQuery( $url, 'fromhttp=1' );
 269                                 $this->getOutput()->redirect( $url );
 270                                 // Since we only do this redir to change proto, always vary
 271                                 $this->getOutput()->addVaryHeader( 'X-Forwarded-Proto' );
 272
 273                                 return;
 274                         } else {
 275                                 // A wiki without HTTPS login support should set $wgServer to
 276                                 // http://somehost, in which case the secure URL generated
 277                                 // above won't actually start with https://
 278                                 if ( substr( $url, 0, 8 ) === 'https://' ) {
 279                                         $this->mSecureLoginUrl = $url;
 280                                 }
 281                         }
 282                 }
 283
 284                 if ( !$this->isActionAllowed( $this->authAction ) ) {
 285                         // FIXME how do we explain this to the user? can we handle session loss better?
 286                         // messages used: authpage-cannot-login, authpage-cannot-login-continue,
 287                         // authpage-cannot-create, authpage-cannot-create-continue
 288                         $this->mainLoginForm( [], 'authpage-cannot-' . $this->authAction );
 289                         return;
 290                 }
 291
 292                 $status = $this->trySubmit();
 293
 294                 if ( !$status || !$status->isGood() ) {
 295                         $this->mainLoginForm( $this->authRequests, $status ? $status->getMessage() : '', 'error' );
 296                         return;
 297                 }
 298
 299                 /** @var AuthenticationResponse $response */
 300                 $response = $status->getValue();
 301
 302                 $returnToUrl = $this->getPageTitle( 'return' )
 303                         ->getFullURL( $this->getPreservedParams( true ), false, PROTO_HTTPS );
 304                 switch ( $response->status ) {
 305                         case AuthenticationResponse::PASS:
 306                                 $this->logAuthResult( true );
 307                                 $this->proxyAccountCreation = $this->isSignup() && !$this->getUser()->isAnon();
 308                                 $this->targetUser = User::newFromName( $response->username );
 309
 310                                 if (
 311                                         !$this->proxyAccountCreation
 312                                         && $response->loginRequest
 313                                         && $authManager->canAuthenticateNow()
 314                                 ) {
 315                                         // successful registration; log the user in instantly
 316                                         $response2 = $authManager->beginAuthentication( [ $response->loginRequest ],
 317                                                 $returnToUrl );
 318                                         if ( $response2->status !== AuthenticationResponse::PASS ) {
 319                                                 LoggerFactory::getInstance( 'login' )
 320                                                         ->error( 'Could not log in after account creation' );
 321                                                 $this->successfulAction( true, Status::newFatal( 'createacct-loginerror' ) );
 322                                                 break;
 323                                         }
 324                                 }
 325
 326                                 if ( !$this->proxyAccountCreation ) {
 327                                         // Ensure that the context user is the same as the session user.
 328                                         $this->setSessionUserForCurrentRequest();
 329                                 }
 330
 331                                 $this->successfulAction( true );
 332                                 break;
 333                         case AuthenticationResponse::FAIL:
 334                                 // fall through
 335                         case AuthenticationResponse::RESTART:
 336                                 unset( $this->authForm );
 337                                 if ( $response->status === AuthenticationResponse::FAIL ) {
 338                                         $action = $this->getDefaultAction( $subPage );
 339                                         $messageType = 'error';
 340                                 } else {
 341                                         $action = $this->getContinueAction( $this->authAction );
 342                                         $messageType = 'warning';
 343                                 }
 344                                 $this->logAuthResult( false, $response->message ? $response->message->getKey() : '-' );
 345                                 $this->loadAuth( $subPage, $action, true );
 346                                 $this->mainLoginForm( $this->authRequests, $response->message, $messageType );
 347                                 break;
 348                         case AuthenticationResponse::REDIRECT:
 349                                 unset( $this->authForm );
 350                                 $this->getOutput()->redirect( $response->redirectTarget );
 351                                 break;
 352                         case AuthenticationResponse::UI:
 353                                 unset( $this->authForm );
 354                                 $this->authAction = $this->isSignup() ? AuthManager::ACTION_CREATE_CONTINUE
 355                                         : AuthManager::ACTION_LOGIN_CONTINUE;
 356                                 $this->authRequests = $response->neededRequests;
 357                                 $this->mainLoginForm( $response->neededRequests, $response->message, 'warning' );
 358                                 break;
 359                         default:
 360                                 throw new LogicException( 'invalid AuthenticationResponse' );
 361                 }
 362         }
 363
 364         /**
 365          * Show the success page.
 366          *
 367          * @param string $type Condition of return to; see `executeReturnTo`
 368          * @param string|Message $title Page's title
 369          * @param string $msgname
 370          * @param string $injected_html
 371          * @param StatusValue|null $extraMessages
 372          */
 373         protected function showSuccessPage(
 374                 $type, $title, $msgname, $injected_html, $extraMessages
 375         ) {
 376                 $out = $this->getOutput();
 377                 $out->setPageTitle( $title );
 378                 if ( $msgname ) {
 379                         $out->addWikiMsg( $msgname, wfEscapeWikiText( $this->getUser()->getName() ) );
 380                 }
 381                 if ( $extraMessages ) {
 382                         $extraMessages = Status::wrap( $extraMessages );
 383                         $out->addWikiText( $extraMessages->getWikiText() );
 384                 }
 385
 386                 $out->addHTML( $injected_html );
 387
 388                 $helper = new LoginHelper( $this->getContext() );
 389                 $helper->showReturnToPage( $type, $this->mReturnTo, $this->mReturnToQuery, $this->mStickHTTPS );
 390         }
 391
 392         /**
 393          * Add a "return to" link or redirect to it.
 394          * Extensions can use this to reuse the "return to" logic after
 395          * inject steps (such as redirection) into the login process.
 396          *
 397          * @param string $type One of the following:
 398          *    - error: display a return to link ignoring $wgRedirectOnLogin
 399          *    - signup: display a return to link using $wgRedirectOnLogin if needed
 400          *    - success: display a return to link using $wgRedirectOnLogin if needed
 401          *    - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
 402          * @param string $returnTo
 403          * @param array|string $returnToQuery
 404          * @param bool $stickHTTPS Keep redirect link on HTTPS
 405          * @since 1.22
 406          */
 407         public function showReturnToPage(
 408                 $type, $returnTo = '', $returnToQuery = '', $stickHTTPS = false
 409         ) {
 410                 $helper = new LoginHelper( $this->getContext() );
 411                 $helper->showReturnToPage( $type, $returnTo, $returnToQuery, $stickHTTPS );
 412         }
 413
 414         /**
 415          * Replace some globals to make sure the fact that the user has just been logged in is
 416          * reflected in the current request.
 417          * @param User $user
 418          */
 419         protected function setSessionUserForCurrentRequest() {
 420                 global $wgUser, $wgLang;
 421
 422                 $context = RequestContext::getMain();
 423                 $localContext = $this->getContext();
 424                 if ( $context !== $localContext ) {
 425                         // remove AuthManagerSpecialPage context hack
 426                         $this->setContext( $context );
 427                 }
 428
 429                 $user = $context->getRequest()->getSession()->getUser();
 430
 431                 $wgUser = $user;
 432                 $context->setUser( $user );
 433
 434                 $code = $this->getRequest()->getVal( 'uselang', $user->getOption( 'language' ) );
 435                 $userLang = Language::factory( $code );
 436                 $wgLang = $userLang;
 437                 $context->setLanguage( $userLang );
 438         }
 439
 440         /**
 441          * @param AuthenticationRequest[] $requests A list of AuthorizationRequest objects,
 442          *   used to generate the form fields. An empty array means a fatal error
 443          *   (authentication cannot continue).
 444          * @param string|Message $msg
 445          * @param string $msgtype
 446          * @throws ErrorPageError
 447          * @throws Exception
 448          * @throws FatalError
 449          * @throws MWException
 450          * @throws PermissionsError
 451          * @throws ReadOnlyError
 452          * @private
 453          */
 454         protected function mainLoginForm( array $requests, $msg = '', $msgtype = 'error' ) {
 455                 $titleObj = $this->getPageTitle();
 456                 $user = $this->getUser();
 457                 $out = $this->getOutput();
 458
 459                 // FIXME how to handle empty $requests - restart, or no form, just an error message?
 460                 // no form would be better for no session type errors, restart is better when can* fails.
 461                 if ( !$requests ) {
 462                         $this->authAction = $this->getDefaultAction( $this->subPage );
 463                         $this->authForm = null;
 464                         $requests = AuthManager::singleton()->getAuthenticationRequests( $this->authAction, $user );
 465                 }
 466
 467                 // Generic styles and scripts for both login and signup form
 468                 $out->addModuleStyles( [
 469                         'mediawiki.ui',
 470                         'mediawiki.ui.button',
 471                         'mediawiki.ui.checkbox',
 472                         'mediawiki.ui.input',
 473                         'mediawiki.special.userlogin.common.styles'
 474                 ] );
 475                 if ( $this->isSignup() ) {
 476                         // XXX hack pending RL or JS parse() support for complex content messages T27349
 477                         $out->addJsConfigVars( 'wgCreateacctImgcaptchaHelp',
 478                                 $this->msg( 'createacct-imgcaptcha-help' )->parse() );
 479
 480                         // Additional styles and scripts for signup form
 481                         $out->addModules( [
 482                                 'mediawiki.special.userlogin.signup.js'
 483                         ] );
 484                         $out->addModuleStyles( [
 485                                 'mediawiki.special.userlogin.signup.styles'
 486                         ] );
 487                 } else {
 488                         // Additional styles for login form
 489                         $out->addModuleStyles( [
 490                                 'mediawiki.special.userlogin.login.styles'
 491                         ] );
 492                 }
 493                 $out->disallowUserJs(); // just in case...
 494
 495                 $form = $this->getAuthForm( $requests, $this->authAction, $msg, $msgtype );
 496                 $form->prepareForm();
 497                 $formHtml = $form->getHTML( $msg ? Status::newFatal( $msg ) : false );
 498
 499                 $out->addHTML( $this->getPageHtml( $formHtml ) );
 500         }
 501
 502         /**
 503          * Add page elements which are outside the form.
 504          * FIXME this should probably be a template, but use a sane language (handlebars?)
 505          * @param string $formHtml
 506          * @return string
 507          */
 508         protected function getPageHtml( $formHtml ) {
 509                 global $wgLoginLanguageSelector;
 510
 511                 $loginPrompt = $this->isSignup() ? '' : Html::rawElement( 'div',
 512                         [ 'id' => 'userloginprompt' ], $this->msg( 'loginprompt' )->parseAsBlock() );
 513                 $languageLinks = $wgLoginLanguageSelector ? $this->makeLanguageSelector() : '';
 514                 $signupStartMsg = $this->msg( 'signupstart' );
 515                 $signupStart = ( $this->isSignup() && !$signupStartMsg->isDisabled() )
 516                         ? Html::rawElement( 'div', [ 'id' => 'signupstart' ], $signupStartMsg->parseAsBlock() ) : '';
 517                 if ( $languageLinks ) {
 518                         $languageLinks = Html::rawElement( 'div', [ 'id' => 'languagelinks' ],
 519                                 Html::rawElement( 'p', [], $languageLinks )
 520                         );
 521                 }
 522
 523                 $benefitsContainer = '';
 524                 if ( $this->isSignup() && $this->showExtraInformation() ) {
 525                         // messages used:
 526                         // createacct-benefit-icon1 createacct-benefit-head1 createacct-benefit-body1
 527                         // createacct-benefit-icon2 createacct-benefit-head2 createacct-benefit-body2
 528                         // createacct-benefit-icon3 createacct-benefit-head3 createacct-benefit-body3
 529                         $benefitCount = 3;
 530                         $benefitList = '';
 531                         for ( $benefitIdx = 1; $benefitIdx <= $benefitCount; $benefitIdx++ ) {
 532                                 $headUnescaped = $this->msg( "createacct-benefit-head$benefitIdx" )->text();
 533                                 $iconClass = $this->msg( "createacct-benefit-icon$benefitIdx" )->escaped();
 534                                 $benefitList .= Html::rawElement( 'div', [ 'class' => "mw-number-text $iconClass" ],
 535                                         Html::rawElement( 'h3', [],
 536                                                 $this->msg( "createacct-benefit-head$benefitIdx" )->escaped()
 537                                         )
 538                                         . Html::rawElement( 'p', [],
 539                                                 $this->msg( "createacct-benefit-body$benefitIdx" )->params( $headUnescaped )->escaped()
 540                                         )
 541                                 );
 542                         }
 543                         $benefitsContainer = Html::rawElement( 'div', [ 'class' => 'mw-createacct-benefits-container' ],
 544                                 Html::rawElement( 'h2', [], $this->msg( 'createacct-benefit-heading' )->escaped() )
 545                                 . Html::rawElement( 'div', [ 'class' => 'mw-createacct-benefits-list' ],
 546                                         $benefitList
 547                                 )
 548                         );
 549                 }
 550
 551                 $html = Html::rawElement( 'div', [ 'class' => 'mw-ui-container' ],
 552                         $loginPrompt
 553                         . $languageLinks
 554                         . $signupStart
 555                         . Html::rawElement( 'div', [ 'id' => 'userloginForm' ],
 556                                 $formHtml
 557                         )
 558                         . $benefitsContainer
 559                 );
 560
 561                 return $html;
 562         }
 563
 564         /**
 565          * Generates a form from the given request.
 566          * @param AuthenticationRequest[] $requests
 567          * @param string $action AuthManager action name
 568          * @param string|Message $msg
 569          * @param string $msgType
 570          * @return HTMLForm
 571          */
 572         protected function getAuthForm( array $requests, $action, $msg = '', $msgType = 'error' ) {
 573                 global $wgSecureLogin, $wgLoginLanguageSelector;
 574                 // FIXME merge this with parent
 575
 576                 if ( isset( $this->authForm ) ) {
 577                         return $this->authForm;
 578                 }
 579
 580                 $usingHTTPS = $this->getRequest()->getProtocol() === 'https';
 581
 582                 // get basic form description from the auth logic
 583                 $fieldInfo = AuthenticationRequest::mergeFieldInfo( $requests );
 584                 $fakeTemplate = $this->getFakeTemplate( $msg, $msgType );
 585                 $this->fakeTemplate = $fakeTemplate; // FIXME there should be a saner way to pass this to the hook
 586                 // this will call onAuthChangeFormFields()
 587                 $formDescriptor = static::fieldInfoToFormDescriptor( $requests, $fieldInfo, $this->authAction );
 588                 $this->postProcessFormDescriptor( $formDescriptor );
 589
 590                 $context = $this->getContext();
 591                 if ( $context->getRequest() !== $this->getRequest() ) {
 592                         // We have overridden the request, need to make sure the form uses that too.
 593                         $context = new DerivativeContext( $this->getContext() );
 594                         $context->setRequest( $this->getRequest() );
 595                 }
 596                 $form = HTMLForm::factory( 'vform', $formDescriptor, $context );
 597
 598                 $form->addHiddenField( 'authAction', $this->authAction );
 599                 if ( $wgLoginLanguageSelector ) {
 600                         $form->addHiddenField( 'uselang', $this->mLanguage );
 601                 }
 602                 $form->addHiddenField( 'force', $this->securityLevel );
 603                 $form->addHiddenField( $this->getTokenName(), $this->getToken()->toString() );
 604                 if ( $wgSecureLogin ) {
 605                         // If using HTTPS coming from HTTP, then the 'fromhttp' parameter must be preserved
 606                         if ( !$this->isSignup() ) {
 607                                 $form->addHiddenField( 'wpForceHttps', (int)$this->mStickHTTPS );
 608                                 $form->addHiddenField( 'wpFromhttp', $usingHTTPS );
 609                         }
 610                 }
 611
 612                 // set properties of the form itself
 613                 $form->setAction( $this->getPageTitle()->getLocalURL( $this->getReturnToQueryStringFragment() ) );
 614                 $form->setName( 'userlogin' . ( $this->isSignup() ? '2' : '' ) );
 615                 if ( $this->isSignup() ) {
 616                         $form->setId( 'userlogin2' );
 617                 }
 618
 619                 // add pre/post text
 620                 // header used by ConfirmEdit, CondfirmAccount, Persona, WikimediaIncubator, SemanticSignup
 621                 // should be above the error message but HTMLForm doesn't support that
 622                 $form->addHeaderText( $fakeTemplate->get( 'header' ) );
 623
 624                 // FIXME the old form used this for error/warning messages which does not play well with
 625                 // HTMLForm (maybe it could with a subclass?); for now only display it for signups
 626                 // (where the JS username validation needs it) and alway empty
 627                 if ( $this->isSignup() ) {
 628                         // used by the mediawiki.special.userlogin.signup.js module
 629                         $statusAreaAttribs = [ 'id' => 'mw-createacct-status-area' ];
 630                         // $statusAreaAttribs += $msg ? [ 'class' => "{$msgType}box" ] : [ 'style' => 'display: none;' ];
 631                         $form->addHeaderText( Html::element( 'div', $statusAreaAttribs ) );
 632                 }
 633
 634                 // header used by MobileFrontend
 635                 $form->addHeaderText( $fakeTemplate->get( 'formheader' ) );
 636
 637                 // blank signup footer for site customization
 638                 if ( $this->isSignup() && $this->showExtraInformation() ) {
 639                         // Use signupend-https for HTTPS requests if it's not blank, signupend otherwise
 640                         $signupendMsg = $this->msg( 'signupend' );
 641                         $signupendHttpsMsg = $this->msg( 'signupend-https' );
 642                         if ( !$signupendMsg->isDisabled() ) {
 643                                 $signupendText = ( $usingHTTPS && !$signupendHttpsMsg->isBlank() )
 644                                         ? $signupendHttpsMsg ->parse() : $signupendMsg->parse();
 645                                 $form->addPostText( Html::rawElement( 'div', [ 'id' => 'signupend' ], $signupendText ) );
 646                         }
 647                 }
 648
 649                 // warning header for non-standard workflows (e.g. security reauthentication)
 650                 if ( !$this->isSignup() && $this->getUser()->isLoggedIn() ) {
 651                         $reauthMessage = $this->securityLevel ? 'userlogin-reauth' : 'userlogin-loggedin';
 652                         $form->addHeaderText( Html::rawElement( 'div', [ 'class' => 'warningbox' ],
 653                                 $this->msg( $reauthMessage )->params( $this->getUser()->getName() )->parse() ) );
 654                 }
 655
 656                 if ( !$this->isSignup() && $this->showExtraInformation() ) {
 657                         $passwordReset = new PasswordReset( $this->getConfig(), AuthManager::singleton() );
 658                         if ( $passwordReset->isAllowed( $this->getUser() ) ) {
 659                                 $form->addFooterText( Html::rawElement(
 660                                         'div',
 661                                         [ 'class' => 'mw-ui-vform-field mw-form-related-link-container' ],
 662                                         Linker::link(
 663                                                 SpecialPage::getTitleFor( 'PasswordReset' ),
 664                                                 $this->msg( 'userlogin-resetpassword-link' )->escaped()
 665                                         )
 666                                 ) );
 667                         }
 668
 669                         // Don't show a "create account" link if the user can't.
 670                         if ( $this->showCreateAccountLink() ) {
 671                                 // link to the other action
 672                                 $linkTitle = $this->getTitleFor( $this->isSignup() ? 'Userlogin' :'CreateAccount' );
 673                                 $linkq = $this->getReturnToQueryStringFragment();
 674                                 // Pass any language selection on to the mode switch link
 675                                 if ( $wgLoginLanguageSelector && $this->mLanguage ) {
 676                                         $linkq .= '&uselang=' . $this->mLanguage;
 677                                 }
 678
 679                                 $loggedIn = $this->getUser()->isLoggedIn();
 680                                 $createOrLoginHtml = Html::rawElement( 'div',
 681                                         [ 'id' => 'mw-createaccount' . ( !$loggedIn ? '-cta' : '' ),
 682                                                 'class' => ( $loggedIn ? 'mw-form-related-link-container' : 'mw-ui-vform-field' ) ],
 683                                         ( $loggedIn ? '' : $this->msg( 'userlogin-noaccount' )->escaped() )
 684                                         . Html::element( 'a',
 685                                                 [
 686                                                         'id' => 'mw-createaccount-join' . ( $loggedIn ? '-loggedin' : '' ),
 687                                                         'href' => $linkTitle->getLocalURL( $linkq ),
 688                                                         'class' => ( $loggedIn ? '' : 'mw-ui-button' ),
 689                                                         'tabindex' => 100,
 690                                                 ],
 691                                                 $this->msg(
 692                                                         ( $this->getUser()->isLoggedIn() ?
 693                                                                 'userlogin-createanother' :
 694                                                                 'userlogin-joinproject'
 695                                                         ) )->escaped()
 696                                         )
 697                                 );
 698                                 $form->addFooterText( $createOrLoginHtml );
 699                         }
 700                 }
 701
 702                 $form->suppressDefaultSubmit();
 703
 704                 $this->authForm = $form;
 705
 706                 return $form;
 707         }
 708
 709         /**
 710          * Temporary B/C method to handle extensions using the UserLoginForm/UserCreateForm hooks.
 711          * @param string|Message $msg
 712          * @param string $msgType
 713          * @return FakeAuthTemplate
 714          */
 715         protected function getFakeTemplate( $msg, $msgType ) {
 716                 global $wgAuth, $wgEnableEmail, $wgHiddenPrefs, $wgEmailConfirmToEdit, $wgEnableUserEmail,
 717                            $wgSecureLogin, $wgLoginLanguageSelector, $wgPasswordResetRoutes;
 718
 719                 // make a best effort to get the value of fields which used to be fixed in the old login
 720                 // template but now might or might not exist depending on what providers are used
 721                 $request = $this->getRequest();
 722                 $data = (object) [
 723                         'mUsername' => $request->getText( 'wpName' ),
 724                         'mPassword' => $request->getText( 'wpPassword' ),
 725                         'mRetype' => $request->getText( 'wpRetype' ),
 726                         'mEmail' => $request->getText( 'wpEmail' ),
 727                         'mRealName' => $request->getText( 'wpRealName' ),
 728                         'mDomain' => $request->getText( 'wpDomain' ),
 729                         'mReason' => $request->getText( 'wpReason' ),
 730                         'mRemember' => $request->getCheck( 'wpRemember' ),
 731                 ];
 732
 733                 // Preserves a bunch of logic from the old code that was rewritten in getAuthForm().
 734                 // There is no code reuse to make this easier to remove .
 735                 // If an extension tries to change any of these values, they are out of luck - we only
 736                 // actually use the domain/usedomain/domainnames, extraInput and extrafields keys.
 737
 738                 $titleObj = $this->getPageTitle();
 739                 $user = $this->getUser();
 740                 $template = new FakeAuthTemplate();
 741
 742                 // Pre-fill username (if not creating an account, bug 44775).
 743                 if ( $data->mUsername == '' && $this->isSignup() ) {
 744                         if ( $user->isLoggedIn() ) {
 745                                 $data->mUsername = $user->getName();
 746                         } else {
 747                                 $data->mUsername = $this->getRequest()->getSession()->suggestLoginUsername();
 748                         }
 749                 }
 750
 751                 if ( $this->isSignup() ) {
 752                         // Must match number of benefits defined in messages
 753                         $template->set( 'benefitCount', 3 );
 754
 755                         $q = 'action=submitlogin&type=signup';
 756                         $linkq = 'type=login';
 757                 } else {
 758                         $q = 'action=submitlogin&type=login';
 759                         $linkq = 'type=signup';
 760                 }
 761
 762                 if ( $this->mReturnTo !== '' ) {
 763                         $returnto = '&returnto=' . wfUrlencode( $this->mReturnTo );
 764                         if ( $this->mReturnToQuery !== '' ) {
 765                                 $returnto .= '&returntoquery=' .
 766                                                          wfUrlencode( $this->mReturnToQuery );
 767                         }
 768                         $q .= $returnto;
 769                         $linkq .= $returnto;
 770                 }
 771
 772                 # Don't show a "create account" link if the user can't.
 773                 if ( $this->showCreateAccountLink() ) {
 774                         # Pass any language selection on to the mode switch link
 775                         if ( $wgLoginLanguageSelector && $this->mLanguage ) {
 776                                 $linkq .= '&uselang=' . $this->mLanguage;
 777                         }
 778                         // Supply URL, login template creates the button.
 779                         $template->set( 'createOrLoginHref', $titleObj->getLocalURL( $linkq ) );
 780                 } else {
 781                         $template->set( 'link', '' );
 782                 }
 783
 784                 $resetLink = $this->isSignup()
 785                         ? null
 786                         : is_array( $wgPasswordResetRoutes )
 787                           && in_array( true, array_values( $wgPasswordResetRoutes ), true );
 788
 789                 $template->set( 'header', '' );
 790                 $template->set( 'formheader', '' );
 791                 $template->set( 'skin', $this->getSkin() );
 792
 793                 $template->set( 'name', $data->mUsername );
 794                 $template->set( 'password', $data->mPassword );
 795                 $template->set( 'retype', $data->mRetype );
 796                 $template->set( 'createemailset', false ); // no easy way to get that from AuthManager
 797                 $template->set( 'email', $data->mEmail );
 798                 $template->set( 'realname', $data->mRealName );
 799                 $template->set( 'domain', $data->mDomain );
 800                 $template->set( 'reason', $data->mReason );
 801                 $template->set( 'remember', $data->mRemember );
 802
 803                 $template->set( 'action', $titleObj->getLocalURL( $q ) );
 804                 $template->set( 'message', $msg );
 805                 $template->set( 'messagetype', $msgType );
 806                 $template->set( 'createemail', $wgEnableEmail && $user->isLoggedIn() );
 807                 $template->set( 'userealname', !in_array( 'realname', $wgHiddenPrefs, true ) );
 808                 $template->set( 'useemail', $wgEnableEmail );
 809                 $template->set( 'emailrequired', $wgEmailConfirmToEdit );
 810                 $template->set( 'emailothers', $wgEnableUserEmail );
 811                 $template->set( 'canreset', $wgAuth->allowPasswordChange() );
 812                 $template->set( 'resetlink', $resetLink );
 813                 $template->set( 'canremember', $request->getSession()->getProvider()
 814                         ->getRememberUserDuration() !== null );
 815                 $template->set( 'usereason', $user->isLoggedIn() );
 816                 $template->set( 'cansecurelogin', ( $wgSecureLogin ) );
 817                 $template->set( 'stickhttps', (int)$this->mStickHTTPS );
 818                 $template->set( 'loggedin', $user->isLoggedIn() );
 819                 $template->set( 'loggedinuser', $user->getName() );
 820                 $template->set( 'token', $this->getToken()->toString() );
 821
 822                 $action = $this->isSignup() ? 'signup' : 'login';
 823                 $wgAuth->modifyUITemplate( $template, $action );
 824
 825                 $oldTemplate = $template;
 826                 $hookName = $this->isSignup() ? 'UserCreateForm' : 'UserLoginForm';
 827                 Hooks::run( $hookName, [ &$template ] );
 828                 if ( $oldTemplate !== $template ) {
 829                         wfDeprecated( "reference in $hookName hook", '1.27' );
 830                 }
 831
 832                 return $template;
 833
 834         }
 835
 836         public function onAuthChangeFormFields(
 837                 array $requests, array $fieldInfo, array &$formDescriptor, $action
 838         ) {
 839                 $coreFieldDescriptors = $this->getFieldDefinitions( $this->fakeTemplate );
 840                 $specialFields = array_merge( [ 'extraInput', 'linkcontainer', 'entryError' ],
 841                         array_keys( $this->fakeTemplate->getExtraInputDefinitions() ) );
 842
 843                 // keep the ordering from getCoreFieldDescriptors() where there is no explicit weight
 844                 foreach ( $coreFieldDescriptors as $fieldName => $coreField ) {
 845                         $requestField = isset( $formDescriptor[$fieldName] ) ?
 846                                 $formDescriptor[$fieldName] : [];
 847
 848                         // remove everything that is not in the fieldinfo, is not marked as a supplemental field
 849                         // to something in the fieldinfo, and is not a generic or B/C field or a submit button
 850                         if (
 851                                 !isset( $fieldInfo[$fieldName] )
 852                                 && (
 853                                         !isset( $coreField['baseField'] )
 854                                         || !isset( $fieldInfo[$coreField['baseField']] )
 855                                 ) && !in_array( $fieldName, $specialFields, true )
 856                                 && ( !isset( $coreField['type'] ) || $coreField['type'] !== 'submit' )
 857                         ) {
 858                                 $coreFieldDescriptors[$fieldName] = null;
 859                                 continue;
 860                         }
 861
 862                         // core message labels should always take priority
 863                         if (
 864                                 isset( $coreField['label'] )
 865                                 || isset( $coreField['label-message'] )
 866                                 || isset( $coreField['label-raw'] )
 867                         ) {
 868                                 unset( $requestField['label'], $requestField['label-message'], $coreField['label-raw'] );
 869                         }
 870
 871                         $coreFieldDescriptors[$fieldName] += $requestField;
 872                 }
 873
 874                 $formDescriptor = array_filter( $coreFieldDescriptors + $formDescriptor );
 875                 return true;
 876         }
 877
 878         /**
 879          * Show extra information such as password recovery information, link from login to signup,
 880          * CTA etc? Such information should only be shown on the "landing page", ie. when the user
 881          * is at the first step of the authentication process.
 882          * @return bool
 883          */
 884         protected function showExtraInformation() {
 885                 return $this->authAction !== $this->getContinueAction( $this->authAction )
 886                         && !$this->securityLevel;
 887         }
 888
 889         /**
 890          * Create a HTMLForm descriptor for the core login fields.
 891          * @param FakeAuthTemplate $template B/C data (not used but needed by getBCFieldDefinitions)
 892          * @return array
 893          */
 894         protected function getFieldDefinitions( $template ) {
 895                 global $wgEmailConfirmToEdit;
 896
 897                 $isLoggedIn = $this->getUser()->isLoggedIn();
 898                 $continuePart = $this->isContinued() ? 'continue-' : '';
 899                 $anotherPart = $isLoggedIn ? 'another-' : '';
 900                 $expiration = $this->getRequest()->getSession()->getProvider()
 901                         ->getRememberUserDuration();
 902                 $expirationDays = ceil( $expiration / ( 3600 * 24 ) );
 903                 $secureLoginLink = '';
 904                 if ( $this->mSecureLoginUrl ) {
 905                         $secureLoginLink = Html::element( 'a', [
 906                                 'href' => $this->mSecureLoginUrl,
 907                                 'class' => 'mw-ui-flush-right mw-secure',
 908                         ], $this->msg( 'userlogin-signwithsecure' )->text() );
 909                 }
 910
 911                 if ( $this->isSignup() ) {
 912                         $fieldDefinitions = [
 913                                 'username' => [
 914                                         'label-message' => 'userlogin-yourname',
 915                                         // FIXME help-message does not match old formatting
 916                                         'help-message' => 'createacct-helpusername',
 917                                         'id' => 'wpName2',
 918                                         'placeholder-message' => $isLoggedIn ? 'createacct-another-username-ph'
 919                                                 : 'userlogin-yourname-ph',
 920                                 ],
 921                                 'mailpassword' => [
 922                                         // create account without providing password, a temporary one will be mailed
 923                                         'type' => 'check',
 924                                         'label-message' => 'createaccountmail',
 925                                         'name' => 'wpCreateaccountMail',
 926                                         'id' => 'wpCreateaccountMail',
 927                                 ],
 928                                 'password' => [
 929                                         'id' => 'wpPassword2',
 930                                         'placeholder-message' => 'createacct-yourpassword-ph',
 931                                         'hide-if' => [ '===', 'wpCreateaccountMail', '1' ],
 932                                 ],
 933                                 'domain' => [],
 934                                 'retype' => [
 935                                         'baseField' => 'password',
 936                                         'type' => 'password',
 937                                         'label-message' => 'createacct-yourpasswordagain',
 938                                         'id' => 'wpRetype',
 939                                         'cssclass' => 'loginPassword',
 940                                         'size' => 20,
 941                                         'validation-callback' => function ( $value, $alldata ) {
 942                                                 if ( empty( $alldata['mailpassword'] ) && !empty( $alldata['password'] ) ) {
 943                                                         if ( !$value ) {
 944                                                                 return $this->msg( 'htmlform-required' );
 945                                                         } elseif ( $value !== $alldata['password'] ) {
 946                                                                 return $this->msg( 'badretype' );
 947                                                         }
 948                                                 }
 949                                                 return true;
 950                                         },
 951                                         'hide-if' => [ '===', 'wpCreateaccountMail', '1' ],
 952                                         'placeholder-message' => 'createacct-yourpasswordagain-ph',
 953                                 ],
 954                                 'email' => [
 955                                         'type' => 'email',
 956                                         'label-message' => $wgEmailConfirmToEdit ? 'createacct-emailrequired'
 957                                                 : 'createacct-emailoptional',
 958                                         'id' => 'wpEmail',
 959                                         'cssclass' => 'loginText',
 960                                         'size' => '20',
 961                                         // FIXME will break non-standard providers
 962                                         'required' => $wgEmailConfirmToEdit,
 963                                         'validation-callback' => function ( $value, $alldata ) {
 964                                                 global $wgEmailConfirmToEdit;
 965
 966                                                 // AuthManager will check most of these, but that will make the auth
 967                                                 // session fail and this won't, so nicer to do it this way
 968                                                 if ( !$value && $wgEmailConfirmToEdit ) {
 969                                                         // no point in allowing registration without email when email is
 970                                                         // required to edit
 971                                                         return $this->msg( 'noemailtitle' );
 972                                                 } elseif ( !$value && !empty( $alldata['mailpassword'] ) ) {
 973                                                         // cannot send password via email when there is no email address
 974                                                         return $this->msg( 'noemailcreate' );
 975                                                 } elseif ( $value && !Sanitizer::validateEmail( $value ) ) {
 976                                                         return $this->msg( 'invalidemailaddress' );
 977                                                 }
 978                                                 return true;
 979                                         },
 980                                         'placeholder-message' => 'createacct-' . $anotherPart . 'email-ph',
 981                                 ],
 982                                 'realname' => [
 983                                         'type' => 'text',
 984                                         'help-message' => $isLoggedIn ? 'createacct-another-realname-tip'
 985                                                 : 'prefs-help-realname',
 986                                         'label-message' => 'createacct-realname',
 987                                         'cssclass' => 'loginText',
 988                                         'size' => 20,
 989                                         'id' => 'wpRealName',
 990                                 ],
 991                                 'reason' => [
 992                                         // comment for the user creation log
 993                                         'type' => 'text',
 994                                         'label-message' => 'createacct-reason',
 995                                         'cssclass' => 'loginText',
 996                                         'id' => 'wpReason',
 997                                         'size' => '20',
 998                                         'placeholder-message' => 'createacct-reason-ph',
 999                                 ],
1000                                 'extrainput' => [], // placeholder for fields coming from the template
1001                                 'createaccount' => [
1002                                         // submit button
1003                                         'type' => 'submit',
1004                                         'default' => $this->msg( 'createacct-' . $anotherPart . $continuePart .
1005                                                 'submit' )->text(),
1006                                         'name' => 'wpCreateaccount',
1007                                         'id' => 'wpCreateaccount',
1008                                         'weight' => 100,
1009                                 ],
1010                         ];
1011                 } else {
1012                         $fieldDefinitions = [
1013                                 'username' => [
1014                                         'label-raw' => $this->msg( 'userlogin-yourname' )->escaped() . $secureLoginLink,
1015                                         'id' => 'wpName1',
1016                                         'placeholder-message' => 'userlogin-yourname-ph',
1017                                 ],
1018                                 'password' => [
1019                                         'id' => 'wpPassword1',
1020                                         'placeholder-message' => 'userlogin-yourpassword-ph',
1021                                 ],
1022                                 'domain' => [],
1023                                 'extrainput' => [],
1024                                 'rememberMe' => [
1025                                         // option for saving the user token to a cookie
1026                                         'type' => 'check',
1027                                         'name' => 'wpRemember',
1028                                         'label-message' => $this->msg( 'userlogin-remembermypassword' )
1029                                                 ->numParams( $expirationDays ),
1030                                         'id' => 'wpRemember',
1031                                 ],
1032                                 'loginattempt' => [
1033                                         // submit button
1034                                         'type' => 'submit',
1035                                         'default' => $this->msg( 'pt-login-' . $continuePart . 'button' )->text(),
1036                                         'id' => 'wpLoginAttempt',
1037                                         'weight' => 100,
1038                                 ],
1039                                 'linkcontainer' => [
1040                                         // help link
1041                                         'type' => 'info',
1042                                         'cssclass' => 'mw-form-related-link-container mw-userlogin-help',
1043                                         // 'id' => 'mw-userlogin-help', // FIXME HTMLInfoField ignores this
1044                                         'raw' => true,
1045                                         'default' => Html::element( 'a', [
1046                                                 'href' => Skin::makeInternalOrExternalUrl( wfMessage( 'helplogin-url' )
1047                                                         ->inContentLanguage()
1048                                                         ->text() ),
1049                                         ], $this->msg( 'userlogin-helplink2' )->text() ),
1050                                         'weight' => 200,
1051                                 ],
1052                                 // button for ResetPasswordSecondaryAuthenticationProvider
1053                                 'skipReset' => [
1054                                         'weight' => 110,
1055                                         'flags' => [],
1056                                 ],
1057                         ];
1058                 }
1059                 $fieldDefinitions['username'] += [
1060                         'type' => 'text',
1061                         'name' => 'wpName',
1062                         'cssclass' => 'loginText',
1063                         'size' => 20,
1064                         // 'required' => true,
1065                 ];
1066                 $fieldDefinitions['password'] += [
1067                         'type' => 'password',
1068                         // 'label-message' => 'userlogin-yourpassword', // would override the changepassword label
1069                         'name' => 'wpPassword',
1070                         'cssclass' => 'loginPassword',
1071                         'size' => 20,
1072                         // 'required' => true,
1073                 ];
1074
1075                 if ( $this->mEntryError ) {
1076                         $fieldDefinitions['entryError'] = [
1077                                 'type' => 'info',
1078                                 'default' => Html::rawElement( 'div', [ 'class' => $this->mEntryErrorType . 'box', ],
1079                                         $this->mEntryError ),
1080                                 'raw' => true,
1081                                 'rawrow' => true,
1082                                 'weight' => -100,
1083                         ];
1084                 }
1085
1086                 if ( !$this->showExtraInformation() ) {
1087                         unset( $fieldDefinitions['linkcontainer'] );
1088                 }
1089
1090                 $fieldDefinitions = $this->getBCFieldDefinitions( $fieldDefinitions, $template );
1091                 $fieldDefinitions = array_filter( $fieldDefinitions );
1092
1093                 return $fieldDefinitions;
1094         }
1095
1096         /**
1097          * Adds fields provided via the deprecated UserLoginForm / UserCreateForm hooks
1098          * @param $fieldDefinitions array
1099          * @param FakeAuthTemplate $template
1100          * @return array
1101          */
1102         protected function getBCFieldDefinitions( $fieldDefinitions, $template ) {
1103                 if ( $template->get( 'usedomain', false ) ) {
1104                         // TODO probably should be translated to the new domain notation in AuthManager
1105                         $fieldDefinitions['domain'] = [
1106                                 'type' => 'select',
1107                                 'label-message' => 'yourdomainname',
1108                                 'options' => array_combine( $template->get( 'domainnames', [] ),
1109                                         $template->get( 'domainnames', [] ) ),
1110                                 'default' => $template->get( 'domain', '' ),
1111                                 'name' => 'wpDomain',
1112                                 // FIXME id => 'mw-user-domain-section' on the parent div
1113                         ];
1114                 }
1115
1116                 // poor man's associative array_splice
1117                 $extraInputPos = array_search( 'extrainput', array_keys( $fieldDefinitions ), true );
1118                 $fieldDefinitions = array_slice( $fieldDefinitions, 0, $extraInputPos, true )
1119                                                         + $template->getExtraInputDefinitions()
1120                                                         + array_slice( $fieldDefinitions, $extraInputPos + 1, null, true );
1121
1122                 return $fieldDefinitions;
1123         }
1124
1125         /**
1126          * Check if a session cookie is present.
1127          *
1128          * This will not pick up a cookie set during _this_ request, but is meant
1129          * to ensure that the client is returning the cookie which was set on a
1130          * previous pass through the system.
1131          *
1132          * @return bool
1133          */
1134         protected function hasSessionCookie() {
1135                 global $wgDisableCookieCheck, $wgInitialSessionId;
1136
1137                 return $wgDisableCookieCheck || (
1138                         $wgInitialSessionId &&
1139                         $this->getRequest()->getSession()->getId() === (string)$wgInitialSessionId
1140                 );
1141         }
1142
1143         /**
1144          * Returns a string that can be appended to the URL (without encoding) to preserve the
1145          * return target. Does not include leading '?'/'&'.
1146          */
1147         protected function getReturnToQueryStringFragment() {
1148                 $returnto = '';
1149                 if ( $this->mReturnTo !== '' ) {
1150                         $returnto = 'returnto=' . wfUrlencode( $this->mReturnTo );
1151                         if ( $this->mReturnToQuery !== '' ) {
1152                                 $returnto .= '&returntoquery=' . wfUrlencode( $this->mReturnToQuery );
1153                         }
1154                 }
1155                 return $returnto;
1156         }
1157
1158         /**
1159          * Whether the login/create account form should display a link to the
1160          * other form (in addition to whatever the skin provides).
1161          * @return bool
1162          */
1163         private function showCreateAccountLink() {
1164                 if ( $this->isSignup() ) {
1165                         return true;
1166                 } elseif ( $this->getUser()->isAllowed( 'createaccount' ) ) {
1167                         return true;
1168                 } else {
1169                         return false;
1170                 }
1171         }
1172
1173         protected function getTokenName() {
1174                 return $this->isSignup() ? 'wpCreateaccountToken' : 'wpLoginToken';
1175         }
1176
1177         /**
1178          * Produce a bar of links which allow the user to select another language
1179          * during login/registration but retain "returnto"
1180          *
1181          * @return string
1182          */
1183         protected function makeLanguageSelector() {
1184                 $msg = $this->msg( 'loginlanguagelinks' )->inContentLanguage();
1185                 if ( $msg->isBlank() ) {
1186                         return '';
1187                 }
1188                 $langs = explode( "\n", $msg->text() );
1189                 $links = [];
1190                 foreach ( $langs as $lang ) {
1191                         $lang = trim( $lang, '* ' );
1192                         $parts = explode( '|', $lang );
1193                         if ( count( $parts ) >= 2 ) {
1194                                 $links[] = $this->makeLanguageSelectorLink( $parts[0], trim( $parts[1] ) );
1195                         }
1196                 }
1197
1198                 return count( $links ) > 0 ? $this->msg( 'loginlanguagelabel' )->rawParams(
1199                         $this->getLanguage()->pipeList( $links ) )->escaped() : '';
1200         }
1201
1202         /**
1203          * Create a language selector link for a particular language
1204          * Links back to this page preserving type and returnto
1205          *
1206          * @param string $text Link text
1207          * @param string $lang Language code
1208          * @return string
1209          */
1210         protected function makeLanguageSelectorLink( $text, $lang ) {
1211                 if ( $this->getLanguage()->getCode() == $lang ) {
1212                         // no link for currently used language
1213                         return htmlspecialchars( $text );
1214                 }
1215                 $query = [ 'uselang' => $lang ];
1216                 if ( $this->mReturnTo !== '' ) {
1217                         $query['returnto'] = $this->mReturnTo;
1218                         $query['returntoquery'] = $this->mReturnToQuery;
1219                 }
1220
1221                 $attr = [];
1222                 $targetLanguage = Language::factory( $lang );
1223                 $attr['lang'] = $attr['hreflang'] = $targetLanguage->getHtmlCode();
1224
1225                 return Linker::linkKnown(
1226                         $this->getPageTitle(),
1227                         htmlspecialchars( $text ),
1228                         $attr,
1229                         $query
1230                 );
1231         }
1232
1233         protected function getGroupName() {
1234                 return 'login';
1235         }
1236
1237         /**
1238          * @param array $formDescriptor
1239          */
1240         protected function postProcessFormDescriptor( &$formDescriptor ) {
1241                 // Pre-fill username (if not creating an account, T46775).
1242                 if (
1243                         isset( $formDescriptor['username'] ) &&
1244                         !isset( $formDescriptor['username']['default'] ) &&
1245                         !$this->isSignup()
1246                 ) {
1247                         $user = $this->getUser();
1248                         if ( $user->isLoggedIn() ) {
1249                                 $formDescriptor['username']['default'] = $user->getName();
1250                         } else {
1251                                 $formDescriptor['username']['default'] =
1252                                         $this->getRequest()->getSession()->suggestLoginUsername();
1253                         }
1254                 }
1255
1256                 // don't show a submit button if there is nothing to submit (i.e. the only form content
1257                 // is other submit buttons, for redirect flows)
1258                 if ( !$this->needsSubmitButton( $formDescriptor ) ) {
1259                         unset( $formDescriptor['createaccount'], $formDescriptor['loginattempt'] );
1260                 }
1261
1262                 if ( !$this->isSignup() ) {
1263                         // FIXME HACK don't focus on non-empty field
1264                         // maybe there should be an autofocus-if similar to hide-if?
1265                         if (
1266                                 isset( $formDescriptor['username'] )
1267                                 && empty( $formDescriptor['username']['default'] )
1268                                 && !$this->getRequest()->getCheck( 'wpName' )
1269                         ) {
1270                                 $formDescriptor['username']['autofocus'] = true;
1271                         } elseif ( isset( $formDescriptor['password'] ) ) {
1272                                 $formDescriptor['password']['autofocus'] = true;
1273                         }
1274                 }
1275
1276                 $this->addTabIndex( $formDescriptor );
1277         }
1278 }
1279
1280 /**
1281  * B/C class to try handling login/signup template modifications even though login/signup does not
1282  * actually happen through a template anymore. Just collects extra field definitions and allows
1283  * some other class to do decide what to do with threm..
1284  * TODO find the right place for adding extra fields and kill this
1285  */
1286 class FakeAuthTemplate extends BaseTemplate {
1287         public function execute() {
1288                 throw new LogicException( 'not used' );
1289         }
1290
1291         /**
1292          * Extensions (AntiSpoof and TitleBlacklist) call this in response to
1293          * UserCreateForm hook to add checkboxes to the create account form.
1294          */
1295         public function addInputItem( $name, $value, $type, $msg, $helptext = false ) {
1296                 // use the same indexes as UserCreateForm just in case someone adds an item manually
1297                 $this->data['extrainput'][] = [
1298                         'name' => $name,
1299                         'value' => $value,
1300                         'type' => $type,
1301                         'msg' => $msg,
1302                         'helptext' => $helptext,
1303                 ];
1304         }
1305
1306         /**
1307          * Turns addInputItem-style field definitions into HTMLForm field definitions.
1308          * @return array
1309          */
1310         public function getExtraInputDefinitions() {
1311                 $definitions = [];
1312
1313                 foreach ( $this->get( 'extrainput', [] ) as $field ) {
1314                         $definition = [
1315                                 'type' => $field['type'] === 'checkbox' ? 'check' : $field['type'],
1316                                 'name' => $field['name'],
1317                                 'value' => $field['value'],
1318                                 'id' => $field['name'],
1319                         ];
1320                         if ( $field['msg'] ) {
1321                                 $definition['label-message'] = $this->getMsg( $field['msg'] );
1322                         }
1323                         if ( $field['helptext'] ) {
1324                                 $definition['help'] = $this->msgWiki( $field['helptext'] );
1325                         }
1326
1327                         // the array key doesn't matter much when name is defined explicitly but
1328                         // let's try and follow HTMLForm conventions
1329                         $name = preg_replace( '/^wp(?=[A-Z])/', '', $field['name'] );
1330                         $definitions[$name] = $definition;
1331                 }
1332
1333                 if ( $this->haveData( 'extrafields' ) ) {
1334                         $definitions['extrafields'] = [
1335                                 'type' => 'info',
1336                                 'raw' => true,
1337                                 'default' => $this->get( 'extrafields' ),
1338                         ];
1339                 }
1340
1341                 return $definitions;
1342         }
1343 }
1344
1345 /**
1346  * LoginForm as a special page has been replaced by SpecialUserLogin and SpecialCreateAccount,
1347  * but some extensions called its public methods directly, so the class is retained as a
1348  * B/C wrapper. Anything that used it before should use AuthManager instead.
1349  */
1350 class LoginForm extends SpecialPage {
1351         const SUCCESS = 0;
1352         const NO_NAME = 1;
1353         const ILLEGAL = 2;
1354         const WRONG_PLUGIN_PASS = 3;
1355         const NOT_EXISTS = 4;
1356         const WRONG_PASS = 5;
1357         const EMPTY_PASS = 6;
1358         const RESET_PASS = 7;
1359         const ABORTED = 8;
1360         const CREATE_BLOCKED = 9;
1361         const THROTTLED = 10;
1362         const USER_BLOCKED = 11;
1363         const NEED_TOKEN = 12;
1364         const WRONG_TOKEN = 13;
1365         const USER_MIGRATED = 14;
1366
1367         public static $statusCodes = [
1368                 self::SUCCESS => 'success',
1369                 self::NO_NAME => 'no_name',
1370                 self::ILLEGAL => 'illegal',
1371                 self::WRONG_PLUGIN_PASS => 'wrong_plugin_pass',
1372                 self::NOT_EXISTS => 'not_exists',
1373                 self::WRONG_PASS => 'wrong_pass',
1374                 self::EMPTY_PASS => 'empty_pass',
1375                 self::RESET_PASS => 'reset_pass',
1376                 self::ABORTED => 'aborted',
1377                 self::CREATE_BLOCKED => 'create_blocked',
1378                 self::THROTTLED => 'throttled',
1379                 self::USER_BLOCKED => 'user_blocked',
1380                 self::NEED_TOKEN => 'need_token',
1381                 self::WRONG_TOKEN => 'wrong_token',
1382                 self::USER_MIGRATED => 'user_migrated',
1383         ];
1384
1385         /**
1386          * @param WebRequest $request
1387          */
1388         public function __construct( $request = null ) {
1389                 wfDeprecated( 'LoginForm', '1.27' );
1390                 parent::__construct();
1391         }
1392
1393         /**
1394          * @deprecated since 1.27 - call LoginHelper::getValidErrorMessages instead.
1395          */
1396         public static function getValidErrorMessages() {
1397                 return LoginHelper::getValidErrorMessages();
1398         }
1399
1400         /**
1401          * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
1402          */
1403         public static function incrementLoginThrottle( $username ) {
1404                 wfDeprecated( __METHOD__, "1.27" );
1405                 global $wgRequest;
1406                 $username = User::getCanonicalName( $username, 'usable' ) ?: $username;
1407                 $throttler = new Throttler();
1408                 return $throttler->increase( $username, $wgRequest->getIP(), __METHOD__ );
1409         }
1410
1411         /**
1412          * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
1413          */
1414         public static function incLoginThrottle( $username ) {
1415                 wfDeprecated( __METHOD__, "1.27" );
1416                 $res = self::incrementLoginThrottle( $username );
1417                 return is_array( $res ) ? true : 0;
1418         }
1419
1420         /**
1421          * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
1422          */
1423         public static function clearLoginThrottle( $username ) {
1424                 wfDeprecated( __METHOD__, "1.27" );
1425                 global $wgRequest;
1426                 $username = User::getCanonicalName( $username, 'usable' ) ?: $username;
1427                 $throttler = new Throttler();
1428                 return $throttler->clear( $username, $wgRequest->getIP() );
1429         }
1430
1431         /**
1432          * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
1433          */
1434         public static function getLoginToken() {
1435                 wfDeprecated( __METHOD__, '1.27' );
1436                 global $wgRequest;
1437                 return $wgRequest->getSession()->getToken( '', 'login' )->toString();
1438         }
1439
1440         /**
1441          * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
1442          */
1443         public static function setLoginToken() {
1444                 wfDeprecated( __METHOD__, '1.27' );
1445         }
1446
1447         /**
1448          * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
1449          */
1450         public static function clearLoginToken() {
1451                 wfDeprecated( __METHOD__, '1.27' );
1452                 global $wgRequest;
1453                 $wgRequest->getSession()->resetToken( 'login' );
1454         }
1455
1456         /**
1457          * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
1458          */
1459         public static function getCreateaccountToken() {
1460                 wfDeprecated( __METHOD__, '1.27' );
1461                 global $wgRequest;
1462                 return $wgRequest->getSession()->getToken( '', 'createaccount' )->toString();
1463         }
1464
1465         /**
1466          * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
1467          */
1468         public static function setCreateaccountToken() {
1469                 wfDeprecated( __METHOD__, '1.27' );
1470         }
1471
1472         /**
1473          * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
1474          */
1475         public static function clearCreateaccountToken() {
1476                 wfDeprecated( __METHOD__, '1.27' );
1477                 global $wgRequest;
1478                 $wgRequest->getSession()->resetToken( 'createaccount' );
1479         }
1480 }