plugins/DomainWhitelist/DomainWhitelistPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Restrict the email addresses in a domain to a select whitelist
   7  *
   8  * PHP version 5
   9  *
  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.
  14  *
  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.
  19  *
  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/>.
  22  *
  23  * @category  Cache
  24  * @package   StatusNet
  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/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Restrict the email addresses to a domain whitelist
  39  *
  40  * @category  General
  41  * @package   StatusNet
  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/
  46  */
  47 class DomainWhitelistPlugin extends Plugin
  48 {
  49     function onRequireValidatedEmailPlugin_Override($user, &$knownGood)
  50     {
  51         $knownGood = (!empty($user->email) && $this->matchesWhitelist($user->email));
  52         return true;
  53     }
  54
  55     function onEndValidateUserEmail($user, $email, &$valid)
  56     {
  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.'),
  64                                        $whitelist[0]);
  65                 } else {
  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));
  71                 }
  72                 throw new ClientException($message);
  73             }
  74         }
  75         return true;
  76     }
  77
  78     function onStartAddEmailAddress($user, $email)
  79     {
  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.'));
  83         }
  84
  85         return true;
  86     }
  87
  88     function onEndValidateEmailInvite($user, $email, &$valid)
  89     {
  90         if ($valid) {
  91             $valid = $this->matchesWhitelist($email);
  92         }
  93
  94         return true;
  95     }
  96
  97     function matchesWhitelist($email)
  98     {
  99         $whitelist = $this->getWhitelist();
 100
 101         if (empty($whitelist)) {
 102             return true;
 103         }
 104
 105         $parts = explode('@', $email);
 106
 107         $userDomain = strtolower($parts[1]);
 108
 109         return in_array($userDomain, $whitelist);
 110     }
 111
 112     function getWhitelist()
 113     {
 114         $whitelist = common_config('email', 'whitelist');
 115
 116         if (is_array($whitelist)) {
 117             return $whitelist;
 118         } else {
 119             return explode('|', $whitelist);
 120         }
 121     }
 122
 123     function onPluginVersion(&$versions)
 124     {
 125         $versions[] = array('name' => 'DomainWhitelist',
 126                             'version' => STATUSNET_VERSION,
 127                             'author' => 'Evan Prodromou',
 128                             'homepage' => 'http://status.net/wiki/Plugin:DomainWhitelist',
 129                             'rawdescription' =>
 130                             // TRANS: Plugin description.
 131                             _m('Restrict domains for email users.'));
 132         return true;
 133     }
 134 }