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