]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/UserLimit/UserLimitPlugin.php
Maximum character limit with utf8mb4 is 191 in varchar
[quix0rs-gnu-social.git] / plugins / UserLimit / UserLimitPlugin.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Plugin to limit number of users that can register (best for cloud providers)
6  *
7  * PHP version 5
8  *
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.
13  *
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.
18  *
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/>.
21  *
22  * @category  Action
23  * @package   StatusNet
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/
28  */
29
30 if (!defined('STATUSNET')) {
31     exit(1);
32 }
33
34 /**
35  * Plugin to limit number of users that can register (best for cloud providers)
36  *
37  * For cloud providers whose freemium model is based on how many
38  * users can register. We use it on the StatusNet Cloud.
39  *
40  * @category Plugin
41  * @package  StatusNet
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/
45  *
46  * @seeAlso  Location
47  */
48 class UserLimitPlugin extends Plugin
49 {
50     public $maxUsers = null;
51
52     public function onStartUserRegister(Profile $profile)
53     {
54         $this->_checkMaxUsers();
55         return true;
56     }
57
58     function onStartRegistrationTry($action)
59     {
60         $this->_checkMaxUsers();
61         return true;
62     }
63
64     function _checkMaxUsers()
65     {
66         if (!is_null($this->maxUsers)) {
67             $cls = new User();
68
69             $cnt = $cls->count();
70
71             if ($cnt >= $this->maxUsers) {
72                 // TRANS: Error message given if creating a new user is not possible because a limit has been reached.
73                 // TRANS: %d is the user limit (also available for plural).
74                 $msg = sprintf(_m('Cannot register because the maximum number of users (%d) for this site was reached.',
75                                   'Cannot register because the maximum number of users (%d) for this site was reached.',
76                                   $this->maxUsers),
77                                $this->maxUsers);
78
79                 throw new ClientException($msg);
80             }
81         }
82     }
83
84     function onPluginVersion(array &$versions)
85     {
86         $versions[] = array('name' => 'UserLimit',
87                             'version' => GNUSOCIAL_VERSION,
88                             'author' => 'Evan Prodromou',
89                             'homepage' => 'http://status.net/wiki/Plugin:UserLimit',
90                             'description' =>
91                             // TRANS: Plugin description.
92                             _m('Limit the number of users who can register.'));
93         return true;
94     }
95 }