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  * @author    Mikael Nordfeldth <mmn@hethane.se>
  49  * @copyright 2009-2013 Free Software Foundation, Inc http://www.fsf.org
  50  * @copyright 2009-2010 StatusNet, Inc.
  51  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  52  * @link      http://status.net/
  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     public $grandfatherCutoff = null;
  61
  62     /**
  63      * If OpenID plugin is installed, users with a verified OpenID
  64      * association whose provider URL matches one of these regexes
  65      * will be considered to be sufficiently valid for our needs.
  66      *
  67      * For example, to trust WikiHow and Wikipedia OpenID users:
  68      *
  69      * addPlugin('RequireValidatedEmailPlugin', array(
  70      *    'trustedOpenIDs' => array(
  71      *        '!^http://\w+\.wikihow\.com/!',
  72      *        '!^http://\w+\.wikipedia\.org/!',
  73      *    ),
  74      * ));
  75      */
  76     public $trustedOpenIDs = array();
  77
  78     /**
  79      * Whether or not to disallow login for unvalidated users.
  80      */
  81     public $disallowLogin = false;
  82
  83     function onRouterInitialized($m)
  84     {
  85         $m->connect('main/confirmfirst/:code',
  86                     array('action' => 'confirmfirstemail'));
  87         return true;
  88     }
  89
  90     /**
  91      * Event handler for notice saves; rejects the notice
  92      * if user's address isn't validated.
  93      *
  94      * @param Notice $notice The notice being saved
  95      *
  96      * @return bool hook result code
  97      */
  98     function onStartNoticeSave($notice)
  99     {
 100         $user = User::getKV('id', $notice->profile_id);
 101         if (!empty($user)) { // it's a remote notice
 102             if (!$this->validated($user)) {
 103                 // TRANS: Client exception thrown when trying to post notices before validating an e-mail address.
 104                 $msg = _m('You must validate your email address before posting.');
 105                 throw new ClientException($msg);
 106             }
 107         }
 108         return true;
 109     }
 110
 111     /**
 112      * Event handler for registration attempts; rejects the registration
 113      * if email field is missing.
 114      *
 115      * @param Action $action Action being executed
 116      *
 117      * @return bool hook result code
 118      */
 119     function onStartRegisterUser(&$user, &$profile)
 120     {
 121         $email = $user->email;
 122
 123         if (empty($email)) {
 124             // TRANS: Client exception thrown when trying to register without providing an e-mail address.
 125             throw new ClientException(_m('You must provide an email address to register.'));
 126         }
 127
 128         return true;
 129     }
 130
 131     /**
 132      * Check if a user has a validated email address or has been
 133      * otherwise grandfathered in.
 134      *
 135      * @param User $user User to valide
 136      *
 137      * @return bool
 138      */
 139     protected function validated($user)
 140     {
 141         // The email field is only stored after validation...
 142         // Until then you'll find them in confirm_address.
 143         $knownGood = !empty($user->email) ||
 144           $this->grandfathered($user) ||
 145           $this->hasTrustedOpenID($user);
 146
 147         // Give other plugins a chance to override, if they can validate
 148         // that somebody's ok despite a non-validated email.
 149
 150         // @todo FIXME: This isn't how to do it! Use Start*/End* instead
 151         Event::handle('RequireValidatedEmailPlugin_Override',
 152                       array($user, &$knownGood));
 153
 154         return $knownGood;
 155     }
 156
 157     /**
 158      * Check if a user was created before the grandfathering cutoff.
 159      * If so, we won't need to check for validation.
 160      *
 161      * @param User $user User to check
 162      *
 163      * @return bool true if user is grandfathered
 164      */
 165     protected function grandfathered($user)
 166     {
 167         if ($this->grandfatherCutoff) {
 168             $created = strtotime($user->created . " GMT");
 169             $cutoff  = strtotime($this->grandfatherCutoff);
 170             if ($created < $cutoff) {
 171                 return true;
 172             }
 173         }
 174         return false;
 175     }
 176
 177     /**
 178      * Override for RequireValidatedEmail plugin. If we have a user who's
 179      * not validated an e-mail, but did come from a trusted provider,
 180      * we'll consider them ok.
 181      *
 182      * @param User $user User to check
 183      *
 184      * @return bool true if user has a trusted OpenID.
 185      */
 186     function hasTrustedOpenID($user)
 187     {
 188         if ($this->trustedOpenIDs && class_exists('User_openid')) {
 189             foreach ($this->trustedOpenIDs as $regex) {
 190                 $oid = new User_openid();
 191
 192                 $oid->user_id = $user->id;
 193
 194                 $oid->find();
 195                 while ($oid->fetch()) {
 196                     if (preg_match($regex, $oid->canonical)) {
 197                         return true;
 198                     }
 199                 }
 200             }
 201         }
 202         return false;
 203     }
 204
 205     /**
 206      * Add version information for this plugin.
 207      *
 208      * @param array &$versions Array of associative arrays of version data
 209      *
 210      * @return boolean hook value
 211      */
 212     function onPluginVersion(array &$versions)
 213     {
 214         $versions[] =
 215           array('name' => 'Require Validated Email',
 216                 'version' => GNUSOCIAL_VERSION,
 217                 'author' => 'Craig Andrews, '.
 218                 'Evan Prodromou, '.
 219                 'Brion Vibber',
 220                 'homepage' =>
 221                 'http://status.net/wiki/Plugin:RequireValidatedEmail',
 222                 'rawdescription' =>
 223                 // TRANS: Plugin description.
 224                 _m('Disables posting without a validated email address.'));
 225
 226         return true;
 227     }
 228
 229     /**
 230      * Show an error message about validating user email before posting
 231      *
 232      * @param string $tag    Current tab tag value
 233      * @param Action $action action being shown
 234      * @param Form   $form   object producing the form
 235      *
 236      * @return boolean hook value
 237      */
 238     function onStartMakeEntryForm($tag, $action, &$form)
 239     {
 240         $user = common_current_user();
 241         if (!empty($user)) {
 242             if (!$this->validated($user)) {
 243                 $action->element('div', array('class'=>'error'), _m('You must validate an email address before posting!'));
 244             }
 245         }
 246         return true;
 247     }
 248
 249     /**
 250      * Prevent unvalidated folks from creating spam groups.
 251      *
 252      * @param Profile $profile User profile we're checking
 253      * @param string $right rights key
 254      * @param boolean $result if overriding, set to true/false has right
 255      * @return boolean hook result value
 256      */
 257     function onUserRightsCheck(Profile $profile, $right, &$result)
 258     {
 259         if ($right == Right::CREATEGROUP ||
 260             ($this->disallowLogin && ($right == Right::WEBLOGIN || $right == Right::API))) {
 261             $user = User::getKV('id', $profile->id);
 262             if ($user && !$this->validated($user)) {
 263                 $result = false;
 264                 return false;
 265             }
 266         }
 267         return true;
 268     }
 269
 270     function onLoginAction($action, &$login)
 271     {
 272         if ($action == 'confirmfirstemail') {
 273             $login = true;
 274             return false;
 275         }
 276         return true;
 277     }
 278 }