3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2011, StatusNet, Inc.
6 * Restrict the email addresses in a domain to a select whitelist
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 2011 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('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
38 * Restrict the email addresses to a domain whitelist
42 * @author Evan Prodromou <evan@status.net>
43 * @copyright 2011 StatusNet, Inc.
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
45 * @link http://status.net/
48 class DomainWhitelistPlugin extends Plugin
50 function onRequireValidatedEmailPlugin_Override($user, &$knownGood)
52 $knownGood = (!empty($user->email) && $this->matchesWhitelist($user->email));
56 function onStartAddEmailAddress($user, $email)
58 if (!$this->matchesWhitelist($email)) {
59 throw new Exception(_('That email address is not allowed on this site.'));
65 function onEndValidateEmailInvite($user, $email, &$valid)
68 $valid = $this->matchesWhitelist($email);
74 function matchesWhitelist($email)
76 $whitelist = $this->getWhitelist();
78 if (empty($whitelist)) {
82 $parts = explode('@', $email);
84 $userDomain = strtolower($parts[1]);
86 return in_array($userDomain, $whitelist);
89 function getWhitelist()
91 $whitelist = common_config('email', 'whitelist');
93 if (is_array($whitelist)) {
96 return explode('|', $whitelist);
100 function onPluginVersion(&$versions)
102 $versions[] = array('name' => 'DomainWhitelist',
103 'version' => STATUSNET_VERSION,
104 'author' => 'Evan Prodromou',
105 'homepage' => 'http://status.net/wiki/Plugin:DomainWhitelist',
107 _m('Restrict domains for email users'));