3 * StatusNet, the distributed open-source microblogging tool
5 * Plugin to limit number of users that can register (best for cloud providers)
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @copyright 2009 StatusNet Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
35 * Plugin to limit number of users that can register (best for cloud providers)
37 * For cloud providers whose freemium model is based on how many
38 * users can register. We use it on the StatusNet Cloud.
42 * @author Evan Prodromou <evan@status.net>
43 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
44 * @link http://status.net/
48 class UserLimitPlugin extends Plugin
50 public $maxUsers = null;
52 public function onStartUserRegister(Profile $profile)
54 $this->_checkMaxUsers();
59 * Called when someone tries to register.
61 * We check the IP here to determine if it goes over any of our
64 * @param Action $action Action that is being executed
66 * @return boolean hook value
68 function onStartRegistrationTry(Action $action)
70 $this->_checkMaxUsers();
74 function _checkMaxUsers()
76 if (!is_null($this->maxUsers)) {
81 if ($cnt >= $this->maxUsers) {
82 // TRANS: Error message given if creating a new user is not possible because a limit has been reached.
83 // TRANS: %d is the user limit (also available for plural).
84 $msg = sprintf(_m('Cannot register because the maximum number of users (%d) for this site was reached.',
85 'Cannot register because the maximum number of users (%d) for this site was reached.',
89 throw new ClientException($msg);
94 function onPluginVersion(array &$versions)
96 $versions[] = array('name' => 'UserLimit',
97 'version' => GNUSOCIAL_VERSION,
98 'author' => 'Evan Prodromou',
99 'homepage' => 'http://status.net/wiki/Plugin:UserLimit',
101 // TRANS: Plugin description.
102 _m('Limit the number of users who can register.'));