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')) {
35 require_once INSTALLDIR.'/lib/accountsettingsaction.php';
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 AccountSettingsAction
55 * @return string Title of the page
60 // TRANS: Title for e-mail settings.
61 return _('Email settings');
65 * Instructions for use
67 * @return instructions for use
70 function getInstructions()
72 // XXX: For consistency of parameters in messages, this should be a
73 // regular parameters, replaced with sprintf().
74 // TRANS: E-mail settings page instructions.
75 // TRANS: %%site.name%% is the name of the site.
76 return _('Manage how you get email from %%site.name%%.');
79 function showScripts()
81 parent::showScripts();
82 $this->autofocus('email');
86 * Content area of the page
88 * Shows a form for adding and removing email addresses and setting
94 function showContent()
96 $user = common_current_user();
98 $this->elementStart('form', array('method' => 'post',
99 'id' => 'form_settings_email',
100 'class' => 'form_settings',
102 common_local_url('emailsettings')));
103 $this->elementStart('fieldset');
104 $this->elementStart('fieldset', array('id' => 'settings_email_address'));
105 // TRANS: Form legend for e-mail settings form.
106 $this->element('legend', null, _('Email address'));
107 $this->hidden('token', common_session_token());
110 $this->element('p', array('id' => 'form_confirmed'), $user->email);
111 // TRANS: Form note in e-mail settings form.
112 $this->element('p', array('class' => 'form_note'), _('Current confirmed email address.'));
113 $this->hidden('email', $user->email);
114 // TRANS: Button label to remove a confirmed e-mail address.
115 $this->submit('remove', _m('BUTTON','Remove'));
117 $confirm = $this->getConfirmation();
119 $this->element('p', array('id' => 'form_unconfirmed'), $confirm->address);
120 // TRANS: Form note in e-mail settings form.
121 $this->element('p', array('class' => 'form_note'),
122 _('Awaiting confirmation on this address. '.
123 'Check your inbox (and spam box!) for a message '.
124 'with further instructions.'));
125 $this->hidden('email', $confirm->address);
126 // TRANS: Button label to cancel an e-mail address confirmation procedure.
127 $this->submit('cancel', _m('BUTTON','Cancel'));
129 $this->elementStart('ul', 'form_data');
130 $this->elementStart('li');
131 // TRANS: Field label for e-mail address input in e-mail settings form.
132 $this->input('email', _('Email address'),
133 ($this->arg('email')) ? $this->arg('email') : null,
134 // TRANS: Instructions for e-mail address input form.
135 _('Email address, like "UserName@example.org"'));
136 $this->elementEnd('li');
137 $this->elementEnd('ul');
138 // TRANS: Button label for adding an e-mail address in e-mail settings form.
139 $this->submit('add', _m('BUTTON','Add'));
142 $this->elementEnd('fieldset');
144 if (common_config('emailpost', 'enabled') && $user->email) {
145 $this->elementStart('fieldset', array('id' => 'settings_email_incoming'));
146 // TRANS: Form legend for incoming e-mail settings form.
147 $this->element('legend', null, _('Incoming email'));
148 if ($user->incomingemail) {
149 $this->elementStart('p');
150 $this->element('span', 'address', $user->incomingemail);
151 // XXX: Looks a little awkward in the UI.
152 // Something like "xxxx@identi.ca Send email ..". Needs improvement.
153 $this->element('span', 'input_instructions',
154 // TRANS: Form instructions for incoming e-mail form in e-mail settings.
155 _('Send email to this address to post new notices.'));
156 $this->elementEnd('p');
157 // TRANS: Button label for removing a set sender e-mail address to post notices from.
158 $this->submit('removeincoming', _m('BUTTON','Remove'));
161 $this->elementStart('p');
162 $this->element('span', 'input_instructions',
163 // TRANS: Instructions for incoming e-mail address input form.
164 _('Make a new email address for posting to; '.
165 'cancels the old one.'));
166 $this->elementEnd('p');
167 // TRANS: Button label for adding an e-mail address to send notices from.
168 $this->submit('newincoming', _m('BUTTON','New'));
169 $this->elementEnd('fieldset');
172 $this->elementStart('fieldset', array('id' => 'settings_email_preferences'));
173 // TRANS: Form legend for e-mail preferences form.
174 $this->element('legend', null, _('Email preferences'));
176 $this->elementStart('ul', 'form_data');
177 $this->elementStart('li');
178 $this->checkbox('emailnotifysub',
179 // TRANS: Checkbox label in e-mail preferences form.
180 _('Send me notices of new subscriptions through email.'),
181 $user->emailnotifysub);
182 $this->elementEnd('li');
183 $this->elementStart('li');
184 $this->checkbox('emailnotifyfav',
185 // TRANS: Checkbox label in e-mail preferences form.
186 _('Send me email when someone '.
187 'adds my notice as a favorite.'),
188 $user->emailnotifyfav);
189 $this->elementEnd('li');
190 $this->elementStart('li');
191 $this->checkbox('emailnotifymsg',
192 // TRANS: Checkbox label in e-mail preferences form.
193 _('Send me email when someone sends me a private message.'),
194 $user->emailnotifymsg);
195 $this->elementEnd('li');
196 $this->elementStart('li');
197 $this->checkbox('emailnotifyattn',
198 // TRANS: Checkbox label in e-mail preferences form.
199 _('Send me email when someone sends me an "@-reply".'),
200 $user->emailnotifyattn);
201 $this->elementEnd('li');
202 $this->elementStart('li');
203 $this->checkbox('emailnotifynudge',
204 // TRANS: Checkbox label in e-mail preferences form.
205 _('Allow friends to nudge me and send me an email.'),
206 $user->emailnotifynudge);
207 $this->elementEnd('li');
208 if (common_config('emailpost', 'enabled')) {
209 $this->elementStart('li');
210 $this->checkbox('emailpost',
211 // TRANS: Checkbox label in e-mail preferences form.
212 _('I want to post notices by email.'),
214 $this->elementEnd('li');
216 $this->elementStart('li');
217 $this->checkbox('emailmicroid',
218 // TRANS: Checkbox label in e-mail preferences form.
219 _('Publish a MicroID for my email address.'),
220 $user->emailmicroid);
221 $this->elementEnd('li');
222 $this->elementEnd('ul');
223 // TRANS: Button label to save e-mail preferences.
224 $this->submit('save', _m('BUTTON','Save'));
225 $this->elementEnd('fieldset');
226 $this->elementEnd('fieldset');
227 $this->elementEnd('form');
231 * Gets any existing email address confirmations we're waiting for
233 * @return Confirm_address Email address confirmation for user, or null
236 function getConfirmation()
238 $user = common_current_user();
240 $confirm = new Confirm_address();
242 $confirm->user_id = $user->id;
243 $confirm->address_type = 'email';
245 if ($confirm->find(true)) {
255 * Since there are a lot of different options on the page, we
256 * figure out what we're supposed to do based on which button was
262 function handlePost()
265 $token = $this->trimmed('token');
266 if (!$token || $token != common_session_token()) {
267 $this->show_form(_('There was a problem with your session token. '.
268 'Try again, please.'));
272 if ($this->arg('save')) {
273 $this->savePreferences();
274 } else if ($this->arg('add')) {
276 } else if ($this->arg('cancel')) {
277 $this->cancelConfirmation();
278 } else if ($this->arg('remove')) {
279 $this->removeAddress();
280 } else if ($this->arg('removeincoming')) {
281 $this->removeIncoming();
282 } else if ($this->arg('newincoming')) {
283 $this->newIncoming();
285 // TRANS: Message given submitting a form with an unknown action in e-mail settings.
286 $this->showForm(_('Unexpected form submission.'));
291 * Save email preferences
296 function savePreferences()
298 $emailnotifysub = $this->boolean('emailnotifysub');
299 $emailnotifyfav = $this->boolean('emailnotifyfav');
300 $emailnotifymsg = $this->boolean('emailnotifymsg');
301 $emailnotifynudge = $this->boolean('emailnotifynudge');
302 $emailnotifyattn = $this->boolean('emailnotifyattn');
303 $emailmicroid = $this->boolean('emailmicroid');
304 $emailpost = $this->boolean('emailpost');
306 $user = common_current_user();
308 assert(!is_null($user)); // should already be checked
310 $user->query('BEGIN');
312 $original = clone($user);
314 $user->emailnotifysub = $emailnotifysub;
315 $user->emailnotifyfav = $emailnotifyfav;
316 $user->emailnotifymsg = $emailnotifymsg;
317 $user->emailnotifynudge = $emailnotifynudge;
318 $user->emailnotifyattn = $emailnotifyattn;
319 $user->emailmicroid = $emailmicroid;
320 $user->emailpost = $emailpost;
322 $result = $user->update($original);
324 if ($result === false) {
325 common_log_db_error($user, 'UPDATE', __FILE__);
326 // TRANS: Server error thrown on database error updating e-mail preferences.
327 $this->serverError(_('Couldn\'t update user.'));
331 $user->query('COMMIT');
333 // TRANS: Confirmation message for successful e-mail preferences save.
334 $this->showForm(_('Email preferences saved.'), true);
338 * Add the address passed in by the user
343 function addAddress()
345 $user = common_current_user();
347 $email = $this->trimmed('email');
352 // TRANS: Message given saving e-mail address without having provided one.
353 $this->showForm(_('No email address.'));
357 $email = common_canonical_email($email);
360 // TRANS: Message given saving e-mail address that cannot be normalised.
361 $this->showForm(_('Cannot normalize that email address'));
364 if (!Validate::email($email, common_config('email', 'check_domain'))) {
365 // TRANS: Message given saving e-mail address that not valid.
366 $this->showForm(_('Not a valid email address.'));
368 } else if ($user->email == $email) {
369 // TRANS: Message given saving e-mail address that is already set.
370 $this->showForm(_('That is already your email address.'));
372 } else if ($this->emailExists($email)) {
373 // TRANS: Message given saving e-mail address that is already set for another user.
374 $this->showForm(_('That email address already belongs '.
375 'to another user.'));
379 $confirm = new Confirm_address();
381 $confirm->address = $email;
382 $confirm->address_type = 'email';
383 $confirm->user_id = $user->id;
384 $confirm->code = common_confirmation_code(64);
386 $result = $confirm->insert();
388 if ($result === false) {
389 common_log_db_error($confirm, 'INSERT', __FILE__);
390 // TRANS: Server error thrown on database error adding e-mail confirmation code.
391 $this->serverError(_('Couldn\'t insert confirmation code.'));
395 mail_confirm_address($user, $confirm->code, $user->nickname, $email);
397 // TRANS: Message given saving valid e-mail address that is to be confirmed.
398 $msg = _('A confirmation code was sent to the email address you added. '.
399 'Check your inbox (and spam box!) for the code and instructions '.
400 'on how to use it.');
402 $this->showForm($msg, true);
406 * Handle a request to cancel email confirmation
411 function cancelConfirmation()
413 $email = $this->arg('email');
415 $confirm = $this->getConfirmation();
418 // TRANS: Message given canceling e-mail address confirmation that is not pending.
419 $this->showForm(_('No pending confirmation to cancel.'));
422 if ($confirm->address != $email) {
423 // TRANS: Message given canceling e-mail address confirmation for the wrong e-mail address.
424 $this->showForm(_('That is the wrong email address.'));
428 $result = $confirm->delete();
431 common_log_db_error($confirm, 'DELETE', __FILE__);
432 // TRANS: Server error thrown on database error canceling e-mail address confirmation.
433 $this->serverError(_('Couldn\'t delete email confirmation.'));
437 // TRANS: Message given after successfully canceling e-mail address confirmation.
438 $this->showForm(_('Email confirmation cancelled.'), true);
442 * Handle a request to remove an address from the user's account
447 function removeAddress()
449 $user = common_current_user();
451 $email = $this->arg('email');
453 // Maybe an old tab open...?
455 if ($user->email != $email) {
456 // TRANS: Message given trying to remove an e-mail address that is not
457 // TRANS: registered for the active user.
458 $this->showForm(_('That is not your email address.'));
462 $user->query('BEGIN');
464 $original = clone($user);
468 $result = $user->updateKeys($original);
471 common_log_db_error($user, 'UPDATE', __FILE__);
472 // TRANS: Server error thrown on database error removing a registered e-mail address.
473 $this->serverError(_('Couldn\'t update user.'));
476 $user->query('COMMIT');
478 // TRANS: Message given after successfully removing a registered e-mail address.
479 $this->showForm(_('The email address was removed.'), true);
483 * Handle a request to remove an incoming email address
488 function removeIncoming()
490 $user = common_current_user();
492 if (!$user->incomingemail) {
493 $this->showForm(_('No incoming email address.'));
497 $orig = clone($user);
499 $user->incomingemail = null;
501 if (!$user->updateKeys($orig)) {
502 common_log_db_error($user, 'UPDATE', __FILE__);
503 // TRANS: Server error thrown on database error removing incoming e-mail address.
504 $this->serverError(_("Couldn't update user record."));
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
517 function newIncoming()
519 $user = common_current_user();
521 $orig = clone($user);
523 $user->incomingemail = mail_new_incoming_address();
525 if (!$user->updateKeys($orig)) {
526 common_log_db_error($user, 'UPDATE', __FILE__);
527 // TRANS: Server error thrown on database error adding incoming e-mail address.
528 $this->serverError(_("Couldn't update user record."));
531 // TRANS: Message given after successfully adding an incoming e-mail address.
532 $this->showForm(_('New incoming email address added.'), true);
536 * Does another user already have this email address?
538 * Email addresses are unique for users.
540 * @param string $email Address to check
542 * @return boolean Whether the email already exists.
545 function emailExists($email)
547 $user = common_current_user();
549 $other = User::staticGet('email', $email);
554 return $other->id != $user->id;