Page MenuHomeWickedGov Phorge
Files F1428512

EvalExpression.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

EvalExpression.php
View Options

<?php
namespace MediaWiki\Extension\AbuseFilter\Api;
use MediaWiki\Api\ApiBase;
use MediaWiki\Api\ApiMain;
use MediaWiki\Api\ApiResult;
use MediaWiki\Extension\AbuseFilter\AbuseFilterPermissionManager;
use MediaWiki\Extension\AbuseFilter\Parser\RuleCheckerFactory;
use MediaWiki\Extension\AbuseFilter\VariableGenerator\VariableGeneratorFactory;
use MediaWiki\Extension\AbuseFilter\Variables\VariablesFormatter;
use MediaWiki\Status\Status;
use Wikimedia\ParamValidator\ParamValidator;
class EvalExpression extends ApiBase {
/** @var RuleCheckerFactory */
private $ruleCheckerFactory;
/** @var AbuseFilterPermissionManager */
private $afPermManager;
/** @var VariableGeneratorFactory */
private $afVariableGeneratorFactory;
/**
* @param ApiMain $main
* @param string $action
* @param RuleCheckerFactory $ruleCheckerFactory
* @param AbuseFilterPermissionManager $afPermManager
* @param VariableGeneratorFactory $afVariableGeneratorFactory
*/
public function __construct(
ApiMain $main,
$action,
RuleCheckerFactory $ruleCheckerFactory,
AbuseFilterPermissionManager $afPermManager,
VariableGeneratorFactory $afVariableGeneratorFactory
) {
parent::__construct( $main, $action );
$this->ruleCheckerFactory = $ruleCheckerFactory;
$this->afPermManager = $afPermManager;
$this->afVariableGeneratorFactory = $afVariableGeneratorFactory;
}
/**
* @inheritDoc
*/
public function execute() {
// "Anti-DoS"
if ( !$this->afPermManager->canUseTestTools( $this->getAuthority() ) ) {
$this->dieWithError( 'apierror-abusefilter-canteval', 'permissiondenied' );
}
$params = $this->extractRequestParams();
$status = $this->evaluateExpression( $params['expression'] );
if ( !$status->isGood() ) {
$this->dieStatus( $status );
} else {
$res = $status->getValue();
$res = $params['prettyprint'] ? VariablesFormatter::formatVar( $res ) : $res;
$this->getResult()->addValue(
null,
$this->getModuleName(),
ApiResult::addMetadataToResultVars( [ 'result' => $res ] )
);
}
}
/**
* @param string $expr
* @return Status
*/
private function evaluateExpression( string $expr ): Status {
$ruleChecker = $this->ruleCheckerFactory->newRuleChecker();
if ( !$ruleChecker->checkSyntax( $expr )->isValid() ) {
return Status::newFatal( 'abusefilter-tools-syntax-error' );
}
// Generic vars are the only ones available
$generator = $this->afVariableGeneratorFactory->newGenerator();
$vars = $generator->addGenericVars()->getVariableHolder();
$ruleChecker->setVariables( $vars );
return Status::newGood( $ruleChecker->evaluateExpression( $expr ) );
}
/**
* @codeCoverageIgnore Merely declarative
* @inheritDoc
*/
public function getAllowedParams() {
return [
'expression' => [
ParamValidator::PARAM_REQUIRED => true,
],
'prettyprint' => [
ParamValidator::PARAM_TYPE => 'boolean'
]
];
}
/**
* @codeCoverageIgnore Merely declarative
* @inheritDoc
*/
protected function getExamplesMessages() {
return [
'action=abusefilterevalexpression&expression=lcase("FOO")'
=> 'apihelp-abusefilterevalexpression-example-1',
'action=abusefilterevalexpression&expression=lcase("FOO")&prettyprint=1'
=> 'apihelp-abusefilterevalexpression-example-2',
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 16:20 (13 h, 43 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
2c/fa/60e9d1d4199b7808f842b04cce96
Default Alt Text
EvalExpression.php (3 KB)

Event Timeline