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 onAutoload($cls)
  84     {
  85         $dir = dirname(__FILE__);
  86
  87         switch ($cls)
  88         {
  89         case 'ConfirmfirstemailAction':
  90             include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
  91             return false;
  92         default:
  93             return true;
  94         }
  95     }
  96
  97     function onRouterInitialized($m)
  98     {
  99         $m->connect('main/confirmfirst/:code',
 100                     array('action' => 'confirmfirstemail'));
 101         return true;
 102     }
 103
 104     /**
 105      * Event handler for notice saves; rejects the notice
 106      * if user's address isn't validated.
 107      *
 108      * @param Notice $notice The notice being saved
 109      *
 110      * @return bool hook result code
 111      */
 112     function onStartNoticeSave($notice)
 113     {
 114         $user = User::getKV('id', $notice->profile_id);
 115         if (!empty($user)) { // it's a remote notice
 116             if (!$this->validated($user)) {
 117                 // TRANS: Client exception thrown when trying to post notices before validating an e-mail address.
 118                 $msg = _m('You must validate your email address before posting.');
 119                 throw new ClientException($msg);
 120             }
 121         }
 122         return true;
 123     }
 124
 125     /**
 126      * Event handler for registration attempts; rejects the registration
 127      * if email field is missing.
 128      *
 129      * @param Action $action Action being executed
 130      *
 131      * @return bool hook result code
 132      */
 133     function onStartRegisterUser(&$user, &$profile)
 134     {
 135         $email = $user->email;
 136
 137         if (empty($email)) {
 138             // TRANS: Client exception thrown when trying to register without providing an e-mail address.
 139             throw new ClientException(_m('You must provide an email address to register.'));
 140         }
 141
 142         return true;
 143     }
 144
 145     /**
 146      * Check if a user has a validated email address or has been
 147      * otherwise grandfathered in.
 148      *
 149      * @param User $user User to valide
 150      *
 151      * @return bool
 152      */
 153     protected function validated($user)
 154     {
 155         // The email field is only stored after validation...
 156         // Until then you'll find them in confirm_address.
 157         $knownGood = !empty($user->email) ||
 158           $this->grandfathered($user) ||
 159           $this->hasTrustedOpenID($user);
 160
 161         // Give other plugins a chance to override, if they can validate
 162         // that somebody's ok despite a non-validated email.
 163
 164         // @todo FIXME: This isn't how to do it! Use Start*/End* instead
 165         Event::handle('RequireValidatedEmailPlugin_Override',
 166                       array($user, &$knownGood));
 167
 168         return $knownGood;
 169     }
 170
 171     /**
 172      * Check if a user was created before the grandfathering cutoff.
 173      * If so, we won't need to check for validation.
 174      *
 175      * @param User $user User to check
 176      *
 177      * @return bool true if user is grandfathered
 178      */
 179     protected function grandfathered($user)
 180     {
 181         if ($this->grandfatherCutoff) {
 182             $created = strtotime($user->created . " GMT");
 183             $cutoff  = strtotime($this->grandfatherCutoff);
 184             if ($created < $cutoff) {
 185                 return true;
 186             }
 187         }
 188         return false;
 189     }
 190
 191     /**
 192      * Override for RequireValidatedEmail plugin. If we have a user who's
 193      * not validated an e-mail, but did come from a trusted provider,
 194      * we'll consider them ok.
 195      *
 196      * @param User $user User to check
 197      *
 198      * @return bool true if user has a trusted OpenID.
 199      */
 200     function hasTrustedOpenID($user)
 201     {
 202         if ($this->trustedOpenIDs && class_exists('User_openid')) {
 203             foreach ($this->trustedOpenIDs as $regex) {
 204                 $oid = new User_openid();
 205
 206                 $oid->user_id = $user->id;
 207
 208                 $oid->find();
 209                 while ($oid->fetch()) {
 210                     if (preg_match($regex, $oid->canonical)) {
 211                         return true;
 212                     }
 213                 }
 214             }
 215         }
 216         return false;
 217     }
 218
 219     /**
 220      * Add version information for this plugin.
 221      *
 222      * @param array &$versions Array of associative arrays of version data
 223      *
 224      * @return boolean hook value
 225      */
 226     function onPluginVersion(&$versions)
 227     {
 228         $versions[] =
 229           array('name' => 'Require Validated Email',
 230                 'version' => STATUSNET_VERSION,
 231                 'author' => 'Craig Andrews, '.
 232                 'Evan Prodromou, '.
 233                 'Brion Vibber',
 234                 'homepage' =>
 235                 'http://status.net/wiki/Plugin:RequireValidatedEmail',
 236                 'rawdescription' =>
 237                 // TRANS: Plugin description.
 238                 _m('Disables posting without a validated email address.'));
 239
 240         return true;
 241     }
 242
 243     /**
 244      * Show an error message about validating user email before posting
 245      *
 246      * @param string $tag    Current tab tag value
 247      * @param Action $action action being shown
 248      * @param Form   $form   object producing the form
 249      *
 250      * @return boolean hook value
 251      */
 252     function onStartMakeEntryForm($tag, $action, &$form)
 253     {
 254         $user = common_current_user();
 255         if (!empty($user)) {
 256             if (!$this->validated($user)) {
 257                 $action->element('div', array('class'=>'error'), _m('You must validate an email address before posting!'));
 258             }
 259         }
 260         return true;
 261     }
 262
 263     /**
 264      * Prevent unvalidated folks from creating spam groups.
 265      *
 266      * @param Profile $profile User profile we're checking
 267      * @param string $right rights key
 268      * @param boolean $result if overriding, set to true/false has right
 269      * @return boolean hook result value
 270      */
 271     function onUserRightsCheck(Profile $profile, $right, &$result)
 272     {
 273         if ($right == Right::CREATEGROUP ||
 274             ($this->disallowLogin && ($right == Right::WEBLOGIN || $right == Right::API))) {
 275             $user = User::getKV('id', $profile->id);
 276             if ($user && !$this->validated($user)) {
 277                 $result = false;
 278                 return false;
 279             }
 280         }
 281         return true;
 282     }
 283
 284     function onLoginAction($action, &$login)
 285     {
 286         if ($action == 'confirmfirstemail') {
 287             $login = true;
 288             return false;
 289         }
 290         return true;
 291     }
 292 }