Utility class for bot passwords. More...

Inheritance diagram for BotPassword:

Collaboration diagram for BotPassword:

Public Member Functions
	delete ()
	Delete the BotPassword from the database. More...

	getAppId ()
	Get the app ID. More...

	getGrants ()
	Get the grants. More...

	getRestrictions ()
	Get the restrictions. More...

	getToken ()
	Get the token. More...

	getUserCentralId ()
	Get the central user ID. More...

	isSaved ()
	Indicate whether this is known to be saved. More...

	save ($operation, Password $password=null)
	Save the BotPassword to the database. More...

Static Public Member Functions
static	getDB ($db)
	Get a database connection for the bot passwords database. More...

static	getSeparator ()
	Get the separator for combined user name + app ID. More...

static	invalidateAllPasswordsForCentralId ($centralId)
	Invalidate all passwords for a user, by central ID. More...

static	invalidateAllPasswordsForUser ($username)
	Invalidate all passwords for a user, by name. More...

static	login ($username, $password, WebRequest $request)
	Try to log the user in. More...

static	newFromCentralId ($centralId, $appId, $flags=self::READ_NORMAL)
	Load a BotPassword from the database. More...

static	newFromUser (User $user, $appId, $flags=self::READ_NORMAL)
	Load a BotPassword from the database. More...

static	newUnsaved (array $data, $flags=self::READ_NORMAL)
	Create an unsaved BotPassword. More...

static	removeAllPasswordsForCentralId ($centralId)
	Remove all passwords for a user, by central ID. More...

static	removeAllPasswordsForUser ($username)
	Remove all passwords for a user, by name. More...

Public Attributes
const	APPID_MAXLENGTH = 32

Public Attributes inherited from IDBAccessObject
const	READ_EXCLUSIVE = 7

const	READ_LATEST = 1

const	READ_LOCKING = 3

const	READ_NONE = -1

const	READ_NORMAL = 0

Protected Member Functions
	__construct ($row, $isSaved, $flags=self::READ_NORMAL)

	getPassword ()
	Get the password. More...

Private Attributes
string	$appId

int	$centralId

int	$flags = self::READ_NORMAL

string[]	$grants

bool	$isSaved

MWRestrictions	$restrictions

string	$token

Detailed Description

Utility class for bot passwords.

Since: 1.27

Definition at line 27 of file BotPassword.php.

Constructor & Destructor Documentation

BotPassword::__construct	(	$row,
		$isSaved,
		$flags = `self::READ_NORMAL`
	)

protected

Parameters

object	$row	bot_passwords database row
bool	$isSaved	Whether the bot password was read from the database
int	$flags	IDBAccessObject read flags

Definition at line 57 of file BotPassword.php.

References $flags, $isSaved, FormatJson\decode(), flags, isSaved(), and MWRestrictions\newFromJson().

Member Function Documentation

BotPassword::delete ( )

Delete the BotPassword from the database.

Returns: bool Success

Definition at line 309 of file BotPassword.php.

References $appId, $centralId, DB_MASTER, and isSaved().

BotPassword::getAppId ( )

Get the app ID.

Returns: string

Definition at line 197 of file BotPassword.php.

References $appId.

Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\newSessionForRequest().

static BotPassword::getDB ( $db )

static

Get a database connection for the bot passwords database.

Parameters

int $db Index of the connection to get, e.g. DB_MASTER or DB_SLAVE.

Returns: DatabaseBase

Definition at line 73 of file BotPassword.php.

References $wgBotPasswordsCluster, $wgBotPasswordsDatabase, global, wfGetLB(), and wfGetLBFactory().

Referenced by SpecialBotPasswords\getFormFields().

BotPassword::getGrants ( )

Get the grants.

Returns: string[]

Definition at line 221 of file BotPassword.php.

References $grants.

Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\newSessionForRequest().

BotPassword::getPassword ( )

protected

Get the password.

Returns: Password

Definition at line 238 of file BotPassword.php.

References $options, flags, DBAccessObjectUtils\getDBOptions(), RequestContext\getMain(), list, and PasswordFactory\newInvalidPassword().

BotPassword::getRestrictions ( )

Get the restrictions.

Returns: MWRestrictions

Definition at line 213 of file BotPassword.php.

References $restrictions.

static BotPassword::getSeparator ( )

static

Get the separator for combined user name + app ID.

Returns: string

Definition at line 229 of file BotPassword.php.

References $wgUserrightsInterwikiDelimiter, and global.

Referenced by ApiLogin\execute(), SpecialBotPasswords\getFormFields(), SpecialBotPasswords\onSuccess(), BotPasswordTest\testBasics(), and ApiLoginTest\testBotPassword().

BotPassword::getToken ( )

Get the token.

Returns: string

Definition at line 205 of file BotPassword.php.

References $token.

Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\newSessionForRequest().

BotPassword::getUserCentralId ( )

Get the central user ID.

Returns: int

Definition at line 189 of file BotPassword.php.

References $centralId.

Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\newSessionForRequest().

static BotPassword::invalidateAllPasswordsForCentralId ( $centralId )

static

Invalidate all passwords for a user, by central ID.

Parameters

int $centralId

Returns: bool Whether any passwords were invalidated

Definition at line 341 of file BotPassword.php.

References $centralId, $wgEnableBotPasswords, DB_MASTER, global, and PasswordFactory\newInvalidPassword().

static BotPassword::invalidateAllPasswordsForUser ( $username )

static

Invalidate all passwords for a user, by name.

Parameters

string $username User name

Returns: bool Whether any passwords were invalidated

Definition at line 329 of file BotPassword.php.

References $centralId, $username, CentralIdLookup\AUDIENCE_RAW, CentralIdLookup\factory(), and IDBAccessObject\READ_LATEST.

Referenced by MediaWiki\Auth\AuthManager\changeAuthenticationData(), User\setPasswordInternal(), and BotPasswordTest\testInvalidateAllPasswordsForUser().

BotPassword::isSaved ( )

Indicate whether this is known to be saved.

Returns: bool

Definition at line 181 of file BotPassword.php.

References $isSaved.

Referenced by __construct(), delete(), and save().

static BotPassword::login	(		$username,
			$password,
		WebRequest	$request
	)

static

Try to log the user in.

Parameters

string	$username	Combined user name and app ID
string	$password	Supplied password
WebRequest	$request

Returns: Status On success, the good status's value is the new Session object

Definition at line 398 of file BotPassword.php.

References $appId, $name, $status, $user, $username, $wgEnableBotPasswords, class, global, list, Status\newFatal(), User\newFromName(), Status\newGood(), and MediaWiki\Session\SessionManager\singleton().

Referenced by ApiLogin\execute(), and BotPasswordTest\testLogin().

static BotPassword::newFromCentralId	(	$centralId,
		$appId,
		$flags = `self::READ_NORMAL`
	)

static

Load a BotPassword from the database.

Parameters

int	$centralId	from CentralIdLookup
string	$appId
int	$flags	IDBAccessObject read flags

Returns: BotPassword|null

Definition at line 103 of file BotPassword.php.

References $appId, $centralId, $flags, $options, $wgEnableBotPasswords, DBAccessObjectUtils\getDBOptions(), global, and list.

Referenced by SpecialBotPasswords\getFormFields(), SpecialBotPasswords\onSubmit(), MediaWiki\Session\Session\BotPasswordSessionProvider\refreshSessionInfo(), BotPasswordTest\testGetPassword(), BotPasswordTest\testInvalidateAllPasswordsForUser(), BotPasswordTest\testRemoveAllPasswordsForUser(), and BotPasswordTest\testSave().

static BotPassword::newFromUser	(	User	$user,
			$appId,
			$flags = `self::READ_NORMAL`
	)

static

Load a BotPassword from the database.

Parameters

User	$user
string	$appId
int	$flags	IDBAccessObject read flags

Returns: BotPassword|null

Definition at line 89 of file BotPassword.php.

References $appId, $centralId, $flags, CentralIdLookup\AUDIENCE_RAW, and CentralIdLookup\factory().

Referenced by BotPasswordTest\testBasics(), MediaWiki\Session\BotPasswordSessionProviderTest\testCheckSessionInfo(), and MediaWiki\Session\BotPasswordSessionProviderTest\testNewSessionInfoForRequest().

static BotPassword::newUnsaved	(	array	$data,
			$flags = `self::READ_NORMAL`
	)

static

Create an unsaved BotPassword.

Parameters

array	$data	Data to use to create the bot password. Keys are: user: (User) User object to create the password for. Overrides username and centralId. username: (string) Username to create the password for. Overrides centralId. centralId: (int) User central ID to create the password for. appId: (string) App ID for the password. restrictions: (MWRestrictions, optional) Restrictions. grants: (string[], optional) Grants.
int	$flags	IDBAccessObject read flags