Add an API action to test blacklisted URLs

Add API action spamblacklist, accepting parameter url, that returns the
parts of the URLs that match the spam blacklist, if any.

Bug: 54441
Change-Id: Ia6aea8b463fc63f951224520b8cc5abf185c5c74

SpamBlacklist.php

@@ -18,6 +18,10 @@ $wgExtensionCredits['antispam'][] = array(
 $dir = __DIR__ . '/';
 $wgExtensionMessagesFiles['SpamBlackList'] = $dir . 'SpamBlacklist.i18n.php';
 
+// Register the API method
+$wgAutoloadClasses['ApiSpamBlacklist'] = "$dir/api/ApiSpamBlacklist.php";
+$wgAPIModules['spamblacklist'] = 'ApiSpamBlacklist';
+
 /**
  * Array of settings for blacklist classes
  */

SpamBlacklist_body.php

@@ -34,10 +34,13 @@ class SpamBlacklist extends BaseBlacklist {
 	 *               This is used to load the old links already on the page, so
 	 *               the filter is only applied to links that got added. If not given,
 	 *               the filter is applied to all $links.
+	 * @param boolean $preventLog Whether to prevent logging of hits. Set to true when
+	 *               the action is testing the links rather than attempting to save them
+	 *               (e.g. the API spamblacklist action)
 	 *
 	 * @return Array Matched text(s) if the edit should not be allowed, false otherwise
 	 */
-	function filter( array $links, Title $title = null ) {
+	function filter( array $links, Title $title = null, $preventLog = false ) {
 		$fname = 'wfSpamBlacklistFilter';
 		wfProfileIn( $fname );
 
@@ -93,7 +96,9 @@ class SpamBlacklist extends BaseBlacklist {
 					$ip = $wgRequest->getIP();
 					$imploded = implode( ' ', $matches[0] );
 					wfDebugLog( 'SpamBlacklistHit', "$ip caught submitting spam: $imploded\n" );
-					$this->logFilterHit( $title, $imploded ); // Log it
+					if( !$preventLog ) {
+						$this->logFilterHit( $title, $imploded ); // Log it
+					}
 					if( $retVal === false ){
 						$retVal = array();
 					}

api/ApiSpamBlacklist.php

@@ -0,0 +1,78 @@
+<?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,
+			)
+		);
+	}
+
+	public function getParamDescription() {
+		return array(
+			'url' => 'A pipe-separated list of URLs to validate against the blacklist',
+		);
+	}
+
+	public function getDescription() {
+		return 'Validate one or more URLs against the SpamBlacklist.';
+	}
+
+	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',
+		);
+	}
+
+	public function getHelpUrls() {
+		return array( 'https://www.mediawiki.org/wiki/Extension:SpamBlacklist/API' );
+	}
+}