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 onStartAddEmailAddress($user, $email)
  56     {
  57         if (!$this->matchesWhitelist($email)) {
  58             // TRANS: Exception thrown when an e-mail address does not match the site's domain whitelist.
  59             throw new Exception(_('That email address is not allowed on this site.'));
  60         }
  61
  62         return true;
  63     }
  64
  65     function onEndValidateEmailInvite($user, $email, &$valid)
  66     {
  67         if ($valid) {
  68             $valid = $this->matchesWhitelist($email);
  69         }
  70
  71         return true;
  72     }
  73
  74     function matchesWhitelist($email)
  75     {
  76         $whitelist = $this->getWhitelist();
  77
  78         if (empty($whitelist)) {
  79             return true;
  80         }
  81
  82         $parts = explode('@', $email);
  83
  84         $userDomain = strtolower($parts[1]);
  85
  86         return in_array($userDomain, $whitelist);
  87     }
  88
  89     function getWhitelist()
  90     {
  91         $whitelist = common_config('email', 'whitelist');
  92
  93         if (is_array($whitelist)) {
  94             return $whitelist;
  95         } else {
  96             return explode('|', $whitelist);
  97         }
  98     }
  99
 100     function onPluginVersion(&$versions)
 101     {
 102         $versions[] = array('name' => 'DomainWhitelist',
 103                             'version' => STATUSNET_VERSION,
 104                             'author' => 'Evan Prodromou',
 105                             'homepage' => 'http://status.net/wiki/Plugin:DomainWhitelist',
 106                             'rawdescription' =>
 107                             // TRANS: Plugin description.
 108                             _m('Restrict domains for email users.'));
 109         return true;
 110     }
 111 }