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
   6  * can post notices
   7  *
   8  * PHP version 5
   9  *
  10  * LICENCE: 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  Plugin
  24  * @package   StatusNet
  25  * @author    Craig Andrews <candrews@integralblue.com>
  26  * @author    Brion Vibber <brion@status.net>
  27  * @author    Evan Prodromou <evan@status.net>
  28  * @copyright 2011 StatusNet Inc. http://status.net/
  29  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  30  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  31  * @link      http://status.net/
  32  */
  33
  34 if (!defined('STATUSNET') && !defined('LACONICA')) {
  35     exit(1);
  36 }
  37
  38 /**
  39  * Plugin for requiring a validated email before posting.
  40  *
  41  * Enable this plugin using addPlugin('RequireValidatedEmail');
  42  *
  43  * @category  Plugin
  44  * @package   StatusNet
  45  * @author    Craig Andrews <candrews@integralblue.com>
  46  * @author    Brion Vibber <brion@status.net>
  47  * @author    Evan Prodromou <evan@status.net>
  48  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  49  * @copyright 2009-2010 StatusNet, Inc.
  50  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  51  * @link      http://status.net/
  52  */
  53
  54 class RequireValidatedEmailPlugin extends Plugin
  55 {
  56     /**
  57      * Users created before this time will be grandfathered in
  58      * without the validation requirement.
  59      */
  60
  61     public $grandfatherCutoff = null;
  62
  63     /**
  64      * If OpenID plugin is installed, users with a verified OpenID
  65      * association whose provider URL matches one of these regexes
  66      * will be considered to be sufficiently valid for our needs.
  67      *
  68      * For example, to trust WikiHow and Wikipedia OpenID users:
  69      *
  70      * addPlugin('RequireValidatedEmailPlugin', array(
  71      *    'trustedOpenIDs' => array(
  72      *        '!^http://\w+\.wikihow\.com/!',
  73      *        '!^http://\w+\.wikipedia\.org/!',
  74      *    ),
  75      * ));
  76      */
  77
  78     public $trustedOpenIDs = array();
  79
  80     /**
  81      * Whether or not to disallow login for unvalidated users.
  82      */
  83
  84     public $disallowLogin = false;
  85
  86     function onAutoload($cls)
  87     {
  88         $dir = dirname(__FILE__);
  89
  90         switch ($cls)
  91         {
  92         case 'ConfirmfirstemailAction':
  93             include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
  94             return false;
  95         default:
  96             return true;
  97         }
  98     }
  99
 100     function onRouterInitialized($m)
 101     {
 102         $m->connect('main/confirmfirst/:code',
 103                     array('action' => 'confirmfirstemail'));
 104         return true;
 105     }
 106
 107     /**
 108      * Event handler for notice saves; rejects the notice
 109      * if user's address isn't validated.
 110      *
 111      * @param Notice $notice The notice being saved
 112      *
 113      * @return bool hook result code
 114      */
 115
 116     function onStartNoticeSave($notice)
 117     {
 118         $user = User::staticGet('id', $notice->profile_id);
 119         if (!empty($user)) { // it's a remote notice
 120             if (!$this->validated($user)) {
 121                 $msg = _m("You must validate your email address before posting.");
 122                 throw new ClientException($msg);
 123             }
 124         }
 125         return true;
 126     }
 127
 128     /**
 129      * Event handler for registration attempts; rejects the registration
 130      * if email field is missing.
 131      *
 132      * @param Action $action Action being executed
 133      *
 134      * @return bool hook result code
 135      */
 136     function onStartRegistrationTry($action)
 137     {
 138         $email = $action->trimmed('email');
 139
 140         if (empty($email)) {
 141             $action->showForm(_m('You must provide an email address to register.'));
 142             return false;
 143         }
 144
 145         // Default form will run address format validation and reject if bad.
 146
 147         return true;
 148     }
 149
 150     /**
 151      * Event handler for registration attempts; rejects the registration
 152      * if email field is missing.
 153      *
 154      * @param Action $action Action being executed
 155      *
 156      * @return bool hook result code
 157      */
 158
 159     function onStartRegisterUser(&$user, &$profile)
 160     {
 161         $email = $user->email;
 162
 163         if (empty($email)) {
 164             throw new ClientException(_m('You must provide an email address to register.'));
 165         }
 166
 167         return true;
 168     }
 169
 170     /**
 171      * Check if a user has a validated email address or has been
 172      * otherwise grandfathered in.
 173      *
 174      * @param User $user User to valide
 175      *
 176      * @return bool
 177      */
 178     protected function validated($user)
 179     {
 180         // The email field is only stored after validation...
 181         // Until then you'll find them in confirm_address.
 182         $knownGood = !empty($user->email) ||
 183           $this->grandfathered($user) ||
 184           $this->hasTrustedOpenID($user);
 185
 186         // Give other plugins a chance to override, if they can validate
 187         // that somebody's ok despite a non-validated email.
 188
 189         // FIXME: This isn't how to do it! Use Start*/End* instead
 190
 191         Event::handle('RequireValidatedEmailPlugin_Override',
 192                       array($user, &$knownGood));
 193
 194         return $knownGood;
 195     }
 196
 197     /**
 198      * Check if a user was created before the grandfathering cutoff.
 199      * If so, we won't need to check for validation.
 200      *
 201      * @param User $user User to check
 202      *
 203      * @return bool true if user is grandfathered
 204      */
 205     protected function grandfathered($user)
 206     {
 207         if ($this->grandfatherCutoff) {
 208             $created = strtotime($user->created . " GMT");
 209             $cutoff  = strtotime($this->grandfatherCutoff);
 210             if ($created < $cutoff) {
 211                 return true;
 212             }
 213         }
 214         return false;
 215     }
 216
 217     /**
 218      * Override for RequireValidatedEmail plugin. If we have a user who's
 219      * not validated an e-mail, but did come from a trusted provider,
 220      * we'll consider them ok.
 221      *
 222      * @param User $user User to check
 223      *
 224      * @return bool true if user has a trusted OpenID.
 225      */
 226
 227     function hasTrustedOpenID($user)
 228     {
 229         if ($this->trustedOpenIDs && class_exists('User_openid')) {
 230             foreach ($this->trustedOpenIDs as $regex) {
 231                 $oid = new User_openid();
 232
 233                 $oid->user_id = $user->id;
 234
 235                 $oid->find();
 236                 while ($oid->fetch()) {
 237                     if (preg_match($regex, $oid->canonical)) {
 238                         return true;
 239                     }
 240                 }
 241             }
 242         }
 243         return false;
 244     }
 245
 246     /**
 247      * Add version information for this plugin.
 248      *
 249      * @param array &$versions Array of associative arrays of version data
 250      *
 251      * @return boolean hook value
 252      */
 253
 254     function onPluginVersion(&$versions)
 255     {
 256         $versions[] =
 257           array('name' => 'Require Validated Email',
 258                 'version' => STATUSNET_VERSION,
 259                 'author' => 'Craig Andrews, '.
 260                 'Evan Prodromou, '.
 261                 'Brion Vibber',
 262                 'homepage' =>
 263                 'http://status.net/wiki/Plugin:RequireValidatedEmail',
 264                 'rawdescription' =>
 265                 _m('Disables posting without a validated email address.'));
 266         return true;
 267     }
 268
 269     /**
 270      * Hide the notice form if the user isn't able to post.
 271      *
 272      * @param Action $action action being shown
 273      *
 274      * @return boolean hook value
 275      */
 276
 277     function onStartShowNoticeForm($action)
 278     {
 279         $user = common_current_user();
 280         if (!empty($user)) { // it's a remote notice
 281             if (!$this->validated($user)) {
 282                 return false;
 283             }
 284         }
 285         return true;
 286     }
 287
 288     /**
 289      * Prevent unvalidated folks from creating spam groups.
 290      *
 291      * @param Profile $profile User profile we're checking
 292      * @param string $right rights key
 293      * @param boolean $result if overriding, set to true/false has right
 294      * @return boolean hook result value
 295      */
 296     function onUserRightsCheck(Profile $profile, $right, &$result)
 297     {
 298         if ($right == Right::CREATEGROUP ||
 299             ($this->disallowLogin && ($right == Right::WEBLOGIN || $right == Right::API))) {
 300             $user = User::staticGet('id', $profile->id);
 301             if ($user && !$this->validated($user)) {
 302                 $result = false;
 303                 return false;
 304             }
 305         }
 306         return true;
 307     }
 308
 309     function onLoginAction($action, &$login)
 310     {
 311         if ($action == 'confirmfirstemail') {
 312             $login = true;
 313             return false;
 314         }
 315         return true;
 316     }
 317 }