MediaWiki  master
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  $this->getHookRunner()->onUserLoginComplete(
128  $user, $injected_html, $direct );
129 
130  if ( $injected_html !== '' || $extraMessages ) {
131  $this->showSuccessPage( 'success', $this->msg( 'loginsuccesstitle' ),
132  'loginsuccess', $injected_html, $extraMessages );
133  } else {
134  $helper = new LoginHelper( $this->getContext() );
135  $helper->showReturnToPage( 'successredirect', $this->mReturnTo, $this->mReturnToQuery,
136  $this->mStickHTTPS );
137  }
138  }
139 
140  protected function getToken() {
141  return $this->getRequest()->getSession()->getToken( '', 'login' );
142  }
143 
144  protected function clearToken() {
145  return $this->getRequest()->getSession()->resetToken( 'login' );
146  }
147 
148  protected function getTokenName() {
149  return 'wpLoginToken';
150  }
151 
152  protected function getGroupName() {
153  return 'login';
154  }
155 
156  protected function logAuthResult( $success, $status = null ) {
157  LoggerFactory::getInstance( 'authevents' )->info( 'Login attempt', [
158  'event' => 'login',
159  'successful' => $success,
160  'status' => $status,
161  ] );
162  }
163 }
SpecialPage\msg
msg( $key,... $params)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:828
SpecialUserLogin\__construct
__construct()
Definition: SpecialUserLogin.php:44
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:744
SpecialUserLogin\getToken
getToken()
Returns the CSRF token.
Definition: SpecialUserLogin.php:140
SpecialUserLogin\getTokenName
getTokenName()
Returns the name of the CSRF token (under which it should be found in the POST or GET data).
Definition: SpecialUserLogin.php:148
LoginSignupSpecialPage\showSuccessPage
showSuccessPage( $type, $title, $msgname, $injected_html, $extraMessages)
Show the success page.
Definition: LoginSignupSpecialPage.php:440
SpecialUserLogin\beforeExecute
beforeExecute( $subPage)
Stable to override.
Definition: SpecialUserLogin.php:76
SpecialUserLogin\$allowedActions
static $allowedActions
Definition: SpecialUserLogin.php:33
SpecialPage\getTitleFor
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:92
$success
$success
Definition: NoLocalSettings.php:42
SpecialUserLogin\$messages
static $messages
Definition: SpecialUserLogin.php:38
SpecialUserLogin\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!...
Definition: SpecialUserLogin.php:64
SpecialUserLogin\logAuthResult
logAuthResult( $success, $status=null)
Logs to the authmanager-stats channel.
Definition: SpecialUserLogin.php:156
LoginHelper
Helper functions for the login form that need to be shared with other special pages (such as CentralA...
Definition: LoginHelper.php:10
SpecialUserLogin\getDescription
getDescription()
Returns the name that goes in the <h1> in the special page itself, and also the name that will be l...
Definition: SpecialUserLogin.php:60
SpecialUserLogin\successfulAction
successfulAction( $direct=false, $extraMessages=null)
Run any hooks registered for logins, then HTTP redirect to $this->mReturnTo (or Main Page if that's u...
Definition: SpecialUserLogin.php:100
AuthManagerSpecialPage\$subPage
string $subPage
Subpage of the special page.
Definition: AuthManagerSpecialPage.php:38
SpecialPage\getHookRunner
getHookRunner()
Definition: SpecialPage.php:1010
MediaWiki\Logger\LoggerFactory
PSR-3 logger instance factory.
Definition: LoggerFactory.php:45
LoginSignupSpecialPage
Holds shared logic for login and account creation pages.
Definition: LoginSignupSpecialPage.php:37
PROTO_CURRENT
const PROTO_CURRENT
Definition: Defines.php:211
SpecialUserLogin\getDefaultAction
getDefaultAction( $subPage)
Get the default action for this special page, if none is given via URL/POST data.
Definition: SpecialUserLogin.php:56
LoginSignupSpecialPage\mainLoginForm
mainLoginForm(array $requests, $msg='', $msgtype='error')
Definition: LoginSignupSpecialPage.php:519
$title
$title
Definition: testCompression.php:38
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:754
LoginSignupSpecialPage\hasSessionCookie
hasSessionCookie()
Check if a session cookie is present.
Definition: LoginSignupSpecialPage.php:1067
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:717
SpecialUserLogin\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialUserLogin.php:152
SpecialUserLogin\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialUserLogin.php:48
SpecialUserLogin\getLoginSecurityLevel
getLoginSecurityLevel()
Stable to override.
Definition: SpecialUserLogin.php:52
SpecialUserLogin\isSignup
isSignup()
Definition: SpecialUserLogin.php:72
MediaWiki\Auth\AuthManager
This serves as the entry point to the authentication system.
Definition: AuthManager.php:88
SpecialUserLogin\clearToken
clearToken()
Definition: SpecialUserLogin.php:144
AuthManagerSpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: AuthManagerSpecialPage.php:73
SpecialUserLogin
Implements Special:UserLogin.
Definition: SpecialUserLogin.php:32
$wgSecureLogin
$wgSecureLogin
This is to let user authenticate using https when they come from http.
Definition: DefaultSettings.php:5356