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('GNUSOCIAL')) { exit(1); }
34 * Throttle registration by IP address
36 * We a) record IP address of registrants and b) throttle registrations.
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/
46 class RegisterThrottlePlugin extends Plugin
49 * Array of time spans in seconds to limits.
51 * Default is 3 registrations per hour, 5 per day, 10 per week.
53 public $regLimits = array(604800 => 10, // per week
54 86400 => 5, // per day
55 3600 => 3); // per hour
58 * Disallow registration if a silenced user has registered from
61 public $silenced = true;
64 * Whether we're enabled; prevents recursion.
66 static private $enabled = true;
69 * Database schema setup
71 * We store user registrations in a table registration_ip.
73 * @return boolean hook value; true means continue processing, false means stop.
75 public function onCheckSchema()
77 $schema = Schema::get();
79 // For storing user-submitted flags on profiles
80 $schema->ensureTable('registration_ip', Registration_ip::schemaDef());
85 * Called when someone tries to register.
87 * We check the IP here to determine if it goes over any of our
90 * @param Action $action Action that is being executed
92 * @return boolean hook value
94 public function onStartRegistrationTry(Action $action)
96 $ipaddress = $this->_getIpAddress();
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.'));
103 foreach ($this->regLimits as $seconds => $limit) {
105 $this->debug("Checking $seconds ($limit)");
107 $reg = $this->_getNthReg($ipaddress, $limit);
110 $this->debug("Got a {$limit}th registration.");
111 $regtime = strtotime($reg->created);
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.'));
121 // Check for silenced users
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.'));
138 * Called after someone registers, by any means.
140 * We record the successful registration and IP address.
142 * @param Profile $profile new user's profile
144 * @return boolean hook value
146 public function onEndUserRegister(Profile $profile)
148 $ipaddress = $this->_getIpAddress();
150 if (empty($ipaddress)) {
151 // User registration can happen from command-line scripts etc.
155 $reg = new Registration_ip();
157 $reg->user_id = $profile->id;
158 $reg->ipaddress = $ipaddress;
159 $reg->created = common_sql_now();
161 $result = $reg->insert();
163 if ($result === false) {
164 common_log_db_error($reg, 'INSERT', __FILE__);
165 // @todo throw an exception?
172 * Check the version of the plugin.
174 * @param array &$versions Version array.
176 * @return boolean hook value
178 public function onPluginVersion(array &$versions)
180 $versions[] = array('name' => 'RegisterThrottle',
181 'version' => GNUSOCIAL_VERSION,
182 'author' => 'Evan Prodromou',
183 'homepage' => 'http://status.net/wiki/Plugin:RegisterThrottle',
185 // TRANS: Plugin description.
186 _m('Throttles excessive registration from a single IP address.'));
191 * Gets the current IP address.
193 * @return string IP address or null if not found.
195 private function _getIpAddress()
197 $keys = array('HTTP_X_FORWARDED_FOR',
202 foreach ($keys as $k) {
203 if (!empty($_SERVER[$k])) {
212 * Gets the Nth registration with the given IP address.
214 * @param string $ipaddress Address to key on
215 * @param integer $n Nth address
217 * @return Registration_ip nth registration or null if not found.
219 private function _getNthReg($ipaddress, $n)
221 $reg = new Registration_ip();
223 $reg->ipaddress = $ipaddress;
225 $reg->orderBy('created DESC');
226 $reg->limit($n - 1, 1);
228 if ($reg->find(true)) {
236 * When silencing a user, silence all other users registered from that IP
239 * @param Profile $profile Person getting a new role
240 * @param string $role Role being assigned like 'moderator' or 'silenced'
242 * @return boolean hook value
244 public function onEndGrantRole(Profile $profile, $role)
246 if (!self::$enabled) {
250 if ($role != Profile_role::SILENCED) {
254 if (!$this->silenced) {
258 $ri = Registration_ip::getKV('user_id', $profile->id);
264 $ids = Registration_ip::usersByIP($ri->ipaddress);
266 foreach ($ids as $id) {
267 if ($id == $profile->id) {
271 $other = Profile::getKV('id', $id);
277 if ($other->isSilenced()) {
281 $old = self::$enabled;
282 self::$enabled = false;
284 self::$enabled = $old;