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
  56     public $regLimits = array(604800 => 10, // per week
  57                               86400 => 5, // per day
  58                               3600 => 3); // per hour
  59
  60     /**
  61      * Disallow registration if a silenced user has registered from
  62      * this IP address.
  63      */
  64
  65     public $silenced = true;
  66
  67     /**
  68      * Whether we're enabled; prevents recursion.
  69      */
  70
  71     static private $enabled = true;
  72
  73     /**
  74      * Database schema setup
  75      *
  76      * We store user registrations in a table registration_ip.
  77      *
  78      * @return boolean hook value; true means continue processing, false means stop.
  79      */
  80
  81     function onCheckSchema()
  82     {
  83         $schema = Schema::get();
  84
  85         // For storing user-submitted flags on profiles
  86
  87         $schema->ensureTable('registration_ip',
  88                              array(new ColumnDef('user_id', 'integer', null,
  89                                                  false, 'PRI'),
  90                                    new ColumnDef('ipaddress', 'varchar', 15, false, 'MUL'),
  91                                    new ColumnDef('created', 'timestamp', null, false, 'MUL')));
  92
  93         return true;
  94     }
  95
  96     /**
  97      * Load related modules when needed
  98      *
  99      * @param string $cls Name of the class to be loaded
 100      *
 101      * @return boolean hook value; true means continue processing, false means stop.
 102      */
 103
 104     function onAutoload($cls)
 105     {
 106         $dir = dirname(__FILE__);
 107
 108         switch ($cls)
 109         {
 110         case 'Registration_ip':
 111             include_once $dir . '/'.$cls.'.php';
 112             return false;
 113         default:
 114             return true;
 115         }
 116     }
 117
 118     /**
 119      * Called when someone tries to register.
 120      *
 121      * We check the IP here to determine if it goes over any of our
 122      * configured limits.
 123      *
 124      * @param Action $action Action that is being executed
 125      *
 126      * @return boolean hook value
 127      *
 128      */
 129     function onStartRegistrationTry($action)
 130     {
 131         $ipaddress = $this->_getIpAddress();
 132
 133         if (empty($ipaddress)) {
 134             throw new ServerException(_m('Cannot find IP address.'));
 135         }
 136
 137         foreach ($this->regLimits as $seconds => $limit) {
 138
 139             $this->debug("Checking $seconds ($limit)");
 140
 141             $reg = $this->_getNthReg($ipaddress, $limit);
 142
 143             if (!empty($reg)) {
 144                 $this->debug("Got a {$limit}th registration.");
 145                 $regtime = strtotime($reg->created);
 146                 $now     = time();
 147                 $this->debug("Comparing {$regtime} to {$now}");
 148                 if ($now - $regtime < $seconds) {
 149                     throw new Exception(_m("Too many registrations. Take a break and try again later."));
 150                 }
 151             }
 152         }
 153
 154         // Check for silenced users
 155
 156         if ($this->silenced) {
 157             $ids = Registration_ip::usersByIP($ipaddress);
 158             foreach ($ids as $id) {
 159                 $profile = Profile::staticGet('id', $id);
 160                 if ($profile && $profile->isSilenced()) {
 161                     throw new Exception(_m("A banned user has registered from this address."));
 162                 }
 163             }
 164         }
 165
 166         return true;
 167     }
 168
 169     /**
 170      * Called after someone registers, by any means.
 171      *
 172      * We record the successful registration and IP address.
 173      *
 174      * @param Profile $profile new user's profile
 175      * @param User $user new user
 176      *
 177      * @return boolean hook value
 178      *
 179      */
 180
 181     function onEndUserRegister($profile, $user)
 182     {
 183         $ipaddress = $this->_getIpAddress();
 184
 185         if (empty($ipaddress)) {
 186             // User registration can happen from command-line scripts etc.
 187             return true;
 188         }
 189
 190         $reg = new Registration_ip();
 191
 192         $reg->user_id   = $user->id;
 193         $reg->ipaddress = $ipaddress;
 194
 195         $result = $reg->insert();
 196
 197         if (!$result) {
 198             common_log_db_error($reg, 'INSERT', __FILE__);
 199             // @todo throw an exception?
 200         }
 201
 202         return true;
 203     }
 204
 205     /**
 206      * Check the version of the plugin.
 207      *
 208      * @param array &$versions Version array.
 209      *
 210      * @return boolean hook value
 211      */
 212
 213     function onPluginVersion(&$versions)
 214     {
 215         $versions[] = array('name' => 'RegisterThrottle',
 216                             'version' => STATUSNET_VERSION,
 217                             'author' => 'Evan Prodromou',
 218                             'homepage' => 'http://status.net/wiki/Plugin:RegisterThrottle',
 219                             'description' =>
 220                             _m('Throttles excessive registration from a single IP address.'));
 221         return true;
 222     }
 223
 224     /**
 225      * Gets the current IP address.
 226      *
 227      * @return string IP address or null if not found.
 228      */
 229
 230     private function _getIpAddress()
 231     {
 232         $keys = array('HTTP_X_FORWARDED_FOR',
 233                       'CLIENT-IP',
 234                       'REMOTE_ADDR');
 235
 236         foreach ($keys as $k) {
 237             if (!empty($_SERVER[$k])) {
 238                 return $_SERVER[$k];
 239             }
 240         }
 241
 242         return null;
 243     }
 244
 245     /**
 246      * Gets the Nth registration with the given IP address.
 247      *
 248      * @param string  $ipaddress Address to key on
 249      * @param integer $n         Nth address
 250      *
 251      * @return Registration_ip nth registration or null if not found.
 252      */
 253
 254     private function _getNthReg($ipaddress, $n)
 255     {
 256         $reg = new Registration_ip();
 257
 258         $reg->ipaddress = $ipaddress;
 259
 260         $reg->orderBy('created DESC');
 261         $reg->limit($n - 1, 1);
 262
 263         if ($reg->find(true)) {
 264             return $reg;
 265         } else {
 266             return null;
 267         }
 268     }
 269
 270     /**
 271      * When silencing a user, silence all other users registered from that IP
 272      * address.
 273      *
 274      * @param Profile $profile Person getting a new role
 275      * @param string  $role    Role being assigned like 'moderator' or 'silenced'
 276      *
 277      * @return boolean hook value
 278      */
 279
 280     function onEndGrantRole($profile, $role)
 281     {
 282         if (!self::$enabled) {
 283             return true;
 284         }
 285
 286         if ($role != Profile_role::SILENCED) {
 287             return true;
 288         }
 289
 290         if (!$this->silenced) {
 291             return true;
 292         }
 293
 294         $ri = Registration_ip::staticGet('user_id', $profile->id);
 295
 296         if (empty($ri)) {
 297             return true;
 298         }
 299
 300         $ids = Registration_ip::usersByIP($ri->ipaddress);
 301
 302         foreach ($ids as $id) {
 303
 304             if ($id == $profile->id) {
 305                 continue;
 306             }
 307
 308             $other = Profile::staticGet('id', $id);
 309
 310             if (empty($other)) {
 311                 continue;
 312             }
 313
 314             if ($other->isSilenced()) {
 315                 continue;
 316             }
 317
 318             $old = self::$enabled;
 319             self::$enabled = false;
 320             $other->silence();
 321             self::$enabled = $old;
 322         }
 323     }
 324 }