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