plugins/RequireValidatedEmail/RequireValidatedEmailPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin that requires the user to have a validated email address before they can post notices
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  24  * @author    Craig Andrews <candrews@integralblue.com>, Brion Vibber <brion@status.net>
  25  * @copyright 2009 Craig Andrews http://candrews.integralblue.com
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 class RequireValidatedEmailPlugin extends Plugin
  35 {
  36     // Users created before this time will be grandfathered in
  37     // without the validation requirement.
  38     public $grandfatherCutoff=null;
  39
  40     function __construct()
  41     {
  42         parent::__construct();
  43     }
  44
  45     /**
  46      * Event handler for notice saves; rejects the notice
  47      * if user's address isn't validated.
  48      *
  49      * @param Notice $notice
  50      * @return bool hook result code
  51      */
  52     function onStartNoticeSave($notice)
  53     {
  54         $user = User::staticGet('id', $notice->profile_id);
  55         if (!empty($user)) { // it's a remote notice
  56             if (!$this->validated($user)) {
  57                 throw new ClientException(_("You must validate your email address before posting."));
  58             }
  59         }
  60         return true;
  61     }
  62
  63     /**
  64      * Check if a user has a validated email address or has been
  65      * otherwise grandfathered in.
  66      *
  67      * @param User $user
  68      * @return bool
  69      */
  70     protected function validated($user)
  71     {
  72         if ($this->grandfathered($user)) {
  73             return true;
  74         }
  75
  76         // The email field is only stored after validation...
  77         // Until then you'll find them in confirm_address.
  78         return !empty($user->email);
  79     }
  80
  81     /**
  82      * Check if a user was created before the grandfathering cutoff.
  83      * If so, we won't need to check for validation.
  84      *
  85      * @param User $user
  86      * @return bool
  87      */
  88     protected function grandfathered($user)
  89     {
  90         if ($this->grandfatherCutoff) {
  91             $created = strtotime($user->created . " GMT");
  92             $cutoff = strtotime($this->grandfatherCutoff);
  93             if ($created < $cutoff) {
  94                 return true;
  95             }
  96         }
  97         return false;
  98     }
  99 }
 100