Page MenuHomeWickedGov Phorge
Files F2750512

ConsequencesRegistry.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ConsequencesRegistry.php
View Options

<?php
namespace MediaWiki\Extension\AbuseFilter\Consequences;
// phpcs:ignore MediaWiki.Classes.UnusedUseStatement.UnusedUse
use MediaWiki\Extension\AbuseFilter\Consequences\Consequence\Consequence;
use MediaWiki\Extension\AbuseFilter\Hooks\AbuseFilterHookRunner;
use RuntimeException;
class ConsequencesRegistry {
public const SERVICE_NAME = 'AbuseFilterConsequencesRegistry';
private const DANGEROUS_ACTIONS = [
'block',
'blockautopromote',
'degroup',
'rangeblock'
];
/** @var AbuseFilterHookRunner */
private $hookRunner;
/** @var bool[] */
private $configActions;
/** @var string[]|null */
private $dangerousActionsCache;
/** @var callable[]|null */
private $customActionsCache;
/**
* @param AbuseFilterHookRunner $hookRunner
* @param bool[] $configActions
*/
public function __construct(
AbuseFilterHookRunner $hookRunner,
array $configActions
) {
$this->hookRunner = $hookRunner;
$this->configActions = $configActions;
}
/**
* Get an array of actions which harm the user.
*
* @return string[]
*/
public function getDangerousActionNames(): array {
if ( $this->dangerousActionsCache === null ) {
$extActions = [];
$this->hookRunner->onAbuseFilterGetDangerousActions( $extActions );
$this->dangerousActionsCache = array_unique(
array_merge( $extActions, self::DANGEROUS_ACTIONS )
);
}
return $this->dangerousActionsCache;
}
/**
* @return string[]
*/
public function getAllActionNames(): array {
return array_unique(
array_merge(
array_keys( $this->configActions ),
array_keys( $this->getCustomActions() )
)
);
}
/**
* @return callable[]
* @phan-return array<string,callable(Parameters,array):Consequence>
*/
public function getCustomActions(): array {
if ( $this->customActionsCache === null ) {
$this->customActionsCache = [];
$this->hookRunner->onAbuseFilterCustomActions( $this->customActionsCache );
$this->validateCustomActions();
}
return $this->customActionsCache;
}
/**
* Ensure that extensions aren't putting crap in this array, since we can't enforce types on closures otherwise
*/
private function validateCustomActions(): void {
foreach ( $this->customActionsCache as $name => $cb ) {
if ( !is_string( $name ) ) {
throw new RuntimeException( 'Custom actions keys should be strings!' );
}
// Validating parameters and return value will happen later at runtime.
if ( !is_callable( $cb ) ) {
throw new RuntimeException( 'Custom actions values should be callables!' );
}
}
}
/**
* @return string[]
*/
public function getAllEnabledActionNames(): array {
$disabledActions = array_keys( array_filter(
$this->configActions,
static function ( $el ) {
return $el === false;
}
) );
return array_values( array_diff( $this->getAllActionNames(), $disabledActions ) );
}
}

File Metadata

Mime Type
text/x-php
Expires
Fri, Jul 3, 16:38 (6 h, 53 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
50/11/d65cbcf305b6282f0505076b36fe
Default Alt Text
ConsequencesRegistry.php (2 KB)

Event Timeline