X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Fimsettings.php;h=6691c8dad76e95f53cbcf621810a3490ea813f95;hb=61ca2cb6b5f474c3fb7f2b59bbb26b2ba25aa46e;hp=d0c47f7fdd6c49e2534c9c213e64beb2dd271920;hpb=edbc0c665cc65875b4d14b79939233b1c9c06bb6;p=quix0rs-gnu-social.git diff --git a/actions/imsettings.php b/actions/imsettings.php index d0c47f7fdd..6691c8dad7 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); } +if (!defined('STATUSNET') && !defined('LACONICA')) { + exit(1); +} -require_once(INSTALLDIR.'/lib/settingsaction.php'); -require_once(INSTALLDIR.'/lib/jabber.php'); +require_once INSTALLDIR.'/lib/connectsettingsaction.php'; +require_once INSTALLDIR.'/lib/jabber.php'; -class ImsettingsAction extends SettingsAction { +/** + * 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 get_instructions() { - return _('You can send and receive notices through Jabber/GTalk [instant messages](%%doc.im%%). Configure your address and settings below.'); +class ImsettingsAction extends ConnectSettingsAction +{ + /** + * Title of the page + * + * @return string Title of the page + */ + + function title() + { + // TRANS: Title for instance messaging settings. + return _('IM settings'); } - 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_hidden('token', common_session_token()); + /** + * 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 '. + 'Jabber/GTalk [instant messages](%%doc.im%%). '. + 'Configure your address and settings below.'); + } - common_element('h2', NULL, _('Address')); + /** + * 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() + { + if (!common_config('xmpp', 'enabled')) { + $this->element('div', array('class' => 'error'), + // TRANS: Message given in the IM settings if XMPP is not enabled on the site. + _('IM is not available.')); + return; + } + + $user = common_current_user(); + $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, _('IM address')); + $this->hidden('token', common_session_token()); if ($user->jabber) { - common_element_start('p'); - common_element('span', 'address confirmed', $user->jabber); - common_element('span', 'input_instructions', + $this->element('p', 'form_confirmed', $user->jabber); + // TRANS: Form note in IM settings form. + $this->element('p', 'form_note', _('Current confirmed Jabber/GTalk address.')); - common_hidden('jabber', $user->jabber); - common_element_end('p'); - common_submit('remove', _('Remove')); + $this->hidden('jabber', $user->jabber); + // TRANS: Button label to remove a confirmed IM address. + $this->submit('remove', _m('BUTTON','Remove')); } else { - $confirm = $this->get_confirmation(); + $confirm = $this->getConfirmation(); 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')); + $this->element('p', 'form_unconfirmed', $confirm->address); + $this->element('p', 'form_note', + // TRANS: Form note in IM settings form. + // TRANS: %s is the IM address set for the site. + 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())); + $this->hidden('jabber', $confirm->address); + // TRANS: Button label to cancel an IM address confirmation procedure. + $this->submit('cancel', _m('BUTTON','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')); + $this->elementStart('ul', 'form_data'); + $this->elementStart('li'); + // TRANS: Field label for IM address input in IM settings form. + $this->input('jabber', _('IM address'), + ($this->arg('jabber')) ? $this->arg('jabber') : null, + // TRANS: IM address input field instructions in IM settings form. + // TRANS: %s is the IM address set for the site. + 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())); + $this->elementEnd('li'); + $this->elementEnd('ul'); + // TRANS: Button label for adding an IM address in IM settings form. + $this->submit('add', _m('BUTTON','Add')); } } - - common_element('h2', NULL, _('Preferences')); - - common_checkbox('jabbernotify', + $this->elementEnd('fieldset'); + + $this->elementStart('fieldset', array('id' => 'settings_im_preferences')); + // TRANS: Form legend for IM preferences form. + $this->element('legend', null, _('IM preferences')); + $this->elementStart('ul', 'form_data'); + $this->elementStart('li'); + $this->checkbox('jabbernotify', + // TRANS: Checkbox label in IM preferences form. _('Send me notices through Jabber/GTalk.'), $user->jabbernotify); - common_checkbox('updatefrompresence', + $this->elementEnd('li'); + $this->elementStart('li'); + $this->checkbox('updatefrompresence', + // TRANS: Checkbox label in IM preferences form. _('Post a notice when my Jabber/GTalk status changes.'), $user->updatefrompresence); - common_checkbox('jabberreplies', - _('Send me replies through Jabber/GTalk from people I\'m not subscribed to.'), + $this->elementEnd('li'); + $this->elementStart('li'); + $this->checkbox('jabberreplies', + // TRANS: Checkbox label in IM preferences form. + _('Send me replies through Jabber/GTalk '. + 'from people I\'m not subscribed to.'), $user->jabberreplies); - common_checkbox('jabbermicroid', + $this->elementEnd('li'); + $this->elementStart('li'); + $this->checkbox('jabbermicroid', + // TRANS: Checkbox label in IM preferences form. _('Publish a MicroID for my Jabber/GTalk address.'), $user->jabbermicroid); - common_submit('save', _('Save')); - - common_element_end('form'); - common_show_footer(); + $this->elementEnd('li'); + $this->elementEnd('ul'); + // TRANS: Button label to save IM preferences. + $this->submit('save', _m('BUTTON','Save')); + $this->elementEnd('fieldset'); + $this->elementEnd('form'); } - function get_confirmation() { + /** + * Get a confirmation code for this user + * + * @return Confirm_address address object for this user + */ + + function getConfirmation() + { $user = common_current_user(); + $confirm = new Confirm_address(); - $confirm->user_id = $user->id; + + $confirm->user_id = $user->id; $confirm->address_type = 'jabber'; - if ($confirm->find(TRUE)) { + + if ($confirm->find(true)) { return $confirm; } else { - return NULL; + return null; } } - function handle_post() { - - # CSRF protection + /** + * Handle posts to this form + * + * Based on the button that was pressed, muxes out to other functions + * to do the actual task requested. + * + * All sub-functions reload the form with a message -- success or failure. + * + * @return void + */ + + function handlePost() + { + // CSRF protection $token = $this->trimmed('token'); if (!$token || $token != common_session_token()) { - $this->show_form(_('There was a problem with your session token. Try again, please.')); + $this->showForm(_('There was a problem with your session token. '. + 'Try again, please.')); return; } if ($this->arg('save')) { - $this->save_preferences(); + $this->savePreferences(); } else if ($this->arg('add')) { - $this->add_address(); + $this->addAddress(); } else if ($this->arg('cancel')) { - $this->cancel_confirmation(); + $this->cancelConfirmation(); } else if ($this->arg('remove')) { - $this->remove_address(); + $this->removeAddress(); } else { - $this->show_form(_('Unexpected form submission.')); + // TRANS: Message given submitting a form with an unknown action in IM settings. + $this->showForm(_('Unexpected form submission.')); } } - function save_preferences() { - - $jabbernotify = $this->boolean('jabbernotify'); + /** + * Save user's Jabber preferences + * + * These are the checkboxes at the bottom of the page. They're used to + * set different settings + * + * @return void + */ + + function savePreferences() + { + $jabbernotify = $this->boolean('jabbernotify'); $updatefrompresence = $this->boolean('updatefrompresence'); - $jabberreplies = $this->boolean('jabberreplies'); - $jabbermicroid = $this->boolean('jabbermicroid'); + $jabberreplies = $this->boolean('jabberreplies'); + $jabbermicroid = $this->boolean('jabbermicroid'); $user = common_current_user(); - assert(!is_null($user)); # should already be checked + assert(!is_null($user)); // should already be checked $user->query('BEGIN'); $original = clone($user); - $user->jabbernotify = $jabbernotify; + $user->jabbernotify = $jabbernotify; $user->updatefrompresence = $updatefrompresence; - $user->jabberreplies = $jabberreplies; - $user->jabbermicroid = $jabbermicroid; + $user->jabberreplies = $jabberreplies; + $user->jabbermicroid = $jabbermicroid; $result = $user->update($original); - if ($result === FALSE) { + if ($result === false) { common_log_db_error($user, 'UPDATE', __FILE__); - common_server_error(_('Couldn\'t update user.')); + // TRANS: Server error thrown on database error updating IM preferences. + $this->serverError(_('Couldn\'t update user.')); return; } $user->query('COMMIT'); - $this->show_form(_('Preferences saved.'), true); + // TRANS: Confirmation message for successful IM preferences save. + $this->showForm(_('Preferences saved.'), true); } - function add_address() { - + /** + * Sends a confirmation to the address given + * + * Stores a confirmation record and sends out a + * Jabber message with the confirmation info. + * + * @return void + */ + + function addAddress() + { $user = common_current_user(); $jabber = $this->trimmed('jabber'); - # Some validation + // Some validation if (!$jabber) { - $this->show_form(_('No Jabber ID.')); + // TRANS: Message given saving IM address without having provided one. + $this->showForm(_('No Jabber ID.')); return; } $jabber = jabber_normalize_jid($jabber); if (!$jabber) { - $this->show_form(_('Cannot normalize that Jabber ID')); + // TRANS: Message given saving IM address that cannot be normalised. + $this->showForm(_('Cannot normalize that Jabber ID')); return; } - if (!jabber_valid_base_jid($jabber)) { - $this->show_form(_('Not a valid Jabber ID')); + if (!jabber_valid_base_jid($jabber, common_config('email', 'domain_check'))) { + // TRANS: Message given saving IM address that not valid. + $this->showForm(_('Not a valid Jabber ID')); return; } else if ($user->jabber == $jabber) { - $this->show_form(_('That is already your Jabber ID.')); + // TRANS: Message given saving IM address that is already set. + $this->showForm(_('That is already your Jabber ID.')); return; - } else if ($this->jabber_exists($jabber)) { - $this->show_form(_('Jabber ID already belongs to another user.')); + } else if ($this->jabberExists($jabber)) { + // TRANS: Message given saving IM address that is already set for another user. + $this->showForm(_('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); + $confirm = new Confirm_address(); + + $confirm->address = $jabber; + $confirm->address_type = 'jabber'; + $confirm->user_id = $user->id; + $confirm->code = common_confirmation_code(64); + $confirm->sent = common_sql_now(); + $confirm->claimed = common_sql_now(); $result = $confirm->insert(); - if ($result === FALSE) { + if ($result === false) { common_log_db_error($confirm, 'INSERT', __FILE__); - common_server_error(_('Couldn\'t insert confirmation code.')); + // TRANS: Server error thrown on database error adding IM confirmation code. + $this->serverError(_('Couldn\'t insert confirmation code.')); return; } - if (!common_config('queue', 'enabled')) { - jabber_confirm_address($confirm->code, - $user->nickname, - $jabber); - } + 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()); + // TRANS: Message given saving valid IM address that is to be confirmed. + // TRANS: %s is the IM address set for the site. + $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); + $this->showForm($msg, true); } - function cancel_confirmation() { + /** + * Cancel a confirmation + * + * If a confirmation exists, cancel it. + * + * @return void + */ + + function cancelConfirmation() + { $jabber = $this->arg('jabber'); - $confirm = $this->get_confirmation(); + + $confirm = $this->getConfirmation(); + if (!$confirm) { - $this->show_form(_('No pending confirmation to cancel.')); + // TRANS: Message given canceling IM address confirmation that is not pending. + $this->showForm(_('No pending confirmation to cancel.')); return; } if ($confirm->address != $jabber) { - $this->show_form(_('That is the wrong IM address.')); + // TRANS: Message given canceling IM address confirmation for the wrong IM address. + $this->showForm(_('That is the wrong IM address.')); return; } @@ -223,44 +393,76 @@ class ImsettingsAction extends SettingsAction { if (!$result) { common_log_db_error($confirm, 'DELETE', __FILE__); - $this->server_error(_('Couldn\'t delete email confirmation.')); + // TRANS: Server error thrown on database error canceling IM address confirmation. + $this->serverError(_('Couldn\'t delete IM confirmation.')); return; } - $this->show_form(_('Confirmation cancelled.'), TRUE); + // TRANS: Message given after successfully canceling IM address confirmation. + $this->showForm(_('IM confirmation cancelled.'), true); } - function remove_address() { + /** + * Remove an address + * + * If the user has a confirmed address, remove it. + * + * @return void + */ + function removeAddress() + { $user = common_current_user(); + $jabber = $this->arg('jabber'); - # Maybe an old tab open...? + // Maybe an old tab open...? if ($user->jabber != $jabber) { - $this->show_form(_('That is not your Jabber ID.')); + // TRANS: Message given trying to remove an IM address that is not + // TRANS: registered for the active user. + $this->showForm(_('That is not your Jabber ID.')); return; } $user->query('BEGIN'); + $original = clone($user); - $user->jabber = NULL; + + $user->jabber = null; + $result = $user->updateKeys($original); + if (!$result) { common_log_db_error($user, 'UPDATE', __FILE__); - common_server_error(_('Couldn\'t update user.')); + // TRANS: Server error thrown on database error removing a registered IM address. + $this->serverError(_('Couldn\'t update user.')); return; } $user->query('COMMIT'); - # XXX: unsubscribe to the old address + // XXX: unsubscribe to the old address - $this->show_form(_('The address was removed.'), TRUE); + // TRANS: Message given after successfully removing a registered IM address. + $this->showForm(_('The IM address was removed.'), true); } - function jabber_exists($jabber) { + /** + * Does this Jabber ID exist? + * + * Checks if we already have another user with this address. + * + * @param string $jabber Address to check + * + * @return boolean whether the Jabber ID exists + */ + + function jabberExists($jabber) + { $user = common_current_user(); + $other = User::staticGet('jabber', $jabber); + if (!$other) { return false; } else {