X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Fimsettings.php;h=40bea10e68b462fa3dc5dffe2709dbfb587e85c3;hb=bc1f9eb3a551bcd0ab74911791087380a16d40e0;hp=1cf3c4e69c527e3e4d4ea78627521cc0c9ff9a46;hpb=4d65b99c68fee83fe461b9d8d6db86a844f2a431;p=quix0rs-gnu-social.git diff --git a/actions/imsettings.php b/actions/imsettings.php index 1cf3c4e69c..40bea10e68 100644 --- a/actions/imsettings.php +++ b/actions/imsettings.php @@ -1,9 +1,12 @@ . + * + * @category Settings + * @package StatusNet + * @author Evan Prodromou + * @copyright 2008-2009 StatusNet, Inc. + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 + * @link http://status.net/ */ -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/settingsaction.php'); -require_once(INSTALLDIR.'/lib/jabber.php'); - -class ImsettingsAction extends SettingsAction { - - function get_instructions() { - return _('You can send and receive notices through '. - 'Jabber/GTalk [instant messages](%%doc.im%%). Configure '. - 'your address and settings below.'); - } - - function show_form($msg=NULL, $success=false) { - $user = common_current_user(); - $this->form_header(_('IM Settings'), $msg, $success); - common_element_start('form', array('method' => 'post', - 'id' => 'imsettings', - 'action' => - common_local_url('imsettings'))); - - common_element('h2', NULL, _('Address')); - - if ($user->jabber) { - common_element_start('p'); - common_element('span', 'address confirmed', $user->jabber); - common_element('span', 'input_instructions', - _('Current confirmed Jabber/GTalk address.')); - common_hidden('jabber', $user->jabber); - common_element_end('p'); - common_submit('remove', _('Remove')); - } else { - $confirm = $this->get_confirmation(); - if ($confirm) { - common_element_start('p'); - common_element('span', 'address unconfirmed', $confirm->address); - common_element('span', 'input_instructions', - sprintf(_('Awaiting confirmation on this address. Check your ' . - 'Jabber/GTalk account for a message with further ' . - 'instructions. (Did you add %s to your buddy list?)', - jabber_daemon_address()))); - common_hidden('jabber', $confirm->address); - common_element_end('p'); - common_submit('cancel', _('Cancel')); - } else { - common_input('jabber', _('IM Address'), - ($this->arg('jabber')) ? $this->arg('jabber') : NULL, - sprintf(_('Jabber or GTalk address, like "UserName@example.org". ' . - 'First, make sure to add %s' . - ' to your buddy list in your IM client or on GTalk.'), jabber_daemon_address())); - common_submit('add', _('Add')); - } - } - - common_element('h2', NULL, _('Preferences')); - - common_checkbox('jabbernotify', - _('Send me notices through Jabber/GTalk.'), - $user->jabbernotify); - common_checkbox('updatefrompresence', - _('Post a notice when my Jabber/GTalk status changes.'), - $user->updatefrompresence); - common_submit('save', _('Save')); - - common_element_end('form'); - common_show_footer(); - } - - function get_confirmation() { - $user = common_current_user(); - $confirm = new Confirm_address(); - $confirm->user_id = $user->id; - $confirm->address_type = 'jabber'; - if ($confirm->find(TRUE)) { - return $confirm; - } else { - return NULL; - } - } - - function handle_post() { - - if ($this->arg('save')) { - $this->save_preferences(); - } else if ($this->arg('add')) { - $this->add_address(); - } else if ($this->arg('cancel')) { - $this->cancel_confirmation(); - } else if ($this->arg('remove')) { - $this->remove_address(); - } else { - $this->show_form(_('Unexpected form submission.')); - } - } - - function save_preferences() { - - $jabbernotify = $this->boolean('jabbernotify'); - $updatefrompresence = $this->boolean('updatefrompresence'); - - $user = common_current_user(); - - assert(!is_null($user)); # should already be checked - - $user->query('BEGIN'); - - $original = clone($user); - - $user->jabbernotify = $jabbernotify; - $user->updatefrompresence = $updatefrompresence; - - $result = $user->update($original); - - if ($result === FALSE) { - common_log_db_error($user, 'UPDATE', __FILE__); - common_server_error(_('Couldnt update user.')); - return; - } - - $user->query('COMMIT'); - - $this->show_form(_('Preferences saved.'), true); - } - - function add_address() { - - $user = common_current_user(); - - $jabber = $this->trimmed('jabber'); - - # Some validation - - if (!$jabber) { - $this->show_form(_('No Jabber ID.')); - return; - } - - $jabber = jabber_normalize_jid($jabber); - - if (!$jabber) { - $this->show_form(_('Cannot normalize that Jabber ID')); - return; - } - if (!jabber_valid_base_jid($jabber)) { - $this->show_form(_('Not a valid Jabber ID')); - return; - } else if ($user->jabber == $jabber) { - $this->show_form(_('That is already your Jabber ID.')); - return; - } else if ($this->jabber_exists($jabber)) { - $this->show_form(_('Jabber ID already belongs to another user.')); - return; - } - - $confirm = new Confirm_address(); - $confirm->address = $jabber; - $confirm->address_type = 'jabber'; - $confirm->user_id = $user->id; - $confirm->code = common_confirmation_code(64); - - $result = $confirm->insert(); - - if ($result === FALSE) { - common_log_db_error($confirm, 'INSERT', __FILE__); - common_server_error(_('Couldnt insert confirmation code.')); - return; - } - - if (!common_config('queue', 'enabled')) { - jabber_confirm_address($confirm->code, - $user->nickname, - $jabber); - } - - $msg = sprintf(_('A confirmation code was sent to the IM address you added. ' . - 'You must approve %s for sending messages to you.'), jabber_daemon_address()); - - $this->show_form($msg, TRUE); - } +if (!defined('GNUSOCIAL')) { exit(1); } + +/** + * Settings for Jabber/XMPP integration + * + * @category Settings + * @package StatusNet + * @author Evan Prodromou + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 + * @link http://status.net/ + * + * @see SettingsAction + */ - function cancel_confirmation() { - $jabber = $this->arg('jabber'); - $confirm = $this->get_confirmation(); - if (!$confirm) { - $this->show_form(_('No pending confirmation to cancel.')); - return; - } - if ($confirm->address != $jabber) { - $this->show_form(_('That is the wrong IM address.')); - return; - } +class ImsettingsAction extends SettingsAction +{ + /** + * Title of the page + * + * @return string Title of the page + */ + function title() + { + // TRANS: Title for Instant Messaging settings. + return _('IM settings'); + } + + /** + * Instructions for use + * + * @return instructions for use + */ + function getInstructions() + { + // TRANS: Instant messaging settings page instructions. + // TRANS: [instant messages] is link text, "(%%doc.im%%)" is the link. + // TRANS: the order and formatting of link text and link should remain unchanged. + return _('You can send and receive notices through '. + '[instant messaging](%%doc.im%%). '. + 'Configure your addresses and settings below.'); + } + + /** + * Content area of the page + * + * We make different sections of the form for the different kinds of + * functions, and have submit buttons with different names. These + * are muxed by handlePost() to see what the user really wants to do. + * + * @return void + */ + function showContent() + { + $transports = array(); + Event::handle('GetImTransports', array(&$transports)); + if (! $transports) { + $this->element('div', array('class' => 'error'), + // TRANS: Message given in the IM settings if IM is not enabled on the site. + _('IM is not available.')); + return; + } + + $user = common_current_user(); + + $user_im_prefs_by_transport = array(); + + foreach($transports as $transport=>$transport_info) + { + $this->elementStart('form', array('method' => 'post', + 'id' => 'form_settings_im', + 'class' => 'form_settings', + 'action' => + common_local_url('imsettings'))); + $this->elementStart('fieldset', array('id' => 'settings_im_address')); + // TRANS: Form legend for IM settings form. + $this->element('legend', null, $transport_info['display']); + $this->hidden('token', common_session_token()); + $this->hidden('transport', $transport); + + if ($user_im_prefs = User_im_prefs::pkeyGet( array('transport' => $transport, 'user_id' => $user->id) )) { + $user_im_prefs_by_transport[$transport] = $user_im_prefs; + $this->element('p', 'form_confirmed', $user_im_prefs->screenname); + $this->element('p', 'form_note', + // TRANS: Form note in IM settings form. %s is the type of IM address that was confirmed. + sprintf(_('Current confirmed %s address.'),$transport_info['display'])); + $this->hidden('screenname', $user_im_prefs->screenname); + // TRANS: Button label to remove a confirmed IM address. + $this->submit('remove', _m('BUTTON','Remove')); + } else { + try { + $confirm = $this->getConfirmation($transport); + $this->element('p', 'form_unconfirmed', $confirm->address); + // TRANS: Form note in IM settings form. + $this->element('p', 'form_note', + // TRANS: Form note in IM settings form. + // TRANS: %s is the IM service name, %2$s is the IM address set. + sprintf(_('Awaiting confirmation on this address. '. + 'Check your %1$s account for a '. + 'message with further instructions. '. + '(Did you add %2$s to your buddy list?)'), + $transport_info['display'], + $transport_info['daemonScreenname'])); + $this->hidden('screenname', $confirm->address); + // TRANS: Button label to cancel an IM address confirmation procedure. + $this->submit('cancel', _m('BUTTON','Cancel')); + } catch (NoResultException $e) { + $this->elementStart('ul', 'form_data'); + $this->elementStart('li'); + // TRANS: Field label for IM address. + $this->input('screenname', _('IM address'), + ($this->arg('screenname')) ? $this->arg('screenname') : null, + // TRANS: Field title for IM address. %s is the IM service name. + sprintf(_('%s screenname.'), + $transport_info['display'])); + $this->elementEnd('li'); + $this->elementEnd('ul'); + // TRANS: Button label for adding an IM address in IM settings form. + $this->submit('add', _m('BUTTON','Add')); + } + } + $this->elementEnd('fieldset'); + $this->elementEnd('form'); + } + + if($user_im_prefs_by_transport) + { + $this->elementStart('form', array('method' => 'post', + 'id' => 'form_settings_im', + 'class' => 'form_settings', + 'action' => + common_local_url('imsettings'))); + $this->elementStart('fieldset', array('id' => 'settings_im_preferences')); + // TRANS: Header for IM preferences form. + $this->element('legend', null, _('IM Preferences')); + $this->hidden('token', common_session_token()); + $this->elementStart('table'); + $this->elementStart('tr'); + foreach($user_im_prefs_by_transport as $transport=>$user_im_prefs) + { + $this->element('th', null, $transports[$transport]['display']); + } + $this->elementEnd('tr'); + $preferences = array( + // TRANS: Checkbox label in IM preferences form. + array('name'=>'notify', 'description'=>_('Send me notices')), + // TRANS: Checkbox label in IM preferences form. + array('name'=>'updatefrompresence', 'description'=>_('Post a notice when my status changes.')), + // TRANS: Checkbox label in IM preferences form. + array('name'=>'replies', 'description'=>_('Send me replies '. + 'from people I\'m not subscribed to.')), + ); + foreach($preferences as $preference) + { + $this->elementStart('tr'); + foreach($user_im_prefs_by_transport as $transport=>$user_im_prefs) + { + $preference_name = $preference['name']; + $this->elementStart('td'); + $this->checkbox($transport . '_' . $preference['name'], + $preference['description'], + $user_im_prefs->$preference_name); + $this->elementEnd('td'); + } + $this->elementEnd('tr'); + } + $this->elementEnd('table'); + // TRANS: Button label to save IM preferences. + $this->submit('save', _m('BUTTON','Save')); + $this->elementEnd('fieldset'); + $this->elementEnd('form'); + } + } + + /** + * Get a confirmation code for this user + * + * @return Confirm_address address object for this user + */ + function getConfirmation($transport) + { + $confirm = new Confirm_address(); + + $confirm->user_id = $this->scoped->getID(); + $confirm->address_type = $transport; + + if ($confirm->find(true)) { + return $confirm; + } + + throw new NoResultException($confirm); + } + + protected function doPost() + { + if ($this->arg('save')) { + return $this->savePreferences(); + } else if ($this->arg('add')) { + return $this->addAddress(); + } else if ($this->arg('cancel')) { + return $this->cancelConfirmation(); + } else if ($this->arg('remove')) { + return $this->removeAddress(); + } + // TRANS: Message given submitting a form with an unknown action in Instant Messaging settings. + throw new ClientException(_('Unexpected form submission.')); + } + + /** + * Save user's XMPP preferences + * + * These are the checkboxes at the bottom of the page. They're used to + * set different settings + * + * @return void + */ + function savePreferences() + { + $user_im_prefs = new User_im_prefs(); + $user_im_prefs->query('BEGIN'); + $user_im_prefs->user_id = $this->scoped->getID(); + if($user_im_prefs->find() && $user_im_prefs->fetch()) + { + $preferences = array('notify', 'updatefrompresence', 'replies'); + do + { + $original = clone($user_im_prefs); + $new = clone($user_im_prefs); + foreach($preferences as $preference) + { + $new->$preference = $this->boolean($new->transport . '_' . $preference); + } + $result = $new->update($original); + + if ($result === false) { + common_log_db_error($user_im_prefs, 'UPDATE', __FILE__); + // TRANS: Server error thrown on database error updating IM preferences. + throw new ServerException(_('Could not update IM preferences.')); + } + }while($user_im_prefs->fetch()); + } + $user_im_prefs->query('COMMIT'); + // TRANS: Confirmation message for successful IM preferences save. + return _('Preferences saved.'); + } + + /** + * Sends a confirmation to the address given + * + * Stores a confirmation record and sends out a + * message with the confirmation info. + * + * @return void + */ + function addAddress() + { + $screenname = $this->trimmed('screenname'); + $transport = $this->trimmed('transport'); + + // Some validation + + if (empty($screenname)) { + // TRANS: Message given saving IM address without having provided one. + throw new ClientException(_('No screenname.')); + } + + if (empty($transport)) { + // TRANS: Form validation error when no transport is available setting an IM address. + throw new ClientException(_('No transport.')); + } + + Event::handle('NormalizeImScreenname', array($transport, &$screenname)); + + if (empty($screenname)) { + // TRANS: Message given saving IM address that cannot be normalised. + throw new ClientException(_('Cannot normalize that screenname.')); + } + $valid = false; + Event::handle('ValidateImScreenname', array($transport, $screenname, &$valid)); + if (!$valid) { + // TRANS: Message given saving IM address that not valid. + throw new ClientException(_('Not a valid screenname.')); + } else if ($this->screennameExists($transport, $screenname)) { + // TRANS: Message given saving IM address that is already set for another user. + throw new ClientException(_('Screenname already belongs to another user.')); + } + + $confirm = new Confirm_address(); + + $confirm->address = $screenname; + $confirm->address_type = $transport; + $confirm->user_id = $this->scoped->getID(); + $confirm->code = common_confirmation_code(64); + $confirm->sent = common_sql_now(); + $confirm->claimed = common_sql_now(); + + $result = $confirm->insert(); + + if ($result === false) { + common_log_db_error($confirm, 'INSERT', __FILE__); + // TRANS: Server error thrown on database error adding Instant Messaging confirmation code. + $this->serverError(_('Could not insert confirmation code.')); + } + + Event::handle('SendImConfirmationCode', array($transport, $screenname, $confirm->code, $this->scoped)); + + // TRANS: Message given saving valid IM address that is to be confirmed. + return _('A confirmation code was sent to the IM address you added.'); + } + + /** + * Cancel a confirmation + * + * If a confirmation exists, cancel it. + * + * @return void + */ + function cancelConfirmation() + { + $screenname = $this->trimmed('screenname'); + $transport = $this->trimmed('transport'); + + try { + $confirm = $this->getConfirmation($transport); + if ($confirm->address != $screenname) { + // TRANS: Message given canceling IM address confirmation for the wrong IM address. + throw new ClientException(_('That is the wrong IM address.')); + } + } catch (NoResultException $e) { + // TRANS: Message given canceling Instant Messaging address confirmation that is not pending. + throw new AlreadyFulfilledException(_('No pending confirmation to cancel.')); + } $result = $confirm->delete(); - if (!$result) { - common_log_db_error($confirm, 'DELETE', __FILE__); - $this->server_error(_('Couldn\'t delete email confirmation.')); - return; + if ($result === false) { + common_log_db_error($confirm, 'DELETE', __FILE__); + // TRANS: Server error thrown on database error canceling IM address confirmation. + throw new ServerException(_('Could not delete confirmation.')); + } + + // TRANS: Message given after successfully canceling IM address confirmation. + return _('IM confirmation cancelled.'); + } + + /** + * Remove an address + * + * If the user has a confirmed address, remove it. + * + * @return void + */ + function removeAddress() + { + $screenname = $this->trimmed('screenname'); + $transport = $this->trimmed('transport'); + + // Maybe an old tab open...? + + $user_im_prefs = new User_im_prefs(); + $user_im_prefs->user_id = $this->scoped->getID(); + $user_im_prefs->transport = $transport; + if (!$user_im_prefs->find(true)) { + // TRANS: Message given trying to remove an IM address that is not + // TRANS: registered for the active user. + throw new AlreadyFulfilledException(_('There were no preferences stored for this transport.')); + } + + $result = $user_im_prefs->delete(); + + if ($result === false) { + common_log_db_error($user_im_prefs, 'UPDATE', __FILE__); + // TRANS: Server error thrown on database error removing a registered IM address. + throw new ServerException(_('Could not update user IM preferences.')); } - $this->show_form(_('Confirmation cancelled.'), TRUE); - } - - function remove_address() { - - $user = common_current_user(); - $jabber = $this->arg('jabber'); - - # Maybe an old tab open...? - - if ($user->jabber != $jabber) { - $this->show_form(_('That is not your Jabber ID.')); - return; - } - - $user->query('BEGIN'); - $original = clone($user); - $user->jabber = NULL; - $result = $user->updateKeys($original); - if (!$result) { - common_log_db_error($user, 'UPDATE', __FILE__); - common_server_error(_('Couldnt update user.')); - return; - } - $user->query('COMMIT'); - - # XXX: unsubscribe to the old address - - $this->show_form(_('The address was removed.'), TRUE); - } - - function jabber_exists($jabber) { - $user = common_current_user(); - $other = User::staticGet('jabber', $jabber); - if (!$other) { - return false; - } else { - return $other->id != $user->id; - } - } + // XXX: unsubscribe to the old address + + // TRANS: Message given after successfully removing a registered Instant Messaging address. + return _('The IM address was removed.'); + } + + /** + * Does this screenname exist? + * + * Checks if we already have another user with this address. + * + * @param string $transport Transport to check + * @param string $screenname Screenname to check + * + * @return boolean whether the screenname exists + */ + + function screennameExists($transport, $screenname) + { + $user_im_prefs = new User_im_prefs(); + $user_im_prefs->transport = $transport; + $user_im_prefs->screenname = $screenname; + return $user_im_prefs->find(true) ? true : false; + } }