3 * StatusNet, the distributed open-source microblogging tool
5 * Plugin that requires the user to have a validated email address before they can post notices
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Craig Andrews <candrews@integralblue.com>, Brion Vibber <brion@status.net>
25 * @copyright 2009 Craig Andrews http://candrews.integralblue.com
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
34 class RequireValidatedEmailPlugin extends Plugin
36 // Users created before this time will be grandfathered in
37 // without the validation requirement.
38 public $grandfatherCutoff=null;
40 function __construct()
42 parent::__construct();
46 * Event handler for notice saves; rejects the notice
47 * if user's address isn't validated.
49 * @param Notice $notice
50 * @return bool hook result code
52 function onStartNoticeSave($notice)
54 $user = User::staticGet('id', $notice->profile_id);
55 if (!empty($user)) { // it's a remote notice
56 if (!$this->validated($user)) {
57 throw new ClientException(_m("You must validate your email address before posting."));
64 * Event handler for registration attempts; rejects the registration
65 * if email field is missing.
67 * @param RegisterAction $action
68 * @return bool hook result code
70 function onStartRegistrationTry($action)
72 $email = $action->trimmed('email');
75 $action->showForm(_m('You must provide an email address to register.'));
79 // Default form will run address format validation and reject if bad.
85 * Check if a user has a validated email address or has been
86 * otherwise grandfathered in.
91 protected function validated($user)
93 if ($this->grandfathered($user)) {
97 // The email field is only stored after validation...
98 // Until then you'll find them in confirm_address.
99 return !empty($user->email);
103 * Check if a user was created before the grandfathering cutoff.
104 * If so, we won't need to check for validation.
109 protected function grandfathered($user)
111 if ($this->grandfatherCutoff) {
112 $created = strtotime($user->created . " GMT");
113 $cutoff = strtotime($this->grandfatherCutoff);
114 if ($created < $cutoff) {
121 function onPluginVersion(&$versions)
123 $versions[] = array('name' => 'Require Validated Email',
124 'version' => STATUSNET_VERSION,
125 'author' => 'Craig Andrews, Evan Prodromou, Brion Vibber',
126 'homepage' => 'http://status.net/wiki/Plugin:RequireValidatedEmail',
128 _m('The Require Validated Email plugin disables posting for accounts that do not have a validated email address.'));