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 public 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 public function onStartNoticeSave(Notice $notice)
100 $author = $notice->getProfile();
101 if (!$author->isLocal()) {
105 $user = $author->getUser();
106 if (!$this->validated($user)) {
107 // TRANS: Client exception thrown when trying to post notices before validating an e-mail address.
108 $msg = _m('You must validate your email address before posting.');
109 throw new ClientException($msg);
115 * Event handler for registration attempts; rejects the registration
116 * if email field is missing.
118 * @param Action $action Action being executed
120 * @return bool hook result code
122 function onStartRegisterUser(&$user, &$profile)
124 $email = $user->email;
127 // TRANS: Client exception thrown when trying to register without providing an e-mail address.
128 throw new ClientException(_m('You must provide an email address to register.'));
135 * Check if a user has a validated email address or has been
136 * otherwise grandfathered in.
138 * @param User $user User to valide
142 protected function validated(User $user)
144 // The email field is only stored after validation...
145 // Until then you'll find them in confirm_address.
146 $knownGood = !empty($user->email) ||
147 $this->grandfathered($user) ||
148 $this->hasTrustedOpenID($user);
150 // Give other plugins a chance to override, if they can validate
151 // that somebody's ok despite a non-validated email.
153 // @todo FIXME: This isn't how to do it! Use Start*/End* instead
154 Event::handle('RequireValidatedEmailPlugin_Override',
155 array($user, &$knownGood));
161 * Check if a user was created before the grandfathering cutoff.
162 * If so, we won't need to check for validation.
164 * @param User $user User to check
166 * @return bool true if user is grandfathered
168 protected function grandfathered(User $user)
170 if ($this->grandfatherCutoff) {
171 $created = strtotime($user->created . " GMT");
172 $cutoff = strtotime($this->grandfatherCutoff);
173 if ($created < $cutoff) {
181 * Override for RequireValidatedEmail plugin. If we have a user who's
182 * not validated an e-mail, but did come from a trusted provider,
183 * we'll consider them ok.
185 * @param User $user User to check
187 * @return bool true if user has a trusted OpenID.
189 function hasTrustedOpenID(User $user)
191 if ($this->trustedOpenIDs && class_exists('User_openid')) {
192 foreach ($this->trustedOpenIDs as $regex) {
193 $oid = new User_openid();
195 $oid->user_id = $user->id;
198 while ($oid->fetch()) {
199 if (preg_match($regex, $oid->canonical)) {
209 * Add version information for this plugin.
211 * @param array &$versions Array of associative arrays of version data
213 * @return boolean hook value
215 function onPluginVersion(array &$versions)
218 array('name' => 'Require Validated Email',
219 'version' => GNUSOCIAL_VERSION,
220 'author' => 'Craig Andrews, '.
224 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/RequireValidatedEmail',
226 // TRANS: Plugin description.
227 _m('Disables posting without a validated email address.'));
233 * Show an error message about validating user email before posting
235 * @param string $tag Current tab tag value
236 * @param Action $action action being shown
237 * @param Form $form object producing the form
239 * @return boolean hook value
241 function onStartMakeEntryForm($tag, $action, &$form)
243 $user = common_current_user();
245 if (!$this->validated($user)) {
246 $action->element('div', array('class'=>'error'), _m('You must validate an email address before posting!'));
253 * Prevent unvalidated folks from creating spam groups.
255 * @param Profile $profile User profile we're checking
256 * @param string $right rights key
257 * @param boolean $result if overriding, set to true/false has right
258 * @return boolean hook result value
260 function onUserRightsCheck(Profile $profile, $right, &$result)
262 if ($right == Right::CREATEGROUP ||
263 ($this->disallowLogin && ($right == Right::WEBLOGIN || $right == Right::API))) {
264 $user = User::getKV('id', $profile->id);
265 if ($user && !$this->validated($user)) {
273 function onLoginAction($action, &$login)
275 if ($action == 'confirmfirstemail') {