Public Member Functions
	__construct (ServiceOptions $options, LoggerInterface $logger, ActorStoreFactory $actorStoreFactory, BlockRestrictionStore $blockRestrictionStore, CommentStore $commentStore, HookContainer $hookContainer, IConnectionProvider $dbProvider, ReadOnlyMode $readOnlyMode, UserFactory $userFactory, TempUserConfig $tempUserConfig, BlockTargetFactory $blockTargetFactory, AutoblockExemptionList $autoblockExemptionList, $wikiId=DatabaseBlock::LOCAL)

Public Attributes
const	CONSTRUCTOR_OPTIONS

Database read methods
	newFromID ( $id, $fromPrimary=false, $includeExpired=false)
	Load a block from the block ID.

	getQueryInfo ()
	Return the tables, fields, and join conditions to be selected to create a new block object.

	getRangeCond ( $start, $end)
	Get a set of SQL conditions which select range blocks encompassing a given range.

	newFromRow (IReadableDatabase $db, $row)
	Create a new DatabaseBlock object from a database row.

	newFromTarget ( $specificTarget, $vagueTarget=null, $fromPrimary=false)
	Given a target and the target's type, get an existing block object if possible.

	newListFromTarget ( $specificTarget, $vagueTarget=null, $fromPrimary=false)
	This is similar to DatabaseBlockStore::newFromTarget, but it returns all the relevant blocks.

	newListFromIPs (array $addresses, $applySoftBlocks, $fromPrimary=false)
	Get all blocks that match any IP from an array of IP addresses.

	newListFromConds ( $conds, $fromPrimary=false, $includeExpired=false)
	Construct an array of blocks from database conditions.

Database write methods
	newUnsaved (array $options)
	Create a DatabaseBlock representing an unsaved block.

	purgeExpiredBlocks ()
	Delete expired blocks from the block table.

	deleteBlocksMatchingConds (array $conds, $limit=null)
	Delete all blocks matching the given conditions.

	insertBlock (DatabaseBlock $block, $expectedTargetCount=0)
	Insert a block into the block table.

	insertBlockWithParams (array $params)
	Create a block with an array of parameters and immediately insert it.

	updateBlock (DatabaseBlock $block)
	Update a block in the DB with new parameters.

	updateTarget (DatabaseBlock $block, $newTarget)
	Update the target in the specified object and in the database.

	deleteBlock (DatabaseBlock $block)
	Delete a DatabaseBlock from the database.

	doAutoblock (DatabaseBlock $parentBlock, $autoblockIP)
	Autoblocks the given IP, referring to the specified block.

	updateTimestamp (DatabaseBlock $block)
	Update the timestamp on autoblocks.

	getAutoblockExpiry ( $timestamp, ?string $parentExpiry=null)
	Get the expiry timestamp for an autoblock created at the given time.

Detailed Description

Since: 1.36

Author: DannyS712

Definition at line 59 of file DatabaseBlockStore.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Block\DatabaseBlockStore::__construct	(	ServiceOptions	$options,
		LoggerInterface	$logger,
		ActorStoreFactory	$actorStoreFactory,
		BlockRestrictionStore	$blockRestrictionStore,
		CommentStore	$commentStore,
		HookContainer	$hookContainer,
		IConnectionProvider	$dbProvider,
		ReadOnlyMode	$readOnlyMode,
		UserFactory	$userFactory,
		TempUserConfig	$tempUserConfig,
		BlockTargetFactory	$blockTargetFactory,
		AutoblockExemptionList	$autoblockExemptionList,
			$wikiId = DatabaseBlock::LOCAL )

Definition at line 87 of file DatabaseBlockStore.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ deleteBlock()

MediaWiki\Block\DatabaseBlockStore::deleteBlock ( DatabaseBlock $block )

Delete a DatabaseBlock from the database.

Parameters

DatabaseBlock $block

Returns: bool whether it was deleted

Definition at line 1244 of file DatabaseBlockStore.php.

◆ deleteBlocksMatchingConds()

MediaWiki\Block\DatabaseBlockStore::deleteBlocksMatchingConds	(	array	$conds,
			$limit = null )

Delete all blocks matching the given conditions.

Since: 1.42

Parameters

array	$conds	An associative array mapping the field name to the matched value.
int \| null	$limit	The maximum number of blocks to delete

Returns: int The number of blocks deleted

Definition at line 652 of file DatabaseBlockStore.php.

◆ doAutoblock()

MediaWiki\Block\DatabaseBlockStore::doAutoblock	(	DatabaseBlock	$parentBlock,
			$autoblockIP )

Autoblocks the given IP, referring to the specified block.

Since: 1.42

Parameters

DatabaseBlock	$parentBlock
string	$autoblockIP	The IP to autoblock.

Returns: int|false ID if an autoblock was inserted, false if not.

Definition at line 1457 of file DatabaseBlockStore.php.

References MediaWiki\DAO\WikiAwareEntity\assertWiki(), MediaWiki\Block\DatabaseBlock\getBlocker(), MediaWiki\Block\AbstractBlock\getExpiry(), MediaWiki\Block\AbstractBlock\getHideName(), MediaWiki\Block\DatabaseBlock\getId(), MediaWiki\Block\DatabaseBlock\getRestrictions(), MediaWiki\Block\DatabaseBlock\isAutoblocking(), MediaWiki\Block\AbstractBlock\isCreateAccountBlocked(), MediaWiki\Block\AbstractBlock\isSitewide(), MediaWiki\Block\AbstractBlock\isUsertalkEditAllowed(), and wfTimestampNow().

◆ getAutoblockExpiry()

MediaWiki\Block\DatabaseBlockStore::getAutoblockExpiry	(		$timestamp,
		?string	$parentExpiry = null )

Get the expiry timestamp for an autoblock created at the given time.

If the parent block expiry is specified, the return value will be earlier than or equal to the parent block expiry.

Access: internal: Public to support deprecated DatabaseBlock method

Parameters

string \| int	$timestamp
string \| null	$parentExpiry

Returns: string

Definition at line 1580 of file DatabaseBlockStore.php.

References wfTimestamp().

◆ getQueryInfo()

MediaWiki\Block\DatabaseBlockStore::getQueryInfo ( )

Return the tables, fields, and join conditions to be selected to create a new block object.

Since: 1.42

Access: internal: Prefer newListFromConds() and deleteBlocksMatchingConds().

Returns

array[] With three keys:

tables: (string[]) to include in the $table to IDatabase->select() or SelectQueryBuilder::tables
fields: (string[]) to include in the $vars to IDatabase->select() or SelectQueryBuilder::fields
joins: (array) to include in the $join_conds to IDatabase->select() or SelectQueryBuilder::joinConds

Definition at line 154 of file DatabaseBlockStore.php.

Referenced by MediaWiki\Block\DatabaseBlockStore\newListFromConds(), and MediaWiki\Block\DatabaseBlockStore\newListFromIPs().

◆ getRangeCond()

MediaWiki\Block\DatabaseBlockStore::getRangeCond	(		$start,
			$end )

Get a set of SQL conditions which select range blocks encompassing a given range.

If the given range is a single IP with start=end, it will also select single IP blocks with that IP.

Since: 1.42

Parameters

string	$start	Hexadecimal IP representation
string \| null	$end	Hexadecimal IP representation, or null to use $start = $end

Returns: string

Definition at line 357 of file DatabaseBlockStore.php.

Referenced by MediaWiki\Block\DatabaseBlockStore\newListFromIPs().

◆ insertBlock()

MediaWiki\Block\DatabaseBlockStore::insertBlock	(	DatabaseBlock	$block,
			$expectedTargetCount = 0 )

Insert a block into the block table.

Will fail if there is a conflicting block (same name and options) already in the database.

Parameters

DatabaseBlock	$block
int \| null	$expectedTargetCount	The expected number of existing blocks on the specified target. If this is zero but there is an existing block, the insertion will fail.

Returns

bool|array False on failure, assoc array on success:

id: block ID
autoIds: array of autoblock IDs
finalTargetCount: The updated number of blocks for the specified target.

Definition at line 806 of file DatabaseBlockStore.php.

References MediaWiki\DAO\WikiAwareEntity\assertWiki(), MediaWiki\Block\DatabaseBlock\getBlocker(), MediaWiki\Block\DatabaseBlock\getId(), MediaWiki\Block\AbstractBlock\getTargetUserIdentity(), and MediaWiki\Block\AbstractBlock\getTimestamp().

◆ insertBlockWithParams()

MediaWiki\Block\DatabaseBlockStore::insertBlockWithParams ( array $params )

Create a block with an array of parameters and immediately insert it.

Throw an exception on failure. This is a convenience method for testing.

Duplicate blocks for a given target are allowed by default.

Since: 1.44

Parameters

array

$params

Parameters for newUnsaved(), and also:

expectedTargetCount: Use this to override conflict checking

Returns: DatabaseBlock The inserted Block

Definition at line 887 of file DatabaseBlockStore.php.

◆ newFromID()

MediaWiki\Block\DatabaseBlockStore::newFromID	(	$id,
		$fromPrimary = false,
		$includeExpired = false )

Load a block from the block ID.

Since: 1.42

Parameters

int	$id	ID to search for
bool	$fromPrimary	Whether to use the DB_PRIMARY database (since 1.44)
bool	$includeExpired	Whether to include expired blocks (since 1.44)

Returns: DatabaseBlock|null

Definition at line 133 of file DatabaseBlockStore.php.

References MediaWiki\Block\DatabaseBlockStore\newListFromConds().

Referenced by MediaWiki\Block\DatabaseBlockStore\newListFromTarget().

◆ newFromRow()

MediaWiki\Block\DatabaseBlockStore::newFromRow	(	IReadableDatabase	$db,
			$row )

Create a new DatabaseBlock object from a database row.

Since: 1.42

Parameters

IReadableDatabase	$db	The database you got the row from
stdClass	$row	Row from the block table

Returns: DatabaseBlock

Definition at line 408 of file DatabaseBlockStore.php.

References Wikimedia\Rdbms\Platform\ISQLPlatform\decodeExpiry().

Referenced by MediaWiki\Block\DatabaseBlockStore\newListFromConds(), and MediaWiki\Block\DatabaseBlockStore\newListFromIPs().

◆ newFromTarget()

MediaWiki\Block\DatabaseBlockStore::newFromTarget	(	$specificTarget,
		$vagueTarget = null,
		$fromPrimary = false )

Given a target and the target's type, get an existing block object if possible.

Since: 1.42

Parameters

BlockTarget \| string \| UserIdentity \| int \| null	$specificTarget	A block target, which may be one of several types: A user to block, in which case $target will be a User An IP to block, in which case $target will be a User generated by using User::newFromName( $ip, false ) to turn off name validation An IP range, in which case $target will be a String "123.123.123.123/18" etc The ID of an existing block, in the format "#12345" (since pure numbers are valid usernames Calling this with a user, IP address or range will not select autoblocks, and will only select a block where the targets match exactly (so looking for blocks on 1.2.3.4 will not select 1.2.0.0/16 or even 1.2.3.4/32)
BlockTarget \| string \| UserIdentity \| int \| null	$vagueTarget	As above, but we will search for any block which affects that target (so for an IP address, get ranges containing that IP; and also get any relevant autoblocks). Leave empty or blank to skip IP-based lookups.
bool	$fromPrimary	Whether to use the DB_PRIMARY database

Returns: DatabaseBlock|null (null if no relevant block could be found). The target and type of the returned block will refer to the actual block which was found, which might not be the same as the target you gave if you used $vagueTarget!

Definition at line 457 of file DatabaseBlockStore.php.

References MediaWiki\Block\DatabaseBlockStore\newListFromTarget().

◆ newListFromConds()

MediaWiki\Block\DatabaseBlockStore::newListFromConds	(	$conds,
		$fromPrimary = false,
		$includeExpired = false )

Construct an array of blocks from database conditions.

Since: 1.42

Parameters

array	$conds	Query conditions, given as an associative array mapping field names to values.
bool	$fromPrimary
bool	$includeExpired

Returns: DatabaseBlock[]

Definition at line 559 of file DatabaseBlockStore.php.

References MediaWiki\Block\DatabaseBlockStore\getQueryInfo(), and MediaWiki\Block\DatabaseBlockStore\newFromRow().

Referenced by MediaWiki\Block\DatabaseBlockStore\newFromID().

◆ newListFromIPs()

MediaWiki\Block\DatabaseBlockStore::newListFromIPs	(	array	$addresses,
			$applySoftBlocks,
			$fromPrimary = false )

Get all blocks that match any IP from an array of IP addresses.

Since: 1.42

Parameters

string[]	$addresses	Validated list of IP addresses
bool	$applySoftBlocks	Include soft blocks (anonymous-only blocks). These should only block anonymous and temporary users.
bool	$fromPrimary	Whether to query the primary or replica DB

Returns: DatabaseBlock[]

Definition at line 507 of file DatabaseBlockStore.php.

References MediaWiki\Block\DatabaseBlockStore\getQueryInfo(), MediaWiki\Block\DatabaseBlockStore\getRangeCond(), LIST_OR, and MediaWiki\Block\DatabaseBlockStore\newFromRow().

◆ newListFromTarget()

MediaWiki\Block\DatabaseBlockStore::newListFromTarget	(	$specificTarget,
		$vagueTarget = null,
		$fromPrimary = false )

This is similar to DatabaseBlockStore::newFromTarget, but it returns all the relevant blocks.

Since: 1.42

Parameters

BlockTarget \| string \| UserIdentity \| int \| null	$specificTarget
BlockTarget \| string \| UserIdentity \| int \| null	$vagueTarget
bool	$fromPrimary

Returns: DatabaseBlock[] Any relevant blocks

Definition at line 475 of file DatabaseBlockStore.php.

References MediaWiki\Block\DatabaseBlockStore\newFromID().

Referenced by LogEventsList\getBlockLogWarningBox(), and MediaWiki\Block\DatabaseBlockStore\newFromTarget().

◆ newUnsaved()

MediaWiki\Block\DatabaseBlockStore::newUnsaved ( array $options )

Create a DatabaseBlock representing an unsaved block.

Pass the returned object to insertBlock().

Since: 1.44

Parameters

array

$options

Options as documented in DatabaseBlock and AbstractBlock, and additionally:

address: (string) A string specifying the block target. This is not the same as the legacy address parameter which allows UserIdentity.
targetUser: (UserIdentity) The UserIdentity to block

Returns: DatabaseBlock

Definition at line 596 of file DatabaseBlockStore.php.

◆ purgeExpiredBlocks()

MediaWiki\Block\DatabaseBlockStore::purgeExpiredBlocks ( )

Delete expired blocks from the block table.

Access: internal: only public for use in DatabaseBlock

Definition at line 619 of file DatabaseBlockStore.php.

References Wikimedia\Rdbms\IReadableDatabase\expr(), Wikimedia\Rdbms\IReadableDatabase\newSelectQueryBuilder(), Wikimedia\Rdbms\Platform\ISQLPlatform\timestamp(), and MediaWiki\MainConfigNames\UpdateRowsPerQuery.

◆ updateBlock()

MediaWiki\Block\DatabaseBlockStore::updateBlock ( DatabaseBlock $block )

Update a block in the DB with new parameters.

The ID field needs to be loaded first. The target must stay the same.

TODO: remove the possibility of false return. The cases where this happens are exotic enough that they should just be exceptions.

Parameters

DatabaseBlock $block

Returns: bool|array False on failure, array on success: ('id' => block ID, 'autoIds' => array of autoblock IDs)

Definition at line 1117 of file DatabaseBlockStore.php.

References MediaWiki\DAO\WikiAwareEntity\assertWiki(), MediaWiki\Block\DatabaseBlock\getId(), MediaWiki\Block\DatabaseBlock\getRawRestrictions(), MediaWiki\Block\AbstractBlock\getTimestamp(), MediaWiki\Block\DatabaseBlock\isAutoblocking(), MediaWiki\Block\AbstractBlock\setTimestamp(), and wfTimestamp().

◆ updateTarget()

MediaWiki\Block\DatabaseBlockStore::updateTarget	(	DatabaseBlock	$block,
			$newTarget )

Update the target in the specified object and in the database.

The block ID must be set.

This is an unusual operation, currently used only by the UserMerge extension.

Since: 1.42

Parameters

DatabaseBlock	$block
BlockTarget \| UserIdentity \| string	$newTarget

Returns: bool True if the update was successful, false if there was no match for the block ID.

Definition at line 1198 of file DatabaseBlockStore.php.

References MediaWiki\Block\DatabaseBlock\getId(), and MediaWiki\Block\AbstractBlock\setTarget().

◆ updateTimestamp()

MediaWiki\Block\DatabaseBlockStore::updateTimestamp ( DatabaseBlock $block )

Update the timestamp on autoblocks.

Access: internal: Public to support deprecated DatabaseBlock::updateTimestamp()

Parameters

DatabaseBlock $block

Definition at line 1545 of file DatabaseBlockStore.php.

References MediaWiki\DAO\WikiAwareEntity\assertWiki(), MediaWiki\Block\AbstractBlock\getExpiry(), MediaWiki\Block\DatabaseBlock\getId(), MediaWiki\Block\AbstractBlock\getTimestamp(), MediaWiki\Block\DatabaseBlock\getType(), MediaWiki\Block\AbstractBlock\setExpiry(), MediaWiki\Block\AbstractBlock\setTimestamp(), and wfTimestamp().

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Block\DatabaseBlockStore::CONSTRUCTOR_OPTIONS

Initial value:

= [
        MainConfigNames::AutoblockExpiry,
        MainConfigNames::BlockCIDRLimit,
        MainConfigNames::BlockDisablesLogin,
        MainConfigNames::PutIPinRC,
        MainConfigNames::UpdateRowsPerQuery,
    ]

Access: internal: For use by ServiceWiring

Definition at line 63 of file DatabaseBlockStore.php.

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

includes/block/DatabaseBlockStore.php

Public Member Functions

Public Attributes

Database read methods

Database write methods

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteBlock()

◆ deleteBlocksMatchingConds()

◆ doAutoblock()

◆ getAutoblockExpiry()

◆ getQueryInfo()

◆ getRangeCond()

◆ insertBlock()

◆ insertBlockWithParams()

◆ newFromID()

◆ newFromRow()

◆ newFromTarget()

◆ newListFromConds()

◆ newListFromIPs()

◆ newListFromTarget()

◆ newUnsaved()

◆ purgeExpiredBlocks()

◆ updateBlock()

◆ updateTarget()

◆ updateTimestamp()

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS