actions/emailsettings.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  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/
  29  */
  30
  31 if (!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  Laconica
  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/
  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         return _('Email Settings');
  61     }
  62
  63     /**
  64      * Instructions for use
  65      *
  66      * @return instructions for use
  67      */
  68
  69     function getInstructions()
  70     {
  71         return _('Manage how you get email from %%site.name%%.');
  72     }
  73
  74     /**
  75      * Content area of the page
  76      *
  77      * Shows a form for adding and removing email addresses and setting
  78      * email preferences.
  79      *
  80      * @return void
  81      */
  82
  83     function showContent()
  84     {
  85         $user = common_current_user();
  86
  87         $this->elementStart('form', array('method' => 'post',
  88                                           'id' => 'form_settings_email',
  89                                           'class' => 'form_settings',
  90                                           'action' =>
  91                                           common_local_url('emailsettings')));
  92
  93         $this->elementStart('fieldset', array('id' => 'settings_email_address'));
  94         $this->element('legend', null, _('Address'));
  95         $this->hidden('token', common_session_token());
  96
  97         if ($user->email) {
  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'));
 102         } else {
 103             $confirm = $this->getConfirmation();
 104             if ($confirm) {
 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'));
 112             } else {
 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'));
 121             }
 122         }
 123         $this->elementEnd('fieldset');
 124
 125        if ($user->email) {
 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'));
 135             }
 136
 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');
 144         }
 145
 146         $this->elementStart('fieldset', array('id' => 'settings_email_preferences'));
 147         $this->element('legend', null, _('Preferences'));
 148
 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.'),
 174                         $user->emailpost);
 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');
 185     }
 186
 187     /**
 188      * Gets any existing email address confirmations we're waiting for
 189      *
 190      * @return Confirm_address Email address confirmation for user, or null
 191      */
 192
 193     function getConfirmation()
 194     {
 195         $user = common_current_user();
 196
 197         $confirm = new Confirm_address();
 198
 199         $confirm->user_id      = $user->id;
 200         $confirm->address_type = 'email';
 201
 202         if ($confirm->find(true)) {
 203             return $confirm;
 204         } else {
 205             return null;
 206         }
 207     }
 208
 209     /**
 210      * Handle posts
 211      *
 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
 214      * pushed
 215      *
 216      * @return void
 217      */
 218
 219     function handlePost()
 220     {
 221         // CSRF protection
 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.'));
 226             return;
 227         }
 228
 229         if ($this->arg('save')) {
 230             $this->savePreferences();
 231         } else if ($this->arg('add')) {
 232             $this->addAddress();
 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();
 241         } else {
 242             $this->showForm(_('Unexpected form submission.'));
 243         }
 244     }
 245
 246     /**
 247      * Save email preferences
 248      *
 249      * @return void
 250      */
 251
 252     function savePreferences()
 253     {
 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');
 260
 261         $user = common_current_user();
 262
 263         assert(!is_null($user)); // should already be checked
 264
 265         $user->query('BEGIN');
 266
 267         $original = clone($user);
 268
 269         $user->emailnotifysub   = $emailnotifysub;
 270         $user->emailnotifyfav   = $emailnotifyfav;
 271         $user->emailnotifymsg   = $emailnotifymsg;
 272         $user->emailnotifynudge = $emailnotifynudge;
 273         $user->emailmicroid     = $emailmicroid;
 274         $user->emailpost        = $emailpost;
 275
 276         $result = $user->update($original);
 277
 278         if ($result === false) {
 279             common_log_db_error($user, 'UPDATE', __FILE__);
 280             $this->serverError(_('Couldn\'t update user.'));
 281             return;
 282         }
 283
 284         $user->query('COMMIT');
 285
 286         $this->showForm(_('Preferences saved.'), true);
 287     }
 288
 289     /**
 290      * Add the address passed in by the user
 291      *
 292      * @return void
 293      */
 294
 295     function addAddress()
 296     {
 297         $user = common_current_user();
 298
 299         $email = $this->trimmed('email');
 300
 301         // Some validation
 302
 303         if (!$email) {
 304             $this->showForm(_('No email address.'));
 305             return;
 306         }
 307
 308         $email = common_canonical_email($email);
 309
 310         if (!$email) {
 311             $this->showForm(_('Cannot normalize that email address'));
 312             return;
 313         }
 314         if (!Validate::email($email, true)) {
 315             $this->showForm(_('Not a valid email address'));
 316             return;
 317         } else if ($user->email == $email) {
 318             $this->showForm(_('That is already your email address.'));
 319             return;
 320         } else if ($this->emailExists($email)) {
 321             $this->showForm(_('That email address already belongs '.
 322                               'to another user.'));
 323             return;
 324         }
 325
 326         $confirm = new Confirm_address();
 327
 328         $confirm->address      = $email;
 329         $confirm->address_type = 'email';
 330         $confirm->user_id      = $user->id;
 331         $confirm->code         = common_confirmation_code(64);
 332
 333         $result = $confirm->insert();
 334
 335         if ($result === false) {
 336             common_log_db_error($confirm, 'INSERT', __FILE__);
 337             $this->serverError(_('Couldn\'t insert confirmation code.'));
 338             return;
 339         }
 340
 341         mail_confirm_address($user, $confirm->code, $user->nickname, $email);
 342
 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.');
 346
 347         $this->showForm($msg, true);
 348     }
 349
 350     /**
 351      * Handle a request to cancel email confirmation
 352      *
 353      * @return void
 354      */
 355
 356     function cancelConfirmation()
 357     {
 358         $email = $this->arg('email');
 359
 360         $confirm = $this->getConfirmation();
 361
 362         if (!$confirm) {
 363             $this->showForm(_('No pending confirmation to cancel.'));
 364             return;
 365         }
 366         if ($confirm->address != $email) {
 367             $this->showForm(_('That is the wrong IM address.'));
 368             return;
 369         }
 370
 371         $result = $confirm->delete();
 372
 373         if (!$result) {
 374             common_log_db_error($confirm, 'DELETE', __FILE__);
 375             $this->serverError(_('Couldn\'t delete email confirmation.'));
 376             return;
 377         }
 378
 379         $this->showForm(_('Confirmation cancelled.'), true);
 380     }
 381
 382     /**
 383      * Handle a request to remove an address from the user's account
 384      *
 385      * @return void
 386      */
 387
 388     function removeAddress()
 389     {
 390         $user = common_current_user();
 391
 392         $email = $this->arg('email');
 393
 394         // Maybe an old tab open...?
 395
 396         if ($user->email != $email) {
 397             $this->showForm(_('That is not your email address.'));
 398             return;
 399         }
 400
 401         $user->query('BEGIN');
 402
 403         $original = clone($user);
 404
 405         $user->email = null;
 406
 407         $result = $user->updateKeys($original);
 408
 409         if (!$result) {
 410             common_log_db_error($user, 'UPDATE', __FILE__);
 411             $this->serverError(_('Couldn\'t update user.'));
 412             return;
 413         }
 414         $user->query('COMMIT');
 415
 416         $this->showForm(_('The address was removed.'), true);
 417     }
 418
 419     /**
 420      * Handle a request to remove an incoming email address
 421      *
 422      * @return void
 423      */
 424
 425     function removeIncoming()
 426     {
 427         $user = common_current_user();
 428
 429         if (!$user->incomingemail) {
 430             $this->showForm(_('No incoming email address.'));
 431             return;
 432         }
 433
 434         $orig = clone($user);
 435
 436         $user->incomingemail = null;
 437
 438         if (!$user->updateKeys($orig)) {
 439             common_log_db_error($user, 'UPDATE', __FILE__);
 440             $this->serverError(_("Couldn't update user record."));
 441         }
 442
 443         $this->showForm(_('Incoming email address removed.'), true);
 444     }
 445
 446     /**
 447      * Generate a new incoming email address
 448      *
 449      * @return void
 450      */
 451
 452     function newIncoming()
 453     {
 454         $user = common_current_user();
 455
 456         $orig = clone($user);
 457
 458         $user->incomingemail = mail_new_incoming_address();
 459
 460         if (!$user->updateKeys($orig)) {
 461             common_log_db_error($user, 'UPDATE', __FILE__);
 462             $this->serverError(_("Couldn't update user record."));
 463         }
 464
 465         $this->showForm(_('New incoming email address added.'), true);
 466     }
 467
 468     /**
 469      * Does another user already have this email address?
 470      *
 471      * Email addresses are unique for users.
 472      *
 473      * @param string $email Address to check
 474      *
 475      * @return boolean Whether the email already exists.
 476      */
 477
 478     function emailExists($email)
 479     {
 480         $user = common_current_user();
 481
 482         $other = User::staticGet('email', $email);
 483
 484         if (!$other) {
 485             return false;
 486         } else {
 487             return $other->id != $user->id;
 488         }
 489     }
 490 }