Implements Special:UserLogin. More...

Inheritance diagram for LoginForm:

Collaboration diagram for LoginForm:

[legend]

Public Member Functions
	__construct ( $request=null)

	addNewAccount ()

	addNewAccountInternal ()
	Make a new user account using the loaded data. More...

	addNewAccountMailPassword ()

	attemptAutoCreate ( $user)
	Attempt to automatically create a user on login. More...

	authenticateUserData ()
	Internally authenticate the login request. More...

	cookieRedirectCheck ( $type)

	execute ( $subPage)
	Default execute method Checks user permissions, calls the function given in mFunction. More...

	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. More...

	hasSessionCookie ()
	Check if a session cookie is present. More...

	initUser ( $u, $autocreate)
	Actually add a user to the database. More...

	load ()
	Loader. More...

	mailPasswordInternal ( $u, $throttle=true, $emailTitle='passwordremindertitle', $emailText='passwordremindertext')

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

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

	onCookieRedirectCheck ( $type)

	processLogin ()

	showReturnToPage ( $type, $returnTo='', $returnToQuery='', $stickHTTPs=false)
	Add a "return to" link or redirect to it. More...

	userBlockedMessage (Block $block)
	Output a message that informs the user that they cannot create an account because there is a block on them or their IP which prevents account creation. More...

Public Member Functions inherited from SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='default', $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. More...

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError. More...

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError. More...

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

	getContext ()
	Gets the context this SpecialPage is executed in. More...

	getFile ()
	Get the file which will be included by SpecialPage::execute() if your extension is still stuck in the past and hasn't overridden the execute() method. More...

	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. More...

	getFullTitle ()
	Return the full title, including $par. More...

	getLang ()
	Shortcut to get user's language. More...

	getLanguage ()
	Shortcut to get user's language. More...

	getLocalName ()
	Get the localised name of the special page. More...

	getName ()
	Get the name of this Special Page. More...

	getOutput ()
	Get the OutputPage being used for this instance. More...

	getPageTitle ( $subpage=false)
	Get a self-referential title object. More...

	getRequest ()
	Get the WebRequest being used for this instance. More...

	getRestriction ()
	Get the permission that a user must have to execute this page. More...

	getSkin ()
	Shortcut to get the skin being used for this instance. More...

	getTitle ( $subpage=false)
	Get a self-referential title object. More...

	getUser ()
	Shortcut to get the User executing this instance. More...

	including ( $x=null)
	Whether the special page is being evaluated via transclusion. More...

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode. More...

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

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

	isListed ()
	Whether this special page is listed in Special:SpecialPages. More...

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes. More...

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages. More...

	msg ()
	Wrapper around wfMessage that sets the current context. More...

	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. More...

	requireLogin ( $reasonMsg=null, $titleMsg=null)
	If the user is not logged in, throws UserNotLoggedIn error. More...

	run ( $subPage)
	Entry point. More...

	setContext ( $context)
	Sets the context this SpecialPage is executed in. More...

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

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time. More...

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

Static Public Member Functions
static	clearCreateaccountToken ()
	Remove any createaccount token attached to the current session. More...

static	clearLoginThrottle ( $username)
	Clear the login attempt throttle hit count for the (username,current IP) tuple. More...

static	clearLoginToken ()
	Remove any login token attached to the current session. More...

static	getCreateaccountToken ()
	Get the createaccount token from the current session. More...

static	getLoginToken ()
	Get the login token from the current session. More...

static	incLoginThrottle ( $username)
	Increment the login attempt throttle hit count for the (username,current IP) tuple unless the throttle was already reached. More...

static	setCreateaccountToken ()
	Randomly generate a new createaccount token and attach it to the current session. More...

static	setLoginToken ()
	Randomly generate a new login token and attach it to the current session. More...

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. More...

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

Public Attributes
	$mAbortLoginErrorMsg = null

const	ABORTED = 8

const	CREATE_BLOCKED = 9

const	EMPTY_PASS = 6

const	ILLEGAL = 2

const	NEED_TOKEN = 12

const	NO_NAME = 1

const	NOT_EXISTS = 4

const	RESET_PASS = 7

const	SUCCESS = 0

const	THROTTLED = 10

const	USER_BLOCKED = 11

const	WRONG_PASS = 5

const	WRONG_PLUGIN_PASS = 3

const	WRONG_TOKEN = 13

Protected Member Functions
	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'. More...

	resetLoginForm (Message $msg)
	Show the Special:ChangePassword form, with custom message. More...

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

	afterExecute ( $subPage)
	Gets called after. More...

	beforeExecute ( $subPage)
	Gets called before. More...

	getRobotPolicy ()
	Return the robot policy. More...

Protected Attributes
	$mAction

	$mCookieCheck

	$mCreateaccount

	$mCreateaccountMail

	$mDomain

	$mEmail

	$mLanguage

	$mLoginattempt

	$mPassword

	$mPosted

	$mRealName

	$mReason

	$mRemember

	$mReturnTo

	$mReturnToQuery

	$mRetype

	$mSkipCookieCheck

	$mStickHTTPS

	$mToken

	$mType

	$mUsername

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

	$mIncludable

	$mIncluding

	$mName

Private Member Functions
	displaySuccessfulAction ( $title, $msgname, $injected_html)
	Display an "successful action" page. More...

	executeReturnTo ( $type)
	Add a "return to" link or redirect to it. More...

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

	renewSessionId ()
	Renew the user's session id, using strong entropy. More...

	showCreateOrLoginLink (&$user)
	Whether the login/create account form should display a link to the other form (in addition to whatever the skin provides). More...

	successfulCreation ()
	Run any hooks registered for logins, then display a message welcoming the user. More...

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

Private Attributes
	$mLoaded = false

WebRequest	$mOverrideRequest = null

WebRequest	$mRequest = null
	Effective request; set at the beginning of load *. More...

	$mSecureLoginUrl

	$mTempPasswordUsed

Detailed Description

Implements Special:UserLogin.

Definition at line 29 of file SpecialUserlogin.php.

Constructor & Destructor Documentation

◆ __construct()

LoginForm::__construct ( $request = null )

Parameters

WebRequest $request

Definition at line 80 of file SpecialUserlogin.php.

Member Function Documentation

◆ addNewAccount()

LoginForm::addNewAccount ( )

Access:\n private

Returns: bool

Definition at line 276 of file SpecialUserlogin.php.

References $error, $out, $wgContLang, $wgUser, addNewAccountInternal(), array(), cookieRedirectCheck(), SpecialPage\getContext(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getUser(), global, hasSessionCookie(), mainLoginForm(), SpecialPage\msg(), successfulCreation(), Sanitizer\validateEmail(), and wfRunHooks().

Referenced by execute().

◆ addNewAccountInternal()

LoginForm::addNewAccountInternal ( )

Make a new user account using the loaded data.

Exceptions

PermissionsError|ReadOnlyError

Returns: Status

Definition at line 358 of file SpecialUserlogin.php.

References $title, $value, $wgMemc, array(), clearCreateaccountToken(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\getUser(), global, initUser(), Title\makeTitleSafe(), Status\newFatal(), User\newFromName(), NS_USER, setCreateaccountToken(), userBlockedMessage(), Sanitizer\validateEmail(), wfDebug(), wfMemcKey(), wfReadOnly(), and wfRunHooks().

Referenced by addNewAccount(), and addNewAccountMailPassword().

◆ addNewAccountMailPassword()

LoginForm::addNewAccountMailPassword ( )

Access:\n private

Definition at line 236 of file SpecialUserlogin.php.

References $error, $out, addNewAccountInternal(), array(), executeReturnTo(), SpecialPage\getOutput(), mailPasswordInternal(), mainLoginForm(), SpecialPage\msg(), text, and wfRunHooks().

Referenced by execute().

◆ attemptAutoCreate()

LoginForm::attemptAutoCreate ( $user )

Attempt to automatically create a user on login.

Only succeeds if there is an external authentication method which allows it.

Parameters

$user User

Returns: integer Status code

Definition at line 767 of file SpecialUserlogin.php.

References $mPassword, $user, ABORTED, array(), CREATE_BLOCKED, SpecialPage\getUser(), global, initUser(), NOT_EXISTS, SUCCESS, wfDebug(), wfRunHooks(), and WRONG_PLUGIN_PASS.

Referenced by authenticateUserData().

◆ authenticateUserData()

LoginForm::authenticateUserData ( )

Internally authenticate the login request.

This may create a local account as a side effect if the authentication plugin allows transparent local account creation.

Returns: int

Definition at line 579 of file SpecialUserlogin.php.

References $retval, $wgUser, ABORTED, array(), attemptAutoCreate(), clearLoginThrottle(), SpecialPage\getContext(), SpecialPage\getName(), SpecialPage\getUser(), global, ILLEGAL, incLoginThrottle(), User\isUsableName(), load(), NEED_TOKEN, User\newFromName(), NO_NAME, RESET_PASS, setLoginToken(), SUCCESS, THROTTLED, USER_BLOCKED, wfDebug(), wfRunHooks(), WRONG_PASS, and WRONG_TOKEN.

Referenced by processLogin().

◆ clearCreateaccountToken()

static LoginForm::clearCreateaccountToken ( )

static

Remove any createaccount token attached to the current session.

Definition at line 1423 of file SpecialUserlogin.php.

References global.

Referenced by addNewAccountInternal().

◆ clearLoginThrottle()

static LoginForm::clearLoginThrottle ( $username )

static

Clear the login attempt throttle hit count for the (username,current IP) tuple.

Parameters

string $username The user name

Returns: void

Definition at line 751 of file SpecialUserlogin.php.

References $wgMemc, global, and wfMemcKey().

Referenced by SpecialChangeEmail\attemptChange(), SpecialChangePassword\attemptReset(), and authenticateUserData().

◆ clearLoginToken()

static LoginForm::clearLoginToken ( )

static

Remove any login token attached to the current session.

Definition at line 1397 of file SpecialUserlogin.php.

References global.

Referenced by processLogin().

◆ cookieRedirectCheck()

LoginForm::cookieRedirectCheck ( $type )

Access:\n private

Definition at line 1443 of file SpecialUserlogin.php.

References $mReturnTo, $mReturnToQuery, $query, $type, array(), SpecialPage\getOutput(), and SpecialPage\getTitleFor().

Referenced by addNewAccount(), and processLogin().

◆ displaySuccessfulAction()

LoginForm::displaySuccessfulAction	(	$title,
		$msgname,
		$injected_html
	)

private

Display an "successful action" page.

Parameters

string \| Message	$title	page's title
	$msgname	string
	$injected_html	string

Definition at line 1042 of file SpecialUserlogin.php.

References $out, $title, executeReturnTo(), SpecialPage\getName(), SpecialPage\getOutput(), SpecialPage\getUser(), and wfEscapeWikiText().

Referenced by successfulCreation(), and successfulLogin().

◆ execute()

LoginForm::execute ( $subPage )

Default execute method Checks user permissions, calls the function given in mFunction.

This must be overridden by subclasses; it will be made abstract in a future version

Parameters

string | null $subPage

Reimplemented from SpecialPage.

Definition at line 169 of file SpecialUserlogin.php.

References $query, $title, addNewAccount(), addNewAccountMailPassword(), array(), SpecialPage\getFullTitle(), SpecialPage\getOutput(), SpecialPage\getRequest(), global, load(), mainLoginForm(), onCookieRedirectCheck(), processLogin(), PROTO_HTTPS, SpecialPage\setHeaders(), wfAppendQuery(), wfCanIPUseHTTPS(), and wfSetupSession().

◆ executeReturnTo()

LoginForm::executeReturnTo ( $type )

private

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

Parameters

$type

string, one of the following:

error: display a return to link ignoring $wgRedirectOnLogin
success: display a return to link using $wgRedirectOnLogin if needed
successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed

Definition at line 1121 of file SpecialUserlogin.php.

References $mReturnTo, $options, $type, array(), SpecialPage\getOutput(), global, Title\newFromText(), Title\newMainPage(), PROTO_HTTP, PROTO_HTTPS, PROTO_RELATIVE, and wfCgiToArray().

Referenced by addNewAccountMailPassword(), displaySuccessfulAction(), showReturnToPage(), and successfulLogin().

◆ getCreateaccountToken()

static LoginForm::getCreateaccountToken ( )

static

Get the createaccount token from the current session.

Returns: Mixed

Definition at line 1406 of file SpecialUserlogin.php.

References global.

Referenced by ApiCreateAccount\execute(), ApiCreateAccountTest\testExistingUser(), ApiCreateAccountTest\testInvalidEmail(), ApiCreateAccountTest\testNoName(), and ApiCreateAccountTest\testNoPassword().

◆ getDescription()

LoginForm::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.

Returns: string

Reimplemented from SpecialPage.

Definition at line 158 of file SpecialUserlogin.php.

References SpecialPage\msg().

◆ getGroupName()

LoginForm::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'.

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 1533 of file SpecialUserlogin.php.

◆ getLoginToken()

static LoginForm::getLoginToken ( )

static

Get the login token from the current session.

Returns: Mixed

Definition at line 1378 of file SpecialUserlogin.php.

References global.

Referenced by SpecialChangePassword\getFormFields(), SpecialChangePassword\onSubmit(), and SpecialChangePassword\onSuccess().

◆ hasSessionCookie()

LoginForm::hasSessionCookie ( )

Check if a session cookie is present.

This will not pick up a cookie set during this request, but is meant to ensure that the client is returning the cookie which was set on a previous pass through the system.

Access:\n private

Returns: bool

Definition at line 1368 of file SpecialUserlogin.php.

References SpecialPage\getRequest(), global, and true.

Referenced by addNewAccount(), onCookieRedirectCheck(), and processLogin().

◆ incLoginThrottle()

static LoginForm::incLoginThrottle ( $username )

static

Increment the login attempt throttle hit count for the (username,current IP) tuple unless the throttle was already reached.

Parameters

string $username The user name

Returns: Bool|Integer The integer hit count or True if it is already at the limit

Definition at line 723 of file SpecialUserlogin.php.

References $count, $wgMemc, global, and wfMemcKey().

Referenced by SpecialChangeEmail\attemptChange(), SpecialChangePassword\attemptReset(), and authenticateUserData().

◆ initUser()

LoginForm::initUser	(	$u,
		$autocreate
	)

Actually add a user to the database.

Give it a User object that has been initialised with a name.

Parameters

$u	User object.
$autocreate	boolean – true if this is an autocreation via auth plugin

Returns: Status object, with the User object in the value member on success

Access:\n private

Definition at line 542 of file SpecialUserlogin.php.

References DeferredUpdates\addUpdate(), global, WatchedItem\IGNORE_USER_RIGHTS, and Status\newGood().

Referenced by addNewAccountInternal(), and attemptAutoCreate().

◆ load()

LoginForm::load ( )

Loader.

Definition at line 89 of file SpecialUserlogin.php.

References $mCreateaccountMail, $mOverrideRequest, SpecialPage\getRequest(), WebRequest\getText(), global, and Title\newFromText().

Referenced by authenticateUserData(), and execute().

◆ mailPasswordInternal()

LoginForm::mailPasswordInternal	(	$u,
		$throttle = `true`,
		$emailTitle = `'passwordremindertitle'`,
		$emailText = `'passwordremindertext'`
	)

Parameters

	$u	User object
	$throttle	Boolean
string	$emailTitle	message name of email title
string	$emailText	message name of email text

Returns: Status object

Definition at line 955 of file SpecialUserlogin.php.

References array(), SpecialPage\getRequest(), SpecialPage\getUser(), global, SpecialPage\msg(), Status\newFatal(), Title\newMainPage(), text, and wfRunHooks().

Referenced by addNewAccountMailPassword().

◆ mainLoginForm()

LoginForm::mainLoginForm	(	$msg,
		$msgtype = `'error'`
	)

private

Definition at line 1159 of file SpecialUserlogin.php.

References $mLanguage, $out, $user, array(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\getSkin(), SpecialPage\getUser(), global, makeLanguageSelector(), SpecialPage\msg(), setCreateaccountToken(), setLoginToken(), showCreateOrLoginLink(), userBlockedMessage(), wfReadOnly(), wfRunHooks(), and wfUrlencode().

Referenced by addNewAccount(), addNewAccountMailPassword(), execute(), onCookieRedirectCheck(), and processLogin().

◆ makeLanguageSelector()

LoginForm::makeLanguageSelector ( )

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

Returns: string

Definition at line 1479 of file SpecialUserlogin.php.

References array(), as, SpecialPage\getLanguage(), makeLanguageSelectorLink(), and SpecialPage\msg().

Referenced by mainLoginForm().

◆ makeLanguageSelectorLink()

LoginForm::makeLanguageSelectorLink	(	$text,
		$lang
	)

Create a language selector link for a particular language Links back to this page preserving type and returnto.

Parameters

string	$text	Link text
string	$lang	Language code

Returns: string

Definition at line 1507 of file SpecialUserlogin.php.

References $mReturnTo, $mReturnToQuery, $query, array(), Language\factory(), SpecialPage\getLanguage(), SpecialPage\getPageTitle(), and Linker\linkKnown().

Referenced by makeLanguageSelector().

◆ onCookieRedirectCheck()

LoginForm::onCookieRedirectCheck ( $type )

Access:\n private

Definition at line 1458 of file SpecialUserlogin.php.

References $type, hasSessionCookie(), mainLoginForm(), SpecialPage\msg(), successfulLogin(), and text.

Referenced by execute().

◆ processLogin()

LoginForm::processLogin ( )

Definition at line 814 of file SpecialUserlogin.php.

References $error, $user, $wgLang, $wgMemc, ABORTED, authenticateUserData(), clearLoginToken(), cookieRedirectCheck(), CREATE_BLOCKED, EMPTY_PASS, Language\factory(), SpecialPage\getContext(), SpecialPage\getLanguage(), SpecialPage\getRequest(), SpecialPage\getUser(), global, hasSessionCookie(), ILLEGAL, mainLoginForm(), SpecialPage\msg(), NEED_TOKEN, NO_NAME, NOT_EXISTS, renewSessionId(), RESET_PASS, resetLoginForm(), SUCCESS, successfulLogin(), text, THROTTLED, USER_BLOCKED, userBlockedMessage(), wfEscapeWikiText(), wfMemcKey(), WRONG_PASS, WRONG_PLUGIN_PASS, and WRONG_TOKEN.

Referenced by execute().

◆ renewSessionId()

LoginForm::renewSessionId ( )

private

Renew the user's session id, using strong entropy.

Definition at line 1431 of file SpecialUserlogin.php.

References global, and wfResetSessionID().

Referenced by processLogin().

◆ resetLoginForm()

LoginForm::resetLoginForm ( Message $msg )

protected

Show the Special:ChangePassword form, with custom message.

Parameters

Message $msg

Definition at line 934 of file SpecialUserlogin.php.

References array(), SpecialPage\getContext(), and wfRunHooks().

Referenced by processLogin().

◆ setCreateaccountToken()

static LoginForm::setCreateaccountToken ( )

static

Randomly generate a new createaccount token and attach it to the current session.

Definition at line 1415 of file SpecialUserlogin.php.

References MWCryptRand\generateHex(), and global.

Referenced by addNewAccountInternal(), mainLoginForm(), and ApiCreateAccountTest\setUp().

◆ setLoginToken()

static LoginForm::setLoginToken ( )

static

Randomly generate a new login token and attach it to the current session.

Definition at line 1387 of file SpecialUserlogin.php.

References MWCryptRand\generateHex(), and global.

Referenced by authenticateUserData(), SpecialChangePassword\getFormFields(), mainLoginForm(), and SpecialChangePassword\onSuccess().

◆ showCreateOrLoginLink()

LoginForm::showCreateOrLoginLink ( & $user )

private

Whether the login/create account form should display a link to the other form (in addition to whatever the skin provides).

Parameters

$user User

Returns: bool

Definition at line 1348 of file SpecialUserlogin.php.

References $user.

Referenced by mainLoginForm().

◆ showReturnToPage()

LoginForm::showReturnToPage	(	$type,
		$returnTo = `''`,
		$returnToQuery = `''`,
		$stickHTTPs = `false`
	)

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

Extensions can use this to reuse the "return to" logic after inject steps (such as redirection) into the login process.

Parameters

	$type	string, one of the following: error: display a return to link ignoring $wgRedirectOnLogin success: display a return to link using $wgRedirectOnLogin if needed successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
string	$returnTo
array \| string	$returnToQuery
bool	$stickHTTPs	Keep redirect link on HTTPs

Since: 1.22

Definition at line 1104 of file SpecialUserlogin.php.

References $type, and executeReturnTo().

◆ successfulCreation()

LoginForm::successfulCreation ( )

private

Run any hooks registered for logins, then display a message welcoming the user.

Definition at line 1016 of file SpecialUserlogin.php.

References array(), displaySuccessfulAction(), SpecialPage\getName(), SpecialPage\getUser(), SpecialPage\msg(), and wfRunHooks().

Referenced by addNewAccount().

◆ successfulLogin()

LoginForm::successfulLogin ( )

private

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.

Definition at line 996 of file SpecialUserlogin.php.

References array(), displaySuccessfulAction(), executeReturnTo(), SpecialPage\getUser(), SpecialPage\msg(), and wfRunHooks().

Referenced by onCookieRedirectCheck(), and processLogin().

◆ userBlockedMessage()

LoginForm::userBlockedMessage ( Block $block )

Output a message that informs the user that they cannot create an account because there is a block on them or their IP which prevents account creation.

Note that User::isBlockedFromCreateAccount(), which gets this block, ignores the 'hardblock' setting on blocks (bug 13611).

Parameters

$block Block the block causing this error

Exceptions

ErrorPageError

Definition at line 1062 of file SpecialUserlogin.php.

References array(), Block\getByName(), SpecialPage\getRequest(), Block\getTarget(), Block\getType(), SpecialPage\msg(), and Block\TYPE_RANGE.

Referenced by addNewAccountInternal(), mainLoginForm(), and processLogin().

Member Data Documentation

◆ $mAbortLoginErrorMsg

LoginForm::$mAbortLoginErrorMsg = null

Definition at line 45 of file SpecialUserlogin.php.

◆ $mAction

LoginForm::$mAction

protected

Definition at line 53 of file SpecialUserlogin.php.

◆ $mCookieCheck

LoginForm::$mCookieCheck

protected

Definition at line 51 of file SpecialUserlogin.php.

◆ $mCreateaccount

LoginForm::$mCreateaccount

protected

Definition at line 54 of file SpecialUserlogin.php.

◆ $mCreateaccountMail

LoginForm::$mCreateaccountMail

protected

Definition at line 55 of file SpecialUserlogin.php.

Referenced by load().

◆ $mDomain

LoginForm::$mDomain

protected

Definition at line 59 of file SpecialUserlogin.php.

◆ $mEmail

LoginForm::$mEmail

protected

Definition at line 58 of file SpecialUserlogin.php.

◆ $mLanguage

LoginForm::$mLanguage

protected

Definition at line 60 of file SpecialUserlogin.php.

Referenced by mainLoginForm().

◆ $mLoaded

LoginForm::$mLoaded = false

private

Definition at line 70 of file SpecialUserlogin.php.

◆ $mLoginattempt

LoginForm::$mLoginattempt

protected

Definition at line 56 of file SpecialUserlogin.php.

◆ $mOverrideRequest

WebRequest LoginForm::$mOverrideRequest = null

private

Definition at line 73 of file SpecialUserlogin.php.

Referenced by load().

◆ $mPassword

LoginForm::$mPassword

protected

Definition at line 48 of file SpecialUserlogin.php.

Referenced by attemptAutoCreate().

◆ $mPosted

LoginForm::$mPosted

protected

Definition at line 52 of file SpecialUserlogin.php.

◆ $mRealName

LoginForm::$mRealName

protected

Definition at line 67 of file SpecialUserlogin.php.

◆ $mReason

LoginForm::$mReason

protected

Definition at line 66 of file SpecialUserlogin.php.

◆ $mRemember

LoginForm::$mRemember

protected

Definition at line 57 of file SpecialUserlogin.php.

◆ $mRequest

WebRequest LoginForm::$mRequest = null

private

Effective request; set at the beginning of load *.

Definition at line 75 of file SpecialUserlogin.php.

◆ $mReturnTo

LoginForm::$mReturnTo

protected

Definition at line 50 of file SpecialUserlogin.php.

Referenced by cookieRedirectCheck(), executeReturnTo(), and makeLanguageSelectorLink().

◆ $mReturnToQuery

LoginForm::$mReturnToQuery

protected

Definition at line 62 of file SpecialUserlogin.php.

Referenced by cookieRedirectCheck(), and makeLanguageSelectorLink().

◆ $mRetype

LoginForm::$mRetype

protected

Definition at line 49 of file SpecialUserlogin.php.

◆ $mSecureLoginUrl

LoginForm::$mSecureLoginUrl

private

Definition at line 71 of file SpecialUserlogin.php.

◆ $mSkipCookieCheck

LoginForm::$mSkipCookieCheck

protected

Definition at line 61 of file SpecialUserlogin.php.

◆ $mStickHTTPS

LoginForm::$mStickHTTPS

protected

Definition at line 64 of file SpecialUserlogin.php.

◆ $mTempPasswordUsed

LoginForm::$mTempPasswordUsed

private

Definition at line 69 of file SpecialUserlogin.php.

◆ $mToken

LoginForm::$mToken

protected

Definition at line 63 of file SpecialUserlogin.php.

◆ $mType

LoginForm::$mType

protected

Definition at line 65 of file SpecialUserlogin.php.

◆ $mUsername

LoginForm::$mUsername

protected

Definition at line 47 of file SpecialUserlogin.php.

◆ ABORTED

const LoginForm::ABORTED = 8

Definition at line 38 of file SpecialUserlogin.php.

Referenced by attemptAutoCreate(), authenticateUserData(), ApiLogin\execute(), and processLogin().

◆ CREATE_BLOCKED

const LoginForm::CREATE_BLOCKED = 9

Definition at line 39 of file SpecialUserlogin.php.

Referenced by attemptAutoCreate(), ApiLogin\execute(), and processLogin().

◆ EMPTY_PASS

const LoginForm::EMPTY_PASS = 6

Definition at line 36 of file SpecialUserlogin.php.

Referenced by ApiLogin\execute(), and processLogin().

◆ ILLEGAL

const LoginForm::ILLEGAL = 2

Definition at line 32 of file SpecialUserlogin.php.

Referenced by authenticateUserData(), ApiLogin\execute(), and processLogin().

◆ NEED_TOKEN

const LoginForm::NEED_TOKEN = 12

Definition at line 42 of file SpecialUserlogin.php.

Referenced by authenticateUserData(), ApiLogin\execute(), and processLogin().

◆ NO_NAME

const LoginForm::NO_NAME = 1

Definition at line 31 of file SpecialUserlogin.php.

Referenced by authenticateUserData(), ApiLogin\execute(), and processLogin().

◆ NOT_EXISTS

const LoginForm::NOT_EXISTS = 4

Definition at line 34 of file SpecialUserlogin.php.

Referenced by attemptAutoCreate(), ApiLogin\execute(), and processLogin().

◆ RESET_PASS

const LoginForm::RESET_PASS = 7

Definition at line 37 of file SpecialUserlogin.php.

Referenced by authenticateUserData(), ApiLogin\execute(), and processLogin().

◆ SUCCESS

const LoginForm::SUCCESS = 0

Definition at line 30 of file SpecialUserlogin.php.

Referenced by attemptAutoCreate(), authenticateUserData(), ApiLogin\execute(), and processLogin().

◆ THROTTLED

const LoginForm::THROTTLED = 10

Definition at line 40 of file SpecialUserlogin.php.

Referenced by authenticateUserData(), ApiLogin\execute(), and processLogin().

◆ USER_BLOCKED

const LoginForm::USER_BLOCKED = 11

Definition at line 41 of file SpecialUserlogin.php.

Referenced by authenticateUserData(), ApiLogin\execute(), and processLogin().

◆ WRONG_PASS

const LoginForm::WRONG_PASS = 5

Definition at line 35 of file SpecialUserlogin.php.

Referenced by ApiLogin\execute(), and processLogin().

◆ WRONG_PLUGIN_PASS

const LoginForm::WRONG_PLUGIN_PASS = 3

Definition at line 33 of file SpecialUserlogin.php.

Referenced by attemptAutoCreate(), ApiLogin\execute(), and processLogin().

◆ WRONG_TOKEN

const LoginForm::WRONG_TOKEN = 13

Definition at line 43 of file SpecialUserlogin.php.

Referenced by authenticateUserData(), ApiLogin\execute(), and processLogin().

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

includes/specials/SpecialUserlogin.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addNewAccount()

◆ addNewAccountInternal()

◆ addNewAccountMailPassword()

◆ attemptAutoCreate()

◆ authenticateUserData()

◆ clearCreateaccountToken()

◆ clearLoginThrottle()

◆ clearLoginToken()

◆ cookieRedirectCheck()

◆ displaySuccessfulAction()

◆ execute()

◆ executeReturnTo()

◆ getCreateaccountToken()

◆ getDescription()

◆ getGroupName()

◆ getLoginToken()

◆ hasSessionCookie()

◆ incLoginThrottle()

◆ initUser()

◆ load()

◆ mailPasswordInternal()

◆ mainLoginForm()

◆ makeLanguageSelector()

◆ makeLanguageSelectorLink()

◆ onCookieRedirectCheck()

◆ processLogin()

◆ renewSessionId()

◆ resetLoginForm()

◆ setCreateaccountToken()

◆ setLoginToken()

◆ showCreateOrLoginLink()

◆ showReturnToPage()

◆ successfulCreation()

◆ successfulLogin()

◆ userBlockedMessage()

Member Data Documentation

◆ $mAbortLoginErrorMsg

◆ $mAction

◆ $mCookieCheck

◆ $mCreateaccount

◆ $mCreateaccountMail

◆ $mDomain

◆ $mEmail

◆ $mLanguage

◆ $mLoaded

◆ $mLoginattempt

◆ $mOverrideRequest

◆ $mPassword

◆ $mPosted

◆ $mRealName

◆ $mReason

◆ $mRemember

◆ $mRequest

◆ $mReturnTo

◆ $mReturnToQuery

◆ $mRetype

◆ $mSecureLoginUrl

◆ $mSkipCookieCheck

◆ $mStickHTTPS

◆ $mTempPasswordUsed

◆ $mToken

◆ $mType

◆ $mUsername

◆ ABORTED

◆ CREATE_BLOCKED

◆ EMPTY_PASS

◆ ILLEGAL

◆ NEED_TOKEN

◆ NO_NAME