actions/imsettings.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Settings for Jabber/XMPP integration
   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  * @copyright 2008-2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Settings for Jabber/XMPP integration
  36  *
  37  * @category Settings
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  42  *
  43  * @see      SettingsAction
  44  */
  45
  46 class ImsettingsAction extends SettingsAction
  47 {
  48     /**
  49      * Title of the page
  50      *
  51      * @return string Title of the page
  52      */
  53     function title()
  54     {
  55         // TRANS: Title for Instant Messaging settings.
  56         return _('IM settings');
  57     }
  58
  59     /**
  60      * Instructions for use
  61      *
  62      * @return instructions for use
  63      */
  64     function getInstructions()
  65     {
  66         // TRANS: Instant messaging settings page instructions.
  67         // TRANS: [instant messages] is link text, "(%%doc.im%%)" is the link.
  68         // TRANS: the order and formatting of link text and link should remain unchanged.
  69         return _('You can send and receive notices through '.
  70                  'instant messaging [instant messages](%%doc.im%%). '.
  71                  'Configure your addresses and settings below.');
  72     }
  73
  74     /**
  75      * Content area of the page
  76      *
  77      * We make different sections of the form for the different kinds of
  78      * functions, and have submit buttons with different names. These
  79      * are muxed by handlePost() to see what the user really wants to do.
  80      *
  81      * @return void
  82      */
  83     function showContent()
  84     {
  85         $transports = array();
  86         Event::handle('GetImTransports', array(&$transports));
  87         if (! $transports) {
  88             $this->element('div', array('class' => 'error'),
  89                            // TRANS: Message given in the IM settings if IM is not enabled on the site.
  90                            _('IM is not available.'));
  91             return;
  92         }
  93
  94         $user = common_current_user();
  95
  96         $user_im_prefs_by_transport = array();
  97
  98         foreach($transports as $transport=>$transport_info)
  99         {
 100             $this->elementStart('form', array('method' => 'post',
 101                                               'id' => 'form_settings_im',
 102                                               'class' => 'form_settings',
 103                                               'action' =>
 104                                               common_local_url('imsettings')));
 105             $this->elementStart('fieldset', array('id' => 'settings_im_address'));
 106             // TRANS: Form legend for IM settings form.
 107             $this->element('legend', null, $transport_info['display']);
 108             $this->hidden('token', common_session_token());
 109             $this->hidden('transport', $transport);
 110
 111             if ($user_im_prefs = User_im_prefs::pkeyGet( array('transport' => $transport, 'user_id' => $user->id) )) {
 112                 $user_im_prefs_by_transport[$transport] = $user_im_prefs;
 113                 $this->element('p', 'form_confirmed', $user_im_prefs->screenname);
 114                 // TRANS: Form note in IM settings form.
 115                 $this->element('p', 'form_note',
 116                                sprintf(_('Current confirmed %s address.'),$transport_info['display']));
 117                 $this->hidden('screenname', $user_im_prefs->screenname);
 118                 // TRANS: Button label to remove a confirmed IM address.
 119                 $this->submit('remove', _m('BUTTON','Remove'));
 120             } else {
 121                 $confirm = $this->getConfirmation($transport);
 122                 if ($confirm) {
 123                     $this->element('p', 'form_unconfirmed', $confirm->address);
 124                     // TRANS: Form note in IM settings form.
 125                     $this->element('p', 'form_note',
 126                                    // TRANS: Form note in IM settings form.
 127                                    // TRANS: %s is the IM address set for the site.
 128                                    sprintf(_('Awaiting confirmation on this address. '.
 129                                              'Check your %s account for a '.
 130                                              'message with further instructions. '.
 131                                              '(Did you add %s to your buddy list?)'),
 132                                              $transport_info['display'],
 133                                              $transport_info['daemonScreenname']));
 134                     $this->hidden('screenname', $confirm->address);
 135                     // TRANS: Button label to cancel an IM address confirmation procedure.
 136                     $this->submit('cancel', _m('BUTTON','Cancel'));
 137                 } else {
 138                     $this->elementStart('ul', 'form_data');
 139                     $this->elementStart('li');
 140                     $this->input('screenname', _('IM address'),
 141                                  ($this->arg('screenname')) ? $this->arg('screenname') : null,
 142                                  sprintf(_('%s screenname.'),
 143                                          $transport_info['display']));
 144                     $this->elementEnd('li');
 145                     $this->elementEnd('ul');
 146                     // TRANS: Button label for adding an IM address in IM settings form.
 147                     $this->submit('add', _m('BUTTON','Add'));
 148                 }
 149             }
 150             $this->elementEnd('fieldset');
 151             $this->elementEnd('form');
 152         }
 153
 154         if($user_im_prefs_by_transport)
 155         {
 156             $this->elementStart('form', array('method' => 'post',
 157                                               'id' => 'form_settings_im',
 158                                               'class' => 'form_settings',
 159                                               'action' =>
 160                                               common_local_url('imsettings')));
 161             $this->elementStart('fieldset', array('id' => 'settings_im_preferences'));
 162             // TRANS: Header for IM preferences form.
 163             $this->element('legend', null, _('IM Preferences'));
 164             $this->hidden('token', common_session_token());
 165             $this->elementStart('table');
 166             $this->elementStart('tr');
 167             foreach($user_im_prefs_by_transport as $transport=>$user_im_prefs)
 168             {
 169                 $this->element('th', null, $transports[$transport]['display']);
 170             }
 171             $this->elementEnd('tr');
 172             $preferences = array(
 173                 // TRANS: Checkbox label in IM preferences form.
 174                 array('name'=>'notify', 'description'=>_('Send me notices')),
 175                 // TRANS: Checkbox label in IM preferences form.
 176                 array('name'=>'updatefrompresence', 'description'=>_('Post a notice when my status changes.')),
 177                 // TRANS: Checkbox label in IM preferences form.
 178                 array('name'=>'replies', 'description'=>_('Send me replies '.
 179                               'from people I\'m not subscribed to.')),
 180                 // TRANS: Checkbox label in IM preferences form.
 181                 array('name'=>'microid', 'description'=>_('Publish a MicroID'))
 182             );
 183             foreach($preferences as $preference)
 184             {
 185                 $this->elementStart('tr');
 186                 foreach($user_im_prefs_by_transport as $transport=>$user_im_prefs)
 187                 {
 188                     $preference_name = $preference['name'];
 189                     $this->elementStart('td');
 190                     $this->checkbox($transport . '_' . $preference['name'],
 191                                 $preference['description'],
 192                                 $user_im_prefs->$preference_name);
 193                     $this->elementEnd('td');
 194                 }
 195                 $this->elementEnd('tr');
 196             }
 197             $this->elementEnd('table');
 198             // TRANS: Button label to save IM preferences.
 199             $this->submit('save', _m('BUTTON','Save'));
 200             $this->elementEnd('fieldset');
 201             $this->elementEnd('form');
 202         }
 203     }
 204
 205     /**
 206      * Get a confirmation code for this user
 207      *
 208      * @return Confirm_address address object for this user
 209      */
 210     function getConfirmation($transport)
 211     {
 212         $user = common_current_user();
 213
 214         $confirm = new Confirm_address();
 215
 216         $confirm->user_id      = $user->id;
 217         $confirm->address_type = $transport;
 218
 219         if ($confirm->find(true)) {
 220             return $confirm;
 221         } else {
 222             return null;
 223         }
 224     }
 225
 226     /**
 227      * Handle posts to this form
 228      *
 229      * Based on the button that was pressed, muxes out to other functions
 230      * to do the actual task requested.
 231      *
 232      * All sub-functions reload the form with a message -- success or failure.
 233      *
 234      * @return void
 235      */
 236     function handlePost()
 237     {
 238         // CSRF protection
 239         $token = $this->trimmed('token');
 240         if (!$token || $token != common_session_token()) {
 241             $this->showForm(_('There was a problem with your session token. '.
 242                               'Try again, please.'));
 243             return;
 244         }
 245
 246         if ($this->arg('save')) {
 247             $this->savePreferences();
 248         } else if ($this->arg('add')) {
 249             $this->addAddress();
 250         } else if ($this->arg('cancel')) {
 251             $this->cancelConfirmation();
 252         } else if ($this->arg('remove')) {
 253             $this->removeAddress();
 254         } else {
 255             // TRANS: Message given submitting a form with an unknown action in Instant Messaging settings.
 256             $this->showForm(_('Unexpected form submission.'));
 257         }
 258     }
 259
 260     /**
 261      * Save user's Jabber preferences
 262      *
 263      * These are the checkboxes at the bottom of the page. They're used to
 264      * set different settings
 265      *
 266      * @return void
 267      */
 268     function savePreferences()
 269     {
 270         $user = common_current_user();
 271
 272         $user_im_prefs = new User_im_prefs();
 273         $user_im_prefs->query('BEGIN');
 274         $user_im_prefs->user_id = $user->id;
 275         if($user_im_prefs->find() && $user_im_prefs->fetch())
 276         {
 277             $preferences = array('notify', 'updatefrompresence', 'replies', 'microid');
 278             do
 279             {
 280                 $original = clone($user_im_prefs);
 281                 $new = clone($user_im_prefs);
 282                 foreach($preferences as $preference)
 283                 {
 284                     $new->$preference = $this->boolean($new->transport . '_' . $preference);
 285                 }
 286                 $result = $new->update($original);
 287
 288                 if ($result === false) {
 289                     common_log_db_error($user, 'UPDATE', __FILE__);
 290                     // TRANS: Server error thrown on database error updating IM preferences.
 291                     $this->serverError(_('Couldn\'t update IM preferences.'));
 292                     return;
 293                 }
 294             }while($user_im_prefs->fetch());
 295         }
 296         $user_im_prefs->query('COMMIT');
 297         // TRANS: Confirmation message for successful IM preferences save.
 298         $this->showForm(_('Preferences saved.'), true);
 299     }
 300
 301     /**
 302      * Sends a confirmation to the address given
 303      *
 304      * Stores a confirmation record and sends out a
 305      * message with the confirmation info.
 306      *
 307      * @return void
 308      */
 309     function addAddress()
 310     {
 311         $user = common_current_user();
 312
 313         $screenname = $this->trimmed('screenname');
 314         $transport = $this->trimmed('transport');
 315
 316         // Some validation
 317
 318         if (!$screenname) {
 319             // TRANS: Message given saving IM address without having provided one.
 320             $this->showForm(_('No screenname.'));
 321             return;
 322         }
 323
 324         if (!$transport) {
 325             $this->showForm(_('No transport.'));
 326             return;
 327         }
 328
 329         Event::handle('NormalizeImScreenname', array($transport, &$screenname));
 330
 331         if (!$screenname) {
 332             // TRANS: Message given saving IM address that cannot be normalised.
 333             $this->showForm(_('Cannot normalize that screenname'));
 334             return;
 335         }
 336         $valid = false;
 337         Event::handle('ValidateImScreenname', array($transport, $screenname, &$valid));
 338         if (!$valid) {
 339             // TRANS: Message given saving IM address that not valid.
 340             $this->showForm(_('Not a valid screenname'));
 341             return;
 342         } else if ($this->screennameExists($transport, $screenname)) {
 343             // TRANS: Message given saving IM address that is already set for another user.
 344             $this->showForm(_('Screenname already belongs to another user.'));
 345             return;
 346         }
 347
 348         $confirm = new Confirm_address();
 349
 350         $confirm->address      = $screenname;
 351         $confirm->address_type = $transport;
 352         $confirm->user_id      = $user->id;
 353         $confirm->code         = common_confirmation_code(64);
 354         $confirm->sent         = common_sql_now();
 355         $confirm->claimed      = common_sql_now();
 356
 357         $result = $confirm->insert();
 358
 359         if ($result === false) {
 360             common_log_db_error($confirm, 'INSERT', __FILE__);
 361             // TRANS: Server error thrown on database error adding Instant Messaging confirmation code.
 362             $this->serverError(_('Could not insert confirmation code.'));
 363             return;
 364         }
 365
 366         Event::handle('SendImConfirmationCode', array($transport, $screenname, $confirm->code, $user));
 367
 368         // TRANS: Message given saving valid IM address that is to be confirmed.
 369         $msg = _('A confirmation code was sent '.
 370                          'to the IM address you added.');
 371
 372         $this->showForm($msg, true);
 373     }
 374
 375     /**
 376      * Cancel a confirmation
 377      *
 378      * If a confirmation exists, cancel it.
 379      *
 380      * @return void
 381      */
 382     function cancelConfirmation()
 383     {
 384         $screenname = $this->trimmed('screenname');
 385         $transport = $this->trimmed('transport');
 386
 387         $confirm = $this->getConfirmation($transport);
 388
 389         if (!$confirm) {
 390             // TRANS: Message given canceling Instant Messaging address confirmation that is not pending.
 391             $this->showForm(_('No pending confirmation to cancel.'));
 392             return;
 393         }
 394         if ($confirm->address != $screenname) {
 395             // TRANS: Message given canceling IM address confirmation for the wrong IM address.
 396             $this->showForm(_('That is the wrong IM address.'));
 397             return;
 398         }
 399
 400         $result = $confirm->delete();
 401
 402         if (!$result) {
 403             common_log_db_error($confirm, 'DELETE', __FILE__);
 404             // TRANS: Server error thrown on database error canceling IM address confirmation.
 405             $this->serverError(_('Couldn\'t delete confirmation.'));
 406             return;
 407         }
 408
 409         // TRANS: Message given after successfully canceling IM address confirmation.
 410         $this->showForm(_('IM confirmation cancelled.'), true);
 411     }
 412
 413     /**
 414      * Remove an address
 415      *
 416      * If the user has a confirmed address, remove it.
 417      *
 418      * @return void
 419      */
 420     function removeAddress()
 421     {
 422         $user = common_current_user();
 423
 424         $screenname = $this->trimmed('screenname');
 425         $transport = $this->trimmed('transport');
 426
 427         // Maybe an old tab open...?
 428
 429         $user_im_prefs = new User_im_prefs();
 430         $user_im_prefs->user_id = $user->id;
 431         if(! ($user_im_prefs->find() && $user_im_prefs->fetch())) {
 432             // TRANS: Message given trying to remove an IM address that is not
 433             // TRANS: registered for the active user.
 434             $this->showForm(_('That is not your screenname.'));
 435             return;
 436         }
 437
 438         $result = $user_im_prefs->delete();
 439
 440         if (!$result) {
 441             common_log_db_error($user, 'UPDATE', __FILE__);
 442             // TRANS: Server error thrown on database error removing a registered IM address.
 443             $this->serverError(_('Couldn\'t update user im prefs.'));
 444             $this->serverError(_('Couldn\'t update user.'));
 445             return;
 446         }
 447
 448         // XXX: unsubscribe to the old address
 449
 450         // TRANS: Message given after successfully removing a registered Instant Messaging address.
 451         $this->showForm(_('The IM address was removed.'), true);
 452     }
 453
 454     /**
 455      * Does this screenname exist?
 456      *
 457      * Checks if we already have another user with this address.
 458      *
 459      * @param string $transport Transport to check
 460      * @param string $screenname Screenname to check
 461      *
 462      * @return boolean whether the screenname exists
 463      */
 464
 465     function screennameExists($transport, $screenname)
 466     {
 467         $user = common_current_user();
 468
 469         $user_im_prefs = new User_im_prefs();
 470         $user_im_prefs->transport = $transport;
 471         $user_im_prefs->screenname = $screenname;
 472         if($user_im_prefs->find() && $user_im_prefs->fetch()){
 473             return true;
 474         }else{
 475             return false;
 476         }
 477     }
 478 }