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', Registration_ip::schemaDef());
87 * Called when someone tries to register.
89 * We check the IP here to determine if it goes over any of our
92 * @param Action $action Action that is being executed
94 * @return boolean hook value
96 function onStartRegistrationTry($action)
98 $ipaddress = $this->_getIpAddress();
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.'));
105 foreach ($this->regLimits as $seconds => $limit) {
107 $this->debug("Checking $seconds ($limit)");
109 $reg = $this->_getNthReg($ipaddress, $limit);
112 $this->debug("Got a {$limit}th registration.");
113 $regtime = strtotime($reg->created);
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.'));
123 // Check for silenced users
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.'));
140 * Called after someone registers, by any means.
142 * We record the successful registration and IP address.
144 * @param Profile $profile new user's profile
145 * @param User $user new user
147 * @return boolean hook value
149 function onEndUserRegister($profile, $user)
151 $ipaddress = $this->_getIpAddress();
153 if (empty($ipaddress)) {
154 // User registration can happen from command-line scripts etc.
158 $reg = new Registration_ip();
160 $reg->user_id = $user->id;
161 $reg->ipaddress = $ipaddress;
163 $result = $reg->insert();
166 common_log_db_error($reg, 'INSERT', __FILE__);
167 // @todo throw an exception?
174 * Check the version of the plugin.
176 * @param array &$versions Version array.
178 * @return boolean hook value
180 function onPluginVersion(&$versions)
182 $versions[] = array('name' => 'RegisterThrottle',
183 'version' => STATUSNET_VERSION,
184 'author' => 'Evan Prodromou',
185 'homepage' => 'http://status.net/wiki/Plugin:RegisterThrottle',
187 // TRANS: Plugin description.
188 _m('Throttles excessive registration from a single IP address.'));
193 * Gets the current IP address.
195 * @return string IP address or null if not found.
197 private function _getIpAddress()
199 $keys = array('HTTP_X_FORWARDED_FOR',
204 foreach ($keys as $k) {
205 if (!empty($_SERVER[$k])) {
214 * Gets the Nth registration with the given IP address.
216 * @param string $ipaddress Address to key on
217 * @param integer $n Nth address
219 * @return Registration_ip nth registration or null if not found.
221 private function _getNthReg($ipaddress, $n)
223 $reg = new Registration_ip();
225 $reg->ipaddress = $ipaddress;
227 $reg->orderBy('created DESC');
228 $reg->limit($n - 1, 1);
230 if ($reg->find(true)) {
238 * When silencing a user, silence all other users registered from that IP
241 * @param Profile $profile Person getting a new role
242 * @param string $role Role being assigned like 'moderator' or 'silenced'
244 * @return boolean hook value
246 function onEndGrantRole($profile, $role)
248 if (!self::$enabled) {
252 if ($role != Profile_role::SILENCED) {
256 if (!$this->silenced) {
260 $ri = Registration_ip::getKV('user_id', $profile->id);
266 $ids = Registration_ip::usersByIP($ri->ipaddress);
268 foreach ($ids as $id) {
269 if ($id == $profile->id) {
273 $other = Profile::getKV('id', $id);
279 if ($other->isSilenced()) {
283 $old = self::$enabled;
284 self::$enabled = false;
286 self::$enabled = $old;