actions/emailsettings.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Settings for email
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  Settings
  23  * @package   StatusNet
  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/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/accountsettingsaction.php';
  36
  37 /**
  38  * Settings for email
  39  *
  40  * @category Settings
  41  * @package  StatusNet
  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/
  46  *
  47  * @see      Widget
  48  */
  49
  50 class EmailsettingsAction extends AccountSettingsAction
  51 {
  52     /**
  53      * Title of the page
  54      *
  55      * @return string Title of the page
  56      */
  57
  58     function title()
  59     {
  60         // TRANS: Title for e-mail settings.
  61         return _('Email settings');
  62     }
  63
  64     /**
  65      * Instructions for use
  66      *
  67      * @return instructions for use
  68      */
  69
  70     function getInstructions()
  71     {
  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%%.');
  77     }
  78
  79     function showScripts()
  80     {
  81         parent::showScripts();
  82         $this->autofocus('email');
  83     }
  84
  85     /**
  86      * Content area of the page
  87      *
  88      * Shows a form for adding and removing email addresses and setting
  89      * email preferences.
  90      *
  91      * @return void
  92      */
  93
  94     function showContent()
  95     {
  96         $user = common_current_user();
  97
  98         $this->elementStart('form', array('method' => 'post',
  99                                           'id' => 'form_settings_email',
 100                                           'class' => 'form_settings',
 101                                           'action' =>
 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());
 108
 109         if ($user->email) {
 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'));
 116         } else {
 117             $confirm = $this->getConfirmation();
 118             if ($confirm) {
 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'));
 128             } else {
 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. Do not translate
 135                              // TRANS: "example.org". It is one of the domain names reserved for
 136                              // TRANS: use in examples by http://www.rfc-editor.org/rfc/rfc2606.txt.
 137                              // TRANS: Any other domain may be owned by a legitimate person or
 138                              // TRANS: organization.
 139                              _('Email address, like "UserName@example.org"'));
 140                 $this->elementEnd('li');
 141                 $this->elementEnd('ul');
 142                 // TRANS: Button label for adding an e-mail address in e-mail settings form.
 143                 $this->submit('add', _m('BUTTON','Add'));
 144             }
 145         }
 146         $this->elementEnd('fieldset');
 147
 148        if (common_config('emailpost', 'enabled') && $user->email) {
 149             $this->elementStart('fieldset', array('id' => 'settings_email_incoming'));
 150             // TRANS: Form legend for incoming e-mail settings form.
 151             $this->element('legend', null, _('Incoming email'));
 152
 153             $this->elementStart('ul', 'form_data');
 154             $this->elementStart('li');
 155             $this->checkbox('emailpost',
 156                     // TRANS: Checkbox label in e-mail preferences form.
 157                     _('I want to post notices by email.'),
 158                     $user->emailpost);
 159             $this->elementEnd('li');
 160             $this->elementEnd('ul');
 161
 162             if ($user->incomingemail) {
 163                 $this->elementStart('p');
 164                 $this->element('span', 'address', $user->incomingemail);
 165                 // XXX: Looks a little awkward in the UI.
 166                 //      Something like "xxxx@identi.ca  Send email ..". Needs improvement.
 167                 $this->element('span', 'input_instructions',
 168                                // TRANS: Form instructions for incoming e-mail form in e-mail settings.
 169                                _('Send email to this address to post new notices.'));
 170                 $this->elementEnd('p');
 171                 // TRANS: Button label for removing a set sender e-mail address to post notices from.
 172                 $this->submit('removeincoming', _m('BUTTON','Remove'));
 173             }
 174
 175             $this->elementStart('p');
 176             $this->element('span', 'input_instructions',
 177                            // TRANS: Instructions for incoming e-mail address input form.
 178                            _('Make a new email address for posting to; '.
 179                              'cancels the old one.'));
 180             $this->elementEnd('p');
 181             // TRANS: Button label for adding an e-mail address to send notices from.
 182             $this->submit('newincoming', _m('BUTTON','New'));
 183             $this->elementEnd('fieldset');
 184         }
 185
 186         $this->elementStart('fieldset', array('id' => 'settings_email_preferences'));
 187         // TRANS: Form legend for e-mail preferences form.
 188         $this->element('legend', null, _('Email preferences'));
 189
 190         $this->elementStart('ul', 'form_data');
 191
 192         if (Event::handle('StartEmailFormData', array($this))) {
 193             $this->elementStart('li');
 194             $this->checkbox('emailnotifysub',
 195                             // TRANS: Checkbox label in e-mail preferences form.
 196                             _('Send me notices of new subscriptions through email.'),
 197                             $user->emailnotifysub);
 198             $this->elementEnd('li');
 199             $this->elementStart('li');
 200             $this->checkbox('emailnotifyfav',
 201                             // TRANS: Checkbox label in e-mail preferences form.
 202                             _('Send me email when someone '.
 203                               'adds my notice as a favorite.'),
 204                             $user->emailnotifyfav);
 205             $this->elementEnd('li');
 206             $this->elementStart('li');
 207             $this->checkbox('emailnotifymsg',
 208                             // TRANS: Checkbox label in e-mail preferences form.
 209                             _('Send me email when someone sends me a private message.'),
 210                             $user->emailnotifymsg);
 211             $this->elementEnd('li');
 212             $this->elementStart('li');
 213             $this->checkbox('emailnotifyattn',
 214                             // TRANS: Checkbox label in e-mail preferences form.
 215                             _('Send me email when someone sends me an "@-reply".'),
 216                             $user->emailnotifyattn);
 217             $this->elementEnd('li');
 218             $this->elementStart('li');
 219             $this->checkbox('emailnotifynudge',
 220                             // TRANS: Checkbox label in e-mail preferences form.
 221                             _('Allow friends to nudge me and send me an email.'),
 222                             $user->emailnotifynudge);
 223             $this->elementEnd('li');
 224             $this->elementStart('li');
 225             $this->checkbox('emailmicroid',
 226                             // TRANS: Checkbox label in e-mail preferences form.
 227                             _('Publish a MicroID for my email address.'),
 228                             $user->emailmicroid);
 229             $this->elementEnd('li');
 230             Event::handle('EndEmailFormData', array($this));
 231         }
 232         $this->elementEnd('ul');
 233         // TRANS: Button label to save e-mail preferences.
 234         $this->submit('save', _m('BUTTON','Save'));
 235         $this->elementEnd('fieldset');
 236         $this->elementEnd('fieldset');
 237         $this->elementEnd('form');
 238     }
 239
 240     /**
 241      * Gets any existing email address confirmations we're waiting for
 242      *
 243      * @return Confirm_address Email address confirmation for user, or null
 244      */
 245
 246     function getConfirmation()
 247     {
 248         $user = common_current_user();
 249
 250         $confirm = new Confirm_address();
 251
 252         $confirm->user_id      = $user->id;
 253         $confirm->address_type = 'email';
 254
 255         if ($confirm->find(true)) {
 256             return $confirm;
 257         } else {
 258             return null;
 259         }
 260     }
 261
 262     /**
 263      * Handle posts
 264      *
 265      * Since there are a lot of different options on the page, we
 266      * figure out what we're supposed to do based on which button was
 267      * pushed
 268      *
 269      * @return void
 270      */
 271
 272     function handlePost()
 273     {
 274         // CSRF protection
 275         $token = $this->trimmed('token');
 276         if (!$token || $token != common_session_token()) {
 277             $this->show_form(_('There was a problem with your session token. '.
 278                                'Try again, please.'));
 279             return;
 280         }
 281
 282         if ($this->arg('save')) {
 283             $this->savePreferences();
 284         } else if ($this->arg('add')) {
 285             $this->addAddress();
 286         } else if ($this->arg('cancel')) {
 287             $this->cancelConfirmation();
 288         } else if ($this->arg('remove')) {
 289             $this->removeAddress();
 290         } else if ($this->arg('removeincoming')) {
 291             $this->removeIncoming();
 292         } else if ($this->arg('newincoming')) {
 293             $this->newIncoming();
 294         } else {
 295             // TRANS: Message given submitting a form with an unknown action in e-mail settings.
 296             $this->showForm(_('Unexpected form submission.'));
 297         }
 298     }
 299
 300     /**
 301      * Save email preferences
 302      *
 303      * @return void
 304      */
 305
 306     function savePreferences()
 307     {
 308         $user = common_current_user();
 309
 310         if (Event::handle('StartEmailSaveForm', array($this, &$user))) {
 311
 312             $emailnotifysub   = $this->boolean('emailnotifysub');
 313             $emailnotifyfav   = $this->boolean('emailnotifyfav');
 314             $emailnotifymsg   = $this->boolean('emailnotifymsg');
 315             $emailnotifynudge = $this->boolean('emailnotifynudge');
 316             $emailnotifyattn  = $this->boolean('emailnotifyattn');
 317             $emailmicroid     = $this->boolean('emailmicroid');
 318             $emailpost        = $this->boolean('emailpost');
 319
 320             assert(!is_null($user)); // should already be checked
 321
 322             $user->query('BEGIN');
 323
 324             $original = clone($user);
 325
 326             $user->emailnotifysub   = $emailnotifysub;
 327             $user->emailnotifyfav   = $emailnotifyfav;
 328             $user->emailnotifymsg   = $emailnotifymsg;
 329             $user->emailnotifynudge = $emailnotifynudge;
 330             $user->emailnotifyattn  = $emailnotifyattn;
 331             $user->emailmicroid     = $emailmicroid;
 332             $user->emailpost        = $emailpost;
 333
 334             $result = $user->update($original);
 335
 336             if ($result === false) {
 337                 common_log_db_error($user, 'UPDATE', __FILE__);
 338                 // TRANS: Server error thrown on database error updating e-mail preferences.
 339                 $this->serverError(_('Couldn\'t update user.'));
 340                 return;
 341             }
 342
 343             $user->query('COMMIT');
 344
 345             Event::handle('EndEmailSaveForm', array($this));
 346
 347             // TRANS: Confirmation message for successful e-mail preferences save.
 348             $this->showForm(_('Email preferences saved.'), true);
 349         }
 350     }
 351
 352     /**
 353      * Add the address passed in by the user
 354      *
 355      * @return void
 356      */
 357
 358     function addAddress()
 359     {
 360         $user = common_current_user();
 361
 362         $email = $this->trimmed('email');
 363
 364         // Some validation
 365
 366         if (!$email) {
 367             // TRANS: Message given saving e-mail address without having provided one.
 368             $this->showForm(_('No email address.'));
 369             return;
 370         }
 371
 372         $email = common_canonical_email($email);
 373
 374         if (!$email) {
 375             // TRANS: Message given saving e-mail address that cannot be normalised.
 376             $this->showForm(_('Cannot normalize that email address'));
 377             return;
 378         }
 379         if (!Validate::email($email, common_config('email', 'check_domain'))) {
 380             // TRANS: Message given saving e-mail address that not valid.
 381             $this->showForm(_('Not a valid email address.'));
 382             return;
 383         } else if ($user->email == $email) {
 384             // TRANS: Message given saving e-mail address that is already set.
 385             $this->showForm(_('That is already your email address.'));
 386             return;
 387         } else if ($this->emailExists($email)) {
 388             // TRANS: Message given saving e-mail address that is already set for another user.
 389             $this->showForm(_('That email address already belongs '.
 390                               'to another user.'));
 391             return;
 392         }
 393
 394         $confirm = new Confirm_address();
 395
 396         $confirm->address      = $email;
 397         $confirm->address_type = 'email';
 398         $confirm->user_id      = $user->id;
 399         $confirm->code         = common_confirmation_code(64);
 400
 401         $result = $confirm->insert();
 402
 403         if ($result === false) {
 404             common_log_db_error($confirm, 'INSERT', __FILE__);
 405             // TRANS: Server error thrown on database error adding e-mail confirmation code.
 406             $this->serverError(_('Couldn\'t insert confirmation code.'));
 407             return;
 408         }
 409
 410         mail_confirm_address($user, $confirm->code, $user->nickname, $email);
 411
 412         // TRANS: Message given saving valid e-mail address that is to be confirmed.
 413         $msg = _('A confirmation code was sent to the email address you added. '.
 414                  'Check your inbox (and spam box!) for the code and instructions '.
 415                  'on how to use it.');
 416
 417         $this->showForm($msg, true);
 418     }
 419
 420     /**
 421      * Handle a request to cancel email confirmation
 422      *
 423      * @return void
 424      */
 425
 426     function cancelConfirmation()
 427     {
 428         $email = $this->arg('email');
 429
 430         $confirm = $this->getConfirmation();
 431
 432         if (!$confirm) {
 433             // TRANS: Message given canceling e-mail address confirmation that is not pending.
 434             $this->showForm(_('No pending confirmation to cancel.'));
 435             return;
 436         }
 437         if ($confirm->address != $email) {
 438             // TRANS: Message given canceling e-mail address confirmation for the wrong e-mail address.
 439             $this->showForm(_('That is the wrong email address.'));
 440             return;
 441         }
 442
 443         $result = $confirm->delete();
 444
 445         if (!$result) {
 446             common_log_db_error($confirm, 'DELETE', __FILE__);
 447             // TRANS: Server error thrown on database error canceling e-mail address confirmation.
 448             $this->serverError(_('Couldn\'t delete email confirmation.'));
 449             return;
 450         }
 451
 452         // TRANS: Message given after successfully canceling e-mail address confirmation.
 453         $this->showForm(_('Email confirmation cancelled.'), true);
 454     }
 455
 456     /**
 457      * Handle a request to remove an address from the user's account
 458      *
 459      * @return void
 460      */
 461
 462     function removeAddress()
 463     {
 464         $user = common_current_user();
 465
 466         $email = $this->arg('email');
 467
 468         // Maybe an old tab open...?
 469
 470         if ($user->email != $email) {
 471             // TRANS: Message given trying to remove an e-mail address that is not
 472             // TRANS: registered for the active user.
 473             $this->showForm(_('That is not your email address.'));
 474             return;
 475         }
 476
 477         $user->query('BEGIN');
 478
 479         $original = clone($user);
 480
 481         $user->email = null;
 482
 483         $result = $user->updateKeys($original);
 484
 485         if (!$result) {
 486             common_log_db_error($user, 'UPDATE', __FILE__);
 487             // TRANS: Server error thrown on database error removing a registered e-mail address.
 488             $this->serverError(_('Couldn\'t update user.'));
 489             return;
 490         }
 491         $user->query('COMMIT');
 492
 493         // TRANS: Message given after successfully removing a registered e-mail address.
 494         $this->showForm(_('The email address was removed.'), true);
 495     }
 496
 497     /**
 498      * Handle a request to remove an incoming email address
 499      *
 500      * @return void
 501      */
 502
 503     function removeIncoming()
 504     {
 505         $user = common_current_user();
 506
 507         if (!$user->incomingemail) {
 508             $this->showForm(_('No incoming email address.'));
 509             return;
 510         }
 511
 512         $orig = clone($user);
 513
 514         $user->incomingemail = null;
 515
 516         if (!$user->updateKeys($orig)) {
 517             common_log_db_error($user, 'UPDATE', __FILE__);
 518             // TRANS: Server error thrown on database error removing incoming e-mail address.
 519             $this->serverError(_("Couldn't update user record."));
 520         }
 521
 522         // TRANS: Message given after successfully removing an incoming e-mail address.
 523         $this->showForm(_('Incoming email address removed.'), true);
 524     }
 525
 526     /**
 527      * Generate a new incoming email address
 528      *
 529      * @return void
 530      */
 531
 532     function newIncoming()
 533     {
 534         $user = common_current_user();
 535
 536         $orig = clone($user);
 537
 538         $user->incomingemail = mail_new_incoming_address();
 539
 540         if (!$user->updateKeys($orig)) {
 541             common_log_db_error($user, 'UPDATE', __FILE__);
 542             // TRANS: Server error thrown on database error adding incoming e-mail address.
 543             $this->serverError(_("Couldn't update user record."));
 544         }
 545
 546         // TRANS: Message given after successfully adding an incoming e-mail address.
 547         $this->showForm(_('New incoming email address added.'), true);
 548     }
 549
 550     /**
 551      * Does another user already have this email address?
 552      *
 553      * Email addresses are unique for users.
 554      *
 555      * @param string $email Address to check
 556      *
 557      * @return boolean Whether the email already exists.
 558      */
 559
 560     function emailExists($email)
 561     {
 562         $user = common_current_user();
 563
 564         $other = User::staticGet('email', $email);
 565
 566         if (!$other) {
 567             return false;
 568         } else {
 569             return $other->id != $user->id;
 570         }
 571     }
 572 }