3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * Throttle registration by IP address
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.
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.
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/>.
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/
31 if (!defined('STATUSNET')) {
36 * Throttle registration by IP address
38 * We a) record IP address of registrants and b) throttle registrations.
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/
48 class RegisterThrottlePlugin extends Plugin
51 * Array of time spans in seconds to limits.
53 * Default is 3 registrations per hour, 5 per day, 10 per week.
55 public $regLimits = array(604800 => 10, // per week
56 86400 => 5, // per day
57 3600 => 3); // per hour
60 * Disallow registration if a silenced user has registered from
63 public $silenced = true;
66 * Whether we're enabled; prevents recursion.
68 static private $enabled = true;
71 * Database schema setup
73 * We store user registrations in a table registration_ip.
75 * @return boolean hook value; true means continue processing, false means stop.
77 function onCheckSchema()
79 $schema = Schema::get();
81 // For storing user-submitted flags on profiles
82 $schema->ensureTable('registration_ip',
83 array(new ColumnDef('user_id', 'integer', null,
85 new ColumnDef('ipaddress', 'varchar', 15, false, 'MUL'),
86 new ColumnDef('created', 'timestamp', null, false, 'MUL')));
92 * Load related modules when needed
94 * @param string $cls Name of the class to be loaded
96 * @return boolean hook value; true means continue processing, false means stop.
98 function onAutoload($cls)
100 $dir = dirname(__FILE__);
104 case 'Registration_ip':
105 include_once $dir . '/'.$cls.'.php';
113 * Called when someone tries to register.
115 * We check the IP here to determine if it goes over any of our
118 * @param Action $action Action that is being executed
120 * @return boolean hook value
122 function onStartRegistrationTry($action)
124 $ipaddress = $this->_getIpAddress();
126 if (empty($ipaddress)) {
127 // TRANS: Server exception thrown when no IP address can be found for a registation attempt.
128 throw new ServerException(_m('Cannot find IP address.'));
131 foreach ($this->regLimits as $seconds => $limit) {
133 $this->debug("Checking $seconds ($limit)");
135 $reg = $this->_getNthReg($ipaddress, $limit);
138 $this->debug("Got a {$limit}th registration.");
139 $regtime = strtotime($reg->created);
141 $this->debug("Comparing {$regtime} to {$now}");
142 if ($now - $regtime < $seconds) {
143 // TRANS: Exception thrown when too many user have registered from one IP address within a given time frame.
144 throw new Exception(_m('Too many registrations. Take a break and try again later.'));
149 // Check for silenced users
151 if ($this->silenced) {
152 $ids = Registration_ip::usersByIP($ipaddress);
153 foreach ($ids as $id) {
154 $profile = Profile::staticGet('id', $id);
155 if ($profile && $profile->isSilenced()) {
156 // TRANS: Exception thrown when attempting to register from an IP address from which silenced users have registered.
157 throw new Exception(_m('A banned user has registered from this address.'));
166 * Called after someone registers, by any means.
168 * We record the successful registration and IP address.
170 * @param Profile $profile new user's profile
171 * @param User $user new user
173 * @return boolean hook value
175 function onEndUserRegister($profile, $user)
177 $ipaddress = $this->_getIpAddress();
179 if (empty($ipaddress)) {
180 // User registration can happen from command-line scripts etc.
184 $reg = new Registration_ip();
186 $reg->user_id = $user->id;
187 $reg->ipaddress = $ipaddress;
189 $result = $reg->insert();
192 common_log_db_error($reg, 'INSERT', __FILE__);
193 // @todo throw an exception?
200 * Check the version of the plugin.
202 * @param array &$versions Version array.
204 * @return boolean hook value
206 function onPluginVersion(&$versions)
208 $versions[] = array('name' => 'RegisterThrottle',
209 'version' => STATUSNET_VERSION,
210 'author' => 'Evan Prodromou',
211 'homepage' => 'http://status.net/wiki/Plugin:RegisterThrottle',
213 // TRANS: Plugin description.
214 _m('Throttles excessive registration from a single IP address.'));
219 * Gets the current IP address.
221 * @return string IP address or null if not found.
223 private function _getIpAddress()
225 $keys = array('HTTP_X_FORWARDED_FOR',
230 foreach ($keys as $k) {
231 if (!empty($_SERVER[$k])) {
240 * Gets the Nth registration with the given IP address.
242 * @param string $ipaddress Address to key on
243 * @param integer $n Nth address
245 * @return Registration_ip nth registration or null if not found.
247 private function _getNthReg($ipaddress, $n)
249 $reg = new Registration_ip();
251 $reg->ipaddress = $ipaddress;
253 $reg->orderBy('created DESC');
254 $reg->limit($n - 1, 1);
256 if ($reg->find(true)) {
264 * When silencing a user, silence all other users registered from that IP
267 * @param Profile $profile Person getting a new role
268 * @param string $role Role being assigned like 'moderator' or 'silenced'
270 * @return boolean hook value
272 function onEndGrantRole($profile, $role)
274 if (!self::$enabled) {
278 if ($role != Profile_role::SILENCED) {
282 if (!$this->silenced) {
286 $ri = Registration_ip::staticGet('user_id', $profile->id);
292 $ids = Registration_ip::usersByIP($ri->ipaddress);
294 foreach ($ids as $id) {
295 if ($id == $profile->id) {
299 $other = Profile::staticGet('id', $id);
305 if ($other->isSilenced()) {
309 $old = self::$enabled;
310 self::$enabled = false;
312 self::$enabled = $old;