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/
47 class DomainWhitelistPlugin extends Plugin
49 function onRequireValidatedEmailPlugin_Override($user, &$knownGood)
51 $knownGood = (!empty($user->email) && $this->matchesWhitelist($user->email));
55 function onEndValidateUserEmail($user, $email, &$valid)
57 if ($valid) { // it's otherwise valid
58 if (!$this->matchesWhitelist($email)) {
59 $whitelist = $this->getWhitelist();
60 if (count($whitelist) == 1) {
61 // TRANS: Client exception thrown when a given e-mailaddress is not in the domain whitelist.
62 // TRANS: %s is a whitelisted e-mail domain.
63 $message = sprintf(_m('Email address must be in this domain: %s.'),
66 // TRANS: Client exception thrown when a given e-mailaddress is not in the domain whitelist.
67 // TRANS: %s are whitelisted e-mail domains separated by comma's (localisable).
68 $message = sprintf(_('Email address must be in one of these domains: %s.'),
69 // TRANS: Separator for whitelisted domains.
70 implode(_m('SEPARATOR',', '), $whitelist));
72 throw new ClientException($message);
78 function onStartAddEmailAddress($user, $email)
80 if (!$this->matchesWhitelist($email)) {
81 // TRANS: Exception thrown when an e-mail address does not match the site's domain whitelist.
82 throw new Exception(_('That email address is not allowed on this site.'));
88 function onEndValidateEmailInvite($user, $email, &$valid)
91 $valid = $this->matchesWhitelist($email);
97 function matchesWhitelist($email)
99 $whitelist = $this->getWhitelist();
101 if (empty($whitelist) || empty($whitelist[0])) {
105 $parts = explode('@', $email);
107 $userDomain = strtolower(trim($parts[1]));
109 return in_array($userDomain, $whitelist);
112 function getWhitelist()
114 $whitelist = common_config('email', 'whitelist');
116 if (is_array($whitelist)) {
119 return explode('|', $whitelist);
123 function onPluginVersion(&$versions)
125 $versions[] = array('name' => 'DomainWhitelist',
126 'version' => STATUSNET_VERSION,
127 'author' => 'Evan Prodromou',
128 'homepage' => 'http://status.net/wiki/Plugin:DomainWhitelist',
130 // TRANS: Plugin description.
131 _m('Restrict domains for email users.'));