MediaWiki  1.28.0
SpecialUserLogin.php
Go to the documentation of this file.
1 <?php
26 
33  protected static $allowedActions = [
34  AuthManager::ACTION_LOGIN,
35  AuthManager::ACTION_LOGIN_CONTINUE
36  ];
37 
38  protected static $messages = [
39  'authform-newtoken' => 'nocookiesforlogin',
40  'authform-notoken' => 'sessionfailure',
41  'authform-wrongtoken' => 'sessionfailure',
42  ];
43 
44  public function __construct() {
45  parent::__construct( 'Userlogin' );
46  }
47 
48  public function doesWrites() {
49  return true;
50  }
51 
52  protected function getLoginSecurityLevel() {
53  return false;
54  }
55 
56  protected function getDefaultAction( $subPage ) {
57  return AuthManager::ACTION_LOGIN;
58  }
59 
60  public function getDescription() {
61  return $this->msg( 'login' )->text();
62  }
63 
64  public function setHeaders() {
65  // override the page title if we are doing a forced reauthentication
66  parent::setHeaders();
67  if ( $this->securityLevel && $this->getUser()->isLoggedIn() ) {
68  $this->getOutput()->setPageTitle( $this->msg( 'login-security' ) );
69  }
70  }
71 
72  protected function isSignup() {
73  return false;
74  }
75 
76  protected function beforeExecute( $subPage ) {
77  if ( $subPage === 'signup' || $this->getRequest()->getText( 'type' ) === 'signup' ) {
78  // B/C for old account creation URLs
79  $title = SpecialPage::getTitleFor( 'CreateAccount' );
80  $query = array_diff_key( $this->getRequest()->getValues(),
81  array_fill_keys( [ 'type', 'title' ], true ) );
82  $url = $title->getFullURL( $query, false, PROTO_CURRENT );
83  $this->getOutput()->redirect( $url );
84  return false;
85  }
86  return parent::beforeExecute( $subPage );
87  }
88 
100  protected function successfulAction( $direct = false, $extraMessages = null ) {
101  global $wgSecureLogin;
102 
103  $user = $this->targetUser ?: $this->getUser();
104  $session = $this->getRequest()->getSession();
105 
106  if ( $direct ) {
107  $user->touch();
108 
109  $this->clearToken();
110 
111  if ( $user->requiresHTTPS() ) {
112  $this->mStickHTTPS = true;
113  }
114  $session->setForceHTTPS( $wgSecureLogin && $this->mStickHTTPS );
115 
116  // If the user does not have a session cookie at this point, they probably need to
117  // do something to their browser.
118  if ( !$this->hasSessionCookie() ) {
119  $this->mainLoginForm( [ /*?*/ ], $session->getProvider()->whyNoSession() );
120  // TODO something more specific? This used to use nocookieslogin
121  return;
122  }
123  }
124 
125  # Run any hooks; display injected HTML if any, else redirect
126  $injected_html = '';
127  Hooks::run( 'UserLoginComplete', [ &$user, &$injected_html, $direct ] );
128 
129  if ( $injected_html !== '' || $extraMessages ) {
130  $this->showSuccessPage( 'success', $this->msg( 'loginsuccesstitle' ),
131  'loginsuccess', $injected_html, $extraMessages );
132  } else {
133  $helper = new LoginHelper( $this->getContext() );
134  $helper->showReturnToPage( 'successredirect', $this->mReturnTo, $this->mReturnToQuery,
135  $this->mStickHTTPS );
136  }
137  }
138 
139  protected function getToken() {
140  return $this->getRequest()->getSession()->getToken( '', 'login' );
141  }
142 
143  protected function clearToken() {
144  return $this->getRequest()->getSession()->resetToken( 'login' );
145  }
146 
147  protected function getTokenName() {
148  return 'wpLoginToken';
149  }
150 
151  protected function getGroupName() {
152  return 'login';
153  }
154 
155  protected function logAuthResult( $success, $status = null ) {
156  LoggerFactory::getInstance( 'authevents' )->info( 'Login attempt', [
157  'event' => 'login',
158  'successful' => $success,
159  'status' => $status,
160  ] );
161  }
162 }
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:1555
getContext()
Gets the context this SpecialPage is executed in.
$success
successfulAction($direct=false, $extraMessages=null)
Run any hooks registered for logins, then HTTP redirect to $this->mReturnTo (or Main Page if that's u...
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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...
Definition: SpecialPage.php:82
logAuthResult($success, $status=null)
hasSessionCookie()
Check if a session cookie is present.
const PROTO_CURRENT
Definition: Defines.php:226
mainLoginForm(array $requests, $msg= '', $msgtype= 'error')
msg()
Wrapper around wfMessage that sets the current context.
getOutput()
Get the OutputPage being used for this instance.
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
Holds shared logic for login and account creation pages.
showSuccessPage($type, $title, $msgname, $injected_html, $extraMessages)
Show the success page.
getDefaultAction($subPage)
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
Helper functions for the login form that need to be shared with other special pages (such as CentralA...
Definition: LoginHelper.php:8
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
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
getUser()
Shortcut to get the User executing this instance.
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
Definition: hooks.txt:1046
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
string $subPage
Subpage of the special page.
Implements Special:UserLogin.