1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
<?php
/**
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2010, StatusNet, Inc.
*
* Throttle registration by IP address
*
* PHP version 5
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Spam
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
if (!defined('STATUSNET')) {
exit(1);
}
/**
* Throttle registration by IP address
*
* We a) record IP address of registrants and b) throttle registrations.
*
* @category Spam
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
class RegisterThrottlePlugin extends Plugin
{
/**
* Array of time spans in seconds to limits.
*
* Default is 3 registrations per hour, 5 per day, 10 per week.
*/
public $regLimits = array(604800 => 10, // per week
86400 => 5, // per day
3600 => 3); // per hour
/**
* Database schema setup
*
* We store user registrations in a table registration_ip.
*
* @return boolean hook value; true means continue processing, false means stop.
*/
function onCheckSchema()
{
$schema = Schema::get();
// For storing user-submitted flags on profiles
$schema->ensureTable('registration_ip',
array(new ColumnDef('user_id', 'integer', null,
false, 'PRI'),
new ColumnDef('ipaddress', 'varchar', 15, false, 'MUL'),
new ColumnDef('created', 'timestamp', null, false, 'MUL')));
return true;
}
/**
* Load related modules when needed
*
* @param string $cls Name of the class to be loaded
*
* @return boolean hook value; true means continue processing, false means stop.
*/
function onAutoload($cls)
{
$dir = dirname(__FILE__);
switch ($cls)
{
case 'Registration_ip':
include_once $dir . '/'.$cls.'.php';
return false;
default:
return true;
}
}
/**
* Called when someone tries to register.
*
* We check the IP here to determine if it goes over any of our
* configured limits.
*
* @param Action $action Action that is being executed
*
* @return boolean hook value
*
*/
function onStartRegistrationTry($action)
{
$ipaddress = $this->_getIpAddress();
if (empty($ipaddress)) {
throw new ServerException(_m('Cannot find IP address.'));
}
foreach ($this->regLimits as $seconds => $limit) {
$this->debug("Checking $seconds ($limit)");
$reg = $this->_getNthReg($ipaddress, $limit);
if (!empty($reg)) {
$this->debug("Got a {$limit}th registration.");
$regtime = strtotime($reg->created);
$now = time();
$this->debug("Comparing {$regtime} to {$now}");
if ($now - $regtime < $seconds) {
throw new Exception(_m("Too many registrations. Take a break and try again later."));
}
}
}
return true;
}
/**
* Called after someone registers.
*
* We record the successful registration and IP address.
*
* @param Action $action Action that is being executed
*
* @return boolean hook value
*
*/
function onEndRegistrationTry($action)
{
$ipaddress = $this->_getIpAddress();
if (empty($ipaddress)) {
throw new ServerException(_m('Cannot find IP address.'));
}
$user = common_current_user();
if (empty($user)) {
throw new ServerException(_m('Cannot find user after successful registration.'));
}
$reg = new Registration_ip();
$reg->user_id = $user->id;
$reg->ipaddress = $ipaddress;
$result = $reg->insert();
if (!$result) {
common_log_db_error($reg, 'INSERT', __FILE__);
// @todo throw an exception?
}
return true;
}
/**
* Check the version of the plugin.
*
* @param array &$versions Version array.
*
* @return boolean hook value
*/
function onPluginVersion(&$versions)
{
$versions[] = array('name' => 'RegisterThrottle',
'version' => STATUSNET_VERSION,
'author' => 'Evan Prodromou',
'homepage' => 'http://status.net/wiki/Plugin:RegisterThrottle',
'description' =>
_m('Throttles excessive registration from a single IP address.'));
return true;
}
/**
* Gets the current IP address.
*
* @return string IP address or null if not found.
*/
private function _getIpAddress()
{
$keys = array('HTTP_X_FORWARDED_FOR',
'CLIENT-IP',
'REMOTE_ADDR');
foreach ($keys as $k) {
if (!empty($_SERVER[$k])) {
return $_SERVER[$k];
}
}
return null;
}
/**
* Gets the Nth registration with the given IP address.
*
* @param string $ipaddress Address to key on
* @param integer $n Nth address
*
* @return Registration_ip nth registration or null if not found.
*/
private function _getNthReg($ipaddress, $n)
{
$reg = new Registration_ip();
$reg->ipaddress = $ipaddress;
$reg->orderBy('created DESC');
$reg->limit($n - 1, 1);
if ($reg->find(true)) {
return $reg;
} else {
return null;
}
}
}
|
