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
|
<?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::getInstance( 'spam' )->filter( $params['url'], NULL, 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 array(
'url' => array(
ApiBase::PARAM_REQUIRED => true,
ApiBase::PARAM_ISMULTI => true,
)
);
}
/**
* @deprecated since MediaWiki core 1.25
*/
public function getParamDescription() {
return array(
'url' => 'A pipe-separated list of URLs to validate against the blacklist',
);
}
/**
* @deprecated since MediaWiki core 1.25
*/
public function getDescription() {
return 'Validate one or more URLs against the SpamBlacklist.';
}
/**
* @deprecated since MediaWiki core 1.25
*/
public function getExamples() {
return array(
'api.php?action=spamblacklist&url=http%3A%2F%2Fwww.example.com%2F%7Chttp%3A%2F%2Fwww.example.org%2F',
'api.php?action=spamblacklist&url=https%3A%2F%2Fwww.example.net%2Findex.php',
);
}
/**
* @see ApiBase::getExamplesMessages()
*/
protected function getExamplesMessages() {
return array(
'action=spamblacklist&url=http://www.example.com/|http://www.example.org/'
=> 'apihelp-spamblacklist-example-1',
);
}
public function getHelpUrls() {
return array( 'https://www.mediawiki.org/wiki/Extension:SpamBlacklist/API' );
}
}
|
