MediaWiki  master
LoginSignupSpecialPage.php
Go to the documentation of this file.
1 <?php
31 
38  protected $mReturnTo;
39  protected $mPosted;
40  protected $mAction;
41  protected $mLanguage;
42  protected $mReturnToQuery;
43  protected $mToken;
44  protected $mStickHTTPS;
45  protected $mFromHTTP;
46  protected $mEntryError = '';
47  protected $mEntryErrorType = 'error';
48 
49  protected $mLoaded = false;
50  protected $mLoadedRequest = false;
51  protected $mSecureLoginUrl;
52 
54  protected $securityLevel;
55 
60  protected $targetUser;
61 
63  protected $authForm;
64 
65  abstract protected function isSignup();
66 
73  abstract protected function successfulAction( $direct = false, $extraMessages = null );
74 
80  abstract protected function logAuthResult( $success, $status = null );
81 
82  public function __construct( $name ) {
84  parent::__construct( $name );
85 
86  // Override UseMediaWikiEverywhere to true, to force login and create form to use mw ui
87  $wgUseMediaWikiUIEverywhere = true;
88  }
89 
90  protected function setRequest( array $data, $wasPosted = null ) {
91  parent::setRequest( $data, $wasPosted );
92  $this->mLoadedRequest = false;
93  }
94 
99  private function loadRequestParameters( $subPage ) {
100  if ( $this->mLoadedRequest ) {
101  return;
102  }
103  $this->mLoadedRequest = true;
104  $request = $this->getRequest();
105 
106  $this->mPosted = $request->wasPosted();
107  $this->mIsReturn = $subPage === 'return';
108  $this->mAction = $request->getVal( 'action' );
109  $this->mFromHTTP = $request->getBool( 'fromhttp', false )
110  || $request->getBool( 'wpFromhttp', false );
111  $this->mStickHTTPS = ( !$this->mFromHTTP && $request->getProtocol() === 'https' )
112  || $request->getBool( 'wpForceHttps', false );
113  $this->mLanguage = $request->getText( 'uselang' );
114  $this->mReturnTo = $request->getVal( 'returnto', '' );
115  $this->mReturnToQuery = $request->getVal( 'returntoquery', '' );
116  }
117 
123  protected function load( $subPage ) {
124  global $wgSecureLogin;
125 
127  if ( $this->mLoaded ) {
128  return;
129  }
130  $this->mLoaded = true;
131  $request = $this->getRequest();
132 
133  $securityLevel = $this->getRequest()->getText( 'force' );
134  if (
135  $securityLevel && AuthManager::singleton()->securitySensitiveOperationStatus(
136  $securityLevel ) === AuthManager::SEC_REAUTH
137  ) {
138  $this->securityLevel = $securityLevel;
139  }
140 
141  $this->loadAuth( $subPage );
142 
143  $this->mToken = $request->getVal( $this->getTokenName() );
144 
145  // Show an error or warning passed on from a previous page
146  $entryError = $this->msg( $request->getVal( 'error', '' ) );
147  $entryWarning = $this->msg( $request->getVal( 'warning', '' ) );
148  // bc: provide login link as a parameter for messages where the translation
149  // was not updated
150  $loginreqlink = $this->getLinkRenderer()->makeKnownLink(
151  $this->getPageTitle(),
152  $this->msg( 'loginreqlink' )->text(),
153  [],
154  [
155  'returnto' => $this->mReturnTo,
156  'returntoquery' => $this->mReturnToQuery,
157  'uselang' => $this->mLanguage ?: null,
158  'fromhttp' => $wgSecureLogin && $this->mFromHTTP ? '1' : null,
159  ]
160  );
161 
162  // Only show valid error or warning messages.
163  if ( $entryError->exists()
164  && in_array( $entryError->getKey(), LoginHelper::getValidErrorMessages(), true )
165  ) {
166  $this->mEntryErrorType = 'error';
167  $this->mEntryError = $entryError->rawParams( $loginreqlink )->parse();
168 
169  } elseif ( $entryWarning->exists()
170  && in_array( $entryWarning->getKey(), LoginHelper::getValidErrorMessages(), true )
171  ) {
172  $this->mEntryErrorType = 'warning';
173  $this->mEntryError = $entryWarning->rawParams( $loginreqlink )->parse();
174  }
175 
176  # 1. When switching accounts, it sucks to get automatically logged out
177  # 2. Do not return to PasswordReset after a successful password change
178  # but goto Wiki start page (Main_Page) instead ( T35997 )
179  $returnToTitle = Title::newFromText( $this->mReturnTo );
180  if ( is_object( $returnToTitle )
181  && ( $returnToTitle->isSpecial( 'Userlogout' )
182  || $returnToTitle->isSpecial( 'PasswordReset' ) )
183  ) {
184  $this->mReturnTo = '';
185  $this->mReturnToQuery = '';
186  }
187  }
188 
189  protected function getPreservedParams( $withToken = false ) {
190  global $wgSecureLogin;
191 
192  $params = parent::getPreservedParams( $withToken );
193  $params += [
194  'returnto' => $this->mReturnTo ?: null,
195  'returntoquery' => $this->mReturnToQuery ?: null,
196  ];
197  if ( $wgSecureLogin && !$this->isSignup() ) {
198  $params['fromhttp'] = $this->mFromHTTP ? '1' : null;
199  }
200  return $params;
201  }
202 
203  protected function beforeExecute( $subPage ) {
204  // finish initializing the class before processing the request - T135924
206  return parent::beforeExecute( $subPage );
207  }
208 
212  public function execute( $subPage ) {
213  if ( $this->mPosted ) {
214  $time = microtime( true );
215  $profilingScope = new ScopedCallback( function () use ( $time ) {
216  $time = microtime( true ) - $time;
217  $statsd = MediaWikiServices::getInstance()->getStatsdDataFactory();
218  $statsd->timing( "timing.login.ui.{$this->authAction}", $time * 1000 );
219  } );
220  }
221 
222  $authManager = AuthManager::singleton();
223  $session = SessionManager::getGlobalSession();
224 
225  // Session data is used for various things in the authentication process, so we must make
226  // sure a session cookie or some equivalent mechanism is set.
227  $session->persist();
228 
229  $this->load( $subPage );
230  $this->setHeaders();
231  $this->checkPermissions();
232 
233  // Make sure the system configuration allows log in / sign up
234  if ( !$this->isSignup() && !$authManager->canAuthenticateNow() ) {
235  if ( !$session->canSetUser() ) {
236  throw new ErrorPageError( 'cannotloginnow-title', 'cannotloginnow-text', [
237  $session->getProvider()->describe( RequestContext::getMain()->getLanguage() )
238  ] );
239  }
240  throw new ErrorPageError( 'cannotlogin-title', 'cannotlogin-text' );
241  } elseif ( $this->isSignup() && !$authManager->canCreateAccounts() ) {
242  throw new ErrorPageError( 'cannotcreateaccount-title', 'cannotcreateaccount-text' );
243  }
244 
245  /*
246  * In the case where the user is already logged in, and was redirected to
247  * the login form from a page that requires login, do not show the login
248  * page. The use case scenario for this is when a user opens a large number
249  * of tabs, is redirected to the login page on all of them, and then logs
250  * in on one, expecting all the others to work properly.
251  *
252  * However, do show the form if it was visited intentionally (no 'returnto'
253  * is present). People who often switch between several accounts have grown
254  * accustomed to this behavior.
255  *
256  * Also make an exception when force=<level> is set in the URL, which means the user must
257  * reauthenticate for security reasons.
258  */
259  if ( !$this->isSignup() && !$this->mPosted && !$this->securityLevel &&
260  ( $this->mReturnTo !== '' || $this->mReturnToQuery !== '' ) &&
261  $this->getUser()->isLoggedIn()
262  ) {
263  $this->successfulAction();
264  return;
265  }
266 
267  // If logging in and not on HTTPS, either redirect to it or offer a link.
268  global $wgSecureLogin;
269  if ( $this->getRequest()->getProtocol() !== 'https' ) {
270  $title = $this->getFullTitle();
271  $query = $this->getPreservedParams( false ) + [
272  'title' => null,
273  ( $this->mEntryErrorType === 'error' ? 'error'
274  : 'warning' ) => $this->mEntryError,
275  ] + $this->getRequest()->getQueryValues();
276  $url = $title->getFullURL( $query, false, PROTO_HTTPS );
277  if ( $wgSecureLogin && !$this->mFromHTTP &&
278  wfCanIPUseHTTPS( $this->getRequest()->getIP() )
279  ) {
280  // Avoid infinite redirect
281  $url = wfAppendQuery( $url, 'fromhttp=1' );
282  $this->getOutput()->redirect( $url );
283  // Since we only do this redir to change proto, always vary
284  $this->getOutput()->addVaryHeader( 'X-Forwarded-Proto' );
285 
286  return;
287  } else {
288  // A wiki without HTTPS login support should set $wgServer to
289  // http://somehost, in which case the secure URL generated
290  // above won't actually start with https://
291  if ( substr( $url, 0, 8 ) === 'https://' ) {
292  $this->mSecureLoginUrl = $url;
293  }
294  }
295  }
296 
297  if ( !$this->isActionAllowed( $this->authAction ) ) {
298  // FIXME how do we explain this to the user? can we handle session loss better?
299  // messages used: authpage-cannot-login, authpage-cannot-login-continue,
300  // authpage-cannot-create, authpage-cannot-create-continue
301  $this->mainLoginForm( [], 'authpage-cannot-' . $this->authAction );
302  return;
303  }
304 
305  if ( $this->canBypassForm( $button_name ) ) {
306  $this->setRequest( [], true );
307  $this->getRequest()->setVal( $this->getTokenName(), $this->getToken() );
308  if ( $button_name ) {
309  $this->getRequest()->setVal( $button_name, true );
310  }
311  }
312 
313  $status = $this->trySubmit();
314 
315  if ( !$status || !$status->isGood() ) {
316  $this->mainLoginForm( $this->authRequests, $status ? $status->getMessage() : '', 'error' );
317  return;
318  }
319 
321  $response = $status->getValue();
322 
323  $returnToUrl = $this->getPageTitle( 'return' )
324  ->getFullURL( $this->getPreservedParams( true ), false, PROTO_HTTPS );
325  switch ( $response->status ) {
326  case AuthenticationResponse::PASS:
327  $this->logAuthResult( true );
328  $this->proxyAccountCreation = $this->isSignup() && !$this->getUser()->isAnon();
329  $this->targetUser = User::newFromName( $response->username );
330 
331  if (
332  !$this->proxyAccountCreation
333  && $response->loginRequest
334  && $authManager->canAuthenticateNow()
335  ) {
336  // successful registration; log the user in instantly
337  $response2 = $authManager->beginAuthentication( [ $response->loginRequest ],
338  $returnToUrl );
339  if ( $response2->status !== AuthenticationResponse::PASS ) {
340  LoggerFactory::getInstance( 'login' )
341  ->error( 'Could not log in after account creation' );
342  $this->successfulAction( true, Status::newFatal( 'createacct-loginerror' ) );
343  break;
344  }
345  }
346 
347  if ( !$this->proxyAccountCreation ) {
348  // Ensure that the context user is the same as the session user.
350  }
351 
352  $this->successfulAction( true );
353  break;
354  case AuthenticationResponse::FAIL:
355  // fall through
356  case AuthenticationResponse::RESTART:
357  unset( $this->authForm );
358  if ( $response->status === AuthenticationResponse::FAIL ) {
359  $action = $this->getDefaultAction( $subPage );
360  $messageType = 'error';
361  } else {
362  $action = $this->getContinueAction( $this->authAction );
363  $messageType = 'warning';
364  }
365  $this->logAuthResult( false, $response->message ? $response->message->getKey() : '-' );
366  $this->loadAuth( $subPage, $action, true );
367  $this->mainLoginForm( $this->authRequests, $response->message, $messageType );
368  break;
369  case AuthenticationResponse::REDIRECT:
370  unset( $this->authForm );
371  $this->getOutput()->redirect( $response->redirectTarget );
372  break;
373  case AuthenticationResponse::UI:
374  unset( $this->authForm );
375  $this->authAction = $this->isSignup() ? AuthManager::ACTION_CREATE_CONTINUE
376  : AuthManager::ACTION_LOGIN_CONTINUE;
377  $this->authRequests = $response->neededRequests;
378  $this->mainLoginForm( $response->neededRequests, $response->message, $response->messageType );
379  break;
380  default:
381  throw new LogicException( 'invalid AuthenticationResponse' );
382  }
383  }
384 
398  private function canBypassForm( &$button_name ) {
399  $button_name = null;
400  if ( $this->isContinued() ) {
401  return false;
402  }
403  $fields = AuthenticationRequest::mergeFieldInfo( $this->authRequests );
404  foreach ( $fields as $fieldname => $field ) {
405  if ( !isset( $field['type'] ) ) {
406  return false;
407  }
408  if ( !empty( $field['skippable'] ) ) {
409  continue;
410  }
411  if ( $field['type'] === 'button' ) {
412  if ( $button_name !== null ) {
413  $button_name = null;
414  return false;
415  } else {
416  $button_name = $fieldname;
417  }
418  } elseif ( $field['type'] !== 'null' ) {
419  return false;
420  }
421  }
422  return true;
423  }
424 
434  protected function showSuccessPage(
435  $type, $title, $msgname, $injected_html, $extraMessages
436  ) {
437  $out = $this->getOutput();
438  $out->setPageTitle( $title );
439  if ( $msgname ) {
440  $out->addWikiMsg( $msgname, wfEscapeWikiText( $this->getUser()->getName() ) );
441  }
442  if ( $extraMessages ) {
443  $extraMessages = Status::wrap( $extraMessages );
444  $out->addWikiTextAsInterface( $extraMessages->getWikiText() );
445  }
446 
447  $out->addHTML( $injected_html );
448 
449  $helper = new LoginHelper( $this->getContext() );
450  $helper->showReturnToPage( $type, $this->mReturnTo, $this->mReturnToQuery, $this->mStickHTTPS );
451  }
452 
468  public function showReturnToPage(
469  $type, $returnTo = '', $returnToQuery = '', $stickHTTPS = false
470  ) {
471  $helper = new LoginHelper( $this->getContext() );
472  $helper->showReturnToPage( $type, $returnTo, $returnToQuery, $stickHTTPS );
473  }
474 
479  protected function setSessionUserForCurrentRequest() {
480  global $wgUser, $wgLang;
481 
483  $localContext = $this->getContext();
484  if ( $context !== $localContext ) {
485  // remove AuthManagerSpecialPage context hack
486  $this->setContext( $context );
487  }
488 
489  $user = $context->getRequest()->getSession()->getUser();
490 
491  $wgUser = $user;
492  $context->setUser( $user );
493 
494  $wgLang = $context->getLanguage();
495  }
496 
511  protected function mainLoginForm( array $requests, $msg = '', $msgtype = 'error' ) {
512  $user = $this->getUser();
513  $out = $this->getOutput();
514 
515  // FIXME how to handle empty $requests - restart, or no form, just an error message?
516  // no form would be better for no session type errors, restart is better when can* fails.
517  if ( !$requests ) {
518  $this->authAction = $this->getDefaultAction( $this->subPage );
519  $this->authForm = null;
520  $requests = AuthManager::singleton()->getAuthenticationRequests( $this->authAction, $user );
521  }
522 
523  // Generic styles and scripts for both login and signup form
524  $out->addModuleStyles( [
525  'mediawiki.ui',
526  'mediawiki.ui.button',
527  'mediawiki.ui.checkbox',
528  'mediawiki.ui.input',
529  'mediawiki.special.userlogin.common.styles'
530  ] );
531  if ( $this->isSignup() ) {
532  // XXX hack pending RL or JS parse() support for complex content messages T27349
533  $out->addJsConfigVars( 'wgCreateacctImgcaptchaHelp',
534  $this->msg( 'createacct-imgcaptcha-help' )->parse() );
535 
536  // Additional styles and scripts for signup form
537  $out->addModules( [
538  'mediawiki.special.userlogin.signup.js'
539  ] );
540  $out->addModuleStyles( [
541  'mediawiki.special.userlogin.signup.styles'
542  ] );
543  } else {
544  // Additional styles for login form
545  $out->addModuleStyles( [
546  'mediawiki.special.userlogin.login.styles'
547  ] );
548  }
549  $out->disallowUserJs(); // just in case...
550 
551  $form = $this->getAuthForm( $requests, $this->authAction, $msg, $msgtype );
552  $form->prepareForm();
553 
554  $submitStatus = Status::newGood();
555  if ( $msg && $msgtype === 'warning' ) {
556  $submitStatus->warning( $msg );
557  } elseif ( $msg && $msgtype === 'error' ) {
558  $submitStatus->fatal( $msg );
559  }
560 
561  // warning header for non-standard workflows (e.g. security reauthentication)
562  if (
563  !$this->isSignup() &&
564  $this->getUser()->isLoggedIn() &&
565  $this->authAction !== AuthManager::ACTION_LOGIN_CONTINUE
566  ) {
567  $reauthMessage = $this->securityLevel ? 'userlogin-reauth' : 'userlogin-loggedin';
568  $submitStatus->warning( $reauthMessage, $this->getUser()->getName() );
569  }
570 
571  $formHtml = $form->getHTML( $submitStatus );
572 
573  $out->addHTML( $this->getPageHtml( $formHtml ) );
574  }
575 
582  protected function getPageHtml( $formHtml ) {
584 
585  $loginPrompt = $this->isSignup() ? '' : Html::rawElement( 'div',
586  [ 'id' => 'userloginprompt' ], $this->msg( 'loginprompt' )->parseAsBlock() );
587  $languageLinks = $wgLoginLanguageSelector ? $this->makeLanguageSelector() : '';
588  $signupStartMsg = $this->msg( 'signupstart' );
589  $signupStart = ( $this->isSignup() && !$signupStartMsg->isDisabled() )
590  ? Html::rawElement( 'div', [ 'id' => 'signupstart' ], $signupStartMsg->parseAsBlock() ) : '';
591  if ( $languageLinks ) {
592  $languageLinks = Html::rawElement( 'div', [ 'id' => 'languagelinks' ],
593  Html::rawElement( 'p', [], $languageLinks )
594  );
595  }
596 
597  $benefitsContainer = '';
598  if ( $this->isSignup() && $this->showExtraInformation() ) {
599  // messages used:
600  // createacct-benefit-icon1 createacct-benefit-head1 createacct-benefit-body1
601  // createacct-benefit-icon2 createacct-benefit-head2 createacct-benefit-body2
602  // createacct-benefit-icon3 createacct-benefit-head3 createacct-benefit-body3
603  $benefitCount = 3;
604  $benefitList = '';
605  for ( $benefitIdx = 1; $benefitIdx <= $benefitCount; $benefitIdx++ ) {
606  $headUnescaped = $this->msg( "createacct-benefit-head$benefitIdx" )->text();
607  $iconClass = $this->msg( "createacct-benefit-icon$benefitIdx" )->text();
608  $benefitList .= Html::rawElement( 'div', [ 'class' => "mw-number-text $iconClass" ],
609  Html::rawElement( 'h3', [],
610  $this->msg( "createacct-benefit-head$benefitIdx" )->escaped()
611  )
612  . Html::rawElement( 'p', [],
613  $this->msg( "createacct-benefit-body$benefitIdx" )->params( $headUnescaped )->escaped()
614  )
615  );
616  }
617  $benefitsContainer = Html::rawElement( 'div', [ 'class' => 'mw-createacct-benefits-container' ],
618  Html::rawElement( 'h2', [], $this->msg( 'createacct-benefit-heading' )->escaped() )
619  . Html::rawElement( 'div', [ 'class' => 'mw-createacct-benefits-list' ],
620  $benefitList
621  )
622  );
623  }
624 
625  $html = Html::rawElement( 'div', [ 'class' => 'mw-ui-container' ],
626  $loginPrompt
627  . $languageLinks
628  . $signupStart
629  . Html::rawElement( 'div', [ 'id' => 'userloginForm' ],
630  $formHtml
631  )
632  . $benefitsContainer
633  );
634 
635  return $html;
636  }
637 
646  protected function getAuthForm( array $requests, $action, $msg = '', $msgType = 'error' ) {
647  global $wgSecureLogin;
648  // FIXME merge this with parent
649 
650  if ( isset( $this->authForm ) ) {
651  return $this->authForm;
652  }
653 
654  $usingHTTPS = $this->getRequest()->getProtocol() === 'https';
655 
656  // get basic form description from the auth logic
657  $fieldInfo = AuthenticationRequest::mergeFieldInfo( $requests );
658  // this will call onAuthChangeFormFields()
659  $formDescriptor = static::fieldInfoToFormDescriptor( $requests, $fieldInfo, $this->authAction );
660  $this->postProcessFormDescriptor( $formDescriptor, $requests );
661 
662  $context = $this->getContext();
663  if ( $context->getRequest() !== $this->getRequest() ) {
664  // We have overridden the request, need to make sure the form uses that too.
665  $context = new DerivativeContext( $this->getContext() );
666  $context->setRequest( $this->getRequest() );
667  }
668  $form = HTMLForm::factory( 'vform', $formDescriptor, $context );
669 
670  $form->addHiddenField( 'authAction', $this->authAction );
671  if ( $this->mLanguage ) {
672  $form->addHiddenField( 'uselang', $this->mLanguage );
673  }
674  $form->addHiddenField( 'force', $this->securityLevel );
675  $form->addHiddenField( $this->getTokenName(), $this->getToken()->toString() );
676  if ( $wgSecureLogin ) {
677  // If using HTTPS coming from HTTP, then the 'fromhttp' parameter must be preserved
678  if ( !$this->isSignup() ) {
679  $form->addHiddenField( 'wpForceHttps', (int)$this->mStickHTTPS );
680  $form->addHiddenField( 'wpFromhttp', $usingHTTPS );
681  }
682  }
683 
684  // set properties of the form itself
685  $form->setAction( $this->getPageTitle()->getLocalURL( $this->getReturnToQueryStringFragment() ) );
686  $form->setName( 'userlogin' . ( $this->isSignup() ? '2' : '' ) );
687  if ( $this->isSignup() ) {
688  $form->setId( 'userlogin2' );
689  }
690 
691  $form->suppressDefaultSubmit();
692 
693  $this->authForm = $form;
694 
695  return $form;
696  }
697 
698  public function onAuthChangeFormFields(
699  array $requests, array $fieldInfo, array &$formDescriptor, $action
700  ) {
701  $coreFieldDescriptors = $this->getFieldDefinitions();
702 
703  // keep the ordering from getCoreFieldDescriptors() where there is no explicit weight
704  foreach ( $coreFieldDescriptors as $fieldName => $coreField ) {
705  $requestField = $formDescriptor[$fieldName] ?? [];
706 
707  // remove everything that is not in the fieldinfo, is not marked as a supplemental field
708  // to something in the fieldinfo, and is not an info field or a submit button
709  if (
710  !isset( $fieldInfo[$fieldName] )
711  && (
712  !isset( $coreField['baseField'] )
713  || !isset( $fieldInfo[$coreField['baseField']] )
714  )
715  && (
716  !isset( $coreField['type'] )
717  || !in_array( $coreField['type'], [ 'submit', 'info' ], true )
718  )
719  ) {
720  $coreFieldDescriptors[$fieldName] = null;
721  continue;
722  }
723 
724  // core message labels should always take priority
725  if (
726  isset( $coreField['label'] )
727  || isset( $coreField['label-message'] )
728  || isset( $coreField['label-raw'] )
729  ) {
730  unset( $requestField['label'], $requestField['label-message'], $coreField['label-raw'] );
731  }
732 
733  $coreFieldDescriptors[$fieldName] += $requestField;
734  }
735 
736  $formDescriptor = array_filter( $coreFieldDescriptors + $formDescriptor );
737  return true;
738  }
739 
746  protected function showExtraInformation() {
747  return $this->authAction !== $this->getContinueAction( $this->authAction )
749  }
750 
755  protected function getFieldDefinitions() {
756  global $wgEmailConfirmToEdit;
757 
758  $isLoggedIn = $this->getUser()->isLoggedIn();
759  $continuePart = $this->isContinued() ? 'continue-' : '';
760  $anotherPart = $isLoggedIn ? 'another-' : '';
761  $expiration = $this->getRequest()->getSession()->getProvider()->getRememberUserDuration();
762  $expirationDays = ceil( $expiration / ( 3600 * 24 ) );
763  $secureLoginLink = '';
764  if ( $this->mSecureLoginUrl ) {
765  $secureLoginLink = Html::element( 'a', [
766  'href' => $this->mSecureLoginUrl,
767  'class' => 'mw-ui-flush-right mw-secure',
768  ], $this->msg( 'userlogin-signwithsecure' )->text() );
769  }
770  $usernameHelpLink = '';
771  if ( !$this->msg( 'createacct-helpusername' )->isDisabled() ) {
772  $usernameHelpLink = Html::rawElement( 'span', [
773  'class' => 'mw-ui-flush-right',
774  ], $this->msg( 'createacct-helpusername' )->parse() );
775  }
776 
777  if ( $this->isSignup() ) {
778  $fieldDefinitions = [
779  'statusarea' => [
780  // used by the mediawiki.special.userlogin.signup.js module for error display
781  // FIXME merge this with HTMLForm's normal status (error) area
782  'type' => 'info',
783  'raw' => true,
784  'default' => Html::element( 'div', [ 'id' => 'mw-createacct-status-area' ] ),
785  'weight' => -105,
786  ],
787  'username' => [
788  'label-raw' => $this->msg( 'userlogin-yourname' )->escaped() . $usernameHelpLink,
789  'id' => 'wpName2',
790  'placeholder-message' => $isLoggedIn ? 'createacct-another-username-ph'
791  : 'userlogin-yourname-ph',
792  ],
793  'mailpassword' => [
794  // create account without providing password, a temporary one will be mailed
795  'type' => 'check',
796  'label-message' => 'createaccountmail',
797  'name' => 'wpCreateaccountMail',
798  'id' => 'wpCreateaccountMail',
799  ],
800  'password' => [
801  'id' => 'wpPassword2',
802  'placeholder-message' => 'createacct-yourpassword-ph',
803  'hide-if' => [ '===', 'wpCreateaccountMail', '1' ],
804  ],
805  'domain' => [],
806  'retype' => [
807  'baseField' => 'password',
808  'type' => 'password',
809  'label-message' => 'createacct-yourpasswordagain',
810  'id' => 'wpRetype',
811  'cssclass' => 'loginPassword',
812  'size' => 20,
813  'validation-callback' => function ( $value, $alldata ) {
814  if ( empty( $alldata['mailpassword'] ) && !empty( $alldata['password'] ) ) {
815  if ( !$value ) {
816  return $this->msg( 'htmlform-required' );
817  } elseif ( $value !== $alldata['password'] ) {
818  return $this->msg( 'badretype' );
819  }
820  }
821  return true;
822  },
823  'hide-if' => [ '===', 'wpCreateaccountMail', '1' ],
824  'placeholder-message' => 'createacct-yourpasswordagain-ph',
825  ],
826  'email' => [
827  'type' => 'email',
828  'label-message' => $wgEmailConfirmToEdit ? 'createacct-emailrequired'
829  : 'createacct-emailoptional',
830  'id' => 'wpEmail',
831  'cssclass' => 'loginText',
832  'size' => '20',
833  // FIXME will break non-standard providers
834  'required' => $wgEmailConfirmToEdit,
835  'validation-callback' => function ( $value, $alldata ) {
836  global $wgEmailConfirmToEdit;
837 
838  // AuthManager will check most of these, but that will make the auth
839  // session fail and this won't, so nicer to do it this way
840  if ( !$value && $wgEmailConfirmToEdit ) {
841  // no point in allowing registration without email when email is
842  // required to edit
843  return $this->msg( 'noemailtitle' );
844  } elseif ( !$value && !empty( $alldata['mailpassword'] ) ) {
845  // cannot send password via email when there is no email address
846  return $this->msg( 'noemailcreate' );
847  } elseif ( $value && !Sanitizer::validateEmail( $value ) ) {
848  return $this->msg( 'invalidemailaddress' );
849  }
850  return true;
851  },
852  'placeholder-message' => 'createacct-' . $anotherPart . 'email-ph',
853  ],
854  'realname' => [
855  'type' => 'text',
856  'help-message' => $isLoggedIn ? 'createacct-another-realname-tip'
857  : 'prefs-help-realname',
858  'label-message' => 'createacct-realname',
859  'cssclass' => 'loginText',
860  'size' => 20,
861  'id' => 'wpRealName',
862  ],
863  'reason' => [
864  // comment for the user creation log
865  'type' => 'text',
866  'label-message' => 'createacct-reason',
867  'cssclass' => 'loginText',
868  'id' => 'wpReason',
869  'size' => '20',
870  'placeholder-message' => 'createacct-reason-ph',
871  ],
872  'createaccount' => [
873  // submit button
874  'type' => 'submit',
875  'default' => $this->msg( 'createacct-' . $anotherPart . $continuePart .
876  'submit' )->text(),
877  'name' => 'wpCreateaccount',
878  'id' => 'wpCreateaccount',
879  'weight' => 100,
880  ],
881  ];
882  } else {
883  $fieldDefinitions = [
884  'username' => [
885  'label-raw' => $this->msg( 'userlogin-yourname' )->escaped() . $secureLoginLink,
886  'id' => 'wpName1',
887  'placeholder-message' => 'userlogin-yourname-ph',
888  ],
889  'password' => [
890  'id' => 'wpPassword1',
891  'placeholder-message' => 'userlogin-yourpassword-ph',
892  ],
893  'domain' => [],
894  'rememberMe' => [
895  // option for saving the user token to a cookie
896  'type' => 'check',
897  'name' => 'wpRemember',
898  'label-message' => $this->msg( 'userlogin-remembermypassword' )
899  ->numParams( $expirationDays ),
900  'id' => 'wpRemember',
901  ],
902  'loginattempt' => [
903  // submit button
904  'type' => 'submit',
905  'default' => $this->msg( 'pt-login-' . $continuePart . 'button' )->text(),
906  'id' => 'wpLoginAttempt',
907  'weight' => 100,
908  ],
909  'linkcontainer' => [
910  // help link
911  'type' => 'info',
912  'cssclass' => 'mw-form-related-link-container mw-userlogin-help',
913  // 'id' => 'mw-userlogin-help', // FIXME HTMLInfoField ignores this
914  'raw' => true,
915  'default' => Html::element( 'a', [
916  'href' => Skin::makeInternalOrExternalUrl( $this->msg( 'helplogin-url' )
917  ->inContentLanguage()
918  ->text() ),
919  ], $this->msg( 'userlogin-helplink2' )->text() ),
920  'weight' => 200,
921  ],
922  // button for ResetPasswordSecondaryAuthenticationProvider
923  'skipReset' => [
924  'weight' => 110,
925  'flags' => [],
926  ],
927  ];
928  }
929 
930  $fieldDefinitions['username'] += [
931  'type' => 'text',
932  'name' => 'wpName',
933  'cssclass' => 'loginText',
934  'size' => 20,
935  // 'required' => true,
936  ];
937  $fieldDefinitions['password'] += [
938  'type' => 'password',
939  // 'label-message' => 'userlogin-yourpassword', // would override the changepassword label
940  'name' => 'wpPassword',
941  'cssclass' => 'loginPassword',
942  'size' => 20,
943  // 'required' => true,
944  ];
945 
946  if ( $this->mEntryError ) {
947  $fieldDefinitions['entryError'] = [
948  'type' => 'info',
949  'default' => Html::rawElement( 'div', [ 'class' => $this->mEntryErrorType . 'box', ],
950  $this->mEntryError ),
951  'raw' => true,
952  'rawrow' => true,
953  'weight' => -100,
954  ];
955  }
956  if ( !$this->showExtraInformation() ) {
957  unset( $fieldDefinitions['linkcontainer'], $fieldDefinitions['signupend'] );
958  }
959  if ( $this->isSignup() && $this->showExtraInformation() ) {
960  // blank signup footer for site customization
961  // uses signupend-https for HTTPS requests if it's not blank, signupend otherwise
962  $signupendMsg = $this->msg( 'signupend' );
963  $signupendHttpsMsg = $this->msg( 'signupend-https' );
964  if ( !$signupendMsg->isDisabled() ) {
965  $usingHTTPS = $this->getRequest()->getProtocol() === 'https';
966  $signupendText = ( $usingHTTPS && !$signupendHttpsMsg->isBlank() )
967  ? $signupendHttpsMsg->parse() : $signupendMsg->parse();
968  $fieldDefinitions['signupend'] = [
969  'type' => 'info',
970  'raw' => true,
971  'default' => Html::rawElement( 'div', [ 'id' => 'signupend' ], $signupendText ),
972  'weight' => 225,
973  ];
974  }
975  }
976  if ( !$this->isSignup() && $this->showExtraInformation() ) {
977  $passwordReset = new PasswordReset( $this->getConfig(), AuthManager::singleton() );
978  if ( $passwordReset->isAllowed( $this->getUser() )->isGood() ) {
979  $fieldDefinitions['passwordReset'] = [
980  'type' => 'info',
981  'raw' => true,
982  'cssclass' => 'mw-form-related-link-container',
983  'default' => $this->getLinkRenderer()->makeLink(
984  SpecialPage::getTitleFor( 'PasswordReset' ),
985  $this->msg( 'userlogin-resetpassword-link' )->text()
986  ),
987  'weight' => 230,
988  ];
989  }
990 
991  // Don't show a "create account" link if the user can't.
992  if ( $this->showCreateAccountLink() ) {
993  // link to the other action
994  $linkTitle = $this->getTitleFor( $this->isSignup() ? 'Userlogin' : 'CreateAccount' );
995  $linkq = $this->getReturnToQueryStringFragment();
996  // Pass any language selection on to the mode switch link
997  if ( $this->mLanguage ) {
998  $linkq .= '&uselang=' . urlencode( $this->mLanguage );
999  }
1000  $loggedIn = $this->getUser()->isLoggedIn();
1001 
1002  $fieldDefinitions['createOrLogin'] = [
1003  'type' => 'info',
1004  'raw' => true,
1005  'linkQuery' => $linkq,
1006  'default' => function ( $params ) use ( $loggedIn, $linkTitle ) {
1007  return Html::rawElement( 'div',
1008  [ 'id' => 'mw-createaccount' . ( !$loggedIn ? '-cta' : '' ),
1009  'class' => ( $loggedIn ? 'mw-form-related-link-container' : 'mw-ui-vform-field' ) ],
1010  ( $loggedIn ? '' : $this->msg( 'userlogin-noaccount' )->escaped() )
1011  . Html::element( 'a',
1012  [
1013  'id' => 'mw-createaccount-join' . ( $loggedIn ? '-loggedin' : '' ),
1014  'href' => $linkTitle->getLocalURL( $params['linkQuery'] ),
1015  'class' => ( $loggedIn ? '' : 'mw-ui-button' ),
1016  'tabindex' => 100,
1017  ],
1018  $this->msg(
1019  $loggedIn ? 'userlogin-createanother' : 'userlogin-joinproject'
1020  )->text()
1021  )
1022  );
1023  },
1024  'weight' => 235,
1025  ];
1026  }
1027  }
1028 
1029  return $fieldDefinitions;
1030  }
1031 
1041  protected function hasSessionCookie() {
1043 
1044  return $wgDisableCookieCheck || (
1045  $wgInitialSessionId &&
1046  $this->getRequest()->getSession()->getId() === (string)$wgInitialSessionId
1047  );
1048  }
1049 
1055  protected function getReturnToQueryStringFragment() {
1056  $returnto = '';
1057  if ( $this->mReturnTo !== '' ) {
1058  $returnto = 'returnto=' . wfUrlencode( $this->mReturnTo );
1059  if ( $this->mReturnToQuery !== '' ) {
1060  $returnto .= '&returntoquery=' . wfUrlencode( $this->mReturnToQuery );
1061  }
1062  }
1063  return $returnto;
1064  }
1065 
1071  private function showCreateAccountLink() {
1072  if ( $this->isSignup() ) {
1073  return true;
1074  } elseif ( $this->getUser()->isAllowed( 'createaccount' ) ) {
1075  return true;
1076  } else {
1077  return false;
1078  }
1079  }
1080 
1081  protected function getTokenName() {
1082  return $this->isSignup() ? 'wpCreateaccountToken' : 'wpLoginToken';
1083  }
1084 
1091  protected function makeLanguageSelector() {
1092  $msg = $this->msg( 'loginlanguagelinks' )->inContentLanguage();
1093  if ( $msg->isBlank() ) {
1094  return '';
1095  }
1096  $langs = explode( "\n", $msg->text() );
1097  $links = [];
1098  foreach ( $langs as $lang ) {
1099  $lang = trim( $lang, '* ' );
1100  $parts = explode( '|', $lang );
1101  if ( count( $parts ) >= 2 ) {
1102  $links[] = $this->makeLanguageSelectorLink( $parts[0], trim( $parts[1] ) );
1103  }
1104  }
1105 
1106  return count( $links ) > 0 ? $this->msg( 'loginlanguagelabel' )->rawParams(
1107  $this->getLanguage()->pipeList( $links ) )->escaped() : '';
1108  }
1109 
1118  protected function makeLanguageSelectorLink( $text, $lang ) {
1119  if ( $this->getLanguage()->getCode() == $lang ) {
1120  // no link for currently used language
1121  return htmlspecialchars( $text );
1122  }
1123  $query = [ 'uselang' => $lang ];
1124  if ( $this->mReturnTo !== '' ) {
1125  $query['returnto'] = $this->mReturnTo;
1126  $query['returntoquery'] = $this->mReturnToQuery;
1127  }
1128 
1129  $attr = [];
1130  $targetLanguage = Language::factory( $lang );
1131  $attr['lang'] = $attr['hreflang'] = $targetLanguage->getHtmlCode();
1132 
1133  return $this->getLinkRenderer()->makeKnownLink(
1134  $this->getPageTitle(),
1135  $text,
1136  $attr,
1137  $query
1138  );
1139  }
1140 
1141  protected function getGroupName() {
1142  return 'login';
1143  }
1144 
1150  // Pre-fill username (if not creating an account, T46775).
1151  if (
1152  isset( $formDescriptor['username'] ) &&
1153  !isset( $formDescriptor['username']['default'] ) &&
1154  !$this->isSignup()
1155  ) {
1156  $user = $this->getUser();
1157  if ( $user->isLoggedIn() ) {
1158  $formDescriptor['username']['default'] = $user->getName();
1159  } else {
1160  $formDescriptor['username']['default'] =
1161  $this->getRequest()->getSession()->suggestLoginUsername();
1162  }
1163  }
1164 
1165  // don't show a submit button if there is nothing to submit (i.e. the only form content
1166  // is other submit buttons, for redirect flows)
1167  if ( !$this->needsSubmitButton( $requests ) ) {
1168  unset( $formDescriptor['createaccount'], $formDescriptor['loginattempt'] );
1169  }
1170 
1171  if ( !$this->isSignup() ) {
1172  // FIXME HACK don't focus on non-empty field
1173  // maybe there should be an autofocus-if similar to hide-if?
1174  if (
1175  isset( $formDescriptor['username'] )
1176  && empty( $formDescriptor['username']['default'] )
1177  && !$this->getRequest()->getCheck( 'wpName' )
1178  ) {
1179  $formDescriptor['username']['autofocus'] = true;
1180  } elseif ( isset( $formDescriptor['password'] ) ) {
1181  $formDescriptor['password']['autofocus'] = true;
1182  }
1183  }
1184 
1185  $this->addTabIndex( $formDescriptor );
1186  }
1187 }
$wgInitialSessionId
Definition: Setup.php:815
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))
setSessionUserForCurrentRequest()
Replace some globals to make sure the fact that the user has just been logged in is reflected in the ...
loadAuth( $subPage, $authAction=null, $reset=false)
Load or initialize $authAction, $authRequests and $subPage.
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:1995
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
showReturnToPage( $type, $returnTo='', $returnToQuery='', $stickHTTPS=false)
Add a "return to" link or redirect to it.
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:1598
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
A special page subclass for authentication-related special pages.
getContext()
Gets the context this SpecialPage is executed in.
$success
loadRequestParameters( $subPage)
Load basic request parameters for this Special page.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
mainLoginForm(array $requests, $msg='', $msgtype='error')
needsSubmitButton(array $requests)
Returns true if the form built from the given AuthenticationRequests needs a submit button...
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:2074
makeLanguageSelector()
Produce a bar of links which allow the user to select another language during login/registration but ...
if(!isset( $args[0])) $lang
logAuthResult( $success, $status=null)
Logs to the authmanager-stats channel.
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:1276
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
An IContextSource implementation which will inherit context from another source but allow individual ...
getPreservedParams( $withToken=false)
hasSessionCookie()
Check if a session cookie is present.
$wgSecureLogin
This is to let user authenticate using https when they come from http.
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:175
$value
getToken()
Returns the CSRF token.
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 MediaWikiServices
Definition: injection.txt:23
$wgEmailConfirmToEdit
Should editors be required to have a validated e-mail address before being allowed to edit...
User $targetUser
FIXME another flag for passing data.
getOutput()
Get the OutputPage being used for this instance.
successfulAction( $direct=false, $extraMessages=null)
this hook is for auditing only $response
Definition: hooks.txt:780
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:286
Holds shared logic for login and account creation pages.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1812
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
showExtraInformation()
Show extra information such as password recovery information, link from login to signup, CTA etc? Such information should only be shown on the "landing page", ie.
static validateEmail( $addr)
Does a string look like an e-mail address?
Definition: Sanitizer.php:2124
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:1995
getPageHtml( $formHtml)
Add page elements which are outside the form.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
getContinueAction( $action)
Gets the _CONTINUE version of an action.
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
$wgLoginLanguageSelector
Show a bar of language selection links in the user login and user registration forms; edit the "login...
getDefaultAction( $subPage)
Get the default action for this special page, if none is given via URL/POST data. ...
showSuccessPage( $type, $title, $msgname, $injected_html, $extraMessages)
Show the success page.
const PROTO_HTTPS
Definition: Defines.php:220
isContinued()
Returns true if this is not the first step of the authentication.
setContext( $context)
Sets the context this SpecialPage is executed in.
isActionAllowed( $action)
Checks whether AuthManager is ready to perform the action.
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness, which urlencode encodes by default.
$wgLang
Definition: Setup.php:891
static getMain()
Get the RequestContext object associated with the main request.
canBypassForm(&$button_name)
Determine if the login form can be bypassed.
addTabIndex(&$formDescriptor)
Adds a sequential tabindex starting from 1 to all form elements.
An error page which can definitely be safely rendered using the OutputPage.
$wgDisableCookieCheck
By default, MediaWiki checks if the client supports cookies during the login process, so that it can display an informative error message if cookies are disabled.
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
load( $subPage)
Load data from request.
$params
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
$wgUseMediaWikiUIEverywhere
Temporary variable that applies MediaWiki UI wherever it can be supported.
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:273
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:935
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:214
Helper functions for the login form that need to be shared with other special pages (such as CentralA...
Definition: LoginHelper.php:8
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:82
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
Definition: distributors.txt:9
Helper class for the password reset functionality shared by the web UI and the API.
static wrap( $sv)
Succinct helper method to wrap a StatusValue.
Definition: Status.php:55
getFieldDefinitions()
Create a HTMLForm descriptor for the core login fields.
onAuthChangeFormFields(array $requests, array $fieldInfo, array &$formDescriptor, $action)
setRequest(array $data, $wasPosted=null)
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
Definition: injection.txt:35
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
getName()
Get the name of this Special Page.
getAuthForm(array $requests, $action, $msg='', $msgType='error')
Generates a form from the given request.
bool $proxyAccountCreation
True if the user if creating an account for someone else.
getUser()
Shortcut to get the User executing this instance.
getConfig()
Shortcut to get main config object.
static getValidErrorMessages()
Returns an array of all valid error messages.
Definition: LoginHelper.php:36
getLanguage()
Shortcut to get user&#39;s language.
msg( $key)
Wrapper around wfMessage that sets the current context.
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:2625
postProcessFormDescriptor(&$formDescriptor, $requests)
MediaWiki Logger LoggerFactory implements a PSR [0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
getFullTitle()
Return the full title, including $par.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
wfCanIPUseHTTPS( $ip)
Determine whether the client at a given source IP is likely to be able to access the wiki via HTTPS...
static makeInternalOrExternalUrl( $name)
If url string starts with http, consider as external URL, else internal.
Definition: Skin.php:1193
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:584
showCreateAccountLink()
Whether the login/create account form should display a link to the other form (in addition to whateve...
string $subPage
Subpage of the special page.
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:2625
getPageTitle( $subpage=false)
Get a self-referential title object.
makeLanguageSelectorLink( $text, $lang)
Create a language selector link for a particular language Links back to this page preserving type and...
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1486
getReturnToQueryStringFragment()
Returns a string that can be appended to the URL (without encoding) to preserve the return target...
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:280
trySubmit()
Attempts to do an authentication step with the submitted data.