plugins/RegisterThrottle/RegisterThrottlePlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * Throttle registration by IP address
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Spam
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Throttle registration by IP address
  37  *
  38  * We a) record IP address of registrants and b) throttle registrations.
  39  *
  40  * @category  Spam
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2010 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 class RegisterThrottlePlugin extends Plugin
  49 {
  50     /**
  51      * Array of time spans in seconds to limits.
  52      *
  53      * Default is 3 registrations per hour, 5 per day, 10 per week.
  54      */
  55     public $regLimits = array(604800 => 10, // per week
  56                               86400 => 5, // per day
  57                               3600 => 3); // per hour
  58
  59     /**
  60      * Disallow registration if a silenced user has registered from
  61      * this IP address.
  62      */
  63     public $silenced = true;
  64
  65     /**
  66      * Whether we're enabled; prevents recursion.
  67      */
  68     static private $enabled = true;
  69
  70     /**
  71      * Database schema setup
  72      *
  73      * We store user registrations in a table registration_ip.
  74      *
  75      * @return boolean hook value; true means continue processing, false means stop.
  76      */
  77     function onCheckSchema()
  78     {
  79         $schema = Schema::get();
  80
  81         // For storing user-submitted flags on profiles
  82         $schema->ensureTable('registration_ip', Registration_ip::schemaDef());
  83         return true;
  84     }
  85
  86     /**
  87      * Called when someone tries to register.
  88      *
  89      * We check the IP here to determine if it goes over any of our
  90      * configured limits.
  91      *
  92      * @param Action $action Action that is being executed
  93      *
  94      * @return boolean hook value
  95      */
  96     function onStartRegistrationTry($action)
  97     {
  98         $ipaddress = $this->_getIpAddress();
  99
 100         if (empty($ipaddress)) {
 101             // TRANS: Server exception thrown when no IP address can be found for a registation attempt.
 102             throw new ServerException(_m('Cannot find IP address.'));
 103         }
 104
 105         foreach ($this->regLimits as $seconds => $limit) {
 106
 107             $this->debug("Checking $seconds ($limit)");
 108
 109             $reg = $this->_getNthReg($ipaddress, $limit);
 110
 111             if (!empty($reg)) {
 112                 $this->debug("Got a {$limit}th registration.");
 113                 $regtime = strtotime($reg->created);
 114                 $now     = time();
 115                 $this->debug("Comparing {$regtime} to {$now}");
 116                 if ($now - $regtime < $seconds) {
 117                     // TRANS: Exception thrown when too many user have registered from one IP address within a given time frame.
 118                     throw new Exception(_m('Too many registrations. Take a break and try again later.'));
 119                 }
 120             }
 121         }
 122
 123         // Check for silenced users
 124
 125         if ($this->silenced) {
 126             $ids = Registration_ip::usersByIP($ipaddress);
 127             foreach ($ids as $id) {
 128                 $profile = Profile::getKV('id', $id);
 129                 if ($profile && $profile->isSilenced()) {
 130                     // TRANS: Exception thrown when attempting to register from an IP address from which silenced users have registered.
 131                     throw new Exception(_m('A banned user has registered from this address.'));
 132                 }
 133             }
 134         }
 135
 136         return true;
 137     }
 138
 139     /**
 140      * Called after someone registers, by any means.
 141      *
 142      * We record the successful registration and IP address.
 143      *
 144      * @param Profile $profile new user's profile
 145      *
 146      * @return boolean hook value
 147      */
 148     public function onEndUserRegister(Profile $profile)
 149     {
 150         $ipaddress = $this->_getIpAddress();
 151
 152         if (empty($ipaddress)) {
 153             // User registration can happen from command-line scripts etc.
 154             return true;
 155         }
 156
 157         $reg = new Registration_ip();
 158
 159         $reg->user_id   = $profile->id;
 160         $reg->ipaddress = $ipaddress;
 161
 162         $result = $reg->insert();
 163
 164         if (!$result) {
 165             common_log_db_error($reg, 'INSERT', __FILE__);
 166             // @todo throw an exception?
 167         }
 168
 169         return true;
 170     }
 171
 172     /**
 173      * Check the version of the plugin.
 174      *
 175      * @param array &$versions Version array.
 176      *
 177      * @return boolean hook value
 178      */
 179     function onPluginVersion(&$versions)
 180     {
 181         $versions[] = array('name' => 'RegisterThrottle',
 182                             'version' => STATUSNET_VERSION,
 183                             'author' => 'Evan Prodromou',
 184                             'homepage' => 'http://status.net/wiki/Plugin:RegisterThrottle',
 185                             'description' =>
 186                             // TRANS: Plugin description.
 187                             _m('Throttles excessive registration from a single IP address.'));
 188         return true;
 189     }
 190
 191     /**
 192      * Gets the current IP address.
 193      *
 194      * @return string IP address or null if not found.
 195      */
 196     private function _getIpAddress()
 197     {
 198         $keys = array('HTTP_X_FORWARDED_FOR',
 199                       'HTTP_X_CLIENT',
 200                       'CLIENT-IP',
 201                       'REMOTE_ADDR');
 202
 203         foreach ($keys as $k) {
 204             if (!empty($_SERVER[$k])) {
 205                 return $_SERVER[$k];
 206             }
 207         }
 208
 209         return null;
 210     }
 211
 212     /**
 213      * Gets the Nth registration with the given IP address.
 214      *
 215      * @param string  $ipaddress Address to key on
 216      * @param integer $n         Nth address
 217      *
 218      * @return Registration_ip nth registration or null if not found.
 219      */
 220     private function _getNthReg($ipaddress, $n)
 221     {
 222         $reg = new Registration_ip();
 223
 224         $reg->ipaddress = $ipaddress;
 225
 226         $reg->orderBy('created DESC');
 227         $reg->limit($n - 1, 1);
 228
 229         if ($reg->find(true)) {
 230             return $reg;
 231         } else {
 232             return null;
 233         }
 234     }
 235
 236     /**
 237      * When silencing a user, silence all other users registered from that IP
 238      * address.
 239      *
 240      * @param Profile $profile Person getting a new role
 241      * @param string  $role    Role being assigned like 'moderator' or 'silenced'
 242      *
 243      * @return boolean hook value
 244      */
 245     function onEndGrantRole($profile, $role)
 246     {
 247         if (!self::$enabled) {
 248             return true;
 249         }
 250
 251         if ($role != Profile_role::SILENCED) {
 252             return true;
 253         }
 254
 255         if (!$this->silenced) {
 256             return true;
 257         }
 258
 259         $ri = Registration_ip::getKV('user_id', $profile->id);
 260
 261         if (empty($ri)) {
 262             return true;
 263         }
 264
 265         $ids = Registration_ip::usersByIP($ri->ipaddress);
 266
 267         foreach ($ids as $id) {
 268             if ($id == $profile->id) {
 269                 continue;
 270             }
 271
 272             $other = Profile::getKV('id', $id);
 273
 274             if (empty($other)) {
 275                 continue;
 276             }
 277
 278             if ($other->isSilenced()) {
 279                 continue;
 280             }
 281
 282             $old = self::$enabled;
 283             self::$enabled = false;
 284             $other->silence();
 285             self::$enabled = $old;
 286         }
 287     }
 288 }