3 * StatusNet, 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@status.net>
25 * @author Zach Copley <zach@status.net>
26 * @copyright 2008-2009 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET') && !defined('LACONICA')) {
42 * @author Evan Prodromou <evan@status.net>
43 * @author Zach Copley <zach@status.net>
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45 * @link http://status.net/
50 class EmailsettingsAction extends SettingsAction
55 * @return string Title of the page
59 // TRANS: Title for e-mail settings.
60 return _('Email settings');
64 * Instructions for use
66 * @return instructions for use
68 function getInstructions()
70 // XXX: For consistency of parameters in messages, this should be a
71 // regular parameters, replaced with sprintf().
72 // TRANS: E-mail settings page instructions.
73 // TRANS: %%site.name%% is the name of the site.
74 return _('Manage how you get email from %%site.name%%.');
77 function showScripts()
79 parent::showScripts();
80 $this->script('emailsettings.js');
81 $this->autofocus('email');
85 * Content area of the page
87 * Shows a form for adding and removing email addresses and setting
92 function showContent()
94 $user = $this->scoped->getUser();
96 $this->elementStart('form', array('method' => 'post',
97 'id' => 'form_settings_email',
98 'class' => 'form_settings',
100 common_local_url('emailsettings')));
101 $this->elementStart('fieldset');
102 $this->elementStart('fieldset', array('id' => 'settings_email_address'));
103 // TRANS: Form legend for e-mail settings form.
104 $this->element('legend', null, _('Email address'));
105 $this->hidden('token', common_session_token());
108 $this->element('p', array('id' => 'form_confirmed'), $user->email);
109 // TRANS: Form note in e-mail settings form.
110 $this->element('p', array('class' => 'form_note'), _('Current confirmed email address.'));
111 $this->hidden('email', $user->email);
112 // TRANS: Button label to remove a confirmed e-mail address.
113 $this->submit('remove', _m('BUTTON','Remove'));
115 $confirm = $this->getConfirmation();
117 $this->element('p', array('id' => 'form_unconfirmed'), $confirm->address);
118 $this->element('p', array('class' => 'form_note'),
119 // TRANS: Form note in e-mail settings form.
120 _('Awaiting confirmation on this address. '.
121 'Check your inbox (and spam box!) for a message '.
122 'with further instructions.'));
123 $this->hidden('email', $confirm->address);
124 // TRANS: Button label to cancel an e-mail address confirmation procedure.
125 $this->submit('cancel', _m('BUTTON','Cancel'));
127 $this->elementStart('ul', 'form_data');
128 $this->elementStart('li');
129 // TRANS: Field label for e-mail address input in e-mail settings form.
130 $this->input('email', _('Email address'),
131 ($this->arg('email')) ? $this->arg('email') : null,
132 // TRANS: Instructions for e-mail address input form. Do not translate
133 // TRANS: "example.org". It is one of the domain names reserved for
134 // TRANS: use in examples by http://www.rfc-editor.org/rfc/rfc2606.txt.
135 // TRANS: Any other domain may be owned by a legitimate person or
136 // TRANS: organization.
137 _('Email address, like "UserName@example.org"'));
138 $this->elementEnd('li');
139 $this->elementEnd('ul');
140 // TRANS: Button label for adding an e-mail address in e-mail settings form.
141 $this->submit('add', _m('BUTTON','Add'));
144 $this->elementEnd('fieldset');
146 if (common_config('emailpost', 'enabled') && $user->email) {
147 $this->elementStart('fieldset', array('id' => 'settings_email_incoming'));
148 // TRANS: Form legend for incoming e-mail settings form.
149 $this->element('legend', null, _('Incoming email'));
151 $this->elementStart('ul', 'form_data');
152 $this->elementStart('li');
153 $this->checkbox('emailpost',
154 // TRANS: Checkbox label in e-mail preferences form.
155 _('I want to post notices by email.'),
157 $this->elementEnd('li');
158 $this->elementEnd('ul');
160 // Our stylesheets make the form_data list items all floats, which
161 // creates lots of problems with trying to wrap divs around things.
162 // This should force a break before the next section, which needs
163 // to be separate so we can disable the things in it when the
165 $this->elementStart('div', array('style' => 'clear: both'));
166 $this->elementEnd('div');
168 $this->elementStart('div', array('id' => 'emailincoming'));
170 if ($user->incomingemail) {
171 $this->elementStart('p');
172 $this->element('span', 'address', $user->incomingemail);
173 // @todo XXX: Looks a little awkward in the UI.
174 // Something like "xxxx@identi.ca Send email ..". Needs improvement.
175 $this->element('span', 'input_instructions',
176 // TRANS: Form instructions for incoming e-mail form in e-mail settings.
177 _('Send email to this address to post new notices.'));
178 $this->elementEnd('p');
179 // TRANS: Button label for removing a set sender e-mail address to post notices from.
180 $this->submit('removeincoming', _m('BUTTON','Remove'));
183 $this->elementStart('p');
184 if ($user->incomingemail) {
185 // TRANS: Instructions for incoming e-mail address input form, when an address has already been assigned.
186 $msg = _('Make a new email address for posting to; '.
187 'cancels the old one.');
189 // TRANS: Instructions for incoming e-mail address input form.
190 $msg = _('To send notices via email, we need to create a unique email address for you on this server:');
192 $this->element('span', 'input_instructions', $msg);
193 $this->elementEnd('p');
195 // TRANS: Button label for adding an e-mail address to send notices from.
196 $this->submit('newincoming', _m('BUTTON','New'));
198 $this->elementEnd('div'); // div#emailincoming
200 $this->elementEnd('fieldset');
203 $this->elementStart('fieldset', array('id' => 'settings_email_preferences'));
204 // TRANS: Form legend for e-mail preferences form.
205 $this->element('legend', null, _('Email preferences'));
207 $this->elementStart('ul', 'form_data');
209 if (Event::handle('StartEmailFormData', array($this, $this->scoped))) {
210 $this->elementStart('li');
211 $this->checkbox('emailnotifysub',
212 // TRANS: Checkbox label in e-mail preferences form.
213 _('Send me notices of new subscriptions through email.'),
214 $user->emailnotifysub);
215 $this->elementEnd('li');
216 $this->elementStart('li');
217 $this->checkbox('emailnotifymsg',
218 // TRANS: Checkbox label in e-mail preferences form.
219 _('Send me email when someone sends me a private message.'),
220 $user->emailnotifymsg);
221 $this->elementEnd('li');
222 $this->elementStart('li');
223 $this->checkbox('emailnotifyattn',
224 // TRANS: Checkbox label in e-mail preferences form.
225 _('Send me email when someone sends me an "@-reply".'),
226 $user->emailnotifyattn);
227 $this->elementEnd('li');
228 $this->elementStart('li');
229 $this->checkbox('emailnotifynudge',
230 // TRANS: Checkbox label in e-mail preferences form.
231 _('Allow friends to nudge me and send me an email.'),
232 $user->emailnotifynudge);
233 $this->elementEnd('li');
234 Event::handle('EndEmailFormData', array($this, $this->scoped));
236 $this->elementEnd('ul');
237 // TRANS: Button label to save e-mail preferences.
238 $this->submit('save', _m('BUTTON','Save'));
239 $this->elementEnd('fieldset');
240 $this->elementEnd('fieldset');
241 $this->elementEnd('form');
245 * Gets any existing email address confirmations we're waiting for
247 * @return Confirm_address Email address confirmation for user, or null
249 function getConfirmation()
251 $user = common_current_user();
253 $confirm = new Confirm_address();
255 $confirm->user_id = $user->id;
256 $confirm->address_type = 'email';
258 if ($confirm->find(true)) {
268 * Since there are a lot of different options on the page, we
269 * figure out what we're supposed to do based on which button was
274 function handlePost()
277 $token = $this->trimmed('token');
278 if (!$token || $token != common_session_token()) {
279 // TRANS: Client error displayed when the session token does not match or is not given.
280 $this->show_form(_('There was a problem with your session token. '.
281 'Try again, please.'));
285 if ($this->arg('save')) {
286 $this->savePreferences();
287 } else if ($this->arg('add')) {
289 } else if ($this->arg('cancel')) {
290 $this->cancelConfirmation();
291 } else if ($this->arg('remove')) {
292 $this->removeAddress();
293 } else if ($this->arg('removeincoming')) {
294 $this->removeIncoming();
295 } else if ($this->arg('newincoming')) {
296 $this->newIncoming();
298 // TRANS: Message given submitting a form with an unknown action in e-mail settings.
299 $this->showForm(_('Unexpected form submission.'));
304 * Save email preferences
308 function savePreferences()
310 $user = $this->scoped->getUser();
312 if (Event::handle('StartEmailSaveForm', array($this, $this->scoped))) {
313 $emailnotifysub = $this->booleanintstring('emailnotifysub');
314 $emailnotifymsg = $this->booleanintstring('emailnotifymsg');
315 $emailnotifynudge = $this->booleanintstring('emailnotifynudge');
316 $emailnotifyattn = $this->booleanintstring('emailnotifyattn');
317 $emailpost = $this->booleanintstring('emailpost');
319 $user->query('BEGIN');
321 $original = clone($user);
323 $user->emailnotifysub = $emailnotifysub;
324 $user->emailnotifymsg = $emailnotifymsg;
325 $user->emailnotifynudge = $emailnotifynudge;
326 $user->emailnotifyattn = $emailnotifyattn;
327 $user->emailpost = $emailpost;
329 $result = $user->update($original);
331 if ($result === false) {
332 common_log_db_error($user, 'UPDATE', __FILE__);
333 $user->query('ROLLBACK');
334 // TRANS: Server error thrown on database error updating e-mail preferences.
335 $this->serverError(_('Could not update user.'));
338 $user->query('COMMIT');
340 Event::handle('EndEmailSaveForm', array($this, $this->scoped));
342 // TRANS: Confirmation message for successful e-mail preferences save.
343 $this->showForm(_('Email preferences saved.'), true);
348 * Add the address passed in by the user
352 function addAddress()
354 $user = common_current_user();
356 $email = $this->trimmed('email');
361 // TRANS: Message given saving e-mail address without having provided one.
362 $this->showForm(_('No email address.'));
366 $email = common_canonical_email($email);
369 // TRANS: Message given saving e-mail address that cannot be normalised.
370 $this->showForm(_('Cannot normalize that email address.'));
373 if (!Validate::email($email, common_config('email', 'check_domain'))) {
374 // TRANS: Message given saving e-mail address that not valid.
375 $this->showForm(_('Not a valid email address.'));
377 } else if ($user->email == $email) {
378 // TRANS: Message given saving e-mail address that is already set.
379 $this->showForm(_('That is already your email address.'));
381 } else if ($this->emailExists($email)) {
382 // TRANS: Message given saving e-mail address that is already set for another user.
383 $this->showForm(_('That email address already belongs '.
384 'to another user.'));
388 if (Event::handle('StartAddEmailAddress', array($user, $email))) {
390 $confirm = new Confirm_address();
392 $confirm->address = $email;
393 $confirm->address_type = 'email';
394 $confirm->user_id = $user->id;
395 $confirm->code = common_confirmation_code(64);
397 $result = $confirm->insert();
399 if ($result === false) {
400 common_log_db_error($confirm, 'INSERT', __FILE__);
401 // TRANS: Server error thrown on database error adding e-mail confirmation code.
402 $this->serverError(_('Could not insert confirmation code.'));
405 common_debug('Sending confirmation address for user '.$user->id.' to email '.$email);
406 mail_confirm_address($user, $confirm->code, $user->nickname, $email);
408 Event::handle('EndAddEmailAddress', array($user, $email));
411 // TRANS: Message given saving valid e-mail address that is to be confirmed.
412 $msg = _('A confirmation code was sent to the email address you added. '.
413 'Check your inbox (and spam box!) for the code and instructions '.
414 'on how to use it.');
416 $this->showForm($msg, true);
420 * Handle a request to cancel email confirmation
424 function cancelConfirmation()
426 $email = $this->arg('email');
428 $confirm = $this->getConfirmation();
431 // TRANS: Message given canceling e-mail address confirmation that is not pending.
432 $this->showForm(_('No pending confirmation to cancel.'));
435 if ($confirm->address != $email) {
436 // TRANS: Message given canceling e-mail address confirmation for the wrong e-mail address.
437 $this->showForm(_('That is the wrong email address.'));
441 $result = $confirm->delete();
444 common_log_db_error($confirm, 'DELETE', __FILE__);
445 // TRANS: Server error thrown on database error canceling e-mail address confirmation.
446 $this->serverError(_('Could not delete email confirmation.'));
449 // TRANS: Message given after successfully canceling e-mail address confirmation.
450 $this->showForm(_('Email confirmation cancelled.'), true);
454 * Handle a request to remove an address from the user's account
458 function removeAddress()
460 $user = common_current_user();
462 $email = $this->arg('email');
464 // Maybe an old tab open...?
466 if ($user->email != $email) {
467 // TRANS: Message given trying to remove an e-mail address that is not
468 // TRANS: registered for the active user.
469 $this->showForm(_('That is not your email address.'));
473 $original = clone($user);
477 // Throws exception on failure. Also performs it within a transaction.
478 $user->updateWithKeys($original);
480 // TRANS: Message given after successfully removing a registered e-mail address.
481 $this->showForm(_('The email address was removed.'), true);
485 * Handle a request to remove an incoming email address
489 function removeIncoming()
491 $user = common_current_user();
493 if (!$user->incomingemail) {
494 // TRANS: Form validation error displayed when trying to remove an incoming e-mail address while no address has been set.
495 $this->showForm(_('No incoming email address.'));
499 $orig = clone($user);
501 $user->incomingemail = null;
502 $user->emailpost = 0;
504 // Throws exception on failure. Also performs it within a transaction.
505 $user->updateWithKeys($orig);
507 // TRANS: Message given after successfully removing an incoming e-mail address.
508 $this->showForm(_('Incoming email address removed.'), true);
512 * Generate a new incoming email address
516 function newIncoming()
518 $user = common_current_user();
520 $orig = clone($user);
522 $user->incomingemail = mail_new_incoming_address();
523 $user->emailpost = 1;
525 // Throws exception on failure. Also performs it within a transaction.
526 $user->updateWithKeys($orig);
528 // TRANS: Message given after successfully adding an incoming e-mail address.
529 $this->showForm(_('New incoming email address added.'), true);
533 * Does another user already have this email address?
535 * Email addresses are unique for users.
537 * @param string $email Address to check
539 * @return boolean Whether the email already exists.
542 function emailExists($email)
544 $user = common_current_user();
546 $other = User::getKV('email', $email);
551 return $other->id != $user->id;