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         $reg->created   = common_sql_now();
 160
 161         $result = $reg->insert();
 162
 163         if ($result === false) {
 164             common_log_db_error($reg, 'INSERT', __FILE__);
 165             // @todo throw an exception?
 166         }
 167
 168         return true;
 169     }
 170
 171     /**
 172      * Check the version of the plugin.
 173      *
 174      * @param array &$versions Version array.
 175      *
 176      * @return boolean hook value
 177      */
 178     public function onPluginVersion(array &$versions)
 179     {
 180         $versions[] = array('name' => 'RegisterThrottle',
 181                             'version' => GNUSOCIAL_VERSION,
 182                             'author' => 'Evan Prodromou',
 183                             'homepage' => 'http://status.net/wiki/Plugin:RegisterThrottle',
 184                             'description' =>
 185                             // TRANS: Plugin description.
 186                             _m('Throttles excessive registration from a single IP address.'));
 187         return true;
 188     }
 189
 190     /**
 191      * Gets the current IP address.
 192      *
 193      * @return string IP address or null if not found.
 194      */
 195     private function _getIpAddress()
 196     {
 197         $keys = array('HTTP_X_FORWARDED_FOR',
 198                       'HTTP_X_CLIENT',
 199                       'CLIENT-IP',
 200                       'REMOTE_ADDR');
 201
 202         foreach ($keys as $k) {
 203             if (!empty($_SERVER[$k])) {
 204                 return $_SERVER[$k];
 205             }
 206         }
 207
 208         return null;
 209     }
 210
 211     /**
 212      * Gets the Nth registration with the given IP address.
 213      *
 214      * @param string  $ipaddress Address to key on
 215      * @param integer $n         Nth address
 216      *
 217      * @return Registration_ip nth registration or null if not found.
 218      */
 219     private function _getNthReg($ipaddress, $n)
 220     {
 221         $reg = new Registration_ip();
 222
 223         $reg->ipaddress = $ipaddress;
 224
 225         $reg->orderBy('created DESC');
 226         $reg->limit($n - 1, 1);
 227
 228         if ($reg->find(true)) {
 229             return $reg;
 230         } else {
 231             return null;
 232         }
 233     }
 234
 235     /**
 236      * When silencing a user, silence all other users registered from that IP
 237      * address.
 238      *
 239      * @param Profile $profile Person getting a new role
 240      * @param string  $role    Role being assigned like 'moderator' or 'silenced'
 241      *
 242      * @return boolean hook value
 243      */
 244     public function onEndGrantRole($profile, $role)
 245     {
 246         if (!self::$enabled) {
 247             return true;
 248         }
 249
 250         if ($role != Profile_role::SILENCED) {
 251             return true;
 252         }
 253
 254         if (!$this->silenced) {
 255             return true;
 256         }
 257
 258         $ri = Registration_ip::getKV('user_id', $profile->id);
 259
 260         if (empty($ri)) {
 261             return true;
 262         }
 263
 264         $ids = Registration_ip::usersByIP($ri->ipaddress);
 265
 266         foreach ($ids as $id) {
 267             if ($id == $profile->id) {
 268                 continue;
 269             }
 270
 271             $other = Profile::getKV('id', $id);
 272
 273             if (empty($other)) {
 274                 continue;
 275             }
 276
 277             if ($other->isSilenced()) {
 278                 continue;
 279             }
 280
 281             $old = self::$enabled;
 282             self::$enabled = false;
 283             $other->silence();
 284             self::$enabled = $old;
 285         }
 286     }
 287 }