Implements Special:UserLogin. More...

Inheritance diagram for SpecialUserLogin:

[legend]

Collaboration diagram for SpecialUserLogin:

[legend]

Public Member Functions

__construct (AuthManager $authManager)

doesWrites ()

Indicates whether this special page may perform database writes.

getDescription ()

Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

setHeaders ()

Sets headers - this should be called from the execute() method of all derived classes!

Public Member Functions inherited from LoginSignupSpecialPage

__construct ( $name, $restriction='')

execute ( $subPage)

onAuthChangeFormFields (array $requests, array $fieldInfo, array &$formDescriptor, $action)

Change the form descriptor that determines how a field will look in the authentication form.Called from fieldInfoToFormDescriptor().

Stability: stable: to override

Parameters

AuthenticationRequest[]	$requests
array	$fieldInfo	Field information array (union of all AuthenticationRequest::getFieldInfo() responses).
array	&$formDescriptor	HTMLForm descriptor. The special key 'weight' can be set to change the order of the fields.
string	$action	Authentication type (one of the AuthManager::ACTION_* constants)

showReturnToPage ( $type, $returnTo='', $returnToQuery='', $stickHTTPS=false)

Add a "return to" link or redirect to it.

Public Member Functions inherited from AuthManagerSpecialPage

getRequest ()

Get the WebRequest being used for this instance.

handleFormSubmit ( $data)

Submit handler callback for HTMLForm.

Public Member Functions inherited from SpecialPage

__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)

Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

addHelpLink ( $to, $overrideBaseUrl=false)

Adds help link with an icon via page indicators.

checkPermissions ()

Checks if userCanExecute, and if not throws a PermissionsError.

checkReadOnly ()

If the wiki is currently in readonly mode, throws a ReadOnlyError.

getAssociatedNavigationLinks ()

Return an array of strings representing page titles that are discoverable to end users via UI.

getAuthority ()

Shortcut to get the Authority executing this instance.

getConfig ()

Shortcut to get main config object.

getContentLanguage ()

Shortcut to get content language.

getContext ()

Gets the context this SpecialPage is executed in.

getFinalGroupName ()

Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

getFullTitle ()

Return the full title, including $par.

getLanguage ()

Shortcut to get user's language.

getLinkRenderer ()

getLocalName ()

Get the localised name of the special page.

getName ()

Get the name of this Special Page.

getOutput ()

Get the OutputPage being used for this instance.

getPageTitle ( $subpage=false)

Get a self-referential title object.

getRestriction ()

Get the permission that a user must have to execute this page.

getShortDescription (string $path='')

Similar to getDescription but takes into account sub pages and designed for display in tabs.

getSkin ()

Shortcut to get the skin being used for this instance.

getUser ()

Shortcut to get the User executing this instance.

including ( $x=null)

Whether the special page is being evaluated via transclusion.

isCached ()

Is this page cached? Expensive pages are cached or disabled in miser mode.

isExpensive ()

Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

isIncludable ()

Whether it's allowed to transclude the special page via {{Special:Foo/params}}.

isListed ()

Whether this special page is listed in Special:SpecialPages.

isRestricted ()

Can be overridden by subclasses with more complicated permissions schemes.

listed ( $x=null)

Get or set whether this special page is listed in Special:SpecialPages.

maxIncludeCacheTime ()

How long to cache page when it is being included.

msg ( $key,... $params)

Wrapper around wfMessage that sets the current context.

prefixSearchSubpages ( $search, $limit, $offset)

Return an array of subpages beginning with $search that this special page will accept.

requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')

If the user is not logged in, throws UserNotLoggedIn error.

requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')

If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

run ( $subPage)

Entry point.

setContentLanguage (Language $contentLanguage)

Set content language.

setContext ( $context)

Sets the context this SpecialPage is executed in.

setHookContainer (HookContainer $hookContainer)

setLinkRenderer (LinkRenderer $linkRenderer)

setListed ( $listed)

Set whether this page is listed in Special:Specialpages, at run-time.

setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

userCanExecute (User $user)

Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Protected Member Functions
	beforeExecute ( $subPage)

	clearToken ()

	getDefaultAction ( $subPage)
	Get the default action for this special page, if none is given via URL/POST data.

	getGroupName ()
	Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

	getLoginSecurityLevel ()

	getToken ()
	Returns the CSRF token.

	getTokenName ()
	Returns the name of the CSRF token (under which it should be found in the POST or GET data).

	isSignup ()

	logAuthResult ( $success, $status=null)
	Logs to the authmanager-stats channel.

	successfulAction ( $direct=false, $extraMessages=null)
	Run any hooks registered for logins, then HTTP redirect to $this->mReturnTo (or Main Page if that's undefined).

Protected Member Functions inherited from LoginSignupSpecialPage
	getAuthForm (array $requests, $action, $msg='', $msgType='error')
	Generates a form from the given request.

	getBenefitsContainerHtml ()
	The HTML to be shown in the "benefits to signing in / creating an account" section of the signup/login page.

	getFieldDefinitions (array $fieldInfo)
	Create a HTMLForm descriptor for the core login fields.

	getPageHtml ( $formHtml)
	Add page elements which are outside the form.

	getPreservedParams ( $withToken=false)
	Returns URL query parameters which can be used to reload the page (or leave and return) while preserving all information that is necessary for authentication to continue.

	getReturnToQueryStringFragment ()
	Returns a string that can be appended to the URL (without encoding) to preserve the return target.

	hasSessionCookie ()
	Check if a session cookie is present.

	load ( $subPage)
	Load data from request.

	mainLoginForm (array $requests, $msg='', $msgtype='error')

	makeLanguageSelector ()
	Produce a bar of links which allow the user to select another language during login/registration but retain "returnto".

	makeLanguageSelectorLink ( $text, $lang)
	Create a language selector link for a particular language Links back to this page preserving type and returnto.

	postProcessFormDescriptor (&$formDescriptor, $requests)

	setRequest (array $data, $wasPosted=null)
	Override the POST data, GET data from the real request is preserved.

	setSessionUserForCurrentRequest ()
	Replace some globals to make sure the fact that the user has just been logged in is reflected in the current request.

	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.

	showSuccessPage ( $type, $title, $msgname, $injected_html, $extraMessages)
	Show the success page.

Protected Member Functions inherited from AuthManagerSpecialPage
	addTabIndex (&$formDescriptor)
	Adds a sequential tabindex starting from 1 to all form elements.

	displayForm ( $status)
	Display the form.

	fieldInfoToFormDescriptor (array $requests, array $fieldInfo, $action)
	Turns a field info array into a form descriptor.

	getAuthForm (array $requests, $action)

	getAuthFormDescriptor ( $requests, $action)
	Generates a HTMLForm descriptor array from a set of authentication requests.

	getContinueAction ( $action)
	Gets the _CONTINUE version of an action.

	getRequestBlacklist ()
	Allows blacklisting certain request types.

	handleReauthBeforeExecute ( $subPage)
	Handle redirection when the user needs to (re)authenticate.

	handleReturnBeforeExecute ( $subPage)
	Handle redirection from the /return subpage.

	hasOwnSubmitButton (AuthenticationRequest $req)
	Checks whether the given AuthenticationRequest has its own submit button.

	isActionAllowed ( $action)
	Checks whether AuthManager is ready to perform the action.

	isContinued ()
	Returns true if this is not the first step of the authentication.

	loadAuth ( $subPage, $authAction=null, $reset=false)
	Load or initialize $authAction, $authRequests and $subPage.

	messageKey ( $defaultKey)
	Return custom message key.

	needsSubmitButton (array $requests)
	Returns true if the form built from the given AuthenticationRequests needs a submit button.

	performAuthenticationStep ( $action, array $requests)

	trySubmit ()
	Attempts to do an authentication step with the submitted data.

Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.

	getAuthManager ()

	getCacheTTL ()

	getHookContainer ()

	getHookRunner ()

	getLanguageConverter ()
	Shortcut to get language's converter.

	getRobotPolicy ()
	Return the robot policy.

	getSpecialPageFactory ()

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages.

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor.

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Static Protected Attributes
static	$allowedActions

static	$messages

Static Protected Attributes inherited from AuthManagerSpecialPage
static string[]	$allowedActions
	The list of actions this special page deals with.

static array	$messages = []
	Customized messages.

Additional Inherited Members
Static Public Member Functions inherited from SpecialPage
static	getSafeTitleFor ( $name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage.

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, consider using TitleValue through getTitleValueFor() below.

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.

static	newSearchPage (User $user)
	Get the users preferred search page.

Static Protected Member Functions inherited from AuthManagerSpecialPage
static	getField (array $array, $fieldName, $default=null)
	Get an array value, or a default if it does not exist.

static	mapFieldInfoTypeToFormDescriptorType ( $type)
	Maps AuthenticationRequest::getFieldInfo() types to HTMLForm types.

static	mapSingleFieldInfo ( $singleFieldInfo, $fieldName)
	Maps an authentication field configuration for a single field (as returned by AuthenticationRequest::getFieldInfo()) to a HTMLForm field descriptor.

static	mergeDefaultFormDescriptor (array $fieldInfo, array $formDescriptor, array $defaultFormDescriptor)
	Apply defaults to a form descriptor, without creating non-existent fields.

static	sortFormDescriptorFields (array &$formDescriptor)
	Sort the fields of a form descriptor by their 'weight' property.

Static Protected Member Functions inherited from SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Protected Attributes inherited from LoginSignupSpecialPage
HTMLForm null	$authForm

	$mAction

	$mEntryError = ''

	$mEntryErrorType = 'error'

	$mFromHTTP

	$mLanguage

	$mLoaded = false

	$mLoadedRequest = false

	$mPosted

	$mReturnTo

	$mReturnToQuery

	$mSecureLoginUrl

	$mStickHTTPS

	$mToken

bool	$proxyAccountCreation
	True if the user if creating an account for someone else.

string	$securityLevel

User	$targetUser
	FIXME another flag for passing data.

Protected Attributes inherited from AuthManagerSpecialPage
string	$authAction
	one of the AuthManager::ACTION_* constants.

AuthenticationRequest[]	$authRequests

bool	$isReturn
	True if the current request is a result of returning from a redirect flow.

WebRequest null	$savedRequest
	If set, will be used instead of the real request.

string	$subPage
	Subpage of the special page.

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Detailed Description

Implements Special:UserLogin.

Definition at line 33 of file SpecialUserLogin.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialUserLogin::__construct ( AuthManager $authManager )

Parameters

AuthManager $authManager

Definition at line 48 of file SpecialUserLogin.php.

References SpecialPage\setAuthManager().

Member Function Documentation

◆ beforeExecute()

SpecialUserLogin::beforeExecute ( $subPage )

protected

Stability: stable: to override

Parameters

string | null $subPage

Returns: bool|void

Reimplemented from LoginSignupSpecialPage.

Definition at line 81 of file SpecialUserLogin.php.

References AuthManagerSpecialPage\$subPage, $title, SpecialPage\getOutput(), AuthManagerSpecialPage\getRequest(), SpecialPage\getTitleFor(), and PROTO_CURRENT.

◆ clearToken()

SpecialUserLogin::clearToken ( )

protected

Definition at line 149 of file SpecialUserLogin.php.

References AuthManagerSpecialPage\getRequest().

Referenced by successfulAction().

◆ doesWrites()

SpecialUserLogin::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable: to override

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 53 of file SpecialUserLogin.php.

◆ getDefaultAction()

SpecialUserLogin::getDefaultAction ( $subPage )

protected

Get the default action for this special page, if none is given via URL/POST data.

Subclasses should override this (or override loadAuth() so this is never called).

Stability: stable: to override

Parameters

string $subPage Subpage of the special page.

Returns: string an AuthManager::ACTION_* constant.

Reimplemented from AuthManagerSpecialPage.

Definition at line 61 of file SpecialUserLogin.php.

◆ getDescription()

SpecialUserLogin::getDescription ( )

Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

Derived classes can override this, but usually it is easier to keep the default behavior.

Stability: stable: to override

Returns: string

Reimplemented from SpecialPage.

Definition at line 65 of file SpecialUserLogin.php.

References SpecialPage\msg().

◆ getGroupName()

SpecialUserLogin::getGroupName ( )

protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Stability: stable: to override

Returns: string

Since: 1.21

Reimplemented from LoginSignupSpecialPage.

Definition at line 157 of file SpecialUserLogin.php.

◆ getLoginSecurityLevel()

SpecialUserLogin::getLoginSecurityLevel ( )

protected

Stability: stable: to override

Returns: bool|string

Reimplemented from AuthManagerSpecialPage.

Definition at line 57 of file SpecialUserLogin.php.

◆ getToken()

SpecialUserLogin::getToken ( )

protected

Returns the CSRF token.

Stability: stable: to override

Returns: Token

Reimplemented from AuthManagerSpecialPage.

Definition at line 145 of file SpecialUserLogin.php.

References AuthManagerSpecialPage\getRequest().

◆ getTokenName()

SpecialUserLogin::getTokenName ( )

protected

Returns the name of the CSRF token (under which it should be found in the POST or GET data).

Stability: stable: to override

Returns: string

Reimplemented from LoginSignupSpecialPage.

Definition at line 153 of file SpecialUserLogin.php.

◆ isSignup()

SpecialUserLogin::isSignup ( )

protected

Reimplemented from LoginSignupSpecialPage.

Definition at line 77 of file SpecialUserLogin.php.

◆ logAuthResult()

SpecialUserLogin::logAuthResult	(		$success,
			$status = null )

protected

Logs to the authmanager-stats channel.

Parameters

bool	$success
string \| null	$status	Error message key

Reimplemented from LoginSignupSpecialPage.

Definition at line 161 of file SpecialUserLogin.php.

References $success.

◆ setHeaders()

SpecialUserLogin::setHeaders ( )

Sets headers - this should be called from the execute() method of all derived classes!

Stability: stable: to override

Reimplemented from SpecialPage.

Definition at line 69 of file SpecialUserLogin.php.

References SpecialPage\getOutput(), SpecialPage\getUser(), and SpecialPage\msg().

◆ successfulAction()

SpecialUserLogin::successfulAction	(		$direct = false,
			$extraMessages = null )

protected

Run any hooks registered for logins, then HTTP redirect to $this->mReturnTo (or Main Page if that's undefined).

Formerly we had a nice message here, but that's really not as useful as just being sent to wherever you logged in from. It should be clear that the action was successful, given the lack of error messages plus the appearance of your name in the upper right.

Parameters

bool	$direct	True if the action was successful just now; false if that happened pre-redirection (so this handler was called already)
StatusValue \| null	$extraMessages

Reimplemented from LoginSignupSpecialPage.

Definition at line 105 of file SpecialUserLogin.php.

References clearToken(), SpecialPage\getConfig(), SpecialPage\getContext(), SpecialPage\getHookRunner(), AuthManagerSpecialPage\getRequest(), SpecialPage\getUser(), LoginSignupSpecialPage\hasSessionCookie(), LoginSignupSpecialPage\mainLoginForm(), SpecialPage\msg(), and LoginSignupSpecialPage\showSuccessPage().

Member Data Documentation

◆ $allowedActions

SpecialUserLogin::$allowedActions

staticprotected

Initial value:

= [
        AuthManager::ACTION_LOGIN,
        AuthManager::ACTION_LOGIN_CONTINUE
    ]

Definition at line 34 of file SpecialUserLogin.php.

◆ $messages

SpecialUserLogin::$messages

staticprotected

Initial value:

= [
        'authform-newtoken' => 'nocookiesforlogin',
        'authform-notoken' => 'sessionfailure',
        'authform-wrongtoken' => 'sessionfailure',
    ]

Definition at line 39 of file SpecialUserLogin.php.

The documentation for this class was generated from the following file:

includes/specials/SpecialUserLogin.php

Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ beforeExecute()

◆ clearToken()

◆ doesWrites()

◆ getDefaultAction()

◆ getDescription()

◆ getGroupName()

◆ getLoginSecurityLevel()

◆ getToken()

◆ getTokenName()

◆ isSignup()

◆ logAuthResult()

◆ setHeaders()

◆ successfulAction()

Member Data Documentation

◆ $allowedActions

◆ $messages