plugins/BlogspamNetPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to check submitted notices with blogspam.net
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Brion Vibber <brion@status.net>
  26  * @copyright 2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 define('BLOGSPAMNETPLUGIN_VERSION', '0.1');
  36
  37 /**
  38  * Plugin to check submitted notices with blogspam.net
  39  *
  40  * When new notices are saved, we check their text with blogspam.net (or
  41  * a compatible service).
  42  *
  43  * Blogspam.net is supposed to catch blog comment spam, and I found that
  44  * some of its tests (min/max size, bayesian match) gave a lot of false positives.
  45  * So, I've turned those tests off by default. This may not get as many
  46  * hits, but it's better than nothing.
  47  *
  48  * @category Plugin
  49  * @package  StatusNet
  50  * @author   Evan Prodromou <evan@status.net>
  51  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  52  * @link     http://status.net/
  53  *
  54  * @see      Event
  55  */
  56
  57 class BlogspamNetPlugin extends Plugin
  58 {
  59     var $baseUrl = 'http://test.blogspam.net:8888/';
  60
  61     function __construct($url=null)
  62     {
  63         parent::__construct();
  64         if ($url) {
  65             $this->baseUrl = $url;
  66         }
  67     }
  68
  69     function onStartNoticeSave($notice)
  70     {
  71         $args = $this->testArgs($notice);
  72         common_debug("Blogspamnet args = " . print_r($args, TRUE));
  73         $requestBody = xmlrpc_encode_request('testComment', array($args));
  74
  75         $request = new HTTPClient($this->baseUrl, HTTPClient::METHOD_POST);
  76         $request->setHeader('Content-Type', 'text/xml');
  77         $request->setBody($requestBody);
  78         $httpResponse = $request->send();
  79
  80         $response = xmlrpc_decode($httpResponse->getBody());
  81         if (xmlrpc_is_fault($response)) {
  82             throw new ServerException("$response[faultString] ($response[faultCode])", 500);
  83         } else {
  84             common_debug("Blogspamnet results = " . $response);
  85             if (preg_match('/^ERROR(:(.*))?$/', $response, $match)) {
  86                 throw new ServerException(sprintf(_("Error from %s: %s"), $this->baseUrl, $match[2]), 500);
  87             } else if (preg_match('/^SPAM(:(.*))?$/', $response, $match)) {
  88                 throw new ClientException(sprintf(_("Spam checker results: %s"), $match[2]), 400);
  89             } else if (preg_match('/^OK$/', $response)) {
  90                 // don't do anything
  91             } else {
  92                 throw new ServerException(sprintf(_("Unexpected response from %s: %s"), $this->baseUrl, $response), 500);
  93             }
  94         }
  95         return true;
  96     }
  97
  98     function testArgs($notice)
  99     {
 100         $args = array();
 101         $args['comment'] = $notice->content;
 102         $args['ip'] = $this->getClientIP();
 103
 104         if (isset($_SERVER) && array_key_exists('HTTP_USER_AGENT', $_SERVER)) {
 105             $args['agent'] = $_SERVER['HTTP_USER_AGENT'];
 106         }
 107
 108         $profile = $notice->getProfile();
 109
 110         if ($profile && $profile->homepage) {
 111             $args['link'] = $profile->homepage;
 112         }
 113
 114         if ($profile && $profile->fullname) {
 115             $args['name'] = $profile->fullname;
 116         } else {
 117             $args['name'] = $profile->nickname;
 118         }
 119
 120         $args['site'] = common_root_url();
 121         $args['version'] = $this->userAgent();
 122
 123         $args['options'] = "max-size=" . common_config('site','textlimit') . ",min-size=0,min-words=0,exclude=bayasian";
 124
 125         return $args;
 126     }
 127
 128     function getClientIP()
 129     {
 130         if (isset($_SERVER) && array_key_exists('REQUEST_METHOD', $_SERVER)) {
 131             // Note: order matters here; use proxy-forwarded stuff first
 132             foreach (array('HTTP_X_FORWARDED_FOR', 'CLIENT-IP', 'REMOTE_ADDR') as $k) {
 133                 if (isset($_SERVER[$k])) {
 134                     return $_SERVER[$k];
 135                 }
 136             }
 137         }
 138         return '127.0.0.1';
 139     }
 140
 141     function userAgent()
 142     {
 143         return 'BlogspamNetPlugin/'.BLOGSPAMNETPLUGIN_VERSION . ' StatusNet/' . STATUSNET_VERSION;
 144     }
 145 }