Implements Special:UserLogin. More...

Inheritance diagram for LoginForm:

Collaboration diagram for LoginForm:

Public Member Functions
	__construct ($request=null)
	addNewAccount ()
	addNewAccountInternal ()
	Make a new user account using the loaded data.
	addNewAccountMailPassword ()
	attemptAutoCreate ($user)
	Attempt to automatically create a user on login.
	authenticateUserData ()
	Internally authenticate the login request.
	cookieRedirectCheck ($type)
	execute ($subPage)
	Default execute method Checks user permissions, calls the function given in mFunction.
	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.
	hasSessionCookie ()
	Check if a session cookie is present.
	load ()
	Loader.
	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".
	makeLanguageSelectorLink ($text, $lang)
	Create a language selector link for a particular language Links back to this page preserving type and returnto.
	onCookieRedirectCheck ($type)
	processLogin ()
	resetLoginForm ($error)
	showReturnToPage ($type, $returnTo= '', $returnToQuery= '', $stickHTTPs=false)
	Add a "return to" link or redirect to it.
	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.
Static Public Member Functions
static	clearCreateaccountToken ()
	Remove any createaccount token attached to the current session.
static	clearLoginThrottle ($username)
	Clear the login attempt throttle hit count for the (username,current IP) tuple.
static	clearLoginToken ()
	Remove any login token attached to the current session.
static	getCreateaccountToken ()
	Get the createaccount token from the current session.
static	getLoginToken ()
	Get the login token from the current session.
static	incLoginThrottle ($username)
	Increment the login attempt throttle hit count for the (username,current IP) tuple unless the throttle was already reached.
static	setCreateaccountToken ()
	Randomly generate a new createaccount token and attach it to the current session.
static	setLoginToken ()
	Randomly generate a new login token and attach it to the current session.
Public Attributes
	$mAbortLoginErrorMsg = null
	$mAction
	$mCookieCheck
	$mCreateaccount
	$mCreateaccountMail
	$mDomain
	$mEmail
	$mLanguage
	$mLoginattempt
	$mPassword
	$mPosted
	$mRealName
	$mReason
	$mRemember
	$mReturnTo
	$mReturnToQuery
	$mRetype
	$mSkipCookieCheck
	$mStickHTTPS
	$mToken
	$mType
	$mUsername
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'.
Private Member Functions
	displaySuccessfulAction ($title, $msgname, $injected_html)
	Display an "successful action" page.
	executeReturnTo ($type)
	Add a "return to" link or redirect to it.
	initUser ($u, $autocreate)
	Actually add a user to the database.
	mainLoginForm ($msg, $msgtype= 'error')
	renewSessionId ()
	Renew the user's session id, using strong entropy.
	showCreateOrLoginLink (&$user)
	Whether the login/create account form should display a link to the other form (in addition to whatever the skin provides).
	successfulCreation ()
	Run any hooks registered for logins, then display a message welcoming the user.
	successfulLogin ()
	Run any hooks registered for logins, then HTTP redirect to $this->mReturnTo (or Main Page if that's undefined).
Private Attributes
	$mLoaded = false
	$mOverrideRequest = null
	@ var WebRequest
WebRequest	$mRequest = null
	Effective request; set at the beginning of load.
	$mSecureLoginUrl

Detailed Description

Implements Special:UserLogin.

Definition at line 29 of file SpecialUserlogin.php.

Constructor & Destructor Documentation

LoginForm::__construct ( $ request = null )

Parameters:

WebRequest $request

Definition at line 69 of file SpecialUserlogin.php.

Member Function Documentation

LoginForm::addNewAccount ( )

Access:: private

Returns:: bool

Definition at line 253 of file SpecialUserlogin.php.

Referenced by execute().

LoginForm::addNewAccountInternal ( )

Make a new user account using the loaded data.

Exceptions:

PermissionsError|ReadOnlyError

Returns:: Status

Definition at line 333 of file SpecialUserlogin.php.

LoginForm::addNewAccountMailPassword ( )

Access:: private

Definition at line 215 of file SpecialUserlogin.php.

Referenced by execute().

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 701 of file SpecialUserlogin.php.

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 523 of file SpecialUserlogin.php.

Referenced by processLogin().

static LoginForm::clearCreateaccountToken ( ) [static]

Remove any createaccount token attached to the current session.

Definition at line 1303 of file SpecialUserlogin.php.

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 685 of file SpecialUserlogin.php.

Referenced by SpecialChangePassword\attemptReset().

static LoginForm::clearLoginToken ( ) [static]

Remove any login token attached to the current session.

Definition at line 1278 of file SpecialUserlogin.php.

Referenced by processLogin().

LoginForm::cookieRedirectCheck ( $ type )

Access:: private

Definition at line 1323 of file SpecialUserlogin.php.

Referenced by processLogin().

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 947 of file SpecialUserlogin.php.

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:

$subPage string|null

Reimplemented from SpecialPage.

Definition at line 154 of file SpecialUserlogin.php.

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

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 1017 of file SpecialUserlogin.php.

static LoginForm::getCreateaccountToken ( ) [static]

Get the createaccount token from the current session.

Returns:: Mixed

Definition at line 1287 of file SpecialUserlogin.php.

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

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. Messages can be added at run-time, see MessageCache.php.

Returns:: String

Reimplemented from SpecialPage.

Definition at line 143 of file SpecialUserlogin.php.

References SpecialPage\msg().

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 1412 of file SpecialUserlogin.php.

static LoginForm::getLoginToken ( ) [static]

Get the login token from the current session.

Returns:: Mixed

Definition at line 1260 of file SpecialUserlogin.php.

Referenced by SpecialChangePassword\execute(), and SpecialChangePassword\showForm().

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:: private

Returns:: bool

Definition at line 1251 of file SpecialUserlogin.php.

Referenced by processLogin().

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 657 of file SpecialUserlogin.php.

Referenced by SpecialChangePassword\attemptReset().

LoginForm::initUser	(	$	u,
		$	autocreate
	)		`[private]`

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

Definition at line 488 of file SpecialUserlogin.php.

LoginForm::load ( )

Loader.

Definition at line 78 of file SpecialUserlogin.php.

Referenced by execute().

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 866 of file SpecialUserlogin.php.

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

Definition at line 1055 of file SpecialUserlogin.php.

Referenced by execute(), and processLogin().

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 1359 of file SpecialUserlogin.php.

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 1386 of file SpecialUserlogin.php.

LoginForm::onCookieRedirectCheck ( $ type )

Access:: private

Definition at line 1338 of file SpecialUserlogin.php.

Referenced by execute().

LoginForm::processLogin ( )

Definition at line 740 of file SpecialUserlogin.php.

References $error, $key, $user, $wgLang, $wgMemc, authenticateUserData(), clearLoginToken(), cookieRedirectCheck(), Language\factory(), SpecialPage\getContext(), SpecialPage\getLanguage(), SpecialPage\getRequest(), SpecialPage\getUser(), global, hasSessionCookie(), mainLoginForm(), SpecialPage\msg(), params, renewSessionId(), resetLoginForm(), successfulLogin(), text, userBlockedMessage(), wfEscapeWikiText(), wfMemcKey(), and WRONG_PASS.

Referenced by execute().

LoginForm::renewSessionId ( ) [private]

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

Definition at line 1311 of file SpecialUserlogin.php.

Referenced by processLogin().

LoginForm::resetLoginForm ( $ error )

Parameters:

$error string

Definition at line 852 of file SpecialUserlogin.php.

Referenced by processLogin().

static LoginForm::setCreateaccountToken ( ) [static]

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

Definition at line 1295 of file SpecialUserlogin.php.

Referenced by ApiCreateAccountTest\setUp().

static LoginForm::setLoginToken ( ) [static]

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

Definition at line 1268 of file SpecialUserlogin.php.

Referenced by SpecialChangePassword\execute().

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 1231 of file SpecialUserlogin.php.

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 1000 of file SpecialUserlogin.php.

LoginForm::successfulCreation ( ) [private]

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

Definition at line 921 of file SpecialUserlogin.php.

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 901 of file SpecialUserlogin.php.

Referenced by processLogin().

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 967 of file SpecialUserlogin.php.

Referenced by processLogin().