1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
|
<?php
namespace MediaWiki\Extension\AbuseFilter;
use LogicException;
use MediaWiki\Extension\AbuseFilter\Parser\RuleCheckerStatus;
/**
* Mutable value class storing and accumulating information about filter matches and runtime
*/
class RunnerData {
/**
* @var array<string,RuleCheckerStatus>
*/
private $matchedFilters;
/**
* @var array[]
* @phan-var array<string,array{time:float,conds:int,result:bool}>
*/
private $profilingData;
/** @var float */
private $totalRuntime;
/** @var int */
private $totalConditions;
/**
* @param RuleCheckerStatus[] $matchedFilters
* @param array[] $profilingData
* @param float $totalRuntime
* @param int $totalConditions
*/
public function __construct(
array $matchedFilters = [],
array $profilingData = [],
float $totalRuntime = 0.0,
int $totalConditions = 0
) {
$this->matchedFilters = $matchedFilters;
$this->profilingData = $profilingData;
$this->totalRuntime = $totalRuntime;
$this->totalConditions = $totalConditions;
}
/**
* Record (memorize) data from a filter run
*
* @param int $filterID
* @param bool $global
* @param RuleCheckerStatus $status
* @param float $timeTaken
*/
public function record( int $filterID, bool $global, RuleCheckerStatus $status, float $timeTaken ): void {
$key = GlobalNameUtils::buildGlobalName( $filterID, $global );
if ( array_key_exists( $key, $this->matchedFilters ) ) {
throw new LogicException( "Filter '$key' has already been recorded" );
}
$this->matchedFilters[$key] = $status;
$this->profilingData[$key] = [
'time' => $timeTaken,
'conds' => $status->getCondsUsed(),
'result' => $status->getResult()
];
$this->totalRuntime += $timeTaken;
$this->totalConditions += $status->getCondsUsed();
}
/**
* Get information about filter matches in backwards compatible format
* @return bool[]
* @phan-return array<string,bool>
*/
public function getMatchesMap(): array {
return array_map(
static function ( $status ) {
return $status->getResult();
},
$this->matchedFilters
);
}
/**
* @return string[]
*/
public function getAllFilters(): array {
return array_keys( $this->matchedFilters );
}
/**
* @return string[]
*/
public function getMatchedFilters(): array {
return array_keys( array_filter( $this->getMatchesMap() ) );
}
/**
* @return array[]
*/
public function getProfilingData(): array {
return $this->profilingData;
}
/**
* @return float
*/
public function getTotalRuntime(): float {
return $this->totalRuntime;
}
/**
* @return int
*/
public function getTotalConditions(): int {
return $this->totalConditions;
}
/**
* Serialize data for edit stash
* @return array
* @phan-return array{matches:array<string,array>,runtime:float,condCount:int,profiling:array}
*/
public function toArray(): array {
return [
'matches' => array_map(
static function ( $status ) {
return $status->toArray();
},
$this->matchedFilters
),
'profiling' => $this->profilingData,
'condCount' => $this->totalConditions,
'runtime' => $this->totalRuntime,
];
}
/**
* Deserialize data from edit stash
* @param array $value
* @return self
*/
public static function fromArray( array $value ): self {
return new self(
array_map( [ RuleCheckerStatus::class, 'fromArray' ], $value['matches'] ),
$value['profiling'],
$value['runtime'],
$value['condCount']
);
}
}
|