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 const PLUGIN_VERSION = '2.0.0';
52 public $maxUsers = null;
54 public function onStartUserRegister(Profile $profile)
56 $this->_checkMaxUsers();
60 function onStartRegistrationTry($action)
62 $this->_checkMaxUsers();
66 function _checkMaxUsers()
68 if (!is_null($this->maxUsers)) {
73 if ($cnt >= $this->maxUsers) {
74 // TRANS: Error message given if creating a new user is not possible because a limit has been reached.
75 // TRANS: %d is the user limit (also available for plural).
76 $msg = sprintf(_m('Cannot register because the maximum number of users (%d) for this site was reached.',
77 'Cannot register because the maximum number of users (%d) for this site was reached.',
81 throw new ClientException($msg);
86 function onPluginVersion(array &$versions)
88 $versions[] = array('name' => 'UserLimit',
89 'version' => self::PLUGIN_VERSION,
90 'author' => 'Evan Prodromou',
91 'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/UserLimit',
93 // TRANS: Plugin description.
94 _m('Limit the number of users who can register.'));