Implements Special:UserLogin. More...

Inheritance diagram for LoginFormPreAuthManager:

Collaboration diagram for LoginFormPreAuthManager:

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)

	doesWrites ()

	execute ($subPage)

	getDescription ()

	hasSessionCookie ()
	Check if a session cookie is present. 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= '', $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...

	addHelpLink ($to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators. 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...

	doesWrites ()
	Indicates whether this special page may perform database writes. More...

	execute ($subPage)
	Default execute method Checks user permissions. More...

	getConfig ()
	Shortcut to get main config object. More...

	getContext ()
	Gets the context this SpecialPage is executed in. 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...

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

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

	maxIncludeCacheTime ()
	How long to cache page when it is being included. 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...

	prefixSearchSubpages ($search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept. More...

	requireLogin ($reasonMsg= 'exception-nologin-text', $titleMsg= 'exception-nologin')
	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...

	setLinkRenderer (LinkRenderer $linkRenderer)

	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	getValidErrorMessages ()
	Returns an array of all valid error messages. 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	incrementLoginThrottle ($username)
	Increment the login attempt throttle hit count for the (username,current IP) tuple unless the throttle was already reached. More...

static	setCreateaccountToken ()
	Formerly randomly generated a createaccount token that would be returned by $this->getCreateaccountToken(). More...

static	setLoginToken ()
	Formerly randomly generated a login token that would be returned by $this->getLoginToken(). 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

int	$mThrottleWait = '?'
	How many seconds user is throttled for. More...

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	USER_MIGRATED = 14

const	WRONG_PASS = 5

const	WRONG_PLUGIN_PASS = 3

const	WRONG_TOKEN = 13

Static Public Attributes
static	$statusCodes

static string[]	$validErrorMessages
	Valid error and warning messages. More...

Protected Member Functions
	getGroupName ()

	getSubpagesForPrefixSearch ()

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

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

	getCacheTTL ()

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

	getLinkRenderer ()

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...

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

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

	prefixSearchString ($search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages. More...

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

Protected Attributes
	$mAction

	$mCookieCheck

	$mCreateaccount

	$mCreateaccountMail

	$mDomain

	$mEmail

	$mEntryError = ''

	$mEntryErrorType = 'error'

	$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

	$mRestriction

Private Member Functions
	checkUserPasswordExpired (User $user)
	Private function to check password expiration, until AuthManager comes along to handle that. More...

	displaySuccessfulAction ($type, $title, $msgname, $injected_html)
	Display a "successful action" page. More...

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

	initUser ($u, $autocreate)
	Actually add a user to the database. 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

Additional Inherited Members
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). More...

Detailed Description

Implements Special:UserLogin.

Definition at line 32 of file SpecialUserlogin.php.

Constructor & Destructor Documentation

LoginFormPreAuthManager::__construct ( $request = null )

Parameters

WebRequest $request

Definition at line 133 of file SpecialUserlogin.php.

References $request, $wgUseMediaWikiUIEverywhere, and global.

Member Function Documentation

LoginFormPreAuthManager::addNewAccount ( )

Access:: private

Returns: bool

Definition at line 423 of file SpecialUserlogin.php.

References $out, $status, $wgContLang, $wgEmailAuthentication, $wgLoginLanguageSelector, $wgUser, addNewAccountInternal(), cookieRedirectCheck(), SpecialPage\getContext(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getUser(), global, hasSessionCookie(), mainLoginForm(), SpecialPage\msg(), Hooks\run(), successfulCreation(), and Sanitizer\validateEmail().

Referenced by execute().

LoginFormPreAuthManager::addNewAccountInternal ( )

Make a new user account using the loaded data.

Exceptions

PermissionsError|ReadOnlyError

Returns: Status

Definition at line 510 of file SpecialUserlogin.php.

References $cache, $value, $wgAccountCreationThrottle, $wgAuth, $wgEmailConfirmToEdit, ObjectCache\getLocalClusterInstance(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\getUser(), global, initUser(), Status\newFatal(), User\newFromName(), IDBAccessObject\READ_LOCKING, Hooks\run(), userBlockedMessage(), Sanitizer\validateEmail(), wfDebug(), wfGlobalCacheKey(), and wfReadOnly().

Referenced by addNewAccount(), and addNewAccountMailPassword().

LoginFormPreAuthManager::addNewAccountMailPassword ( )

Access:: private

Definition at line 378 of file SpecialUserlogin.php.

References $out, $status, addNewAccountInternal(), executeReturnTo(), SpecialPage\getOutput(), mailPasswordInternal(), mainLoginForm(), SpecialPage\msg(), Hooks\run(), and text.

Referenced by execute().

LoginFormPreAuthManager::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: int Status code

Definition at line 1014 of file SpecialUserlogin.php.

References $mPassword, $status, $user, $wgAuth, SpecialPage\getUser(), global, initUser(), Hooks\run(), and wfDebug().

Referenced by authenticateUserData().

LoginFormPreAuthManager::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 730 of file SpecialUserlogin.php.

References $mUsername, $retval, $status, $wgAuth, $wgBlockDisablesLogin, $wgUser, attemptAutoCreate(), checkUserPasswordExpired(), SpecialPage\getContext(), SpecialPage\getUser(), global, User\isUsableName(), load(), User\newFromName(), Hooks\run(), wfDebug(), wfReadOnly(), wfWarn(), and WRONG_PASS.

Referenced by processLogin().

LoginFormPreAuthManager::checkUserPasswordExpired ( User $user )

private

Private function to check password expiration, until AuthManager comes along to handle that.

Parameters

User $user

Returns: string|bool

Definition at line 1830 of file SpecialUserlogin.php.

References $dbr, $wgPasswordExpireGrace, DB_SLAVE, User\getId(), global, TS_UNIX, wfGetDB(), and wfTimestamp().

Referenced by authenticateUserData(), and processLogin().

static LoginFormPreAuthManager::clearCreateaccountToken ( )

static

Remove any createaccount token attached to the current session.

Definition at line 1708 of file SpecialUserlogin.php.

References $wgRequest, and global.

static LoginFormPreAuthManager::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 981 of file SpecialUserlogin.php.

References $username, $wgPasswordAttemptThrottle, $wgRequest, as, User\getCanonicalName(), ObjectCache\getLocalClusterInstance(), global, and wfGlobalCacheKey().

static LoginFormPreAuthManager::clearLoginToken ( )

static

Remove any login token attached to the current session.

Definition at line 1677 of file SpecialUserlogin.php.

References $wgRequest, and global.

LoginFormPreAuthManager::cookieRedirectCheck ( $type )

Parameters

string $type

Access:: private

Definition at line 1730 of file SpecialUserlogin.php.

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

Referenced by addNewAccount(), and processLogin().

LoginFormPreAuthManager::displaySuccessfulAction	(	$type,
		$title,
		$msgname,
		$injected_html
	)

private

Display a "successful action" page.

Parameters

string	$type	Condition of return to; see `executeReturnTo`
string \| Message	$title	Page's title
string	$msgname
string	$injected_html

Definition at line 1313 of file SpecialUserlogin.php.

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

Referenced by successfulCreation(), and successfulLogin().

LoginFormPreAuthManager::doesWrites ( )

Definition at line 142 of file SpecialUserlogin.php.

LoginFormPreAuthManager::execute ( $subPage )

Parameters

string | null $subPage

Definition at line 276 of file SpecialUserlogin.php.

References $query, $title, $wgSecureLogin, addNewAccount(), addNewAccountMailPassword(), SpecialPage\getFullTitle(), SpecialPage\getLanguage(), RequestContext\getMain(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getUser(), global, load(), mainLoginForm(), onCookieRedirectCheck(), processLogin(), PROTO_HTTPS, SpecialPage\setHeaders(), successfulLogin(), wfAppendQuery(), and wfCanIPUseHTTPS().

LoginFormPreAuthManager::executeReturnTo ( $type )

private

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

Parameters

string

$type

One of the following:

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

Definition at line 1394 of file SpecialUserlogin.php.

References $mReturnTo, $options, $returnTo, $returnToQuery, $type, $wgRedirectOnLogin, $wgSecureLogin, SpecialPage\getOutput(), global, Title\newFromText(), Title\newMainPage(), PROTO_HTTP, PROTO_HTTPS, PROTO_RELATIVE, Hooks\run(), and wfCgiToArray().

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

static LoginFormPreAuthManager::getCreateaccountToken ( )

static

Get the createaccount token from the current session.

Since: 1.27 returns a MediaWiki\Session\Token instead of a string

Returns: MediaWiki\Session\Token

Definition at line 1687 of file SpecialUserlogin.php.

References $wgRequest, and global.

LoginFormPreAuthManager::getDescription ( )

Definition at line 265 of file SpecialUserlogin.php.

References SpecialPage\msg().

LoginFormPreAuthManager::getGroupName ( )

protected

Definition at line 1820 of file SpecialUserlogin.php.

static LoginFormPreAuthManager::getLoginToken ( )

static

Get the login token from the current session.

Since: 1.27 returns a MediaWiki\Session\Token instead of a string

Returns: MediaWiki\Session\Token

Definition at line 1656 of file SpecialUserlogin.php.

References $wgRequest, and global.

LoginFormPreAuthManager::getSubpagesForPrefixSearch ( )

protected

Definition at line 1844 of file SpecialUserlogin.php.

static LoginFormPreAuthManager::getValidErrorMessages ( )

static

Returns an array of all valid error messages.

Returns: array

Definition at line 151 of file SpecialUserlogin.php.

References $messages, and Hooks\run().

LoginFormPreAuthManager::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 1642 of file SpecialUserlogin.php.

References $wgDisableCookieCheck, $wgInitialSessionId, SpecialPage\getRequest(), global, and string.

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

static LoginFormPreAuthManager::incLoginThrottle ( $username )

static

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

Deprecated:

Use LoginForm::incrementLoginThrottle instead

Parameters

string $username The user name

Returns: bool|int true if above throttle, or 0 (prior to 1.27, returned current count)

Definition at line 970 of file SpecialUserlogin.php.

References $res, $username, and wfDeprecated().

static LoginFormPreAuthManager::incrementLoginThrottle ( $username )

static

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

Since: 1.27 Return value changed.

Parameters

string $username The user name

Returns: bool|array false if below limit or an array if above limit Array contains keys wait, count, and throttleIndex

Definition at line 895 of file SpecialUserlogin.php.

References $cache, $count, $username, $wgPasswordAttemptThrottle, $wgRequest, as, User\getCanonicalName(), ObjectCache\getLocalClusterInstance(), global, and wfGlobalCacheKey().

LoginFormPreAuthManager::initUser	(	$u,
		$autocreate
	)

private

Actually add a user to the database.

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

Parameters

User	$u
bool	$autocreate	True if this is an autocreation via auth plugin

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

Definition at line 688 of file SpecialUserlogin.php.

References $status, $wgAuth, DeferredUpdates\addUpdate(), global, User\IGNORE_USER_RIGHTS, Status\newGood(), Hooks\run(), and wfWarn().

Referenced by addNewAccountInternal(), and attemptAutoCreate().

LoginFormPreAuthManager::load ( )

Loader.

Definition at line 164 of file SpecialUserlogin.php.

References $mCreateaccountMail, $mOverrideRequest, $request, $wgAuth, $wgEnableEmail, $wgHiddenPrefs, SpecialPage\getPageTitle(), SpecialPage\getRequest(), global, Linker\linkKnown(), SpecialPage\msg(), and Title\newFromText().

Referenced by authenticateUserData(), and execute().

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

Parameters

User	$u
bool	$throttle
string	$emailTitle	Message name of email title
string	$emailText	Message name of email text

Returns: Status

Definition at line 1220 of file SpecialUserlogin.php.

References $wgMinimalPasswordLength, $wgNewPasswordExpiry, PasswordFactory\generateRandomPasswordString(), SpecialPage\getRequest(), SpecialPage\getUser(), global, SpecialPage\msg(), Status\newFatal(), Title\newMainPage(), Hooks\run(), and text.

Referenced by addNewAccountMailPassword().

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

private

Parameters

string	$msg
string	$msgtype

Exceptions

ErrorPageError
Exception
FatalError
MWException
PermissionsError
ReadOnlyError

Definition at line 1443 of file SpecialUserlogin.php.

References $mLanguage, $out, $template, $user, $wgAuth, $wgCookieExpiration, $wgEmailConfirmToEdit, $wgEnableEmail, $wgEnableUserEmail, $wgExtendedLoginCookieExpiration, $wgHiddenPrefs, $wgLoginLanguageSelector, $wgPasswordResetRoutes, $wgSecureLogin, SpecialPage\getConfig(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\getSkin(), SpecialPage\getUser(), global, makeLanguageSelector(), SpecialPage\msg(), Hooks\run(), showCreateOrLoginLink(), userBlockedMessage(), wfReadOnly(), and wfUrlencode().

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

LoginFormPreAuthManager::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 1767 of file SpecialUserlogin.php.

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

Referenced by mainLoginForm().

LoginFormPreAuthManager::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 1794 of file SpecialUserlogin.php.

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

Referenced by makeLanguageSelector().

LoginFormPreAuthManager::onCookieRedirectCheck ( $type )

Parameters

string $type

Access:: private

Definition at line 1746 of file SpecialUserlogin.php.

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

Referenced by execute().

LoginFormPreAuthManager::processLogin ( )

LoginFormPreAuthManager::renewSessionId ( )

private

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

Definition at line 1716 of file SpecialUserlogin.php.

References $wgCookieSecure, $wgSecureLogin, and global.

Referenced by processLogin().

LoginFormPreAuthManager::resetLoginForm ( Message $msg )

protected

Show the Special:ChangePassword form, with custom message.

Parameters

Message $msg

Definition at line 1199 of file SpecialUserlogin.php.

References SpecialPage\getContext(), and Hooks\run().

Referenced by processLogin().

static LoginFormPreAuthManager::setCreateaccountToken ( )

static

Formerly randomly generated a createaccount token that would be returned by $this->getCreateaccountToken().

Since 1.27, this is a no-op. The token is generated as necessary by $this->getCreateaccountToken().

Deprecated:: since 1.27

Definition at line 1701 of file SpecialUserlogin.php.

References wfDeprecated().

static LoginFormPreAuthManager::setLoginToken ( )

static

Formerly randomly generated a login token that would be returned by $this->getLoginToken().

Since 1.27, this is a no-op. The token is generated as necessary by $this->getLoginToken().

Deprecated:: since 1.27

Definition at line 1670 of file SpecialUserlogin.php.

References wfDeprecated().

LoginFormPreAuthManager::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 1622 of file SpecialUserlogin.php.

References $user.

Referenced by mainLoginForm().

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

string	$type	One of the following: error: display a return to link ignoring $wgRedirectOnLogin signup: display a return to link using $wgRedirectOnLogin if needed 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 1376 of file SpecialUserlogin.php.

References $returnTo, $returnToQuery, $type, and executeReturnTo().

LoginFormPreAuthManager::successfulCreation ( )

private

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

Definition at line 1282 of file SpecialUserlogin.php.

References displaySuccessfulAction(), RequestContext\getMain(), SpecialPage\getName(), SpecialPage\getUser(), SpecialPage\msg(), and Hooks\run().

Referenced by addNewAccount().

LoginFormPreAuthManager::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 1261 of file SpecialUserlogin.php.

References displaySuccessfulAction(), executeReturnTo(), RequestContext\getMain(), SpecialPage\getUser(), SpecialPage\msg(), and Hooks\run().

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

LoginFormPreAuthManager::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 1333 of file SpecialUserlogin.php.

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

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

Member Data Documentation

LoginFormPreAuthManager::$mAbortLoginErrorMsg = null

Definition at line 89 of file SpecialUserlogin.php.

Referenced by processLogin().

LoginFormPreAuthManager::$mAction

protected

Definition at line 102 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mCookieCheck

protected

Definition at line 100 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mCreateaccount

protected

Definition at line 103 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mCreateaccountMail

protected

Definition at line 104 of file SpecialUserlogin.php.

Referenced by load().

LoginFormPreAuthManager::$mDomain

protected

Definition at line 108 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mEmail

protected

Definition at line 107 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mEntryError = ''

protected

Definition at line 117 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mEntryErrorType = 'error'

protected

Definition at line 118 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mLanguage

protected

Definition at line 109 of file SpecialUserlogin.php.

Referenced by mainLoginForm().

LoginFormPreAuthManager::$mLoaded = false

private

Definition at line 121 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mLoginattempt

protected

Definition at line 105 of file SpecialUserlogin.php.

WebRequest LoginFormPreAuthManager::$mOverrideRequest = null

private

Definition at line 125 of file SpecialUserlogin.php.

Referenced by load().

LoginFormPreAuthManager::$mPassword

protected

Definition at line 97 of file SpecialUserlogin.php.

Referenced by attemptAutoCreate().

LoginFormPreAuthManager::$mPosted

protected

Definition at line 101 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mRealName

protected

Definition at line 116 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mReason

protected

Definition at line 115 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mRemember

protected

Definition at line 106 of file SpecialUserlogin.php.

WebRequest LoginFormPreAuthManager::$mRequest = null

private

Effective request; set at the beginning of load.

Definition at line 128 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mReturnTo

protected

Definition at line 99 of file SpecialUserlogin.php.

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

LoginFormPreAuthManager::$mReturnToQuery

protected

Definition at line 111 of file SpecialUserlogin.php.

Referenced by cookieRedirectCheck(), and makeLanguageSelectorLink().

LoginFormPreAuthManager::$mRetype

protected

Definition at line 98 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mSecureLoginUrl

private

Definition at line 122 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mSkipCookieCheck

protected

Definition at line 110 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mStickHTTPS

protected

Definition at line 113 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mTempPasswordUsed

private

Definition at line 120 of file SpecialUserlogin.php.

int LoginFormPreAuthManager::$mThrottleWait = '?'

How many seconds user is throttled for.

Since: 1.27

Definition at line 94 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mToken

protected

Definition at line 112 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mType

protected

Definition at line 114 of file SpecialUserlogin.php.

LoginFormPreAuthManager::$mUsername

protected

Definition at line 96 of file SpecialUserlogin.php.

Referenced by authenticateUserData().

LoginFormPreAuthManager::$statusCodes

static

Initial value:

= [

self::SUCCESS => 'success'

Definition at line 49 of file SpecialUserlogin.php.

string [] LoginFormPreAuthManager::$validErrorMessages

static

Initial value:

= [
        'exception-nologin-text',
        'watchlistanontext',
        'changeemail-no-info',
        'resetpass-no-info',
        'confirmemail_needlogin',
        'prefsnologintext2',
    ]

Valid error and warning messages.

Special:Userlogin can show an error or warning message on the form when coming from another page. This is done via the ?error= or ?warning= GET parameters.

This array is the list of valid message keys. All other values will be ignored.

Since: 1.24

Definition at line 80 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::ABORTED = 8

Definition at line 41 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::CREATE_BLOCKED = 9

Definition at line 42 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::EMPTY_PASS = 6

Definition at line 39 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::ILLEGAL = 2

Definition at line 35 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::NEED_TOKEN = 12

Definition at line 45 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::NO_NAME = 1

Definition at line 34 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::NOT_EXISTS = 4

Definition at line 37 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::RESET_PASS = 7

Definition at line 40 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::SUCCESS = 0

Definition at line 33 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::THROTTLED = 10

Definition at line 43 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::USER_BLOCKED = 11

Definition at line 44 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::USER_MIGRATED = 14

Definition at line 47 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::WRONG_PASS = 5

Definition at line 38 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::WRONG_PLUGIN_PASS = 3

Definition at line 36 of file SpecialUserlogin.php.

const LoginFormPreAuthManager::WRONG_TOKEN = 13

Definition at line 46 of file SpecialUserlogin.php.

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

includes/specials/pre-authmanager/SpecialUserlogin.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation