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 * @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/
53 class RequireValidatedEmailPlugin extends Plugin
56 * Users created before this time will be grandfathered in
57 * without the validation requirement.
59 public $grandfatherCutoff = null;
62 * If OpenID plugin is installed, users with a verified OpenID
63 * association whose provider URL matches one of these regexes
64 * will be considered to be sufficiently valid for our needs.
66 * For example, to trust WikiHow and Wikipedia OpenID users:
68 * addPlugin('RequireValidatedEmailPlugin', array(
69 * 'trustedOpenIDs' => array(
70 * '!^http://\w+\.wikihow\.com/!',
71 * '!^http://\w+\.wikipedia\.org/!',
75 public $trustedOpenIDs = array();
78 * Whether or not to disallow login for unvalidated users.
80 public $disallowLogin = false;
82 function onAutoload($cls)
84 $dir = dirname(__FILE__);
88 case 'ConfirmfirstemailAction':
89 include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
96 function onRouterInitialized($m)
98 $m->connect('main/confirmfirst/:code',
99 array('action' => 'confirmfirstemail'));
104 * Event handler for notice saves; rejects the notice
105 * if user's address isn't validated.
107 * @param Notice $notice The notice being saved
109 * @return bool hook result code
111 function onStartNoticeSave($notice)
113 $user = User::staticGet('id', $notice->profile_id);
114 if (!empty($user)) { // it's a remote notice
115 if (!$this->validated($user)) {
116 // TRANS: Client exception thrown when trying to post notices before validating an e-mail address.
117 $msg = _m('You must validate your email address before posting.');
118 throw new ClientException($msg);
125 * Event handler for registration attempts; rejects the registration
126 * if email field is missing.
128 * @param Action $action Action being executed
130 * @return bool hook result code
132 function onStartRegisterUser(&$user, &$profile)
134 $email = $user->email;
137 // TRANS: Client exception thrown when trying to register without providing an e-mail address.
138 throw new ClientException(_m('You must provide an email address to register.'));
145 * Check if a user has a validated email address or has been
146 * otherwise grandfathered in.
148 * @param User $user User to valide
152 protected function validated($user)
154 // The email field is only stored after validation...
155 // Until then you'll find them in confirm_address.
156 $knownGood = !empty($user->email) ||
157 $this->grandfathered($user) ||
158 $this->hasTrustedOpenID($user);
160 // Give other plugins a chance to override, if they can validate
161 // that somebody's ok despite a non-validated email.
163 // @todo FIXME: This isn't how to do it! Use Start*/End* instead
164 Event::handle('RequireValidatedEmailPlugin_Override',
165 array($user, &$knownGood));
171 * Check if a user was created before the grandfathering cutoff.
172 * If so, we won't need to check for validation.
174 * @param User $user User to check
176 * @return bool true if user is grandfathered
178 protected function grandfathered($user)
180 if ($this->grandfatherCutoff) {
181 $created = strtotime($user->created . " GMT");
182 $cutoff = strtotime($this->grandfatherCutoff);
183 if ($created < $cutoff) {
191 * Override for RequireValidatedEmail plugin. If we have a user who's
192 * not validated an e-mail, but did come from a trusted provider,
193 * we'll consider them ok.
195 * @param User $user User to check
197 * @return bool true if user has a trusted OpenID.
199 function hasTrustedOpenID($user)
201 if ($this->trustedOpenIDs && class_exists('User_openid')) {
202 foreach ($this->trustedOpenIDs as $regex) {
203 $oid = new User_openid();
205 $oid->user_id = $user->id;
208 while ($oid->fetch()) {
209 if (preg_match($regex, $oid->canonical)) {
219 * Add version information for this plugin.
221 * @param array &$versions Array of associative arrays of version data
223 * @return boolean hook value
225 function onPluginVersion(&$versions)
228 array('name' => 'Require Validated Email',
229 'version' => STATUSNET_VERSION,
230 'author' => 'Craig Andrews, '.
234 'http://status.net/wiki/Plugin:RequireValidatedEmail',
236 // TRANS: Plugin description.
237 _m('Disables posting without a validated email address.'));
243 * Hide the notice form if the user isn't able to post.
245 * @param Action $action action being shown
247 * @return boolean hook value
249 function onStartShowNoticeForm($action)
251 $user = common_current_user();
252 if (!empty($user)) { // it's a remote notice
253 if (!$this->validated($user)) {
261 * Prevent unvalidated folks from creating spam groups.
263 * @param Profile $profile User profile we're checking
264 * @param string $right rights key
265 * @param boolean $result if overriding, set to true/false has right
266 * @return boolean hook result value
268 function onUserRightsCheck(Profile $profile, $right, &$result)
270 if ($right == Right::CREATEGROUP ||
271 ($this->disallowLogin && ($right == Right::WEBLOGIN || $right == Right::API))) {
272 $user = User::staticGet('id', $profile->id);
273 if ($user && !$this->validated($user)) {
281 function onLoginAction($action, &$login)
283 if ($action == 'confirmfirstemail') {