home/omtekel/wiki/extensions/AbuseFilter/includes/Api/CheckSyntax.php000066600000005205151335007340021766 0ustar00ruleCheckerFactory = $ruleCheckerFactory; $this->afPermManager = $afPermManager; } /** * @inheritDoc */ public function execute() { // "Anti-DoS" if ( !$this->afPermManager->canUseTestTools( $this->getAuthority() ) && !$this->afPermManager->canEdit( $this->getAuthority() ) ) { $this->dieWithError( 'apierror-abusefilter-cantcheck', 'permissiondenied' ); } $params = $this->extractRequestParams(); $result = $this->ruleCheckerFactory->newRuleChecker()->checkSyntax( $params['filter'] ); $r = []; $warnings = []; foreach ( $result->getWarnings() as $warning ) { $warnings[] = [ 'message' => $this->msg( $warning->getMessageObj() )->text(), 'character' => $warning->getPosition() ]; } if ( $warnings ) { $r['warnings'] = $warnings; } if ( $result->isValid() ) { // Everything went better than expected :) $r['status'] = 'ok'; } else { // TODO: Improve the type here. /** @var UserVisibleException $excep */ $excep = $result->getException(); '@phan-var UserVisibleException $excep'; $r = [ 'status' => 'error', 'message' => $this->msg( $excep->getMessageObj() )->text(), 'character' => $excep->getPosition(), ]; } $this->getResult()->addValue( null, $this->getModuleName(), $r ); } /** * @codeCoverageIgnore Merely declarative * @inheritDoc */ public function getAllowedParams() { return [ 'filter' => [ ParamValidator::PARAM_REQUIRED => true, ], ]; } /** * @codeCoverageIgnore Merely declarative * @inheritDoc */ protected function getExamplesMessages() { return [ 'action=abusefilterchecksyntax&filter="foo"' => 'apihelp-abusefilterchecksyntax-example-1', 'action=abusefilterchecksyntax&filter="bar"%20bad_variable' => 'apihelp-abusefilterchecksyntax-example-2', ]; } }