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                     $message = sprintf(_("Email address must be in this domain: %s"),
  62                                        $whitelist[0]);
  63                 } else {
  64                     $message = sprintf(_("Email address must be in one of these domains: %s"),
  65                                        implode(', ', $whitelist));
  66                 }
  67                 throw new ClientException($message);
  68             }
  69         }
  70         return true;
  71     }
  72
  73     function onStartAddEmailAddress($user, $email)
  74     {
  75         if (!$this->matchesWhitelist($email)) {
  76             // TRANS: Exception thrown when an e-mail address does not match the site's domain whitelist.
  77             throw new Exception(_('That email address is not allowed on this site.'));
  78         }
  79
  80         return true;
  81     }
  82
  83     function onEndValidateEmailInvite($user, $email, &$valid)
  84     {
  85         if ($valid) {
  86             $valid = $this->matchesWhitelist($email);
  87         }
  88
  89         return true;
  90     }
  91
  92     function matchesWhitelist($email)
  93     {
  94         $whitelist = $this->getWhitelist();
  95
  96         if (empty($whitelist)) {
  97             return true;
  98         }
  99
 100         $parts = explode('@', $email);
 101
 102         $userDomain = strtolower($parts[1]);
 103
 104         return in_array($userDomain, $whitelist);
 105     }
 106
 107     function getWhitelist()
 108     {
 109         $whitelist = common_config('email', 'whitelist');
 110
 111         if (is_array($whitelist)) {
 112             return $whitelist;
 113         } else {
 114             return explode('|', $whitelist);
 115         }
 116     }
 117
 118     function onPluginVersion(&$versions)
 119     {
 120         $versions[] = array('name' => 'DomainWhitelist',
 121                             'version' => STATUSNET_VERSION,
 122                             'author' => 'Evan Prodromou',
 123                             'homepage' => 'http://status.net/wiki/Plugin:DomainWhitelist',
 124                             'rawdescription' =>
 125                             // TRANS: Plugin description.
 126                             _m('Restrict domains for email users.'));
 127         return true;
 128     }
 129 }