MediaWiki REL1_32
LoginSignupSpecialPage.php
Go to the documentation of this file.
1<?php
31use Wikimedia\ScopedCallback;
32
39 protected $mReturnTo;
40 protected $mPosted;
41 protected $mAction;
42 protected $mLanguage;
43 protected $mReturnToQuery;
44 protected $mToken;
45 protected $mStickHTTPS;
46 protected $mFromHTTP;
47 protected $mEntryError = '';
48 protected $mEntryErrorType = 'error';
49
50 protected $mLoaded = false;
51 protected $mLoadedRequest = false;
53
55 protected $securityLevel;
56
61 protected $targetUser;
62
64 protected $authForm;
65
67 protected $fakeTemplate;
68
69 abstract protected function isSignup();
70
77 abstract protected function successfulAction( $direct = false, $extraMessages = null );
78
84 abstract protected function logAuthResult( $success, $status = null );
85
86 public function __construct( $name ) {
88 parent::__construct( $name );
89
90 // Override UseMediaWikiEverywhere to true, to force login and create form to use mw ui
92 }
93
94 protected function setRequest( array $data, $wasPosted = null ) {
95 parent::setRequest( $data, $wasPosted );
96 $this->mLoadedRequest = false;
97 }
98
103 private function loadRequestParameters( $subPage ) {
104 if ( $this->mLoadedRequest ) {
105 return;
106 }
107 $this->mLoadedRequest = true;
108 $request = $this->getRequest();
109
110 $this->mPosted = $request->wasPosted();
111 $this->mIsReturn = $subPage === 'return';
112 $this->mAction = $request->getVal( 'action' );
113 $this->mFromHTTP = $request->getBool( 'fromhttp', false )
114 || $request->getBool( 'wpFromhttp', false );
115 $this->mStickHTTPS = ( !$this->mFromHTTP && $request->getProtocol() === 'https' )
116 || $request->getBool( 'wpForceHttps', false );
117 $this->mLanguage = $request->getText( 'uselang' );
118 $this->mReturnTo = $request->getVal( 'returnto', '' );
119 $this->mReturnToQuery = $request->getVal( 'returntoquery', '' );
120 }
121
127 protected function load( $subPage ) {
128 global $wgSecureLogin;
129
131 if ( $this->mLoaded ) {
132 return;
133 }
134 $this->mLoaded = true;
135 $request = $this->getRequest();
136
137 $securityLevel = $this->getRequest()->getText( 'force' );
138 if (
139 $securityLevel && AuthManager::singleton()->securitySensitiveOperationStatus(
140 $securityLevel ) === AuthManager::SEC_REAUTH
141 ) {
142 $this->securityLevel = $securityLevel;
143 }
144
145 $this->loadAuth( $subPage );
146
147 $this->mToken = $request->getVal( $this->getTokenName() );
148
149 // Show an error or warning passed on from a previous page
150 $entryError = $this->msg( $request->getVal( 'error', '' ) );
151 $entryWarning = $this->msg( $request->getVal( 'warning', '' ) );
152 // bc: provide login link as a parameter for messages where the translation
153 // was not updated
154 $loginreqlink = $this->getLinkRenderer()->makeKnownLink(
155 $this->getPageTitle(),
156 $this->msg( 'loginreqlink' )->text(),
157 [],
158 [
159 'returnto' => $this->mReturnTo,
160 'returntoquery' => $this->mReturnToQuery,
161 'uselang' => $this->mLanguage ?: null,
162 'fromhttp' => $wgSecureLogin && $this->mFromHTTP ? '1' : null,
163 ]
164 );
165
166 // Only show valid error or warning messages.
167 if ( $entryError->exists()
168 && in_array( $entryError->getKey(), LoginHelper::getValidErrorMessages(), true )
169 ) {
170 $this->mEntryErrorType = 'error';
171 $this->mEntryError = $entryError->rawParams( $loginreqlink )->parse();
172
173 } elseif ( $entryWarning->exists()
174 && in_array( $entryWarning->getKey(), LoginHelper::getValidErrorMessages(), true )
175 ) {
176 $this->mEntryErrorType = 'warning';
177 $this->mEntryError = $entryWarning->rawParams( $loginreqlink )->parse();
178 }
179
180 # 1. When switching accounts, it sucks to get automatically logged out
181 # 2. Do not return to PasswordReset after a successful password change
182 # but goto Wiki start page (Main_Page) instead ( T35997 )
183 $returnToTitle = Title::newFromText( $this->mReturnTo );
184 if ( is_object( $returnToTitle )
185 && ( $returnToTitle->isSpecial( 'Userlogout' )
186 || $returnToTitle->isSpecial( 'PasswordReset' ) )
187 ) {
188 $this->mReturnTo = '';
189 $this->mReturnToQuery = '';
190 }
191 }
192
193 protected function getPreservedParams( $withToken = false ) {
194 global $wgSecureLogin;
195
196 $params = parent::getPreservedParams( $withToken );
197 $params += [
198 'returnto' => $this->mReturnTo ?: null,
199 'returntoquery' => $this->mReturnToQuery ?: null,
200 ];
201 if ( $wgSecureLogin && !$this->isSignup() ) {
202 $params['fromhttp'] = $this->mFromHTTP ? '1' : null;
203 }
204 return $params;
205 }
206
207 protected function beforeExecute( $subPage ) {
208 // finish initializing the class before processing the request - T135924
210 return parent::beforeExecute( $subPage );
211 }
212
216 public function execute( $subPage ) {
217 if ( $this->mPosted ) {
218 $time = microtime( true );
219 $profilingScope = new ScopedCallback( function () use ( $time ) {
220 $time = microtime( true ) - $time;
221 $statsd = MediaWikiServices::getInstance()->getStatsdDataFactory();
222 $statsd->timing( "timing.login.ui.{$this->authAction}", $time * 1000 );
223 } );
224 }
225
226 $authManager = AuthManager::singleton();
227 $session = SessionManager::getGlobalSession();
228
229 // Session data is used for various things in the authentication process, so we must make
230 // sure a session cookie or some equivalent mechanism is set.
231 $session->persist();
232
233 $this->load( $subPage );
234 $this->setHeaders();
235 $this->checkPermissions();
236
237 // Make sure the system configuration allows log in / sign up
238 if ( !$this->isSignup() && !$authManager->canAuthenticateNow() ) {
239 if ( !$session->canSetUser() ) {
240 throw new ErrorPageError( 'cannotloginnow-title', 'cannotloginnow-text', [
241 $session->getProvider()->describe( RequestContext::getMain()->getLanguage() )
242 ] );
243 }
244 throw new ErrorPageError( 'cannotlogin-title', 'cannotlogin-text' );
245 } elseif ( $this->isSignup() && !$authManager->canCreateAccounts() ) {
246 throw new ErrorPageError( 'cannotcreateaccount-title', 'cannotcreateaccount-text' );
247 }
248
249 /*
250 * In the case where the user is already logged in, and was redirected to
251 * the login form from a page that requires login, do not show the login
252 * page. The use case scenario for this is when a user opens a large number
253 * of tabs, is redirected to the login page on all of them, and then logs
254 * in on one, expecting all the others to work properly.
255 *
256 * However, do show the form if it was visited intentionally (no 'returnto'
257 * is present). People who often switch between several accounts have grown
258 * accustomed to this behavior.
259 *
260 * Also make an exception when force=<level> is set in the URL, which means the user must
261 * reauthenticate for security reasons.
262 */
263 if ( !$this->isSignup() && !$this->mPosted && !$this->securityLevel &&
264 ( $this->mReturnTo !== '' || $this->mReturnToQuery !== '' ) &&
265 $this->getUser()->isLoggedIn()
266 ) {
267 $this->successfulAction();
268 return;
269 }
270
271 // If logging in and not on HTTPS, either redirect to it or offer a link.
272 global $wgSecureLogin;
273 if ( $this->getRequest()->getProtocol() !== 'https' ) {
274 $title = $this->getFullTitle();
275 $query = $this->getPreservedParams( false ) + [
276 'title' => null,
277 ( $this->mEntryErrorType === 'error' ? 'error'
278 : 'warning' ) => $this->mEntryError,
279 ] + $this->getRequest()->getQueryValues();
280 $url = $title->getFullURL( $query, false, PROTO_HTTPS );
281 if ( $wgSecureLogin && !$this->mFromHTTP &&
282 wfCanIPUseHTTPS( $this->getRequest()->getIP() )
283 ) {
284 // Avoid infinite redirect
285 $url = wfAppendQuery( $url, 'fromhttp=1' );
286 $this->getOutput()->redirect( $url );
287 // Since we only do this redir to change proto, always vary
288 $this->getOutput()->addVaryHeader( 'X-Forwarded-Proto' );
289
290 return;
291 } else {
292 // A wiki without HTTPS login support should set $wgServer to
293 // http://somehost, in which case the secure URL generated
294 // above won't actually start with https://
295 if ( substr( $url, 0, 8 ) === 'https://' ) {
296 $this->mSecureLoginUrl = $url;
297 }
298 }
299 }
300
301 if ( !$this->isActionAllowed( $this->authAction ) ) {
302 // FIXME how do we explain this to the user? can we handle session loss better?
303 // messages used: authpage-cannot-login, authpage-cannot-login-continue,
304 // authpage-cannot-create, authpage-cannot-create-continue
305 $this->mainLoginForm( [], 'authpage-cannot-' . $this->authAction );
306 return;
307 }
308
309 if ( $this->canBypassForm( $button_name ) ) {
310 $this->setRequest( [], true );
311 $this->getRequest()->setVal( $this->getTokenName(), $this->getToken() );
312 if ( $button_name ) {
313 $this->getRequest()->setVal( $button_name, true );
314 }
315 }
316
317 $status = $this->trySubmit();
318
319 if ( !$status || !$status->isGood() ) {
320 $this->mainLoginForm( $this->authRequests, $status ? $status->getMessage() : '', 'error' );
321 return;
322 }
323
325 $response = $status->getValue();
326
327 $returnToUrl = $this->getPageTitle( 'return' )
328 ->getFullURL( $this->getPreservedParams( true ), false, PROTO_HTTPS );
329 switch ( $response->status ) {
330 case AuthenticationResponse::PASS:
331 $this->logAuthResult( true );
332 $this->proxyAccountCreation = $this->isSignup() && !$this->getUser()->isAnon();
333 $this->targetUser = User::newFromName( $response->username );
334
335 if (
336 !$this->proxyAccountCreation
337 && $response->loginRequest
338 && $authManager->canAuthenticateNow()
339 ) {
340 // successful registration; log the user in instantly
341 $response2 = $authManager->beginAuthentication( [ $response->loginRequest ],
342 $returnToUrl );
343 if ( $response2->status !== AuthenticationResponse::PASS ) {
344 LoggerFactory::getInstance( 'login' )
345 ->error( 'Could not log in after account creation' );
346 $this->successfulAction( true, Status::newFatal( 'createacct-loginerror' ) );
347 break;
348 }
349 }
350
351 if ( !$this->proxyAccountCreation ) {
352 // Ensure that the context user is the same as the session user.
354 }
355
356 $this->successfulAction( true );
357 break;
358 case AuthenticationResponse::FAIL:
359 // fall through
360 case AuthenticationResponse::RESTART:
361 unset( $this->authForm );
362 if ( $response->status === AuthenticationResponse::FAIL ) {
363 $action = $this->getDefaultAction( $subPage );
364 $messageType = 'error';
365 } else {
366 $action = $this->getContinueAction( $this->authAction );
367 $messageType = 'warning';
368 }
369 $this->logAuthResult( false, $response->message ? $response->message->getKey() : '-' );
370 $this->loadAuth( $subPage, $action, true );
371 $this->mainLoginForm( $this->authRequests, $response->message, $messageType );
372 break;
373 case AuthenticationResponse::REDIRECT:
374 unset( $this->authForm );
375 $this->getOutput()->redirect( $response->redirectTarget );
376 break;
377 case AuthenticationResponse::UI:
378 unset( $this->authForm );
379 $this->authAction = $this->isSignup() ? AuthManager::ACTION_CREATE_CONTINUE
380 : AuthManager::ACTION_LOGIN_CONTINUE;
381 $this->authRequests = $response->neededRequests;
382 $this->mainLoginForm( $response->neededRequests, $response->message, $response->messageType );
383 break;
384 default:
385 throw new LogicException( 'invalid AuthenticationResponse' );
386 }
387 }
388
402 private function canBypassForm( &$button_name ) {
403 $button_name = null;
404 if ( $this->isContinued() ) {
405 return false;
406 }
407 $fields = AuthenticationRequest::mergeFieldInfo( $this->authRequests );
408 foreach ( $fields as $fieldname => $field ) {
409 if ( !isset( $field['type'] ) ) {
410 return false;
411 }
412 if ( !empty( $field['skippable'] ) ) {
413 continue;
414 }
415 if ( $field['type'] === 'button' ) {
416 if ( $button_name !== null ) {
417 $button_name = null;
418 return false;
419 } else {
420 $button_name = $fieldname;
421 }
422 } elseif ( $field['type'] !== 'null' ) {
423 return false;
424 }
425 }
426 return true;
427 }
428
438 protected function showSuccessPage(
439 $type, $title, $msgname, $injected_html, $extraMessages
440 ) {
441 $out = $this->getOutput();
442 $out->setPageTitle( $title );
443 if ( $msgname ) {
444 $out->addWikiMsg( $msgname, wfEscapeWikiText( $this->getUser()->getName() ) );
445 }
446 if ( $extraMessages ) {
447 $extraMessages = Status::wrap( $extraMessages );
448 $out->addWikiText( $extraMessages->getWikiText() );
449 }
450
451 $out->addHTML( $injected_html );
452
453 $helper = new LoginHelper( $this->getContext() );
454 $helper->showReturnToPage( $type, $this->mReturnTo, $this->mReturnToQuery, $this->mStickHTTPS );
455 }
456
472 public function showReturnToPage(
473 $type, $returnTo = '', $returnToQuery = '', $stickHTTPS = false
474 ) {
475 $helper = new LoginHelper( $this->getContext() );
476 $helper->showReturnToPage( $type, $returnTo, $returnToQuery, $stickHTTPS );
477 }
478
483 protected function setSessionUserForCurrentRequest() {
484 global $wgUser, $wgLang;
485
486 $context = RequestContext::getMain();
487 $localContext = $this->getContext();
488 if ( $context !== $localContext ) {
489 // remove AuthManagerSpecialPage context hack
490 $this->setContext( $context );
491 }
492
493 $user = $context->getRequest()->getSession()->getUser();
494
495 $wgUser = $user;
496 $context->setUser( $user );
497
498 $wgLang = $context->getLanguage();
499 }
500
515 protected function mainLoginForm( array $requests, $msg = '', $msgtype = 'error' ) {
516 $user = $this->getUser();
517 $out = $this->getOutput();
518
519 // FIXME how to handle empty $requests - restart, or no form, just an error message?
520 // no form would be better for no session type errors, restart is better when can* fails.
521 if ( !$requests ) {
522 $this->authAction = $this->getDefaultAction( $this->subPage );
523 $this->authForm = null;
524 $requests = AuthManager::singleton()->getAuthenticationRequests( $this->authAction, $user );
525 }
526
527 // Generic styles and scripts for both login and signup form
528 $out->addModuleStyles( [
529 'mediawiki.ui',
530 'mediawiki.ui.button',
531 'mediawiki.ui.checkbox',
532 'mediawiki.ui.input',
533 'mediawiki.special.userlogin.common.styles'
534 ] );
535 if ( $this->isSignup() ) {
536 // XXX hack pending RL or JS parse() support for complex content messages T27349
537 $out->addJsConfigVars( 'wgCreateacctImgcaptchaHelp',
538 $this->msg( 'createacct-imgcaptcha-help' )->parse() );
539
540 // Additional styles and scripts for signup form
541 $out->addModules( [
542 'mediawiki.special.userlogin.signup.js'
543 ] );
544 $out->addModuleStyles( [
545 'mediawiki.special.userlogin.signup.styles'
546 ] );
547 } else {
548 // Additional styles for login form
549 $out->addModuleStyles( [
550 'mediawiki.special.userlogin.login.styles'
551 ] );
552 }
553 $out->disallowUserJs(); // just in case...
554
555 $form = $this->getAuthForm( $requests, $this->authAction, $msg, $msgtype );
556 $form->prepareForm();
557
558 $submitStatus = Status::newGood();
559 if ( $msg && $msgtype === 'warning' ) {
560 $submitStatus->warning( $msg );
561 } elseif ( $msg && $msgtype === 'error' ) {
562 $submitStatus->fatal( $msg );
563 }
564
565 // warning header for non-standard workflows (e.g. security reauthentication)
566 if (
567 !$this->isSignup() &&
568 $this->getUser()->isLoggedIn() &&
569 $this->authAction !== AuthManager::ACTION_LOGIN_CONTINUE
570 ) {
571 $reauthMessage = $this->securityLevel ? 'userlogin-reauth' : 'userlogin-loggedin';
572 $submitStatus->warning( $reauthMessage, $this->getUser()->getName() );
573 }
574
575 $formHtml = $form->getHTML( $submitStatus );
576
577 $out->addHTML( $this->getPageHtml( $formHtml ) );
578 }
579
586 protected function getPageHtml( $formHtml ) {
588
589 $loginPrompt = $this->isSignup() ? '' : Html::rawElement( 'div',
590 [ 'id' => 'userloginprompt' ], $this->msg( 'loginprompt' )->parseAsBlock() );
591 $languageLinks = $wgLoginLanguageSelector ? $this->makeLanguageSelector() : '';
592 $signupStartMsg = $this->msg( 'signupstart' );
593 $signupStart = ( $this->isSignup() && !$signupStartMsg->isDisabled() )
594 ? Html::rawElement( 'div', [ 'id' => 'signupstart' ], $signupStartMsg->parseAsBlock() ) : '';
595 if ( $languageLinks ) {
596 $languageLinks = Html::rawElement( 'div', [ 'id' => 'languagelinks' ],
597 Html::rawElement( 'p', [], $languageLinks )
598 );
599 }
600
601 $benefitsContainer = '';
602 if ( $this->isSignup() && $this->showExtraInformation() ) {
603 // messages used:
604 // createacct-benefit-icon1 createacct-benefit-head1 createacct-benefit-body1
605 // createacct-benefit-icon2 createacct-benefit-head2 createacct-benefit-body2
606 // createacct-benefit-icon3 createacct-benefit-head3 createacct-benefit-body3
607 $benefitCount = 3;
608 $benefitList = '';
609 for ( $benefitIdx = 1; $benefitIdx <= $benefitCount; $benefitIdx++ ) {
610 $headUnescaped = $this->msg( "createacct-benefit-head$benefitIdx" )->text();
611 $iconClass = $this->msg( "createacct-benefit-icon$benefitIdx" )->text();
612 $benefitList .= Html::rawElement( 'div', [ 'class' => "mw-number-text $iconClass" ],
613 Html::rawElement( 'h3', [],
614 $this->msg( "createacct-benefit-head$benefitIdx" )->escaped()
615 )
616 . Html::rawElement( 'p', [],
617 $this->msg( "createacct-benefit-body$benefitIdx" )->params( $headUnescaped )->escaped()
618 )
619 );
620 }
621 $benefitsContainer = Html::rawElement( 'div', [ 'class' => 'mw-createacct-benefits-container' ],
622 Html::rawElement( 'h2', [], $this->msg( 'createacct-benefit-heading' )->escaped() )
623 . Html::rawElement( 'div', [ 'class' => 'mw-createacct-benefits-list' ],
624 $benefitList
625 )
626 );
627 }
628
629 $html = Html::rawElement( 'div', [ 'class' => 'mw-ui-container' ],
630 $loginPrompt
631 . $languageLinks
632 . $signupStart
633 . Html::rawElement( 'div', [ 'id' => 'userloginForm' ],
634 $formHtml
635 )
636 . $benefitsContainer
637 );
638
639 return $html;
640 }
641
650 protected function getAuthForm( array $requests, $action, $msg = '', $msgType = 'error' ) {
651 global $wgSecureLogin;
652 // FIXME merge this with parent
653
654 if ( isset( $this->authForm ) ) {
655 return $this->authForm;
656 }
657
658 $usingHTTPS = $this->getRequest()->getProtocol() === 'https';
659
660 // get basic form description from the auth logic
661 $fieldInfo = AuthenticationRequest::mergeFieldInfo( $requests );
662 $fakeTemplate = $this->getFakeTemplate( $msg, $msgType );
663 $this->fakeTemplate = $fakeTemplate; // FIXME there should be a saner way to pass this to the hook
664 // this will call onAuthChangeFormFields()
665 $formDescriptor = static::fieldInfoToFormDescriptor( $requests, $fieldInfo, $this->authAction );
666 $this->postProcessFormDescriptor( $formDescriptor, $requests );
667
668 $context = $this->getContext();
669 if ( $context->getRequest() !== $this->getRequest() ) {
670 // We have overridden the request, need to make sure the form uses that too.
671 $context = new DerivativeContext( $this->getContext() );
672 $context->setRequest( $this->getRequest() );
673 }
674 $form = HTMLForm::factory( 'vform', $formDescriptor, $context );
675
676 $form->addHiddenField( 'authAction', $this->authAction );
677 if ( $this->mLanguage ) {
678 $form->addHiddenField( 'uselang', $this->mLanguage );
679 }
680 $form->addHiddenField( 'force', $this->securityLevel );
681 $form->addHiddenField( $this->getTokenName(), $this->getToken()->toString() );
682 if ( $wgSecureLogin ) {
683 // If using HTTPS coming from HTTP, then the 'fromhttp' parameter must be preserved
684 if ( !$this->isSignup() ) {
685 $form->addHiddenField( 'wpForceHttps', (int)$this->mStickHTTPS );
686 $form->addHiddenField( 'wpFromhttp', $usingHTTPS );
687 }
688 }
689
690 // set properties of the form itself
691 $form->setAction( $this->getPageTitle()->getLocalURL( $this->getReturnToQueryStringFragment() ) );
692 $form->setName( 'userlogin' . ( $this->isSignup() ? '2' : '' ) );
693 if ( $this->isSignup() ) {
694 $form->setId( 'userlogin2' );
695 }
696
697 $form->suppressDefaultSubmit();
698
699 $this->authForm = $form;
700
701 return $form;
702 }
703
710 protected function getFakeTemplate( $msg, $msgType ) {
713
714 // make a best effort to get the value of fields which used to be fixed in the old login
715 // template but now might or might not exist depending on what providers are used
716 $request = $this->getRequest();
717 $data = (object)[
718 'mUsername' => $request->getText( 'wpName' ),
719 'mPassword' => $request->getText( 'wpPassword' ),
720 'mRetype' => $request->getText( 'wpRetype' ),
721 'mEmail' => $request->getText( 'wpEmail' ),
722 'mRealName' => $request->getText( 'wpRealName' ),
723 'mDomain' => $request->getText( 'wpDomain' ),
724 'mReason' => $request->getText( 'wpReason' ),
725 'mRemember' => $request->getCheck( 'wpRemember' ),
726 ];
727
728 // Preserves a bunch of logic from the old code that was rewritten in getAuthForm().
729 // There is no code reuse to make this easier to remove .
730 // If an extension tries to change any of these values, they are out of luck - we only
731 // actually use the domain/usedomain/domainnames, extraInput and extrafields keys.
732
733 $titleObj = $this->getPageTitle();
734 $user = $this->getUser();
736
737 // Pre-fill username (if not creating an account, T46775).
738 if ( $data->mUsername == '' && $this->isSignup() ) {
739 if ( $user->isLoggedIn() ) {
740 $data->mUsername = $user->getName();
741 } else {
742 $data->mUsername = $this->getRequest()->getSession()->suggestLoginUsername();
743 }
744 }
745
746 if ( $this->isSignup() ) {
747 // Must match number of benefits defined in messages
748 $template->set( 'benefitCount', 3 );
749
750 $q = 'action=submitlogin&type=signup';
751 $linkq = 'type=login';
752 } else {
753 $q = 'action=submitlogin&type=login';
754 $linkq = 'type=signup';
755 }
756
757 if ( $this->mReturnTo !== '' ) {
758 $returnto = '&returnto=' . wfUrlencode( $this->mReturnTo );
759 if ( $this->mReturnToQuery !== '' ) {
760 $returnto .= '&returntoquery=' .
761 wfUrlencode( $this->mReturnToQuery );
762 }
763 $q .= $returnto;
764 $linkq .= $returnto;
765 }
766
767 # Don't show a "create account" link if the user can't.
768 if ( $this->showCreateAccountLink() ) {
769 # Pass any language selection on to the mode switch link
770 if ( $this->mLanguage ) {
771 $linkq .= '&uselang=' . urlencode( $this->mLanguage );
772 }
773 // Supply URL, login template creates the button.
774 $template->set( 'createOrLoginHref', $titleObj->getLocalURL( $linkq ) );
775 } else {
776 $template->set( 'link', '' );
777 }
778
779 $resetLink = $this->isSignup()
780 ? null
781 : is_array( $wgPasswordResetRoutes )
782 && in_array( true, array_values( $wgPasswordResetRoutes ), true );
783
784 $template->set( 'header', '' );
785 $template->set( 'formheader', '' );
786 $template->set( 'skin', $this->getSkin() );
787
788 $template->set( 'name', $data->mUsername );
789 $template->set( 'password', $data->mPassword );
790 $template->set( 'retype', $data->mRetype );
791 $template->set( 'createemailset', false ); // no easy way to get that from AuthManager
792 $template->set( 'email', $data->mEmail );
793 $template->set( 'realname', $data->mRealName );
794 $template->set( 'domain', $data->mDomain );
795 $template->set( 'reason', $data->mReason );
796 $template->set( 'remember', $data->mRemember );
797
798 $template->set( 'action', $titleObj->getLocalURL( $q ) );
799 $template->set( 'message', $msg );
800 $template->set( 'messagetype', $msgType );
801 $template->set( 'createemail', $wgEnableEmail && $user->isLoggedIn() );
802 $template->set( 'userealname', !in_array( 'realname', $wgHiddenPrefs, true ) );
803 $template->set( 'useemail', $wgEnableEmail );
804 $template->set( 'emailrequired', $wgEmailConfirmToEdit );
805 $template->set( 'emailothers', $wgEnableUserEmail );
806 $template->set( 'canreset', $wgAuth->allowPasswordChange() );
807 $template->set( 'resetlink', $resetLink );
808 $template->set( 'canremember', $request->getSession()->getProvider()
809 ->getRememberUserDuration() !== null );
810 $template->set( 'usereason', $user->isLoggedIn() );
811 $template->set( 'cansecurelogin', ( $wgSecureLogin ) );
812 $template->set( 'stickhttps', (int)$this->mStickHTTPS );
813 $template->set( 'loggedin', $user->isLoggedIn() );
814 $template->set( 'loggedinuser', $user->getName() );
815 $template->set( 'token', $this->getToken()->toString() );
816
817 $action = $this->isSignup() ? 'signup' : 'login';
818 $wgAuth->modifyUITemplate( $template, $action );
819
820 $oldTemplate = $template;
821
822 // Both Hooks::run are explicit here to make findHooks.php happy
823 if ( $this->isSignup() ) {
824 Hooks::run( 'UserCreateForm', [ &$template ], '1.27' );
825 if ( $oldTemplate !== $template ) {
826 wfDeprecated( "reference in UserCreateForm hook", '1.27' );
827 }
828 } else {
829 Hooks::run( 'UserLoginForm', [ &$template ], '1.27' );
830 if ( $oldTemplate !== $template ) {
831 wfDeprecated( "reference in UserLoginForm hook", '1.27' );
832 }
833 }
834
835 return $template;
836 }
837
838 public function onAuthChangeFormFields(
839 array $requests, array $fieldInfo, array &$formDescriptor, $action
840 ) {
841 $coreFieldDescriptors = $this->getFieldDefinitions( $this->fakeTemplate );
842 $specialFields = array_merge( [ 'extraInput' ],
843 array_keys( $this->fakeTemplate->getExtraInputDefinitions() ) );
844
845 // keep the ordering from getCoreFieldDescriptors() where there is no explicit weight
846 foreach ( $coreFieldDescriptors as $fieldName => $coreField ) {
847 $requestField = $formDescriptor[$fieldName] ?? [];
848
849 // remove everything that is not in the fieldinfo, is not marked as a supplemental field
850 // to something in the fieldinfo, is not B/C for the pre-AuthManager templates,
851 // and is not an info field or a submit button
852 if (
853 !isset( $fieldInfo[$fieldName] )
854 && (
855 !isset( $coreField['baseField'] )
856 || !isset( $fieldInfo[$coreField['baseField']] )
857 )
858 && !in_array( $fieldName, $specialFields, true )
859 && (
860 !isset( $coreField['type'] )
861 || !in_array( $coreField['type'], [ 'submit', 'info' ], true )
862 )
863 ) {
864 $coreFieldDescriptors[$fieldName] = null;
865 continue;
866 }
867
868 // core message labels should always take priority
869 if (
870 isset( $coreField['label'] )
871 || isset( $coreField['label-message'] )
872 || isset( $coreField['label-raw'] )
873 ) {
874 unset( $requestField['label'], $requestField['label-message'], $coreField['label-raw'] );
875 }
876
877 $coreFieldDescriptors[$fieldName] += $requestField;
878 }
879
880 $formDescriptor = array_filter( $coreFieldDescriptors + $formDescriptor );
881 return true;
882 }
883
890 protected function showExtraInformation() {
891 return $this->authAction !== $this->getContinueAction( $this->authAction )
893 }
894
900 protected function getFieldDefinitions( $template ) {
902
903 $isLoggedIn = $this->getUser()->isLoggedIn();
904 $continuePart = $this->isContinued() ? 'continue-' : '';
905 $anotherPart = $isLoggedIn ? 'another-' : '';
906 $expiration = $this->getRequest()->getSession()->getProvider()->getRememberUserDuration();
907 $expirationDays = ceil( $expiration / ( 3600 * 24 ) );
908 $secureLoginLink = '';
909 if ( $this->mSecureLoginUrl ) {
910 $secureLoginLink = Html::element( 'a', [
911 'href' => $this->mSecureLoginUrl,
912 'class' => 'mw-ui-flush-right mw-secure',
913 ], $this->msg( 'userlogin-signwithsecure' )->text() );
914 }
915 $usernameHelpLink = '';
916 if ( !$this->msg( 'createacct-helpusername' )->isDisabled() ) {
917 $usernameHelpLink = Html::rawElement( 'span', [
918 'class' => 'mw-ui-flush-right',
919 ], $this->msg( 'createacct-helpusername' )->parse() );
920 }
921
922 if ( $this->isSignup() ) {
923 $fieldDefinitions = [
924 'statusarea' => [
925 // used by the mediawiki.special.userlogin.signup.js module for error display
926 // FIXME merge this with HTMLForm's normal status (error) area
927 'type' => 'info',
928 'raw' => true,
929 'default' => Html::element( 'div', [ 'id' => 'mw-createacct-status-area' ] ),
930 'weight' => -105,
931 ],
932 'username' => [
933 'label-raw' => $this->msg( 'userlogin-yourname' )->escaped() . $usernameHelpLink,
934 'id' => 'wpName2',
935 'placeholder-message' => $isLoggedIn ? 'createacct-another-username-ph'
936 : 'userlogin-yourname-ph',
937 ],
938 'mailpassword' => [
939 // create account without providing password, a temporary one will be mailed
940 'type' => 'check',
941 'label-message' => 'createaccountmail',
942 'name' => 'wpCreateaccountMail',
943 'id' => 'wpCreateaccountMail',
944 ],
945 'password' => [
946 'id' => 'wpPassword2',
947 'placeholder-message' => 'createacct-yourpassword-ph',
948 'hide-if' => [ '===', 'wpCreateaccountMail', '1' ],
949 ],
950 'domain' => [],
951 'retype' => [
952 'baseField' => 'password',
953 'type' => 'password',
954 'label-message' => 'createacct-yourpasswordagain',
955 'id' => 'wpRetype',
956 'cssclass' => 'loginPassword',
957 'size' => 20,
958 'validation-callback' => function ( $value, $alldata ) {
959 if ( empty( $alldata['mailpassword'] ) && !empty( $alldata['password'] ) ) {
960 if ( !$value ) {
961 return $this->msg( 'htmlform-required' );
962 } elseif ( $value !== $alldata['password'] ) {
963 return $this->msg( 'badretype' );
964 }
965 }
966 return true;
967 },
968 'hide-if' => [ '===', 'wpCreateaccountMail', '1' ],
969 'placeholder-message' => 'createacct-yourpasswordagain-ph',
970 ],
971 'email' => [
972 'type' => 'email',
973 'label-message' => $wgEmailConfirmToEdit ? 'createacct-emailrequired'
974 : 'createacct-emailoptional',
975 'id' => 'wpEmail',
976 'cssclass' => 'loginText',
977 'size' => '20',
978 // FIXME will break non-standard providers
979 'required' => $wgEmailConfirmToEdit,
980 'validation-callback' => function ( $value, $alldata ) {
982
983 // AuthManager will check most of these, but that will make the auth
984 // session fail and this won't, so nicer to do it this way
985 if ( !$value && $wgEmailConfirmToEdit ) {
986 // no point in allowing registration without email when email is
987 // required to edit
988 return $this->msg( 'noemailtitle' );
989 } elseif ( !$value && !empty( $alldata['mailpassword'] ) ) {
990 // cannot send password via email when there is no email address
991 return $this->msg( 'noemailcreate' );
992 } elseif ( $value && !Sanitizer::validateEmail( $value ) ) {
993 return $this->msg( 'invalidemailaddress' );
994 }
995 return true;
996 },
997 'placeholder-message' => 'createacct-' . $anotherPart . 'email-ph',
998 ],
999 'realname' => [
1000 'type' => 'text',
1001 'help-message' => $isLoggedIn ? 'createacct-another-realname-tip'
1002 : 'prefs-help-realname',
1003 'label-message' => 'createacct-realname',
1004 'cssclass' => 'loginText',
1005 'size' => 20,
1006 'id' => 'wpRealName',
1007 ],
1008 'reason' => [
1009 // comment for the user creation log
1010 'type' => 'text',
1011 'label-message' => 'createacct-reason',
1012 'cssclass' => 'loginText',
1013 'id' => 'wpReason',
1014 'size' => '20',
1015 'placeholder-message' => 'createacct-reason-ph',
1016 ],
1017 'extrainput' => [], // placeholder for fields coming from the template
1018 'createaccount' => [
1019 // submit button
1020 'type' => 'submit',
1021 'default' => $this->msg( 'createacct-' . $anotherPart . $continuePart .
1022 'submit' )->text(),
1023 'name' => 'wpCreateaccount',
1024 'id' => 'wpCreateaccount',
1025 'weight' => 100,
1026 ],
1027 ];
1028 } else {
1029 $fieldDefinitions = [
1030 'username' => [
1031 'label-raw' => $this->msg( 'userlogin-yourname' )->escaped() . $secureLoginLink,
1032 'id' => 'wpName1',
1033 'placeholder-message' => 'userlogin-yourname-ph',
1034 ],
1035 'password' => [
1036 'id' => 'wpPassword1',
1037 'placeholder-message' => 'userlogin-yourpassword-ph',
1038 ],
1039 'domain' => [],
1040 'extrainput' => [],
1041 'rememberMe' => [
1042 // option for saving the user token to a cookie
1043 'type' => 'check',
1044 'name' => 'wpRemember',
1045 'label-message' => $this->msg( 'userlogin-remembermypassword' )
1046 ->numParams( $expirationDays ),
1047 'id' => 'wpRemember',
1048 ],
1049 'loginattempt' => [
1050 // submit button
1051 'type' => 'submit',
1052 'default' => $this->msg( 'pt-login-' . $continuePart . 'button' )->text(),
1053 'id' => 'wpLoginAttempt',
1054 'weight' => 100,
1055 ],
1056 'linkcontainer' => [
1057 // help link
1058 'type' => 'info',
1059 'cssclass' => 'mw-form-related-link-container mw-userlogin-help',
1060 // 'id' => 'mw-userlogin-help', // FIXME HTMLInfoField ignores this
1061 'raw' => true,
1062 'default' => Html::element( 'a', [
1063 'href' => Skin::makeInternalOrExternalUrl( $this->msg( 'helplogin-url' )
1064 ->inContentLanguage()
1065 ->text() ),
1066 ], $this->msg( 'userlogin-helplink2' )->text() ),
1067 'weight' => 200,
1068 ],
1069 // button for ResetPasswordSecondaryAuthenticationProvider
1070 'skipReset' => [
1071 'weight' => 110,
1072 'flags' => [],
1073 ],
1074 ];
1075 }
1076
1077 $fieldDefinitions['username'] += [
1078 'type' => 'text',
1079 'name' => 'wpName',
1080 'cssclass' => 'loginText',
1081 'size' => 20,
1082 // 'required' => true,
1083 ];
1084 $fieldDefinitions['password'] += [
1085 'type' => 'password',
1086 // 'label-message' => 'userlogin-yourpassword', // would override the changepassword label
1087 'name' => 'wpPassword',
1088 'cssclass' => 'loginPassword',
1089 'size' => 20,
1090 // 'required' => true,
1091 ];
1092
1093 if ( $template->get( 'header' ) || $template->get( 'formheader' ) ) {
1094 // B/C for old extensions that haven't been converted to AuthManager (or have been
1095 // but somebody is using the old version) and still use templates via the
1096 // UserCreateForm/UserLoginForm hook.
1097 // 'header' used by ConfirmEdit, ConfirmAccount, Persona, WikimediaIncubator, SemanticSignup
1098 // 'formheader' used by MobileFrontend
1099 $fieldDefinitions['header'] = [
1100 'type' => 'info',
1101 'raw' => true,
1102 'default' => $template->get( 'header' ) ?: $template->get( 'formheader' ),
1103 'weight' => -110,
1104 ];
1105 }
1106 if ( $this->mEntryError ) {
1107 $fieldDefinitions['entryError'] = [
1108 'type' => 'info',
1109 'default' => Html::rawElement( 'div', [ 'class' => $this->mEntryErrorType . 'box', ],
1110 $this->mEntryError ),
1111 'raw' => true,
1112 'rawrow' => true,
1113 'weight' => -100,
1114 ];
1115 }
1116 if ( !$this->showExtraInformation() ) {
1117 unset( $fieldDefinitions['linkcontainer'], $fieldDefinitions['signupend'] );
1118 }
1119 if ( $this->isSignup() && $this->showExtraInformation() ) {
1120 // blank signup footer for site customization
1121 // uses signupend-https for HTTPS requests if it's not blank, signupend otherwise
1122 $signupendMsg = $this->msg( 'signupend' );
1123 $signupendHttpsMsg = $this->msg( 'signupend-https' );
1124 if ( !$signupendMsg->isDisabled() ) {
1125 $usingHTTPS = $this->getRequest()->getProtocol() === 'https';
1126 $signupendText = ( $usingHTTPS && !$signupendHttpsMsg->isBlank() )
1127 ? $signupendHttpsMsg->parse() : $signupendMsg->parse();
1128 $fieldDefinitions['signupend'] = [
1129 'type' => 'info',
1130 'raw' => true,
1131 'default' => Html::rawElement( 'div', [ 'id' => 'signupend' ], $signupendText ),
1132 'weight' => 225,
1133 ];
1134 }
1135 }
1136 if ( !$this->isSignup() && $this->showExtraInformation() ) {
1137 $passwordReset = new PasswordReset( $this->getConfig(), AuthManager::singleton() );
1138 if ( $passwordReset->isAllowed( $this->getUser() )->isGood() ) {
1139 $fieldDefinitions['passwordReset'] = [
1140 'type' => 'info',
1141 'raw' => true,
1142 'cssclass' => 'mw-form-related-link-container',
1143 'default' => $this->getLinkRenderer()->makeLink(
1144 SpecialPage::getTitleFor( 'PasswordReset' ),
1145 $this->msg( 'userlogin-resetpassword-link' )->text()
1146 ),
1147 'weight' => 230,
1148 ];
1149 }
1150
1151 // Don't show a "create account" link if the user can't.
1152 if ( $this->showCreateAccountLink() ) {
1153 // link to the other action
1154 $linkTitle = $this->getTitleFor( $this->isSignup() ? 'Userlogin' : 'CreateAccount' );
1155 $linkq = $this->getReturnToQueryStringFragment();
1156 // Pass any language selection on to the mode switch link
1157 if ( $this->mLanguage ) {
1158 $linkq .= '&uselang=' . urlencode( $this->mLanguage );
1159 }
1160 $loggedIn = $this->getUser()->isLoggedIn();
1161
1162 $fieldDefinitions['createOrLogin'] = [
1163 'type' => 'info',
1164 'raw' => true,
1165 'linkQuery' => $linkq,
1166 'default' => function ( $params ) use ( $loggedIn, $linkTitle ) {
1167 return Html::rawElement( 'div',
1168 [ 'id' => 'mw-createaccount' . ( !$loggedIn ? '-cta' : '' ),
1169 'class' => ( $loggedIn ? 'mw-form-related-link-container' : 'mw-ui-vform-field' ) ],
1170 ( $loggedIn ? '' : $this->msg( 'userlogin-noaccount' )->escaped() )
1171 . Html::element( 'a',
1172 [
1173 'id' => 'mw-createaccount-join' . ( $loggedIn ? '-loggedin' : '' ),
1174 'href' => $linkTitle->getLocalURL( $params['linkQuery'] ),
1175 'class' => ( $loggedIn ? '' : 'mw-ui-button' ),
1176 'tabindex' => 100,
1177 ],
1178 $this->msg(
1179 $loggedIn ? 'userlogin-createanother' : 'userlogin-joinproject'
1180 )->text()
1181 )
1182 );
1183 },
1184 'weight' => 235,
1185 ];
1186 }
1187 }
1188
1189 $fieldDefinitions = $this->getBCFieldDefinitions( $fieldDefinitions, $template );
1190 $fieldDefinitions = array_filter( $fieldDefinitions );
1191
1192 return $fieldDefinitions;
1193 }
1194
1201 protected function getBCFieldDefinitions( $fieldDefinitions, $template ) {
1202 if ( $template->get( 'usedomain', false ) ) {
1203 // TODO probably should be translated to the new domain notation in AuthManager
1204 $fieldDefinitions['domain'] = [
1205 'type' => 'select',
1206 'label-message' => 'yourdomainname',
1207 'options' => array_combine( $template->get( 'domainnames', [] ),
1208 $template->get( 'domainnames', [] ) ),
1209 'default' => $template->get( 'domain', '' ),
1210 'name' => 'wpDomain',
1211 // FIXME id => 'mw-user-domain-section' on the parent div
1212 ];
1213 }
1214
1215 // poor man's associative array_splice
1216 $extraInputPos = array_search( 'extrainput', array_keys( $fieldDefinitions ), true );
1217 $fieldDefinitions = array_slice( $fieldDefinitions, 0, $extraInputPos, true )
1218 + $template->getExtraInputDefinitions()
1219 + array_slice( $fieldDefinitions, $extraInputPos + 1, null, true );
1220
1221 return $fieldDefinitions;
1222 }
1223
1233 protected function hasSessionCookie() {
1235
1236 return $wgDisableCookieCheck || (
1238 $this->getRequest()->getSession()->getId() === (string)$wgInitialSessionId
1239 );
1240 }
1241
1247 protected function getReturnToQueryStringFragment() {
1248 $returnto = '';
1249 if ( $this->mReturnTo !== '' ) {
1250 $returnto = 'returnto=' . wfUrlencode( $this->mReturnTo );
1251 if ( $this->mReturnToQuery !== '' ) {
1252 $returnto .= '&returntoquery=' . wfUrlencode( $this->mReturnToQuery );
1253 }
1254 }
1255 return $returnto;
1256 }
1257
1263 private function showCreateAccountLink() {
1264 if ( $this->isSignup() ) {
1265 return true;
1266 } elseif ( $this->getUser()->isAllowed( 'createaccount' ) ) {
1267 return true;
1268 } else {
1269 return false;
1270 }
1271 }
1272
1273 protected function getTokenName() {
1274 return $this->isSignup() ? 'wpCreateaccountToken' : 'wpLoginToken';
1275 }
1276
1283 protected function makeLanguageSelector() {
1284 $msg = $this->msg( 'loginlanguagelinks' )->inContentLanguage();
1285 if ( $msg->isBlank() ) {
1286 return '';
1287 }
1288 $langs = explode( "\n", $msg->text() );
1289 $links = [];
1290 foreach ( $langs as $lang ) {
1291 $lang = trim( $lang, '* ' );
1292 $parts = explode( '|', $lang );
1293 if ( count( $parts ) >= 2 ) {
1294 $links[] = $this->makeLanguageSelectorLink( $parts[0], trim( $parts[1] ) );
1295 }
1296 }
1297
1298 return count( $links ) > 0 ? $this->msg( 'loginlanguagelabel' )->rawParams(
1299 $this->getLanguage()->pipeList( $links ) )->escaped() : '';
1300 }
1301
1310 protected function makeLanguageSelectorLink( $text, $lang ) {
1311 if ( $this->getLanguage()->getCode() == $lang ) {
1312 // no link for currently used language
1313 return htmlspecialchars( $text );
1314 }
1315 $query = [ 'uselang' => $lang ];
1316 if ( $this->mReturnTo !== '' ) {
1317 $query['returnto'] = $this->mReturnTo;
1318 $query['returntoquery'] = $this->mReturnToQuery;
1319 }
1320
1321 $attr = [];
1322 $targetLanguage = Language::factory( $lang );
1323 $attr['lang'] = $attr['hreflang'] = $targetLanguage->getHtmlCode();
1324
1325 return $this->getLinkRenderer()->makeKnownLink(
1326 $this->getPageTitle(),
1327 $text,
1328 $attr,
1329 $query
1330 );
1331 }
1332
1333 protected function getGroupName() {
1334 return 'login';
1335 }
1336
1342 // Pre-fill username (if not creating an account, T46775).
1343 if (
1344 isset( $formDescriptor['username'] ) &&
1345 !isset( $formDescriptor['username']['default'] ) &&
1346 !$this->isSignup()
1347 ) {
1348 $user = $this->getUser();
1349 if ( $user->isLoggedIn() ) {
1350 $formDescriptor['username']['default'] = $user->getName();
1351 } else {
1352 $formDescriptor['username']['default'] =
1353 $this->getRequest()->getSession()->suggestLoginUsername();
1354 }
1355 }
1356
1357 // don't show a submit button if there is nothing to submit (i.e. the only form content
1358 // is other submit buttons, for redirect flows)
1359 if ( !$this->needsSubmitButton( $requests ) ) {
1360 unset( $formDescriptor['createaccount'], $formDescriptor['loginattempt'] );
1361 }
1362
1363 if ( !$this->isSignup() ) {
1364 // FIXME HACK don't focus on non-empty field
1365 // maybe there should be an autofocus-if similar to hide-if?
1366 if (
1367 isset( $formDescriptor['username'] )
1368 && empty( $formDescriptor['username']['default'] )
1369 && !$this->getRequest()->getCheck( 'wpName' )
1370 ) {
1371 $formDescriptor['username']['autofocus'] = true;
1372 } elseif ( isset( $formDescriptor['password'] ) ) {
1373 $formDescriptor['password']['autofocus'] = true;
1374 }
1375 }
1376
1377 $this->addTabIndex( $formDescriptor );
1378 }
1379}
1380
1388 public function execute() {
1389 throw new LogicException( 'not used' );
1390 }
1391
1401 public function addInputItem( $name, $value, $type, $msg, $helptext = false ) {
1402 // use the same indexes as UserCreateForm just in case someone adds an item manually
1403 $this->data['extrainput'][] = [
1404 'name' => $name,
1405 'value' => $value,
1406 'type' => $type,
1407 'msg' => $msg,
1408 'helptext' => $helptext,
1409 ];
1410 }
1411
1416 public function getExtraInputDefinitions() {
1417 $definitions = [];
1418
1419 foreach ( $this->get( 'extrainput', [] ) as $field ) {
1420 $definition = [
1421 'type' => $field['type'] === 'checkbox' ? 'check' : $field['type'],
1422 'name' => $field['name'],
1423 'value' => $field['value'],
1424 'id' => $field['name'],
1425 ];
1426 if ( $field['msg'] ) {
1427 $definition['label-message'] = $this->getMsg( $field['msg'] );
1428 }
1429 if ( $field['helptext'] ) {
1430 $definition['help'] = $this->msgWiki( $field['helptext'] );
1431 }
1432
1433 // the array key doesn't matter much when name is defined explicitly but
1434 // let's try and follow HTMLForm conventions
1435 $name = preg_replace( '/^wp(?=[A-Z])/', '', $field['name'] );
1436 $definitions[$name] = $definition;
1437 }
1438
1439 if ( $this->haveData( 'extrafields' ) ) {
1440 $definitions['extrafields'] = [
1441 'type' => 'info',
1442 'raw' => true,
1443 'default' => $this->get( 'extrafields' ),
1444 ];
1445 }
1446
1447 return $definitions;
1448 }
1449}
1450
1456class LoginForm extends SpecialPage {
1457 const SUCCESS = 0;
1458 const NO_NAME = 1;
1459 const ILLEGAL = 2;
1461 const NOT_EXISTS = 4;
1462 const WRONG_PASS = 5;
1463 const EMPTY_PASS = 6;
1464 const RESET_PASS = 7;
1465 const ABORTED = 8;
1467 const THROTTLED = 10;
1468 const USER_BLOCKED = 11;
1469 const NEED_TOKEN = 12;
1470 const WRONG_TOKEN = 13;
1471 const USER_MIGRATED = 14;
1472
1473 public static $statusCodes = [
1474 self::SUCCESS => 'success',
1475 self::NO_NAME => 'no_name',
1476 self::ILLEGAL => 'illegal',
1477 self::WRONG_PLUGIN_PASS => 'wrong_plugin_pass',
1478 self::NOT_EXISTS => 'not_exists',
1479 self::WRONG_PASS => 'wrong_pass',
1480 self::EMPTY_PASS => 'empty_pass',
1481 self::RESET_PASS => 'reset_pass',
1482 self::ABORTED => 'aborted',
1483 self::CREATE_BLOCKED => 'create_blocked',
1484 self::THROTTLED => 'throttled',
1485 self::USER_BLOCKED => 'user_blocked',
1486 self::NEED_TOKEN => 'need_token',
1487 self::WRONG_TOKEN => 'wrong_token',
1488 self::USER_MIGRATED => 'user_migrated',
1489 ];
1490
1494 public function __construct( $request = null ) {
1495 wfDeprecated( 'LoginForm', '1.27' );
1496 parent::__construct();
1497 }
1498
1503 public static function getValidErrorMessages() {
1505 }
1506
1512 public static function incrementLoginThrottle( $username ) {
1513 wfDeprecated( __METHOD__, "1.27" );
1514 global $wgRequest;
1516 $throttler = new Throttler();
1517 return $throttler->increase( $username, $wgRequest->getIP(), __METHOD__ );
1518 }
1519
1525 public static function incLoginThrottle( $username ) {
1526 wfDeprecated( __METHOD__, "1.27" );
1527 $res = self::incrementLoginThrottle( $username );
1528 return is_array( $res ) ? true : 0;
1529 }
1530
1536 public static function clearLoginThrottle( $username ) {
1537 wfDeprecated( __METHOD__, "1.27" );
1538 global $wgRequest;
1540 $throttler = new Throttler();
1541 return $throttler->clear( $username, $wgRequest->getIP() );
1542 }
1543
1547 public static function getLoginToken() {
1548 wfDeprecated( __METHOD__, '1.27' );
1549 global $wgRequest;
1550 return $wgRequest->getSession()->getToken( '', 'login' )->toString();
1551 }
1552
1556 public static function setLoginToken() {
1557 wfDeprecated( __METHOD__, '1.27' );
1558 }
1559
1563 public static function clearLoginToken() {
1564 wfDeprecated( __METHOD__, '1.27' );
1565 global $wgRequest;
1566 $wgRequest->getSession()->resetToken( 'login' );
1567 }
1568
1573 public static function getCreateaccountToken() {
1574 wfDeprecated( __METHOD__, '1.27' );
1575 global $wgRequest;
1576 return $wgRequest->getSession()->getToken( '', 'createaccount' )->toString();
1577 }
1578
1582 public static function setCreateaccountToken() {
1583 wfDeprecated( __METHOD__, '1.27' );
1584 }
1585
1589 public static function clearCreateaccountToken() {
1590 wfDeprecated( __METHOD__, '1.27' );
1591 global $wgRequest;
1592 $wgRequest->getSession()->resetToken( 'createaccount' );
1593 }
1594}
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
$wgDisableCookieCheck
By default, MediaWiki checks if the client supports cookies during the login process,...
$wgHiddenPrefs
An array of preferences to not show for the user.
$wgLoginLanguageSelector
Show a bar of language selection links in the user login and user registration forms; edit the "login...
$wgEnableUserEmail
Set to true to enable user-to-user e-mail.
$wgPasswordResetRoutes
Whether to allow password resets ("enter some identifying data, and we'll send an email with a tempor...
$wgEnableEmail
Set to true to enable the e-mail basic features: Password reminders, etc.
$wgSecureLogin
This is to let user authenticate using https when they come from http.
$wgEmailConfirmToEdit
Should editors be required to have a validated e-mail address before being allowed to edit?
$wgAuth $wgAuth
Authentication plugin.
$wgUseMediaWikiUIEverywhere
Temporary variable that applies MediaWiki UI wherever it can be supported.
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness,...
wfCanIPUseHTTPS( $ip)
Determine whether the client at a given source IP is likely to be able to access the wiki via HTTPS.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
$wgInitialSessionId
Definition Setup.php:834
if(! $wgDBerrorLogTZ) $wgRequest
Definition Setup.php:747
$wgLang
Definition Setup.php:910
A special page subclass for authentication-related special pages.
getContinueAction( $action)
Gets the _CONTINUE version of an action.
isActionAllowed( $action)
Checks whether AuthManager is ready to perform the action.
loadAuth( $subPage, $authAction=null, $reset=false)
Load or initialize $authAction, $authRequests and $subPage.
getDefaultAction( $subPage)
Get the default action for this special page, if none is given via URL/POST data.
needsSubmitButton(array $requests)
Returns true if the form built from the given AuthenticationRequests needs a submit button.
string $subPage
Subpage of the special page.
isContinued()
Returns true if this is not the first step of the authentication.
getRequest()
Get the WebRequest being used for this instance.
trySubmit()
Attempts to do an authentication step with the submitted data.
getToken()
Returns the CSRF token.
addTabIndex(&$formDescriptor)
Adds a sequential tabindex starting from 1 to all form elements.
New base template for a skin's template extended from QuickTemplate this class features helper method...
msgWiki( $str)
An ugly, ugly hack.
getMsg( $name)
Get a Message object with its context set.
An IContextSource implementation which will inherit context from another source but allow individual ...
An error page which can definitely be safely rendered using the OutputPage.
B/C class to try handling login/signup template modifications even though login/signup does not actua...
addInputItem( $name, $value, $type, $msg, $helptext=false)
Extensions (AntiSpoof and TitleBlacklist) call this in response to UserCreateForm hook to add checkbo...
getExtraInputDefinitions()
Turns addInputItem-style field definitions into HTMLForm field definitions.
execute()
Main function, used by classes that subclass QuickTemplate to show the actual HTML output.
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition HTMLForm.php:136
LoginForm as a special page has been replaced by SpecialUserLogin and SpecialCreateAccount,...
static incrementLoginThrottle( $username)
static incLoginThrottle( $username)
__construct( $request=null)
static clearLoginThrottle( $username)
static clearCreateaccountToken()
Helper functions for the login form that need to be shared with other special pages (such as CentralA...
static getValidErrorMessages()
Returns an array of all valid error messages.
Holds shared logic for login and account creation pages.
mainLoginForm(array $requests, $msg='', $msgtype='error')
canBypassForm(&$button_name)
Determine if the login form can be bypassed.
getPreservedParams( $withToken=false)
Returns URL query parameters which can be used to reload the page (or leave and return) while preserv...
logAuthResult( $success, $status=null)
Logs to the authmanager-stats channel.
onAuthChangeFormFields(array $requests, array $fieldInfo, array &$formDescriptor, $action)
Change the form descriptor that determines how a field will look in the authentication form.
loadRequestParameters( $subPage)
Load basic request parameters for this Special page.
setSessionUserForCurrentRequest()
Replace some globals to make sure the fact that the user has just been logged in is reflected in the ...
getFakeTemplate( $msg, $msgType)
Temporary B/C method to handle extensions using the UserLoginForm/UserCreateForm hooks.
showSuccessPage( $type, $title, $msgname, $injected_html, $extraMessages)
Show the success page.
getReturnToQueryStringFragment()
Returns a string that can be appended to the URL (without encoding) to preserve the return target.
User $targetUser
FIXME another flag for passing data.
successfulAction( $direct=false, $extraMessages=null)
getBCFieldDefinitions( $fieldDefinitions, $template)
Adds fields provided via the deprecated UserLoginForm / UserCreateForm hooks.
showExtraInformation()
Show extra information such as password recovery information, link from login to signup,...
getPageHtml( $formHtml)
Add page elements which are outside the form.
hasSessionCookie()
Check if a session cookie is present.
getAuthForm(array $requests, $action, $msg='', $msgType='error')
Generates a form from the given request.
getTokenName()
Returns the name of the CSRF token (under which it should be found in the POST or GET data).
makeLanguageSelectorLink( $text, $lang)
Create a language selector link for a particular language Links back to this page preserving type and...
bool $proxyAccountCreation
True if the user if creating an account for someone else.
showCreateAccountLink()
Whether the login/create account form should display a link to the other form (in addition to whateve...
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
beforeExecute( $subPage)
Gets called before.
getFieldDefinitions( $template)
Create a HTMLForm descriptor for the core login fields.
postProcessFormDescriptor(&$formDescriptor, $requests)
setRequest(array $data, $wasPosted=null)
Override the POST data, GET data from the real request is preserved.
showReturnToPage( $type, $returnTo='', $returnToQuery='', $stickHTTPS=false)
Add a "return to" link or redirect to it.
makeLanguageSelector()
Produce a bar of links which allow the user to select another language during login/registration but ...
load( $subPage)
Load data from request.
This serves as the entry point to the authentication system.
This is a value object for authentication requests.
This is a value object to hold authentication response data.
PSR-3 logger instance factory.
MediaWikiServices is the service locator for the application scope of MediaWiki.
This serves as the entry point to the MediaWiki session handling system.
Helper class for the password reset functionality shared by the web UI and the API.
Parent class for all special pages.
setContext( $context)
Sets the context this SpecialPage is executed in.
getName()
Get the name of this Special Page.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getOutput()
Get the OutputPage being used for this instance.
getUser()
Shortcut to get the User executing this instance.
getSkin()
Shortcut to get the skin being used for this instance.
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
getContext()
Gets the context this SpecialPage is executed in.
msg( $key)
Wrapper around wfMessage that sets the current context.
getConfig()
Shortcut to get main config object.
getPageTitle( $subpage=false)
Get a self-referential title object.
getLanguage()
Shortcut to get user's language.
getFullTitle()
Return the full title, including $par.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition User.php:592
static getCanonicalName( $name, $validate='valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid.
Definition User.php:1238
$res
Definition database.txt:21
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2880
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition hooks.txt:1841
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition hooks.txt:181
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead & $formDescriptor
Definition hooks.txt:2208
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping $template
Definition hooks.txt:861
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition hooks.txt:2885
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition hooks.txt:2055
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:894
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition hooks.txt:2062
Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink() instead. & $feedLinks hooks can tweak the array to change how login etc forms should look $requests
Definition hooks.txt:304
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
this hook is for auditing only or null if authentication failed before getting that far $username
Definition hooks.txt:815
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy: boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1071
this hook is for auditing only $response
Definition hooks.txt:813
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1656
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
Definition globals.txt:62
const PROTO_HTTPS
Definition Defines.php:220
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
MediaWiki has optional support for a high distributed memory object caching system For general information on but for a larger site with heavy load
Definition memcached.txt:6
$params
if(!isset( $args[0])) $lang