mediawiki-extensions-AbuseF.../maintenance/SearchFilters.php
Dreamy Jazz aee25cfdaf Allow consequence to be used without pattern in SearchFilters.php
Why:
* The SearchFilters.php maintenance script fails to produce any
  filters when the --pattern option is not provided
* This is because the condition that checked for a missing pattern
  did this after it was passed through ::addQuotes, which made
  the value always truthy.

What:
* Fix this bug, so that the --consequence option can be provided
  without the --pattern option.

Bug: T373148
Change-Id: I316d3f940a8e7616a56040077a20563ee653515b
2024-08-27 11:19:56 +01:00

88 lines
2.5 KiB
PHP

<?php
namespace MediaWiki\Extension\AbuseFilter\Maintenance;
use Maintenance;
use MediaWiki\MainConfigNames;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\LikeValue;
// @codeCoverageIgnoreStart
$IP = getenv( 'MW_INSTALL_PATH' );
if ( $IP === false ) {
$IP = __DIR__ . '/../../..';
}
require_once "$IP/maintenance/Maintenance.php";
// @codeCoverageIgnoreEnd
class SearchFilters extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription(
'Find all filters matching a regular expression pattern and/or that have given consequence'
);
$this->addOption( 'pattern', 'Regular expression pattern', false, true );
$this->addOption( 'consequence', 'The consequence that the filter should have', false, true );
$this->requireExtension( 'Abuse Filter' );
}
/**
* @see Maintenance:execute()
*/
public function execute() {
global $wgConf;
if ( $this->getConfig()->get( MainConfigNames::DBtype ) !== 'mysql' ) {
$this->fatalError( 'This maintenance script only works with MySQL databases' );
}
if ( !$this->getOption( 'pattern' ) && !$this->getOption( 'consequence' ) ) {
$this->fatalError( 'One of --consequence or --pattern should be specified.' );
}
$this->output( "wiki\tfilter\n" );
if ( count( $wgConf->wikis ) > 0 ) {
foreach ( $wgConf->wikis as $dbname ) {
$this->getMatchingFilters( $dbname );
}
} else {
$this->getMatchingFilters();
}
}
/**
* @param string|false $dbname Name of database, or false if the wiki is not part of a wikifarm
*/
private function getMatchingFilters( $dbname = false ) {
$dbr = $this->getDB( DB_REPLICA, [], $dbname );
$pattern = $dbr->addQuotes( $this->getOption( 'pattern' ) );
$consequence = $this->getOption( 'consequence' );
if ( $dbr->tableExists( 'abuse_filter' ) ) {
$queryBuilder = $dbr->newSelectQueryBuilder()
->select( [ 'dbname' => 'DATABASE()', 'af_id' ] )
->from( 'abuse_filter' );
if ( $this->getOption( 'pattern' ) ) {
$queryBuilder->where( "af_pattern RLIKE $pattern" );
}
if ( $consequence ) {
$queryBuilder->where( $dbr->expr(
'af_actions',
IExpression::LIKE,
new LikeValue( $dbr->anyString(), $consequence, $dbr->anyString() )
) );
}
$rows = $queryBuilder->caller( __METHOD__ )->fetchResultSet();
foreach ( $rows as $row ) {
$this->output( $row->dbname . "\t" . $row->af_id . "\n" );
}
}
}
}
$maintClass = SearchFilters::class;
require_once RUN_MAINTENANCE_IF_MAIN;