Page MenuHomeWickedGov Phorge

AbuseFilterLogDetailsLookup.php
No OneTemporary

Size
4 KB
Referenced Files
None
Subscribers
None

AbuseFilterLogDetailsLookup.php

<?php
namespace MediaWiki\Extension\AbuseFilter;
use MediaWiki\Permissions\Authority;
use StatusValue;
use Wikimedia\IPUtils;
use Wikimedia\Rdbms\IConnectionProvider;
/**
* This service allows code to lookup details about abuse_filter_log rows.
*
* @since 1.45
*/
class AbuseFilterLogDetailsLookup {
public const SERVICE_NAME = 'AbuseFilterLogDetailsLookup';
public function __construct(
private readonly IConnectionProvider $dbProvider,
private readonly AbuseFilterPermissionManager $afPermissionManager,
private readonly FilterLookup $filterLookup
) {
}
/**
* Returns the IP address associated with a given abuse_filter_log row identified by its afl_id.
*
* This method does NOT check whether the given {@link Authority} has the right to see IP
* addresses in general, but does check if the user can see each associated abuse_filter_log row.
*
* Callers are expected to log the access if the given {@link Authority} actually does view
* the IP address that was returned.
*
* @param Authority $authority The user who's trying to view the IP address.
* @param int $id The afl_id values for the rows
* @return StatusValue If a good status, the associated IP address is stored as the value of the status.
* The IP address may be empty string if the row is more than $wgAbuseFilterLogIPMaxAge seconds old
* or $wgAbuseFilterLogIP was false when the row was created.
*/
public function getIPForAbuseFilterLog( Authority $authority, int $id ): StatusValue {
$row = $this->dbProvider->getReplicaDatabase()->newSelectQueryBuilder()
->select( [ 'afl_filter_id', 'afl_global', 'afl_ip_hex', 'afl_user_text' ] )
->from( 'abuse_filter_log' )
->where( [ 'afl_id' => $id ] )
->caller( __METHOD__ )
->fetchRow();
if ( !$row ) {
return StatusValue::newFatal( 'abusefilter-log-nonexistent' );
}
$filter = $this->filterLookup->getFilter( $row->afl_filter_id, $row->afl_global );
if ( !$this->afPermissionManager->canSeeIPForFilterLog( $authority, $filter, $row->afl_user_text ) ) {
return StatusValue::newFatal( 'abusefilter-log-cannot-see-details' );
}
return StatusValue::newGood( $row->afl_ip_hex ? IPUtils::formatHex( $row->afl_ip_hex ) : '' );
}
/**
* Returns the IP addresses associated with given abuse_filter_log rows identified by their afl_id.
*
* This method does NOT check whether the given {@link Authority} has the right to see IP
* addresses in general, except for temporary account IPs, but does check if the user can see
* each associated abuse_filter_log row.
*
* Callers are expected to log the access if the given {@link Authority} actually does view
* the IP address that was returned.
*
* If only ever looking up one IP, callers are advised to use
* {@link AbuseFilterLogDetailsLookup::getIPForAbuseFilterLog} instead.
*
* @stable to call
* @param Authority $authority The user who's trying to view the IP address.
* @param int[] $ids The afl_id values for the rows
* @return string[]|false[] The IPs found with indexed by the associated afl_id. The IP is false if the user cannot
* see the IP. The IP is an empty string if the row is more than $wgAbuseFilterLogIPMaxAge seconds old,
* no such afl_id exists, or $wgAbuseFilterLogIP was false when the row was created.
*/
public function getIPsForAbuseFilterLogs( Authority $authority, array $ids ): array {
$rows = $this->dbProvider->getReplicaDatabase()->newSelectQueryBuilder()
->select( [ 'afl_filter_id', 'afl_global', 'afl_ip_hex', 'afl_id', 'afl_user_text' ] )
->from( 'abuse_filter_log' )
->where( [ 'afl_id' => $ids ] )
->caller( __METHOD__ )
->fetchResultSet();
$returnArray = array_fill_keys( $ids, '' );
foreach ( $rows as $row ) {
$filter = $this->filterLookup->getFilter( $row->afl_filter_id, $row->afl_global );
if ( !$this->afPermissionManager->canSeeIPForFilterLog( $authority, $filter, $row->afl_user_text ) ) {
$returnArray[$row->afl_id] = false;
} else {
$returnArray[$row->afl_id] = $row->afl_ip_hex ? IPUtils::formatHex( $row->afl_ip_hex ) : '';
}
}
return $returnArray;
}
/**
* Groups the provided list of afl_id values by the user who triggered the abuse_filter_log row to be created.
*
* @stable to call
* @param int[] $ids The afl_id values for the rows
* @return int[][] The afl_id values grouped by the user who triggered theabuse_filter_log row to be created.
*/
public function groupAbuseFilterLogIdsByPerformer( array $ids ): array {
$rows = $this->dbProvider->getReplicaDatabase()->newSelectQueryBuilder()
->select( [ 'afl_user_text', 'afl_id' ] )
->from( 'abuse_filter_log' )
->where( [ 'afl_id' => $ids ] )
->caller( __METHOD__ )
->fetchResultSet();
$returnArray = [];
foreach ( $rows as $row ) {
if ( !array_key_exists( $row->afl_user_text, $returnArray ) ) {
$returnArray[$row->afl_user_text] = [];
}
$returnArray[$row->afl_user_text][] = $row->afl_id;
}
return $returnArray;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Nov 21, 20:03 (21 h, 59 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
6c/20/4f33a1959f37f1aeb6597e099a1e
Default Alt Text
AbuseFilterLogDetailsLookup.php (4 KB)

Event Timeline