Page MenuHomeWickedGov Phorge
Files F2753110

ChangeTagsManager.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

ChangeTagsManager.php
View Options

<?php
namespace MediaWiki\Extension\AbuseFilter\ChangeTags;
use MediaWiki\ChangeTags\ChangeTagsStore;
use MediaWiki\Extension\AbuseFilter\CentralDBManager;
use MediaWiki\Extension\AbuseFilter\CentralDBNotAvailableException;
use Wikimedia\ObjectCache\WANObjectCache;
use Wikimedia\Rdbms\Database;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\LBFactory;
/**
* Database wrapper class which aids registering and reserving change tags
* used by relevant abuse filters
* @todo Consider verbose constants instead of boolean?
*/
class ChangeTagsManager {
public const SERVICE_NAME = 'AbuseFilterChangeTagsManager';
private const CONDS_LIMIT_TAG = 'abusefilter-condition-limit';
private ChangeTagsStore $changeTagsStore;
private LBFactory $lbFactory;
private WANObjectCache $cache;
private CentralDBManager $centralDBManager;
/**
* @param ChangeTagsStore $changeTagsStore
* @param LBFactory $lbFactory
* @param WANObjectCache $cache
* @param CentralDBManager $centralDBManager
*/
public function __construct(
ChangeTagsStore $changeTagsStore,
LBFactory $lbFactory,
WANObjectCache $cache,
CentralDBManager $centralDBManager
) {
$this->changeTagsStore = $changeTagsStore;
$this->lbFactory = $lbFactory;
$this->cache = $cache;
$this->centralDBManager = $centralDBManager;
}
/**
* Purge all cache related to tags, both within AbuseFilter and in core
*/
public function purgeTagCache(): void {
// xxx: this doesn't purge all existing caches, see T266105
$this->changeTagsStore->purgeTagCacheAll();
$this->cache->delete( $this->getCacheKeyForStatus( true ) );
$this->cache->delete( $this->getCacheKeyForStatus( false ) );
}
/**
* Return tags used by any active (enabled) filter, both local and global.
* @return string[]
*/
public function getTagsDefinedByActiveFilters(): array {
return $this->loadTags( true );
}
/**
* Return tags used by any filter that is not deleted, both local and global.
* @return string[]
*/
public function getTagsDefinedByFilters(): array {
return $this->loadTags( false );
}
/**
* @param IReadableDatabase $dbr
* @param bool $enabled
* @param bool $global
* @return string[]
*/
private function loadTagsFromDb( IReadableDatabase $dbr, bool $enabled, bool $global = false ): array {
// This is a pretty awful hack.
$where = [
'afa_consequence' => 'tag',
'af_deleted' => 0
];
if ( $enabled ) {
$where['af_enabled'] = 1;
}
if ( $global ) {
$where['af_global'] = 1;
}
$res = $dbr->newSelectQueryBuilder()
->select( 'afa_parameters' )
->from( 'abuse_filter_action' )
->join( 'abuse_filter', null, 'afa_filter=af_id' )
->where( $where )
->caller( __METHOD__ )
->fetchResultSet();
$tags = [];
foreach ( $res as $row ) {
$tags = array_merge(
$row->afa_parameters !== '' ? explode( "\n", $row->afa_parameters ) : [],
$tags
);
}
return $tags;
}
/**
* @param bool $enabled
* @return string[]
*/
private function loadTags( bool $enabled ): array {
return $this->cache->getWithSetCallback(
$this->getCacheKeyForStatus( $enabled ),
WANObjectCache::TTL_MINUTE,
function ( $oldValue, &$ttl, array &$setOpts ) use ( $enabled ) {
$dbr = $this->lbFactory->getReplicaDatabase();
try {
$globalDbr = $this->centralDBManager->getConnection( DB_REPLICA );
} catch ( CentralDBNotAvailableException $_ ) {
$globalDbr = null;
}
if ( $globalDbr !== null ) {
// Account for any snapshot/replica DB lag
$setOpts += Database::getCacheSetOptions( $dbr, $globalDbr );
$tags = array_merge(
$this->loadTagsFromDb( $dbr, $enabled ),
$this->loadTagsFromDb( $globalDbr, $enabled, true )
);
} else {
$setOpts += Database::getCacheSetOptions( $dbr );
$tags = $this->loadTagsFromDb( $dbr, $enabled );
}
return array_unique( $tags );
}
);
}
/**
* @param bool $enabled
* @return string
*/
private function getCacheKeyForStatus( bool $enabled ): string {
return $this->cache->makeKey( 'abusefilter-fetch-all-tags', (int)$enabled );
}
/**
* Get the tag identifier used to indicate a change has exceeded the condition limit
* @return string
*/
public function getCondsLimitTag(): string {
return self::CONDS_LIMIT_TAG;
}
}

File Metadata

Mime Type
text/x-php
Expires
Fri, Jul 3, 20:49 (1 d, 9 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
dd/d4/6d60ca1b851f1bdab23db7b6ebef
Default Alt Text
ChangeTagsManager.php (4 KB)

Event Timeline