31use Wikimedia\ScopedCallback;
77 abstract protected function successfulAction( $direct =
false, $extraMessages =
null );
88 parent::__construct( $name );
94 protected function setRequest( array $data, $wasPosted =
null ) {
95 parent::setRequest( $data, $wasPosted );
96 $this->mLoadedRequest =
false;
104 if ( $this->mLoadedRequest ) {
107 $this->mLoadedRequest =
true;
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',
'' );
131 if ( $this->mLoaded ) {
134 $this->mLoaded =
true;
139 $securityLevel && AuthManager::singleton()->securitySensitiveOperationStatus(
150 $entryError = $this->
msg(
$request->getVal(
'error',
'' ) );
151 $entryWarning = $this->
msg(
$request->getVal(
'warning',
'' ) );
156 $this->
msg(
'loginreqlink' )->
text(),
159 'returnto' => $this->mReturnTo,
160 'returntoquery' => $this->mReturnToQuery,
161 'uselang' => $this->mLanguage ?:
null,
167 if ( $entryError->exists()
170 $this->mEntryErrorType =
'error';
171 $this->mEntryError = $entryError->rawParams( $loginreqlink )->parse();
173 } elseif ( $entryWarning->exists()
176 $this->mEntryErrorType =
'warning';
177 $this->mEntryError = $entryWarning->rawParams( $loginreqlink )->parse();
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' ) )
188 $this->mReturnTo =
'';
189 $this->mReturnToQuery =
'';
196 $params = parent::getPreservedParams( $withToken );
198 'returnto' => $this->mReturnTo ?:
null,
199 'returntoquery' => $this->mReturnToQuery ?:
null,
202 $params[
'fromhttp'] = $this->mFromHTTP ?
'1' :
null;
210 return parent::beforeExecute(
$subPage );
217 if ( $this->mPosted ) {
218 $time = microtime(
true );
219 $profilingScope =
new ScopedCallback(
function () use (
$time ) {
221 $statsd = MediaWikiServices::getInstance()->getStatsdDataFactory();
222 $statsd->timing(
"timing.login.ui.{$this->authAction}",
$time * 1000 );
226 $authManager = AuthManager::singleton();
227 $session = SessionManager::getGlobalSession();
238 if ( !$this->
isSignup() && !$authManager->canAuthenticateNow() ) {
239 if ( !$session->canSetUser() ) {
240 throw new ErrorPageError(
'cannotloginnow-title',
'cannotloginnow-text', [
244 throw new ErrorPageError(
'cannotlogin-title',
'cannotlogin-text' );
245 } elseif ( $this->
isSignup() && !$authManager->canCreateAccounts() ) {
246 throw new ErrorPageError(
'cannotcreateaccount-title',
'cannotcreateaccount-text' );
263 if ( !$this->
isSignup() && !$this->mPosted && !$this->securityLevel &&
264 ( $this->mReturnTo !==
'' || $this->mReturnToQuery !==
'' ) &&
272 if ( $this->
getRequest()->getProtocol() !==
'https' ) {
276 ( $this->mEntryErrorType ===
'error' ?
'error'
277 :
'warning' ) => $this->mEntryError,
287 $this->
getOutput()->addVaryHeader(
'X-Forwarded-Proto' );
294 if ( substr( $url, 0, 8 ) ===
'https://' ) {
295 $this->mSecureLoginUrl = $url;
304 $this->
mainLoginForm( [],
'authpage-cannot-' . $this->authAction );
311 if ( $button_name ) {
312 $this->
getRequest()->setVal( $button_name,
true );
329 case AuthenticationResponse::PASS:
331 $this->proxyAccountCreation = $this->
isSignup() && !$this->
getUser()->isAnon();
332 $this->targetUser = User::newFromName(
$response->username );
335 !$this->proxyAccountCreation
337 && $authManager->canAuthenticateNow()
340 $response2 = $authManager->beginAuthentication( [
$response->loginRequest ],
342 if ( $response2->status !== AuthenticationResponse::PASS ) {
343 LoggerFactory::getInstance(
'login' )
344 ->error(
'Could not log in after account creation' );
345 $this->
successfulAction(
true, Status::newFatal(
'createacct-loginerror' ) );
350 if ( !$this->proxyAccountCreation ) {
357 case AuthenticationResponse::FAIL:
359 case AuthenticationResponse::RESTART:
360 unset( $this->authForm );
361 if (
$response->status === AuthenticationResponse::FAIL ) {
363 $messageType =
'error';
366 $messageType =
'warning';
372 case AuthenticationResponse::REDIRECT:
373 unset( $this->authForm );
376 case AuthenticationResponse::UI:
377 unset( $this->authForm );
378 $this->authAction = $this->
isSignup() ? AuthManager::ACTION_CREATE_CONTINUE
379 : AuthManager::ACTION_LOGIN_CONTINUE;
380 $this->authRequests =
$response->neededRequests;
384 throw new LogicException(
'invalid AuthenticationResponse' );
406 $fields = AuthenticationRequest::mergeFieldInfo( $this->authRequests );
407 foreach ( $fields as $fieldname => $field ) {
408 if ( !isset( $field[
'type'] ) ) {
411 if ( !empty( $field[
'skippable'] ) ) {
414 if ( $field[
'type'] ===
'button' ) {
415 if ( $button_name !==
null ) {
419 $button_name = $fieldname;
421 } elseif ( $field[
'type'] !==
'null' ) {
438 $type, $title, $msgname, $injected_html, $extraMessages
441 $out->setPageTitle( $title );
445 if ( $extraMessages ) {
446 $extraMessages = Status::wrap( $extraMessages );
447 $out->addWikiText( $extraMessages->getWikiText() );
450 $out->addHTML( $injected_html );
453 $helper->showReturnToPage(
$type, $this->mReturnTo, $this->mReturnToQuery, $this->mStickHTTPS );
472 $type, $returnTo =
'', $returnToQuery =
'', $stickHTTPS =
false
475 $helper->showReturnToPage(
$type, $returnTo, $returnToQuery, $stickHTTPS );
493 $user =
$context->getRequest()->getSession()->getUser();
498 $code = $this->
getRequest()->getVal(
'uselang', $user->getOption(
'language' ) );
499 $userLang = Language::factory(
$code );
527 $this->authForm =
null;
528 $requests = AuthManager::singleton()->getAuthenticationRequests( $this->authAction, $user );
532 $out->addModuleStyles( [
534 'mediawiki.ui.button',
535 'mediawiki.ui.checkbox',
536 'mediawiki.ui.input',
537 'mediawiki.special.userlogin.common.styles'
541 $out->addJsConfigVars(
'wgCreateacctImgcaptchaHelp',
542 $this->
msg(
'createacct-imgcaptcha-help' )->parse() );
546 'mediawiki.special.userlogin.signup.js'
548 $out->addModuleStyles( [
549 'mediawiki.special.userlogin.signup.styles'
553 $out->addModuleStyles( [
554 'mediawiki.special.userlogin.login.styles'
557 $out->disallowUserJs();
559 $form = $this->
getAuthForm( $requests, $this->authAction, $msg, $msgtype );
560 $form->prepareForm();
562 $submitStatus = Status::newGood();
563 if ( $msg && $msgtype ===
'warning' ) {
564 $submitStatus->warning( $msg );
565 } elseif ( $msg && $msgtype ===
'error' ) {
566 $submitStatus->fatal( $msg );
572 $this->
getUser()->isLoggedIn() &&
573 $this->authAction !== AuthManager::ACTION_LOGIN_CONTINUE
575 $reauthMessage = $this->securityLevel ?
'userlogin-reauth' :
'userlogin-loggedin';
576 $submitStatus->warning( $reauthMessage, $this->
getUser()->
getName() );
579 $formHtml = $form->getHTML( $submitStatus );
593 $loginPrompt = $this->
isSignup() ?
'' : Html::rawElement(
'div',
594 [
'id' =>
'userloginprompt' ], $this->
msg(
'loginprompt' )->parseAsBlock() );
596 $signupStartMsg = $this->
msg(
'signupstart' );
597 $signupStart = ( $this->
isSignup() && !$signupStartMsg->isDisabled() )
598 ? Html::rawElement(
'div', [
'id' =>
'signupstart' ], $signupStartMsg->parseAsBlock() ) :
'';
599 if ( $languageLinks ) {
600 $languageLinks = Html::rawElement(
'div', [
'id' =>
'languagelinks' ],
601 Html::rawElement(
'p', [], $languageLinks )
605 $benefitsContainer =
'';
613 for ( $benefitIdx = 1; $benefitIdx <= $benefitCount; $benefitIdx++ ) {
614 $headUnescaped = $this->
msg(
"createacct-benefit-head$benefitIdx" )->text();
615 $iconClass = $this->
msg(
"createacct-benefit-icon$benefitIdx" )->escaped();
616 $benefitList .= Html::rawElement(
'div', [
'class' =>
"mw-number-text $iconClass" ],
617 Html::rawElement(
'h3', [],
618 $this->
msg(
"createacct-benefit-head$benefitIdx" )->escaped()
620 . Html::rawElement(
'p', [],
621 $this->
msg(
"createacct-benefit-body$benefitIdx" )->params( $headUnescaped )->escaped()
625 $benefitsContainer = Html::rawElement(
'div', [
'class' =>
'mw-createacct-benefits-container' ],
626 Html::rawElement(
'h2', [], $this->
msg(
'createacct-benefit-heading' )->escaped() )
627 . Html::rawElement(
'div', [
'class' =>
'mw-createacct-benefits-list' ],
633 $html = Html::rawElement(
'div', [
'class' =>
'mw-ui-container' ],
637 . Html::rawElement(
'div', [
'id' =>
'userloginForm' ],
658 if ( isset( $this->authForm ) ) {
662 $usingHTTPS = $this->
getRequest()->getProtocol() ===
'https';
665 $fieldInfo = AuthenticationRequest::mergeFieldInfo(
$requests );
669 $formDescriptor = static::fieldInfoToFormDescriptor(
$requests, $fieldInfo, $this->authAction );
673 if (
$context->getRequest() !== $this->getRequest() ) {
680 $form->addHiddenField(
'authAction', $this->authAction );
681 if ( $this->mLanguage ) {
682 $form->addHiddenField(
'uselang', $this->mLanguage );
684 $form->addHiddenField(
'force', $this->securityLevel );
689 $form->addHiddenField(
'wpForceHttps', (
int)$this->mStickHTTPS );
690 $form->addHiddenField(
'wpFromhttp', $usingHTTPS );
696 $form->setName(
'userlogin' . ( $this->
isSignup() ?
'2' :
'' ) );
698 $form->setId(
'userlogin2' );
701 $form->suppressDefaultSubmit();
703 $this->authForm = $form;
722 'mUsername' =>
$request->getText(
'wpName' ),
723 'mPassword' =>
$request->getText(
'wpPassword' ),
724 'mRetype' =>
$request->getText(
'wpRetype' ),
725 'mEmail' =>
$request->getText(
'wpEmail' ),
726 'mRealName' =>
$request->getText(
'wpRealName' ),
727 'mDomain' =>
$request->getText(
'wpDomain' ),
728 'mReason' =>
$request->getText(
'wpReason' ),
729 'mRemember' =>
$request->getCheck(
'wpRemember' ),
742 if ( $data->mUsername ==
'' && $this->isSignup() ) {
743 if ( $user->isLoggedIn() ) {
744 $data->mUsername = $user->getName();
746 $data->mUsername = $this->
getRequest()->getSession()->suggestLoginUsername();
754 $q =
'action=submitlogin&type=signup';
755 $linkq =
'type=login';
757 $q =
'action=submitlogin&type=login';
758 $linkq =
'type=signup';
761 if ( $this->mReturnTo !==
'' ) {
762 $returnto =
'&returnto=' .
wfUrlencode( $this->mReturnTo );
763 if ( $this->mReturnToQuery !==
'' ) {
764 $returnto .=
'&returntoquery=' .
771 # Don't show a "create account" link if the user can't.
773 # Pass any language selection on to the mode switch link
774 if ( $this->mLanguage ) {
775 $linkq .=
'&uselang=' . urlencode( $this->mLanguage );
778 $template->set(
'createOrLoginHref', $titleObj->getLocalURL( $linkq ) );
792 $template->set(
'name', $data->mUsername );
793 $template->set(
'password', $data->mPassword );
794 $template->set(
'retype', $data->mRetype );
795 $template->set(
'createemailset',
false );
796 $template->set(
'email', $data->mEmail );
797 $template->set(
'realname', $data->mRealName );
798 $template->set(
'domain', $data->mDomain );
799 $template->set(
'reason', $data->mReason );
800 $template->set(
'remember', $data->mRemember );
802 $template->set(
'action', $titleObj->getLocalURL( $q ) );
804 $template->set(
'messagetype', $msgType );
811 $template->set(
'resetlink', $resetLink );
813 ->getRememberUserDuration() !==
null );
814 $template->set(
'usereason', $user->isLoggedIn() );
816 $template->set(
'stickhttps', (
int)$this->mStickHTTPS );
817 $template->set(
'loggedin', $user->isLoggedIn() );
818 $template->set(
'loggedinuser', $user->getName() );
821 $action = $this->
isSignup() ?
'signup' :
'login';
822 $wgAuth->modifyUITemplate(
$template, $action );
828 Hooks::run(
'UserCreateForm', [ &
$template ] );
830 wfDeprecated(
"reference in UserCreateForm hook",
'1.27' );
833 Hooks::run(
'UserLoginForm', [ &
$template ] );
835 wfDeprecated(
"reference in UserLoginForm hook",
'1.27' );
843 array
$requests, array $fieldInfo, array &$formDescriptor, $action
846 $specialFields = array_merge( [
'extraInput' ],
847 array_keys( $this->fakeTemplate->getExtraInputDefinitions() ) );
850 foreach ( $coreFieldDescriptors as $fieldName => $coreField ) {
851 $requestField = isset( $formDescriptor[$fieldName] ) ?
852 $formDescriptor[$fieldName] : [];
858 !isset( $fieldInfo[$fieldName] )
860 !isset( $coreField[
'baseField'] )
861 || !isset( $fieldInfo[$coreField[
'baseField']] )
863 && !in_array( $fieldName, $specialFields,
true )
865 !isset( $coreField[
'type'] )
866 || !in_array( $coreField[
'type'], [
'submit',
'info' ],
true )
869 $coreFieldDescriptors[$fieldName] =
null;
875 isset( $coreField[
'label'] )
876 || isset( $coreField[
'label-message'] )
877 || isset( $coreField[
'label-raw'] )
879 unset( $requestField[
'label'], $requestField[
'label-message'], $coreField[
'label-raw'] );
882 $coreFieldDescriptors[$fieldName] += $requestField;
885 $formDescriptor = array_filter( $coreFieldDescriptors + $formDescriptor );
908 $isLoggedIn = $this->
getUser()->isLoggedIn();
909 $continuePart = $this->
isContinued() ?
'continue-' :
'';
910 $anotherPart = $isLoggedIn ?
'another-' :
'';
911 $expiration = $this->
getRequest()->getSession()->getProvider()->getRememberUserDuration();
912 $expirationDays = ceil( $expiration / ( 3600 * 24 ) );
913 $secureLoginLink =
'';
914 if ( $this->mSecureLoginUrl ) {
915 $secureLoginLink = Html::element(
'a', [
916 'href' => $this->mSecureLoginUrl,
917 'class' =>
'mw-ui-flush-right mw-secure',
918 ], $this->
msg(
'userlogin-signwithsecure' )->
text() );
920 $usernameHelpLink =
'';
921 if ( !$this->
msg(
'createacct-helpusername' )->isDisabled() ) {
922 $usernameHelpLink = Html::rawElement(
'span', [
923 'class' =>
'mw-ui-flush-right',
924 ], $this->
msg(
'createacct-helpusername' )->parse() );
928 $fieldDefinitions = [
934 'default' => Html::element(
'div', [
'id' =>
'mw-createacct-status-area' ] ),
938 'label-raw' => $this->
msg(
'userlogin-yourname' )->escaped() . $usernameHelpLink,
940 'placeholder-message' => $isLoggedIn ?
'createacct-another-username-ph'
941 :
'userlogin-yourname-ph',
946 'label-message' =>
'createaccountmail',
947 'name' =>
'wpCreateaccountMail',
948 'id' =>
'wpCreateaccountMail',
951 'id' =>
'wpPassword2',
952 'placeholder-message' =>
'createacct-yourpassword-ph',
953 'hide-if' => [
'===',
'wpCreateaccountMail',
'1' ],
957 'baseField' =>
'password',
958 'type' =>
'password',
959 'label-message' =>
'createacct-yourpasswordagain',
961 'cssclass' =>
'loginPassword',
963 'validation-callback' =>
function (
$value, $alldata ) {
964 if ( empty( $alldata[
'mailpassword'] ) && !empty( $alldata[
'password'] ) ) {
966 return $this->
msg(
'htmlform-required' );
967 } elseif (
$value !== $alldata[
'password'] ) {
968 return $this->
msg(
'badretype' );
973 'hide-if' => [
'===',
'wpCreateaccountMail',
'1' ],
974 'placeholder-message' =>
'createacct-yourpasswordagain-ph',
978 'label-message' => $wgEmailConfirmToEdit ?
'createacct-emailrequired'
979 :
'createacct-emailoptional',
981 'cssclass' =>
'loginText',
985 'validation-callback' =>
function (
$value, $alldata ) {
993 return $this->
msg(
'noemailtitle' );
994 } elseif ( !
$value && !empty( $alldata[
'mailpassword'] ) ) {
996 return $this->
msg(
'noemailcreate' );
997 } elseif (
$value && !Sanitizer::validateEmail(
$value ) ) {
998 return $this->
msg(
'invalidemailaddress' );
1002 'placeholder-message' =>
'createacct-' . $anotherPart .
'email-ph',
1006 'help-message' => $isLoggedIn ?
'createacct-another-realname-tip'
1007 :
'prefs-help-realname',
1008 'label-message' =>
'createacct-realname',
1009 'cssclass' =>
'loginText',
1011 'id' =>
'wpRealName',
1016 'label-message' =>
'createacct-reason',
1017 'cssclass' =>
'loginText',
1020 'placeholder-message' =>
'createacct-reason-ph',
1023 'createaccount' => [
1026 'default' => $this->
msg(
'createacct-' . $anotherPart . $continuePart .
1028 'name' =>
'wpCreateaccount',
1029 'id' =>
'wpCreateaccount',
1034 $fieldDefinitions = [
1036 'label-raw' => $this->
msg(
'userlogin-yourname' )->escaped() . $secureLoginLink,
1038 'placeholder-message' =>
'userlogin-yourname-ph',
1041 'id' =>
'wpPassword1',
1042 'placeholder-message' =>
'userlogin-yourpassword-ph',
1049 'name' =>
'wpRemember',
1050 'label-message' => $this->
msg(
'userlogin-remembermypassword' )
1051 ->numParams( $expirationDays ),
1052 'id' =>
'wpRemember',
1057 'default' => $this->
msg(
'pt-login-' . $continuePart .
'button' )->text(),
1058 'id' =>
'wpLoginAttempt',
1061 'linkcontainer' => [
1064 'cssclass' =>
'mw-form-related-link-container mw-userlogin-help',
1067 'default' => Html::element(
'a', [
1069 ->inContentLanguage()
1071 ], $this->
msg(
'userlogin-helplink2' )->
text() ),
1082 $fieldDefinitions[
'username'] += [
1085 'cssclass' =>
'loginText',
1089 $fieldDefinitions[
'password'] += [
1090 'type' =>
'password',
1092 'name' =>
'wpPassword',
1093 'cssclass' =>
'loginPassword',
1104 $fieldDefinitions[
'header'] = [
1111 if ( $this->mEntryError ) {
1112 $fieldDefinitions[
'entryError'] = [
1114 'default' => Html::rawElement(
'div', [
'class' => $this->mEntryErrorType .
'box', ],
1115 $this->mEntryError ),
1122 unset( $fieldDefinitions[
'linkcontainer'], $fieldDefinitions[
'signupend'] );
1127 $signupendMsg = $this->
msg(
'signupend' );
1128 $signupendHttpsMsg = $this->
msg(
'signupend-https' );
1129 if ( !$signupendMsg->isDisabled() ) {
1130 $usingHTTPS = $this->
getRequest()->getProtocol() ===
'https';
1131 $signupendText = ( $usingHTTPS && !$signupendHttpsMsg->isBlank() )
1132 ? $signupendHttpsMsg ->parse() : $signupendMsg->parse();
1133 $fieldDefinitions[
'signupend'] = [
1136 'default' => Html::rawElement(
'div', [
'id' =>
'signupend' ], $signupendText ),
1143 if ( $passwordReset->isAllowed( $this->getUser() )->isGood() ) {
1144 $fieldDefinitions[
'passwordReset'] = [
1147 'cssclass' =>
'mw-form-related-link-container',
1150 $this->
msg(
'userlogin-resetpassword-link' )->
text()
1162 if ( $this->mLanguage ) {
1163 $linkq .=
'&uselang=' . urlencode( $this->mLanguage );
1165 $loggedIn = $this->
getUser()->isLoggedIn();
1167 $fieldDefinitions[
'createOrLogin'] = [
1170 'linkQuery' => $linkq,
1171 'default' =>
function (
$params ) use ( $loggedIn, $linkTitle ) {
1172 return Html::rawElement(
'div',
1173 [
'id' =>
'mw-createaccount' . ( !$loggedIn ?
'-cta' :
'' ),
1174 'class' => ( $loggedIn ?
'mw-form-related-link-container' :
'mw-ui-vform-field' ) ],
1175 ( $loggedIn ?
'' : $this->
msg(
'userlogin-noaccount' )->escaped() )
1176 . Html::element(
'a',
1178 'id' =>
'mw-createaccount-join' . ( $loggedIn ?
'-loggedin' :
'' ),
1179 'href' => $linkTitle->getLocalURL(
$params[
'linkQuery'] ),
1180 'class' => ( $loggedIn ?
'' :
'mw-ui-button' ),
1184 $loggedIn ?
'userlogin-createanother' :
'userlogin-joinproject'
1195 $fieldDefinitions = array_filter( $fieldDefinitions );
1197 return $fieldDefinitions;
1207 if (
$template->get(
'usedomain',
false ) ) {
1209 $fieldDefinitions[
'domain'] = [
1211 'label-message' =>
'yourdomainname',
1212 'options' => array_combine(
$template->get(
'domainnames', [] ),
1214 'default' =>
$template->get(
'domain',
'' ),
1215 'name' =>
'wpDomain',
1221 $extraInputPos = array_search(
'extrainput', array_keys( $fieldDefinitions ),
true );
1222 $fieldDefinitions = array_slice( $fieldDefinitions, 0, $extraInputPos,
true )
1224 + array_slice( $fieldDefinitions, $extraInputPos + 1,
null,
true );
1226 return $fieldDefinitions;
1254 if ( $this->mReturnTo !==
'' ) {
1255 $returnto =
'returnto=' .
wfUrlencode( $this->mReturnTo );
1256 if ( $this->mReturnToQuery !==
'' ) {
1257 $returnto .=
'&returntoquery=' .
wfUrlencode( $this->mReturnToQuery );
1271 } elseif ( $this->
getUser()->isAllowed(
'createaccount' ) ) {
1279 return $this->
isSignup() ?
'wpCreateaccountToken' :
'wpLoginToken';
1289 $msg = $this->
msg(
'loginlanguagelinks' )->inContentLanguage();
1290 if ( $msg->isBlank() ) {
1293 $langs = explode(
"\n", $msg->text() );
1295 foreach ( $langs as
$lang ) {
1297 $parts = explode(
'|',
$lang );
1298 if ( count( $parts ) >= 2 ) {
1303 return count( $links ) > 0 ? $this->
msg(
'loginlanguagelabel' )->rawParams(
1304 $this->
getLanguage()->pipeList( $links ) )->escaped() :
'';
1318 return htmlspecialchars( $text );
1321 if ( $this->mReturnTo !==
'' ) {
1327 $targetLanguage = Language::factory(
$lang );
1328 $attr[
'lang'] = $attr[
'hreflang'] = $targetLanguage->getHtmlCode();
1349 isset( $formDescriptor[
'username'] ) &&
1350 !isset( $formDescriptor[
'username'][
'default'] ) &&
1354 if ( $user->isLoggedIn() ) {
1355 $formDescriptor[
'username'][
'default'] = $user->getName();
1357 $formDescriptor[
'username'][
'default'] =
1358 $this->
getRequest()->getSession()->suggestLoginUsername();
1365 unset( $formDescriptor[
'createaccount'], $formDescriptor[
'loginattempt'] );
1372 isset( $formDescriptor[
'username'] )
1373 && empty( $formDescriptor[
'username'][
'default'] )
1374 && !$this->
getRequest()->getCheck(
'wpName' )
1376 $formDescriptor[
'username'][
'autofocus'] =
true;
1377 } elseif ( isset( $formDescriptor[
'password'] ) ) {
1378 $formDescriptor[
'password'][
'autofocus'] =
true;
1394 throw new LogicException(
'not used' );
1408 $this->data[
'extrainput'][] = [
1413 'helptext' => $helptext,
1424 foreach ( $this->
get(
'extrainput', [] ) as $field ) {
1426 'type' => $field[
'type'] ===
'checkbox' ?
'check' : $field[
'type'],
1427 'name' => $field[
'name'],
1428 'value' => $field[
'value'],
1429 'id' => $field[
'name'],
1431 if ( $field[
'msg'] ) {
1432 $definition[
'label-message'] = $this->
getMsg( $field[
'msg'] );
1434 if ( $field[
'helptext'] ) {
1435 $definition[
'help'] = $this->
msgWiki( $field[
'helptext'] );
1440 $name = preg_replace(
'/^wp(?=[A-Z])/',
'', $field[
'name'] );
1441 $definitions[
$name] = $definition;
1444 if ( $this->
haveData(
'extrafields' ) ) {
1445 $definitions[
'extrafields'] = [
1448 'default' => $this->
get(
'extrafields' ),
1452 return $definitions;
1479 self::SUCCESS =>
'success',
1480 self::NO_NAME =>
'no_name',
1481 self::ILLEGAL =>
'illegal',
1482 self::WRONG_PLUGIN_PASS =>
'wrong_plugin_pass',
1483 self::NOT_EXISTS =>
'not_exists',
1484 self::WRONG_PASS =>
'wrong_pass',
1485 self::EMPTY_PASS =>
'empty_pass',
1486 self::RESET_PASS =>
'reset_pass',
1487 self::ABORTED =>
'aborted',
1488 self::CREATE_BLOCKED =>
'create_blocked',
1489 self::THROTTLED =>
'throttled',
1490 self::USER_BLOCKED =>
'user_blocked',
1491 self::NEED_TOKEN =>
'need_token',
1492 self::WRONG_TOKEN =>
'wrong_token',
1493 self::USER_MIGRATED =>
'user_migrated',
1501 parent::__construct();
1533 return is_array(
$res ) ?
true : 0;
1555 return $wgRequest->getSession()->getToken(
'',
'login' )->toString();
1571 $wgRequest->getSession()->resetToken(
'login' );
1581 return $wgRequest->getSession()->getToken(
'',
'createaccount' )->toString();
1597 $wgRequest->getSession()->resetToken(
'createaccount' );
$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.
if(! $wgDBerrorLogTZ) $wgRequest
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.
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.
FakeAuthTemplate $fakeTemplate
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.
Helper class for the password reset functionality shared by the web UI and the API.
static getMain()
Static methods.
static makeInternalOrExternalUrl( $name)
If url string starts with http, consider as external URL, else internal.
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,...
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
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
see documentation in includes Linker php for Linker::makeImageLink & $time
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
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
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 modifiable & $code
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
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 default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<div ...>$1</div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
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
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
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
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
this hook is for auditing only or null if authentication failed before getting that far $username
Allows to change the fields on the form that will be generated $name
this hook is for auditing only $response
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. '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). '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
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
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
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 For a description of the see design txt $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
MediaWiki has optional support for a high distributed memory object caching system For general information on but for a larger site with heavy load
if(!isset( $args[0])) $lang