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                 $this->element('p', 'form_note',
 115                                // TRANS: Form note in IM settings form. %s is the type of IM address that was confirmed.
 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 service name, %2$s is the IM address set.
 128                                    sprintf(_('Awaiting confirmation on this address. '.
 129                                              'Check your %1$s account for a '.
 130                                              'message with further instructions. '.
 131                                              '(Did you add %2$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                     // TRANS: Field label for IM address.
 141                     $this->input('screenname', _('IM address'),
 142                                  ($this->arg('screenname')) ? $this->arg('screenname') : null,
 143                                  // TRANS: Field title for IM address. %s is the IM service name.
 144                                  sprintf(_('%s screenname.'),
 145                                          $transport_info['display']));
 146                     $this->elementEnd('li');
 147                     $this->elementEnd('ul');
 148                     // TRANS: Button label for adding an IM address in IM settings form.
 149                     $this->submit('add', _m('BUTTON','Add'));
 150                 }
 151             }
 152             $this->elementEnd('fieldset');
 153             $this->elementEnd('form');
 154         }
 155
 156         if($user_im_prefs_by_transport)
 157         {
 158             $this->elementStart('form', array('method' => 'post',
 159                                               'id' => 'form_settings_im',
 160                                               'class' => 'form_settings',
 161                                               'action' =>
 162                                               common_local_url('imsettings')));
 163             $this->elementStart('fieldset', array('id' => 'settings_im_preferences'));
 164             // TRANS: Header for IM preferences form.
 165             $this->element('legend', null, _('IM Preferences'));
 166             $this->hidden('token', common_session_token());
 167             $this->elementStart('table');
 168             $this->elementStart('tr');
 169             foreach($user_im_prefs_by_transport as $transport=>$user_im_prefs)
 170             {
 171                 $this->element('th', null, $transports[$transport]['display']);
 172             }
 173             $this->elementEnd('tr');
 174             $preferences = array(
 175                 // TRANS: Checkbox label in IM preferences form.
 176                 array('name'=>'notify', 'description'=>_('Send me notices')),
 177                 // TRANS: Checkbox label in IM preferences form.
 178                 array('name'=>'updatefrompresence', 'description'=>_('Post a notice when my status changes.')),
 179                 // TRANS: Checkbox label in IM preferences form.
 180                 array('name'=>'replies', 'description'=>_('Send me replies '.
 181                               'from people I\'m not subscribed to.')),
 182                 // TRANS: Checkbox label in IM preferences form.
 183                 array('name'=>'microid', 'description'=>_('Publish a MicroID'))
 184             );
 185             foreach($preferences as $preference)
 186             {
 187                 $this->elementStart('tr');
 188                 foreach($user_im_prefs_by_transport as $transport=>$user_im_prefs)
 189                 {
 190                     $preference_name = $preference['name'];
 191                     $this->elementStart('td');
 192                     $this->checkbox($transport . '_' . $preference['name'],
 193                                 $preference['description'],
 194                                 $user_im_prefs->$preference_name);
 195                     $this->elementEnd('td');
 196                 }
 197                 $this->elementEnd('tr');
 198             }
 199             $this->elementEnd('table');
 200             // TRANS: Button label to save IM preferences.
 201             $this->submit('save', _m('BUTTON','Save'));
 202             $this->elementEnd('fieldset');
 203             $this->elementEnd('form');
 204         }
 205     }
 206
 207     /**
 208      * Get a confirmation code for this user
 209      *
 210      * @return Confirm_address address object for this user
 211      */
 212     function getConfirmation($transport)
 213     {
 214         $user = common_current_user();
 215
 216         $confirm = new Confirm_address();
 217
 218         $confirm->user_id      = $user->id;
 219         $confirm->address_type = $transport;
 220
 221         if ($confirm->find(true)) {
 222             return $confirm;
 223         } else {
 224             return null;
 225         }
 226     }
 227
 228     /**
 229      * Handle posts to this form
 230      *
 231      * Based on the button that was pressed, muxes out to other functions
 232      * to do the actual task requested.
 233      *
 234      * All sub-functions reload the form with a message -- success or failure.
 235      *
 236      * @return void
 237      */
 238     function handlePost()
 239     {
 240         // CSRF protection
 241         $token = $this->trimmed('token');
 242         if (!$token || $token != common_session_token()) {
 243             // TRANS: Client error displayed when the session token does not match or is not given.
 244             $this->showForm(_('There was a problem with your session token. '.
 245                               'Try again, please.'));
 246             return;
 247         }
 248
 249         if ($this->arg('save')) {
 250             $this->savePreferences();
 251         } else if ($this->arg('add')) {
 252             $this->addAddress();
 253         } else if ($this->arg('cancel')) {
 254             $this->cancelConfirmation();
 255         } else if ($this->arg('remove')) {
 256             $this->removeAddress();
 257         } else {
 258             // TRANS: Message given submitting a form with an unknown action in Instant Messaging settings.
 259             $this->showForm(_('Unexpected form submission.'));
 260         }
 261     }
 262
 263     /**
 264      * Save user's Jabber preferences
 265      *
 266      * These are the checkboxes at the bottom of the page. They're used to
 267      * set different settings
 268      *
 269      * @return void
 270      */
 271     function savePreferences()
 272     {
 273         $user = common_current_user();
 274
 275         $user_im_prefs = new User_im_prefs();
 276         $user_im_prefs->query('BEGIN');
 277         $user_im_prefs->user_id = $user->id;
 278         if($user_im_prefs->find() && $user_im_prefs->fetch())
 279         {
 280             $preferences = array('notify', 'updatefrompresence', 'replies', 'microid');
 281             do
 282             {
 283                 $original = clone($user_im_prefs);
 284                 $new = clone($user_im_prefs);
 285                 foreach($preferences as $preference)
 286                 {
 287                     $new->$preference = $this->boolean($new->transport . '_' . $preference);
 288                 }
 289                 $result = $new->update($original);
 290
 291                 if ($result === false) {
 292                     common_log_db_error($user, 'UPDATE', __FILE__);
 293                     // TRANS: Server error thrown on database error updating IM preferences.
 294                     $this->serverError(_('Could not update IM preferences.'));
 295                     return;
 296                 }
 297             }while($user_im_prefs->fetch());
 298         }
 299         $user_im_prefs->query('COMMIT');
 300         // TRANS: Confirmation message for successful IM preferences save.
 301         $this->showForm(_('Preferences saved.'), true);
 302     }
 303
 304     /**
 305      * Sends a confirmation to the address given
 306      *
 307      * Stores a confirmation record and sends out a
 308      * message with the confirmation info.
 309      *
 310      * @return void
 311      */
 312     function addAddress()
 313     {
 314         $user = common_current_user();
 315
 316         $screenname = $this->trimmed('screenname');
 317         $transport = $this->trimmed('transport');
 318
 319         // Some validation
 320
 321         if (!$screenname) {
 322             // TRANS: Message given saving IM address without having provided one.
 323             $this->showForm(_('No screenname.'));
 324             return;
 325         }
 326
 327         if (!$transport) {
 328             // TRANS: Form validation error when no transport is available setting an IM address.
 329             $this->showForm(_('No transport.'));
 330             return;
 331         }
 332
 333         Event::handle('NormalizeImScreenname', array($transport, &$screenname));
 334
 335         if (!$screenname) {
 336             // TRANS: Message given saving IM address that cannot be normalised.
 337             $this->showForm(_('Cannot normalize that screenname.'));
 338             return;
 339         }
 340         $valid = false;
 341         Event::handle('ValidateImScreenname', array($transport, $screenname, &$valid));
 342         if (!$valid) {
 343             // TRANS: Message given saving IM address that not valid.
 344             $this->showForm(_('Not a valid screenname.'));
 345             return;
 346         } else if ($this->screennameExists($transport, $screenname)) {
 347             // TRANS: Message given saving IM address that is already set for another user.
 348             $this->showForm(_('Screenname already belongs to another user.'));
 349             return;
 350         }
 351
 352         $confirm = new Confirm_address();
 353
 354         $confirm->address      = $screenname;
 355         $confirm->address_type = $transport;
 356         $confirm->user_id      = $user->id;
 357         $confirm->code         = common_confirmation_code(64);
 358         $confirm->sent         = common_sql_now();
 359         $confirm->claimed      = common_sql_now();
 360
 361         $result = $confirm->insert();
 362
 363         if ($result === false) {
 364             common_log_db_error($confirm, 'INSERT', __FILE__);
 365             // TRANS: Server error thrown on database error adding Instant Messaging confirmation code.
 366             $this->serverError(_('Could not insert confirmation code.'));
 367             return;
 368         }
 369
 370         Event::handle('SendImConfirmationCode', array($transport, $screenname, $confirm->code, $user));
 371
 372         // TRANS: Message given saving valid IM address that is to be confirmed.
 373         $msg = _('A confirmation code was sent '.
 374                          'to the IM address you added.');
 375
 376         $this->showForm($msg, true);
 377     }
 378
 379     /**
 380      * Cancel a confirmation
 381      *
 382      * If a confirmation exists, cancel it.
 383      *
 384      * @return void
 385      */
 386     function cancelConfirmation()
 387     {
 388         $screenname = $this->trimmed('screenname');
 389         $transport = $this->trimmed('transport');
 390
 391         $confirm = $this->getConfirmation($transport);
 392
 393         if (!$confirm) {
 394             // TRANS: Message given canceling Instant Messaging address confirmation that is not pending.
 395             $this->showForm(_('No pending confirmation to cancel.'));
 396             return;
 397         }
 398         if ($confirm->address != $screenname) {
 399             // TRANS: Message given canceling IM address confirmation for the wrong IM address.
 400             $this->showForm(_('That is the wrong IM address.'));
 401             return;
 402         }
 403
 404         $result = $confirm->delete();
 405
 406         if (!$result) {
 407             common_log_db_error($confirm, 'DELETE', __FILE__);
 408             // TRANS: Server error thrown on database error canceling IM address confirmation.
 409             $this->serverError(_('Could not delete confirmation.'));
 410             return;
 411         }
 412
 413         // TRANS: Message given after successfully canceling IM address confirmation.
 414         $this->showForm(_('IM confirmation cancelled.'), true);
 415     }
 416
 417     /**
 418      * Remove an address
 419      *
 420      * If the user has a confirmed address, remove it.
 421      *
 422      * @return void
 423      */
 424     function removeAddress()
 425     {
 426         $user = common_current_user();
 427
 428         $screenname = $this->trimmed('screenname');
 429         $transport = $this->trimmed('transport');
 430
 431         // Maybe an old tab open...?
 432
 433         $user_im_prefs = new User_im_prefs();
 434         $user_im_prefs->user_id = $user->id;
 435         if(! ($user_im_prefs->find() && $user_im_prefs->fetch())) {
 436             // TRANS: Message given trying to remove an IM address that is not
 437             // TRANS: registered for the active user.
 438             $this->showForm(_('That is not your screenname.'));
 439             return;
 440         }
 441
 442         $result = $user_im_prefs->delete();
 443
 444         if (!$result) {
 445             common_log_db_error($user, 'UPDATE', __FILE__);
 446             // TRANS: Server error thrown on database error removing a registered IM address.
 447             $this->serverError(_('Could not update user IM preferences.'));
 448             return;
 449         }
 450
 451         // XXX: unsubscribe to the old address
 452
 453         // TRANS: Message given after successfully removing a registered Instant Messaging address.
 454         $this->showForm(_('The IM address was removed.'), true);
 455     }
 456
 457     /**
 458      * Does this screenname exist?
 459      *
 460      * Checks if we already have another user with this address.
 461      *
 462      * @param string $transport Transport to check
 463      * @param string $screenname Screenname to check
 464      *
 465      * @return boolean whether the screenname exists
 466      */
 467
 468     function screennameExists($transport, $screenname)
 469     {
 470         $user = common_current_user();
 471
 472         $user_im_prefs = new User_im_prefs();
 473         $user_im_prefs->transport = $transport;
 474         $user_im_prefs->screenname = $screenname;
 475         if($user_im_prefs->find() && $user_im_prefs->fetch()){
 476             return true;
 477         }else{
 478             return false;
 479         }
 480     }
 481 }