3 * StatusNet, the distributed open-source microblogging tool
5 * Plugin that requires the user to have a validated email address before they
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.
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.
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/>.
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/
34 if (!defined('STATUSNET') && !defined('LACONICA')) {
39 * Plugin for requiring a validated email before posting.
41 * Enable this plugin using addPlugin('RequireValidatedEmail');
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/
54 class RequireValidatedEmailPlugin extends Plugin
57 * Users created before this time will be grandfathered in
58 * without the validation requirement.
60 public $grandfatherCutoff = null;
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.
67 * For example, to trust WikiHow and Wikipedia OpenID users:
69 * addPlugin('RequireValidatedEmailPlugin', array(
70 * 'trustedOpenIDs' => array(
71 * '!^http://\w+\.wikihow\.com/!',
72 * '!^http://\w+\.wikipedia\.org/!',
76 public $trustedOpenIDs = array();
79 * Whether or not to disallow login for unvalidated users.
81 public $disallowLogin = false;
83 function onRouterInitialized(URLMapper $m)
85 $m->connect('main/confirmfirst/:code',
86 array('action' => 'confirmfirstemail'));
91 * Event handler for notice saves; rejects the notice
92 * if user's address isn't validated.
94 * @param Notice $notice The notice being saved
96 * @return bool hook result code
98 function onStartNoticeSave(Notice $notice)
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);
112 * Event handler for registration attempts; rejects the registration
113 * if email field is missing.
115 * @param Action $action Action being executed
117 * @return bool hook result code
119 function onStartRegisterUser(User &$user, Profile &$profile)
121 $email = $user->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.'));
132 * Check if a user has a validated email address or has been
133 * otherwise grandfathered in.
135 * @param User $user User to valide
139 protected function validated(User $user)
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);
147 // Give other plugins a chance to override, if they can validate
148 // that somebody's ok despite a non-validated email.
150 // @todo FIXME: This isn't how to do it! Use Start*/End* instead
151 Event::handle('RequireValidatedEmailPlugin_Override',
152 array($user, &$knownGood));
158 * Check if a user was created before the grandfathering cutoff.
159 * If so, we won't need to check for validation.
161 * @param User $user User to check
163 * @return bool true if user is grandfathered
165 protected function grandfathered($user)
167 if ($this->grandfatherCutoff) {
168 $created = strtotime($user->created . " GMT");
169 $cutoff = strtotime($this->grandfatherCutoff);
170 if ($created < $cutoff) {
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.
182 * @param User $user User to check
184 * @return bool true if user has a trusted OpenID.
186 function hasTrustedOpenID($user)
188 if ($this->trustedOpenIDs && class_exists('User_openid')) {
189 foreach ($this->trustedOpenIDs as $regex) {
190 $oid = new User_openid();
192 $oid->user_id = $user->id;
195 while ($oid->fetch()) {
196 if (preg_match($regex, $oid->canonical)) {
206 * Add version information for this plugin.
208 * @param array &$versions Array of associative arrays of version data
210 * @return boolean hook value
212 function onPluginVersion(array &$versions)
215 array('name' => 'Require Validated Email',
216 'version' => GNUSOCIAL_VERSION,
217 'author' => 'Craig Andrews, '.
221 'http://status.net/wiki/Plugin:RequireValidatedEmail',
223 // TRANS: Plugin description.
224 _m('Disables posting without a validated email address.'));
230 * Show an error message about validating user email before posting
232 * @param string $tag Current tab tag value
233 * @param Action $action action being shown
234 * @param Form $form object producing the form
236 * @return boolean hook value
238 function onStartMakeEntryForm($tag, $action, &$form)
240 $user = common_current_user();
242 if (!$this->validated($user)) {
243 $action->element('div', array('class'=>'error'), _m('You must validate an email address before posting!'));
250 * Prevent unvalidated folks from creating spam groups.
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
257 function onUserRightsCheck(Profile $profile, $right, &$result)
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)) {
270 function onLoginAction($action, &$login)
272 if ($action == 'confirmfirstemail') {