3 * Laconica, the distributed open-source microblogging tool
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 Evan Prodromou <evan@controlyourself.ca>
25 * @author Zach Copley <zach@controlyourself.ca>
26 * @copyright 2008-2009 Control Yourself, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://laconi.ca/
31 if (!defined('LACONICA')) {
35 require_once INSTALLDIR.'/lib/accountsettingsaction.php';
42 * @author Evan Prodromou <evan@controlyourself.ca>
43 * @author Zach Copley <zach@controlyourself.ca>
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45 * @link http://laconi.ca/
50 class EmailsettingsAction extends AccountSettingsAction
55 * @return string Title of the page
60 return _('Email Settings');
64 * Instructions for use
66 * @return instructions for use
69 function getInstructions()
71 return _('Manage how you get email from %%site.name%%.');
75 * Content area of the page
77 * Shows a form for adding and removing email addresses and setting
83 function showContent()
85 $user = common_current_user();
87 $this->elementStart('form', array('method' => 'post',
88 'id' => 'form_settings_email',
89 'class' => 'form_settings',
91 common_local_url('emailsettings')));
93 $this->elementStart('fieldset', array('id' => 'settings_email_address'));
94 $this->element('legend', null, _('Address'));
95 $this->hidden('token', common_session_token());
98 $this->element('p', array('id' => 'form_confirmed'), $user->email);
99 $this->element('p', array('class' => 'form_note'), _('Current confirmed email address.'));
100 $this->hidden('email', $user->email);
101 $this->submit('remove', _('Remove'));
103 $confirm = $this->getConfirmation();
105 $this->element('p', array('id' => 'form_unconfirmed'), $confirm->address);
106 $this->element('p', array('class' => 'form_note'),
107 _('Awaiting confirmation on this address. '.
108 'Check your inbox (and spam box!) for a message '.
109 'with further instructions.'));
110 $this->hidden('email', $confirm->address);
111 $this->submit('cancel', _('Cancel'));
113 $this->elementStart('ul', 'form_data');
114 $this->elementStart('li');
115 $this->input('email', _('Email Address'),
116 ($this->arg('email')) ? $this->arg('email') : null,
117 _('Email address, like "UserName@example.org"'));
118 $this->elementEnd('li');
119 $this->elementEnd('ul');
120 $this->submit('add', _('Add'));
123 $this->elementEnd('fieldset');
126 $this->elementStart('fieldset', array('id' => 'settings_email_incoming'));
127 $this->element('legend',_('Incoming email'));
128 if ($user->incomingemail) {
129 $this->elementStart('p');
130 $this->element('span', 'address', $user->incomingemail);
131 $this->element('span', 'input_instructions',
132 _('Send email to this address to post new notices.'));
133 $this->elementEnd('p');
134 $this->submit('removeincoming', _('Remove'));
137 $this->elementStart('p');
138 $this->element('span', 'input_instructions',
139 _('Make a new email address for posting to; '.
140 'cancels the old one.'));
141 $this->elementEnd('p');
142 $this->submit('newincoming', _('New'));
143 $this->elementEnd('fieldset');
146 $this->elementStart('fieldset', array('id' => 'settings_email_preferences'));
147 $this->element('legend', null, _('Preferences'));
149 $this->elementStart('ul', 'form_data');
150 $this->elementStart('li');
151 $this->checkbox('emailnotifysub',
152 _('Send me notices of new subscriptions through email.'),
153 $user->emailnotifysub);
154 $this->elementEnd('li');
155 $this->elementStart('li');
156 $this->checkbox('emailnotifyfav',
157 _('Send me email when someone '.
158 'adds my notice as a favorite.'),
159 $user->emailnotifyfav);
160 $this->elementEnd('li');
161 $this->elementStart('li');
162 $this->checkbox('emailnotifymsg',
163 _('Send me email when someone sends me a private message.'),
164 $user->emailnotifymsg);
165 $this->elementEnd('li');
166 $this->elementStart('li');
167 $this->checkbox('emailnotifynudge',
168 _('Allow friends to nudge me and send me an email.'),
169 $user->emailnotifynudge);
170 $this->elementEnd('li');
171 $this->elementStart('li');
172 $this->checkbox('emailpost',
173 _('I want to post notices by email.'),
175 $this->elementEnd('li');
176 $this->elementStart('li');
177 $this->checkbox('emailmicroid',
178 _('Publish a MicroID for my email address.'),
179 $user->emailmicroid);
180 $this->elementEnd('li');
181 $this->elementEnd('ul');
182 $this->submit('save', _('Save'));
183 $this->elementEnd('fieldset');
184 $this->elementEnd('form');
188 * Gets any existing email address confirmations we're waiting for
190 * @return Confirm_address Email address confirmation for user, or null
193 function getConfirmation()
195 $user = common_current_user();
197 $confirm = new Confirm_address();
199 $confirm->user_id = $user->id;
200 $confirm->address_type = 'email';
202 if ($confirm->find(true)) {
212 * Since there are a lot of different options on the page, we
213 * figure out what we're supposed to do based on which button was
219 function handlePost()
222 $token = $this->trimmed('token');
223 if (!$token || $token != common_session_token()) {
224 $this->show_form(_('There was a problem with your session token. '.
225 'Try again, please.'));
229 if ($this->arg('save')) {
230 $this->savePreferences();
231 } else if ($this->arg('add')) {
233 } else if ($this->arg('cancel')) {
234 $this->cancelConfirmation();
235 } else if ($this->arg('remove')) {
236 $this->removeAddress();
237 } else if ($this->arg('removeincoming')) {
238 $this->removeIncoming();
239 } else if ($this->arg('newincoming')) {
240 $this->newIncoming();
242 $this->showForm(_('Unexpected form submission.'));
247 * Save email preferences
252 function savePreferences()
254 $emailnotifysub = $this->boolean('emailnotifysub');
255 $emailnotifyfav = $this->boolean('emailnotifyfav');
256 $emailnotifymsg = $this->boolean('emailnotifymsg');
257 $emailnotifynudge = $this->boolean('emailnotifynudge');
258 $emailmicroid = $this->boolean('emailmicroid');
259 $emailpost = $this->boolean('emailpost');
261 $user = common_current_user();
263 assert(!is_null($user)); // should already be checked
265 $user->query('BEGIN');
267 $original = clone($user);
269 $user->emailnotifysub = $emailnotifysub;
270 $user->emailnotifyfav = $emailnotifyfav;
271 $user->emailnotifymsg = $emailnotifymsg;
272 $user->emailnotifynudge = $emailnotifynudge;
273 $user->emailmicroid = $emailmicroid;
274 $user->emailpost = $emailpost;
276 $result = $user->update($original);
278 if ($result === false) {
279 common_log_db_error($user, 'UPDATE', __FILE__);
280 $this->serverError(_('Couldn\'t update user.'));
284 $user->query('COMMIT');
286 $this->showForm(_('Preferences saved.'), true);
290 * Add the address passed in by the user
295 function addAddress()
297 $user = common_current_user();
299 $email = $this->trimmed('email');
304 $this->showForm(_('No email address.'));
308 $email = common_canonical_email($email);
311 $this->showForm(_('Cannot normalize that email address'));
314 if (!Validate::email($email, true)) {
315 $this->showForm(_('Not a valid email address'));
317 } else if ($user->email == $email) {
318 $this->showForm(_('That is already your email address.'));
320 } else if ($this->emailExists($email)) {
321 $this->showForm(_('That email address already belongs '.
322 'to another user.'));
326 $confirm = new Confirm_address();
328 $confirm->address = $email;
329 $confirm->address_type = 'email';
330 $confirm->user_id = $user->id;
331 $confirm->code = common_confirmation_code(64);
333 $result = $confirm->insert();
335 if ($result === false) {
336 common_log_db_error($confirm, 'INSERT', __FILE__);
337 $this->serverError(_('Couldn\'t insert confirmation code.'));
341 mail_confirm_address($user, $confirm->code, $user->nickname, $email);
343 $msg = _('A confirmation code was sent to the email address you added. '.
344 'Check your inbox (and spam box!) for the code and instructions '.
345 'on how to use it.');
347 $this->showForm($msg, true);
351 * Handle a request to cancel email confirmation
356 function cancelConfirmation()
358 $email = $this->arg('email');
360 $confirm = $this->getConfirmation();
363 $this->showForm(_('No pending confirmation to cancel.'));
366 if ($confirm->address != $email) {
367 $this->showForm(_('That is the wrong IM address.'));
371 $result = $confirm->delete();
374 common_log_db_error($confirm, 'DELETE', __FILE__);
375 $this->serverError(_('Couldn\'t delete email confirmation.'));
379 $this->showForm(_('Confirmation cancelled.'), true);
383 * Handle a request to remove an address from the user's account
388 function removeAddress()
390 $user = common_current_user();
392 $email = $this->arg('email');
394 // Maybe an old tab open...?
396 if ($user->email != $email) {
397 $this->showForm(_('That is not your email address.'));
401 $user->query('BEGIN');
403 $original = clone($user);
407 $result = $user->updateKeys($original);
410 common_log_db_error($user, 'UPDATE', __FILE__);
411 $this->serverError(_('Couldn\'t update user.'));
414 $user->query('COMMIT');
416 $this->showForm(_('The address was removed.'), true);
420 * Handle a request to remove an incoming email address
425 function removeIncoming()
427 $user = common_current_user();
429 if (!$user->incomingemail) {
430 $this->showForm(_('No incoming email address.'));
434 $orig = clone($user);
436 $user->incomingemail = null;
438 if (!$user->updateKeys($orig)) {
439 common_log_db_error($user, 'UPDATE', __FILE__);
440 $this->serverError(_("Couldn't update user record."));
443 $this->showForm(_('Incoming email address removed.'), true);
447 * Generate a new incoming email address
452 function newIncoming()
454 $user = common_current_user();
456 $orig = clone($user);
458 $user->incomingemail = mail_new_incoming_address();
460 if (!$user->updateKeys($orig)) {
461 common_log_db_error($user, 'UPDATE', __FILE__);
462 $this->serverError(_("Couldn't update user record."));
465 $this->showForm(_('New incoming email address added.'), true);
469 * Does another user already have this email address?
471 * Email addresses are unique for users.
473 * @param string $email Address to check
475 * @return boolean Whether the email already exists.
478 function emailExists($email)
480 $user = common_current_user();
482 $other = User::staticGet('email', $email);
487 return $other->id != $user->id;