75 abstract protected function successfulAction( $direct =
false, $extraMessages =
null );
86 parent::__construct(
$name );
93 parent::setRequest( $data, $wasPosted );
94 $this->mLoadedRequest =
false;
102 if ( $this->mLoadedRequest ) {
105 $this->mLoadedRequest =
true;
108 $this->mPosted =
$request->wasPosted();
109 $this->mIsReturn =
$subPage ===
'return';
110 $this->mAction =
$request->getVal(
'action' );
111 $this->mFromHTTP =
$request->getBool(
'fromhttp',
false )
112 ||
$request->getBool(
'wpFromhttp',
false );
113 $this->mStickHTTPS = ( !$this->mFromHTTP &&
$request->getProtocol() ===
'https' )
114 ||
$request->getBool(
'wpForceHttps',
false );
115 $this->mLanguage =
$request->getText(
'uselang' );
116 $this->mReturnTo =
$request->getVal(
'returnto',
'' );
117 $this->mReturnToQuery =
$request->getVal(
'returntoquery',
'' );
129 if ( $this->mLoaded ) {
132 $this->mLoaded =
true;
137 $securityLevel && AuthManager::singleton()->securitySensitiveOperationStatus(
148 $entryError = $this->
msg(
$request->getVal(
'error',
'' ) );
149 $entryWarning = $this->
msg(
$request->getVal(
'warning',
'' ) );
154 $this->
msg(
'loginreqlink' )->escaped(),
157 'returnto' => $this->mReturnTo,
158 'returntoquery' => $this->mReturnToQuery,
159 'uselang' => $this->mLanguage,
165 if ( $entryError->exists()
168 $this->mEntryErrorType =
'error';
169 $this->mEntryError = $entryError->rawParams( $loginreqlink )->parse();
171 } elseif ( $entryWarning->exists()
174 $this->mEntryErrorType =
'warning';
175 $this->mEntryError = $entryWarning->rawParams( $loginreqlink )->parse();
178 # 1. When switching accounts, it sucks to get automatically logged out
179 # 2. Do not return to PasswordReset after a successful password change
180 # but goto Wiki start page (Main_Page) instead ( bug 33997 )
181 $returnToTitle = Title::newFromText( $this->mReturnTo );
182 if ( is_object( $returnToTitle )
183 && ( $returnToTitle->isSpecial(
'Userlogout' )
184 || $returnToTitle->isSpecial(
'PasswordReset' ) )
186 $this->mReturnTo =
'';
187 $this->mReturnToQuery =
'';
194 $params = parent::getPreservedParams( $withToken );
196 'returnto' => $this->mReturnTo ?:
null,
197 'returntoquery' => $this->mReturnToQuery ?:
null,
200 $params[
'fromhttp'] = $this->mFromHTTP ?
'1' :
null;
208 return parent::beforeExecute(
$subPage );
215 $authManager = AuthManager::singleton();
216 $session = SessionManager::getGlobalSession();
227 if ( !$this->
isSignup() && !$authManager->canAuthenticateNow() ) {
228 if ( !$session->canSetUser() ) {
229 throw new ErrorPageError(
'cannotloginnow-title',
'cannotloginnow-text', [
233 throw new ErrorPageError(
'cannotlogin-title',
'cannotlogin-text' );
234 } elseif ( $this->
isSignup() && !$authManager->canCreateAccounts() ) {
235 throw new ErrorPageError(
'cannotcreateaccount-title',
'cannotcreateaccount-text' );
252 if ( !$this->
isSignup() && !$this->mPosted && !$this->securityLevel &&
253 ( $this->mReturnTo !==
'' || $this->mReturnToQuery !==
'' ) &&
261 if ( $this->
getRequest()->getProtocol() !==
'https' ) {
265 ( $this->mEntryErrorType ===
'error' ?
'error'
266 :
'warning' ) => $this->mEntryError,
276 $this->
getOutput()->addVaryHeader(
'X-Forwarded-Proto' );
283 if ( substr( $url, 0, 8 ) ===
'https://' ) {
284 $this->mSecureLoginUrl = $url;
293 $this->
mainLoginForm( [],
'authpage-cannot-' . $this->authAction );
300 if ( $button_name ) {
301 $this->
getRequest()->setVal( $button_name,
true );
318 case AuthenticationResponse::PASS:
320 $this->proxyAccountCreation = $this->
isSignup() && !$this->
getUser()->isAnon();
321 $this->targetUser = User::newFromName(
$response->username );
324 !$this->proxyAccountCreation
326 && $authManager->canAuthenticateNow()
329 $response2 = $authManager->beginAuthentication( [
$response->loginRequest ],
331 if ( $response2->status !== AuthenticationResponse::PASS ) {
332 LoggerFactory::getInstance(
'login' )
333 ->error(
'Could not log in after account creation' );
334 $this->
successfulAction(
true, Status::newFatal(
'createacct-loginerror' ) );
339 if ( !$this->proxyAccountCreation ) {
346 case AuthenticationResponse::FAIL:
348 case AuthenticationResponse::RESTART:
349 unset( $this->authForm );
350 if (
$response->status === AuthenticationResponse::FAIL ) {
352 $messageType =
'error';
355 $messageType =
'warning';
361 case AuthenticationResponse::REDIRECT:
362 unset( $this->authForm );
365 case AuthenticationResponse::UI:
366 unset( $this->authForm );
367 $this->authAction = $this->
isSignup() ? AuthManager::ACTION_CREATE_CONTINUE
368 : AuthManager::ACTION_LOGIN_CONTINUE;
369 $this->authRequests =
$response->neededRequests;
373 throw new LogicException(
'invalid AuthenticationResponse' );
395 $fields = AuthenticationRequest::mergeFieldInfo( $this->authRequests );
396 foreach ( $fields
as $fieldname => $field ) {
397 if ( !isset( $field[
'type'] ) ) {
400 if ( !empty( $field[
'skippable'] ) ) {
403 if ( $field[
'type'] ===
'button' ) {
404 if ( $button_name !==
null ) {
408 $button_name = $fieldname;
410 } elseif ( $field[
'type'] !==
'null' ) {
427 $type, $title, $msgname, $injected_html, $extraMessages
434 if ( $extraMessages ) {
435 $extraMessages = Status::wrap( $extraMessages );
436 $out->addWikiText( $extraMessages->getWikiText() );
439 $out->addHTML( $injected_html );
442 $helper->showReturnToPage(
$type, $this->mReturnTo, $this->mReturnToQuery, $this->mStickHTTPS );
488 $userLang = Language::factory(
$code );
516 $this->authForm =
null;
517 $requests = AuthManager::singleton()->getAuthenticationRequests( $this->authAction,
$user );
521 $out->addModuleStyles( [
523 'mediawiki.ui.button',
524 'mediawiki.ui.checkbox',
525 'mediawiki.ui.input',
526 'mediawiki.special.userlogin.common.styles'
530 $out->addJsConfigVars(
'wgCreateacctImgcaptchaHelp',
531 $this->
msg(
'createacct-imgcaptcha-help' )->parse() );
535 'mediawiki.special.userlogin.signup.js'
537 $out->addModuleStyles( [
538 'mediawiki.special.userlogin.signup.styles'
542 $out->addModuleStyles( [
543 'mediawiki.special.userlogin.login.styles'
546 $out->disallowUserJs();
548 $form = $this->
getAuthForm( $requests, $this->authAction, $msg, $msgtype );
549 $form->prepareForm();
551 $submitStatus = Status::newGood();
552 if ( $msg && $msgtype ===
'warning' ) {
553 $submitStatus->warning( $msg );
554 } elseif ( $msg && $msgtype ===
'error' ) {
555 $submitStatus->fatal( $msg );
560 $reauthMessage = $this->securityLevel ?
'userlogin-reauth' :
'userlogin-loggedin';
561 $submitStatus->warning( $reauthMessage, $this->
getUser()->
getName() );
564 $formHtml = $form->getHTML( $submitStatus );
578 $loginPrompt = $this->
isSignup() ?
'' : Html::rawElement(
'div',
579 [
'id' =>
'userloginprompt' ], $this->
msg(
'loginprompt' )->parseAsBlock() );
581 $signupStartMsg = $this->
msg(
'signupstart' );
582 $signupStart = ( $this->
isSignup() && !$signupStartMsg->isDisabled() )
583 ? Html::rawElement(
'div', [
'id' =>
'signupstart' ], $signupStartMsg->parseAsBlock() ) :
'';
584 if ( $languageLinks ) {
585 $languageLinks = Html::rawElement(
'div', [
'id' =>
'languagelinks' ],
586 Html::rawElement(
'p', [], $languageLinks )
590 $benefitsContainer =
'';
598 for ( $benefitIdx = 1; $benefitIdx <= $benefitCount; $benefitIdx++ ) {
599 $headUnescaped = $this->
msg(
"createacct-benefit-head$benefitIdx" )->text();
600 $iconClass = $this->
msg(
"createacct-benefit-icon$benefitIdx" )->escaped();
601 $benefitList .= Html::rawElement(
'div', [
'class' =>
"mw-number-text $iconClass" ],
602 Html::rawElement(
'h3', [],
603 $this->
msg(
"createacct-benefit-head$benefitIdx" )->escaped()
605 . Html::rawElement(
'p', [],
606 $this->
msg(
"createacct-benefit-body$benefitIdx" )->params( $headUnescaped )->escaped()
610 $benefitsContainer = Html::rawElement(
'div', [
'class' =>
'mw-createacct-benefits-container' ],
611 Html::rawElement(
'h2', [], $this->
msg(
'createacct-benefit-heading' )->escaped() )
612 . Html::rawElement(
'div', [
'class' =>
'mw-createacct-benefits-list' ],
618 $html = Html::rawElement(
'div', [
'class' =>
'mw-ui-container' ],
622 . Html::rawElement(
'div', [
'id' =>
'userloginForm' ],
643 if ( isset( $this->authForm ) ) {
647 $usingHTTPS = $this->
getRequest()->getProtocol() ===
'https';
650 $fieldInfo = AuthenticationRequest::mergeFieldInfo(
$requests );
654 $formDescriptor = static::fieldInfoToFormDescriptor(
$requests, $fieldInfo, $this->authAction );
658 if (
$context->getRequest() !== $this->getRequest() ) {
665 $form->addHiddenField(
'authAction', $this->authAction );
667 $form->addHiddenField(
'uselang', $this->mLanguage );
669 $form->addHiddenField(
'force', $this->securityLevel );
674 $form->addHiddenField(
'wpForceHttps', (
int)$this->mStickHTTPS );
675 $form->addHiddenField(
'wpFromhttp', $usingHTTPS );
681 $form->setName(
'userlogin' . ( $this->
isSignup() ?
'2' :
'' ) );
683 $form->setId(
'userlogin2' );
686 $form->suppressDefaultSubmit();
688 $this->authForm = $form;
707 'mUsername' =>
$request->getText(
'wpName' ),
708 'mPassword' =>
$request->getText(
'wpPassword' ),
709 'mRetype' =>
$request->getText(
'wpRetype' ),
710 'mEmail' =>
$request->getText(
'wpEmail' ),
711 'mRealName' =>
$request->getText(
'wpRealName' ),
712 'mDomain' =>
$request->getText(
'wpDomain' ),
713 'mReason' =>
$request->getText(
'wpReason' ),
714 'mRemember' =>
$request->getCheck(
'wpRemember' ),
727 if ( $data->mUsername ==
'' && $this->isSignup() ) {
728 if (
$user->isLoggedIn() ) {
729 $data->mUsername =
$user->getName();
731 $data->mUsername = $this->
getRequest()->getSession()->suggestLoginUsername();
739 $q =
'action=submitlogin&type=signup';
740 $linkq =
'type=login';
742 $q =
'action=submitlogin&type=login';
743 $linkq =
'type=signup';
746 if ( $this->mReturnTo !==
'' ) {
747 $returnto =
'&returnto=' .
wfUrlencode( $this->mReturnTo );
748 if ( $this->mReturnToQuery !==
'' ) {
749 $returnto .=
'&returntoquery=' .
756 # Don't show a "create account" link if the user can't.
758 # Pass any language selection on to the mode switch link
759 if ( $wgLoginLanguageSelector && $this->mLanguage ) {
763 $template->set(
'createOrLoginHref', $titleObj->getLocalURL( $linkq ) );
777 $template->set(
'name', $data->mUsername );
778 $template->set(
'password', $data->mPassword );
779 $template->set(
'retype', $data->mRetype );
780 $template->set(
'createemailset',
false );
781 $template->set(
'email', $data->mEmail );
782 $template->set(
'realname', $data->mRealName );
783 $template->set(
'domain', $data->mDomain );
784 $template->set(
'reason', $data->mReason );
785 $template->set(
'remember', $data->mRemember );
787 $template->set(
'action', $titleObj->getLocalURL( $q ) );
789 $template->set(
'messagetype', $msgType );
796 $template->set(
'resetlink', $resetLink );
798 ->getRememberUserDuration() !==
null );
801 $template->set(
'stickhttps', (
int)$this->mStickHTTPS );
806 $action = $this->
isSignup() ?
'signup' :
'login';
807 $wgAuth->modifyUITemplate(
$template, $action );
810 $hookName = $this->
isSignup() ?
'UserCreateForm' :
'UserLoginForm';
824 $specialFields = array_merge( [
'extraInput' ],
825 array_keys( $this->fakeTemplate->getExtraInputDefinitions() ) );
828 foreach ( $coreFieldDescriptors
as $fieldName => $coreField ) {
829 $requestField = isset( $formDescriptor[$fieldName] ) ?
830 $formDescriptor[$fieldName] : [];
836 !isset( $fieldInfo[$fieldName] )
838 !isset( $coreField[
'baseField'] )
839 || !isset( $fieldInfo[$coreField[
'baseField']] )
841 && !in_array( $fieldName, $specialFields,
true )
843 !isset( $coreField[
'type'] )
844 || !in_array( $coreField[
'type'], [
'submit',
'info' ],
true )
847 $coreFieldDescriptors[$fieldName] =
null;
853 isset( $coreField[
'label'] )
854 || isset( $coreField[
'label-message'] )
855 || isset( $coreField[
'label-raw'] )
857 unset( $requestField[
'label'], $requestField[
'label-message'], $coreField[
'label-raw'] );
860 $coreFieldDescriptors[$fieldName] += $requestField;
863 $formDescriptor = array_filter( $coreFieldDescriptors + $formDescriptor );
886 $isLoggedIn = $this->
getUser()->isLoggedIn();
887 $continuePart = $this->
isContinued() ?
'continue-' :
'';
888 $anotherPart = $isLoggedIn ?
'another-' :
'';
889 $expiration = $this->
getRequest()->getSession()->getProvider()->getRememberUserDuration();
890 $expirationDays = ceil( $expiration / ( 3600 * 24 ) );
891 $secureLoginLink =
'';
892 if ( $this->mSecureLoginUrl ) {
893 $secureLoginLink = Html::element(
'a', [
894 'href' => $this->mSecureLoginUrl,
895 'class' =>
'mw-ui-flush-right mw-secure',
896 ], $this->
msg(
'userlogin-signwithsecure' )->
text() );
898 $usernameHelpLink =
'';
899 if ( !$this->
msg(
'createacct-helpusername' )->isDisabled() ) {
900 $usernameHelpLink = Html::rawElement(
'span', [
901 'class' =>
'mw-ui-flush-right',
902 ], $this->
msg(
'createacct-helpusername' )->parse() );
906 $fieldDefinitions = [
912 'default' => Html::element(
'div', [
'id' =>
'mw-createacct-status-area' ] ),
916 'label-raw' => $this->
msg(
'userlogin-yourname' )->escaped() . $usernameHelpLink,
918 'placeholder-message' => $isLoggedIn ?
'createacct-another-username-ph'
919 :
'userlogin-yourname-ph',
924 'label-message' =>
'createaccountmail',
925 'name' =>
'wpCreateaccountMail',
926 'id' =>
'wpCreateaccountMail',
929 'id' =>
'wpPassword2',
930 'placeholder-message' =>
'createacct-yourpassword-ph',
931 'hide-if' => [
'===',
'wpCreateaccountMail',
'1' ],
935 'baseField' =>
'password',
936 'type' =>
'password',
937 'label-message' =>
'createacct-yourpasswordagain',
939 'cssclass' =>
'loginPassword',
941 'validation-callback' =>
function (
$value, $alldata ) {
942 if ( empty( $alldata[
'mailpassword'] ) && !empty( $alldata[
'password'] ) ) {
944 return $this->
msg(
'htmlform-required' );
945 } elseif (
$value !== $alldata[
'password'] ) {
946 return $this->
msg(
'badretype' );
951 'hide-if' => [
'===',
'wpCreateaccountMail',
'1' ],
952 'placeholder-message' =>
'createacct-yourpasswordagain-ph',
956 'label-message' => $wgEmailConfirmToEdit ?
'createacct-emailrequired'
957 :
'createacct-emailoptional',
959 'cssclass' =>
'loginText',
963 'validation-callback' =>
function (
$value, $alldata ) {
971 return $this->
msg(
'noemailtitle' );
972 } elseif ( !
$value && !empty( $alldata[
'mailpassword'] ) ) {
974 return $this->
msg(
'noemailcreate' );
975 } elseif (
$value && !Sanitizer::validateEmail(
$value ) ) {
976 return $this->
msg(
'invalidemailaddress' );
980 'placeholder-message' =>
'createacct-' . $anotherPart .
'email-ph',
984 'help-message' => $isLoggedIn ?
'createacct-another-realname-tip'
985 :
'prefs-help-realname',
986 'label-message' =>
'createacct-realname',
987 'cssclass' =>
'loginText',
989 'id' =>
'wpRealName',
994 'label-message' =>
'createacct-reason',
995 'cssclass' =>
'loginText',
998 'placeholder-message' =>
'createacct-reason-ph',
1001 'createaccount' => [
1004 'default' => $this->
msg(
'createacct-' . $anotherPart . $continuePart .
1006 'name' =>
'wpCreateaccount',
1007 'id' =>
'wpCreateaccount',
1012 $fieldDefinitions = [
1014 'label-raw' => $this->
msg(
'userlogin-yourname' )->escaped() . $secureLoginLink,
1016 'placeholder-message' =>
'userlogin-yourname-ph',
1019 'id' =>
'wpPassword1',
1020 'placeholder-message' =>
'userlogin-yourpassword-ph',
1027 'name' =>
'wpRemember',
1028 'label-message' => $this->
msg(
'userlogin-remembermypassword' )
1029 ->numParams( $expirationDays ),
1030 'id' =>
'wpRemember',
1035 'default' => $this->
msg(
'pt-login-' . $continuePart .
'button' )->text(),
1036 'id' =>
'wpLoginAttempt',
1039 'linkcontainer' => [
1042 'cssclass' =>
'mw-form-related-link-container mw-userlogin-help',
1045 'default' => Html::element(
'a', [
1047 ->inContentLanguage()
1049 ], $this->
msg(
'userlogin-helplink2' )->
text() ),
1060 $fieldDefinitions[
'username'] += [
1063 'cssclass' =>
'loginText',
1067 $fieldDefinitions[
'password'] += [
1068 'type' =>
'password',
1070 'name' =>
'wpPassword',
1071 'cssclass' =>
'loginPassword',
1082 $fieldDefinitions[
'header'] = [
1089 if ( $this->mEntryError ) {
1090 $fieldDefinitions[
'entryError'] = [
1092 'default' => Html::rawElement(
'div', [
'class' => $this->mEntryErrorType .
'box', ],
1093 $this->mEntryError ),
1100 unset( $fieldDefinitions[
'linkcontainer'], $fieldDefinitions[
'signupend'] );
1105 $signupendMsg = $this->
msg(
'signupend' );
1106 $signupendHttpsMsg = $this->
msg(
'signupend-https' );
1107 if ( !$signupendMsg->isDisabled() ) {
1108 $usingHTTPS = $this->
getRequest()->getProtocol() ===
'https';
1109 $signupendText = ( $usingHTTPS && !$signupendHttpsMsg->isBlank() )
1110 ? $signupendHttpsMsg ->parse() : $signupendMsg->parse();
1111 $fieldDefinitions[
'signupend'] = [
1114 'default' => Html::rawElement(
'div', [
'id' =>
'signupend' ], $signupendText ),
1121 if ( $passwordReset->isAllowed( $this->getUser() )->isGood() ) {
1122 $fieldDefinitions[
'passwordReset'] = [
1125 'cssclass' =>
'mw-form-related-link-container',
1128 $this->
msg(
'userlogin-resetpassword-link' )->escaped()
1140 if ( $wgLoginLanguageSelector && $this->mLanguage ) {
1143 $loggedIn = $this->
getUser()->isLoggedIn();
1145 $fieldDefinitions[
'createOrLogin'] = [
1148 'linkQuery' => $linkq,
1149 'default' =>
function (
$params )
use ( $loggedIn, $linkTitle ) {
1150 return Html::rawElement(
'div',
1151 [
'id' =>
'mw-createaccount' . ( !$loggedIn ?
'-cta' :
'' ),
1152 'class' => ( $loggedIn ?
'mw-form-related-link-container' :
'mw-ui-vform-field' ) ],
1153 ( $loggedIn ?
'' : $this->
msg(
'userlogin-noaccount' )->escaped() )
1154 . Html::element(
'a',
1156 'id' =>
'mw-createaccount-join' . ( $loggedIn ?
'-loggedin' :
'' ),
1157 'href' => $linkTitle->getLocalURL(
$params[
'linkQuery'] ),
1158 'class' => ( $loggedIn ?
'' :
'mw-ui-button' ),
1162 $loggedIn ?
'userlogin-createanother' :
'userlogin-joinproject'
1173 $fieldDefinitions = array_filter( $fieldDefinitions );
1175 return $fieldDefinitions;
1185 if (
$template->get(
'usedomain',
false ) ) {
1187 $fieldDefinitions[
'domain'] = [
1189 'label-message' =>
'yourdomainname',
1190 'options' => array_combine(
$template->get(
'domainnames', [] ),
1192 'default' =>
$template->get(
'domain',
'' ),
1193 'name' =>
'wpDomain',
1199 $extraInputPos = array_search(
'extrainput', array_keys( $fieldDefinitions ),
true );
1200 $fieldDefinitions = array_slice( $fieldDefinitions, 0, $extraInputPos,
true )
1202 + array_slice( $fieldDefinitions, $extraInputPos + 1,
null,
true );
1204 return $fieldDefinitions;
1231 if ( $this->mReturnTo !==
'' ) {
1232 $returnto =
'returnto=' .
wfUrlencode( $this->mReturnTo );
1233 if ( $this->mReturnToQuery !==
'' ) {
1234 $returnto .=
'&returntoquery=' .
wfUrlencode( $this->mReturnToQuery );
1248 } elseif ( $this->
getUser()->isAllowed(
'createaccount' ) ) {
1256 return $this->
isSignup() ?
'wpCreateaccountToken' :
'wpLoginToken';
1266 $msg = $this->
msg(
'loginlanguagelinks' )->inContentLanguage();
1267 if ( $msg->isBlank() ) {
1270 $langs = explode(
"\n", $msg->text() );
1274 $parts = explode(
'|',
$lang );
1275 if ( count( $parts ) >= 2 ) {
1280 return count( $links ) > 0 ? $this->
msg(
'loginlanguagelabel' )->rawParams(
1281 $this->
getLanguage()->pipeList( $links ) )->escaped() :
'';
1295 return htmlspecialchars( $text );
1298 if ( $this->mReturnTo !==
'' ) {
1304 $targetLanguage = Language::factory(
$lang );
1305 $attr[
'lang'] = $attr[
'hreflang'] = $targetLanguage->getHtmlCode();
1309 htmlspecialchars( $text ),
1325 isset( $formDescriptor[
'username'] ) &&
1326 !isset( $formDescriptor[
'username'][
'default'] ) &&
1330 if (
$user->isLoggedIn() ) {
1331 $formDescriptor[
'username'][
'default'] =
$user->getName();
1333 $formDescriptor[
'username'][
'default'] =
1334 $this->
getRequest()->getSession()->suggestLoginUsername();
1341 unset( $formDescriptor[
'createaccount'], $formDescriptor[
'loginattempt'] );
1348 isset( $formDescriptor[
'username'] )
1349 && empty( $formDescriptor[
'username'][
'default'] )
1350 && !$this->
getRequest()->getCheck(
'wpName' )
1352 $formDescriptor[
'username'][
'autofocus'] =
true;
1353 } elseif ( isset( $formDescriptor[
'password'] ) ) {
1354 $formDescriptor[
'password'][
'autofocus'] =
true;
1370 throw new LogicException(
'not used' );
1379 $this->
data[
'extrainput'][] = [
1384 'helptext' => $helptext,
1395 foreach ( $this->
get(
'extrainput', [] )
as $field ) {
1397 'type' => $field[
'type'] ===
'checkbox' ?
'check' : $field[
'type'],
1398 'name' => $field[
'name'],
1399 'value' => $field[
'value'],
1400 'id' => $field[
'name'],
1402 if ( $field[
'msg'] ) {
1403 $definition[
'label-message'] = $this->
getMsg( $field[
'msg'] );
1405 if ( $field[
'helptext'] ) {
1406 $definition[
'help'] = $this->
msgWiki( $field[
'helptext'] );
1411 $name = preg_replace(
'/^wp(?=[A-Z])/',
'', $field[
'name'] );
1412 $definitions[
$name] = $definition;
1415 if ( $this->
haveData(
'extrafields' ) ) {
1416 $definitions[
'extrafields'] = [
1419 'default' => $this->
get(
'extrafields' ),
1423 return $definitions;
1450 self::SUCCESS =>
'success',
1451 self::NO_NAME =>
'no_name',
1452 self::ILLEGAL =>
'illegal',
1453 self::WRONG_PLUGIN_PASS =>
'wrong_plugin_pass',
1454 self::NOT_EXISTS =>
'not_exists',
1455 self::WRONG_PASS =>
'wrong_pass',
1456 self::EMPTY_PASS =>
'empty_pass',
1457 self::RESET_PASS =>
'reset_pass',
1458 self::ABORTED =>
'aborted',
1459 self::CREATE_BLOCKED =>
'create_blocked',
1460 self::THROTTLED =>
'throttled',
1461 self::USER_BLOCKED =>
'user_blocked',
1462 self::NEED_TOKEN =>
'need_token',
1463 self::WRONG_TOKEN =>
'wrong_token',
1464 self::USER_MIGRATED =>
'user_migrated',
1472 parent::__construct();
1499 return is_array(
$res ) ?
true : 0;
1519 return $wgRequest->getSession()->getToken(
'',
'login' )->toString();
1535 $wgRequest->getSession()->resetToken(
'login' );
1544 return $wgRequest->getSession()->getToken(
'',
'createaccount' )->toString();
1560 $wgRequest->getSession()->resetToken(
'createaccount' );
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$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.
static link( $target, $html=null, $customAttribs=[], $query=[], $options=[])
This function returns an HTML link to the given target.
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
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.
getConfig()
Shortcut to get main config object.
getPageTitle( $subpage=false)
Get a self-referential title object.
getLanguage()
Shortcut to get user's language.
msg()
Wrapper around wfMessage that sets the current context.
getFullTitle()
Return the full title, including $par.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
when a variable name is used in a it is silently declared as a new local masking the global
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
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
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
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
the array() calling protocol came about after MediaWiki 1.4rc1.
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
namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable(). 'NewDifferenceEngine' do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
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
namespace and then decline to actually register it file or subcat img or subcat $title
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
namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable(). 'NewDifferenceEngine' do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect & $returnTo
error also a ContextSource you ll probably need to make sure the header is varied on $request
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
namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable(). 'NewDifferenceEngine' do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string & $returnToQuery
this hook is for auditing only or null if authentication failed before getting that far $username
this hook is for auditing only $response
Allows to change the fields on the form that will be generated $name
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
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
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
MediaWiki has optional support for a high distributed memory object caching system For general information on but for a larger site with heavy load
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN boolean columns are always mapped to as the code does not always treat the column as a and VARBINARY columns should simply be TEXT The only exception is when VARBINARY is used to store true binary data
if(!isset( $args[0])) $lang