mediawiki-extensions-SpamBl.../includes/ApiSpamBlacklist.php
Daimona Eaytoy da1af447e2 Always pass a User object to SpamBlacklist::filter
There are some usages outside of SpamBlacklist that must be fixed. After
doing that, the signature should be updated to make the user
non-optional.

Note: I've changed the signature because external callers only pass the
first two parameters. Hence, it's easier to change it now, add a
User parameter to the callers and then make it non-optional, than having
to pass $preserveLog and $mode in all callers and then swapping the
order (as that would break the world).

Change-Id: I0714eb9dbc6af3c775ab7a81cb4b59e687183f77
2020-11-10 19:13:01 +00:00

77 lines
2.1 KiB
PHP

<?php
/**
* SpamBlacklist extension API
*
* Copyright © 2013 Wikimedia Foundation
* Based on code by Ian Baker, Victor Vasiliev, Bryan Tong Minh, Roan Kattouw,
* Alex Z., and Jackmcbarn
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
/**
* Query module check a URL against the blacklist
*
* @ingroup API
* @ingroup Extensions
*/
class ApiSpamBlacklist extends ApiBase {
public function execute() {
$params = $this->extractRequestParams();
$matches = BaseBlacklist::getSpamBlacklist()->filter(
$params['url'],
null,
$this->getUser(),
true
);
$res = $this->getResult();
if ( $matches !== false ) {
// this url is blacklisted.
$res->addValue( 'spamblacklist', 'result', 'blacklisted' );
$res->setIndexedTagName( $matches, 'match' );
$res->addValue( 'spamblacklist', 'matches', $matches );
} else {
// not blacklisted
$res->addValue( 'spamblacklist', 'result', 'ok' );
}
}
public function getAllowedParams() {
return [
'url' => [
ApiBase::PARAM_REQUIRED => true,
ApiBase::PARAM_ISMULTI => true,
]
];
}
/**
* @see ApiBase::getExamplesMessages()
* @return array
*/
protected function getExamplesMessages() {
return [
'action=spamblacklist&url=http://www.example.com/|http://www.example.org/'
=> 'apihelp-spamblacklist-example-1',
];
}
public function getHelpUrls() {
return [ 'https://www.mediawiki.org/wiki/Extension:SpamBlacklist/API' ];
}
}