X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Fimsettings.php;h=40bea10e68b462fa3dc5dffe2709dbfb587e85c3;hb=0463d96392abd1976486c1ae53ece8466e930e29;hp=fe1864f0d1cb6c326af4762cc57ff2c0b84c1190;hpb=d14651706cf728f116b7ae44c6a6e37b5eb918a4;p=quix0rs-gnu-social.git diff --git a/actions/imsettings.php b/actions/imsettings.php index fe1864f0d1..40bea10e68 100644 --- a/actions/imsettings.php +++ b/actions/imsettings.php @@ -27,9 +27,7 @@ * @link http://status.net/ */ -if (!defined('STATUSNET') && !defined('LACONICA')) { - exit(1); -} +if (!defined('GNUSOCIAL')) { exit(1); } /** * Settings for Jabber/XMPP integration @@ -43,16 +41,16 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { * @see SettingsAction */ -class ImsettingsAction extends ConnectSettingsAction +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'); } @@ -61,11 +59,13 @@ class ImsettingsAction extends ConnectSettingsAction * * @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 [instant messages](%%doc.im%%). '. + '[instant messaging](%%doc.im%%). '. 'Configure your addresses and settings below.'); } @@ -78,13 +78,13 @@ class ImsettingsAction extends ConnectSettingsAction * * @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; } @@ -101,6 +101,7 @@ class ImsettingsAction extends ConnectSettingsAction '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); @@ -109,30 +110,41 @@ class ImsettingsAction extends ConnectSettingsAction $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); - $this->submit('remove', _('Remove')); + // TRANS: Button label to remove a confirmed IM address. + $this->submit('remove', _m('BUTTON','Remove')); } else { - $confirm = $this->getConfirmation($transport); - if ($confirm) { + 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 %s account for a '. - 'message with further instructions.'), - $transport_info['display'])); + '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); - $this->submit('cancel', _('Cancel')); - } else { + // 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'); - $this->submit('add', _('Add')); + // TRANS: Button label for adding an IM address in IM settings form. + $this->submit('add', _m('BUTTON','Add')); } } $this->elementEnd('fieldset'); @@ -147,22 +159,24 @@ class ImsettingsAction extends ConnectSettingsAction 'action' => common_local_url('imsettings'))); $this->elementStart('fieldset', array('id' => 'settings_im_preferences')); - $this->element('legend', null, _('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'); - $this->element('th', null, _('Preferences')); 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.')), - array('name'=>'microid', 'description'=>_('Publish a MicroID')) ); foreach($preferences as $preference) { @@ -179,7 +193,8 @@ class ImsettingsAction extends ConnectSettingsAction $this->elementEnd('tr'); } $this->elementEnd('table'); - $this->submit('save', _('Save')); + // TRANS: Button label to save IM preferences. + $this->submit('save', _m('BUTTON','Save')); $this->elementEnd('fieldset'); $this->elementEnd('form'); } @@ -190,94 +205,71 @@ class ImsettingsAction extends ConnectSettingsAction * * @return Confirm_address address object for this user */ - function getConfirmation($transport) { - $user = common_current_user(); - $confirm = new Confirm_address(); - $confirm->user_id = $user->id; + $confirm->user_id = $this->scoped->getID(); $confirm->address_type = $transport; if ($confirm->find(true)) { return $confirm; - } else { - return null; } - } - /** - * 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 - */ + throw new NoResultException($confirm); + } - function handlePost() + protected function doPost() { - // CSRF protection - $token = $this->trimmed('token'); - if (!$token || $token != common_session_token()) { - $this->showForm(_('There was a problem with your session token. '. - 'Try again, please.')); - return; - } - if ($this->arg('save')) { - $this->savePreferences(); + return $this->savePreferences(); } else if ($this->arg('add')) { - $this->addAddress(); + return $this->addAddress(); } else if ($this->arg('cancel')) { - $this->cancelConfirmation(); + return $this->cancelConfirmation(); } else if ($this->arg('remove')) { - $this->removeAddress(); - } else { - $this->showForm(_('Unexpected form submission.')); + 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 Jabber preferences + * 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 = common_current_user(); - $user_im_prefs = new User_im_prefs(); - $user_im_prefs->user_id = $user->id; + $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', 'microid'); - $user_im_prefs->query('BEGIN'); + $preferences = array('notify', 'updatefrompresence', 'replies'); do { $original = clone($user_im_prefs); + $new = clone($user_im_prefs); foreach($preferences as $preference) { - $user_im_prefs->$preference = $this->boolean($user_im_prefs->transport . '_' . $preference); + $new->$preference = $this->boolean($new->transport . '_' . $preference); } - $result = $user_im_prefs->update($original); + $result = $new->update($original); if ($result === false) { - common_log_db_error($user, 'UPDATE', __FILE__); - $this->serverError(_('Couldn\'t update IM preferences.')); - return; + 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'); } - $this->showForm(_('Preferences saved.'), true); + $user_im_prefs->query('COMMIT'); + // TRANS: Confirmation message for successful IM preferences save. + return _('Preferences saved.'); } /** @@ -288,47 +280,44 @@ class ImsettingsAction extends ConnectSettingsAction * * @return void */ - function addAddress() { - $user = common_current_user(); - $screenname = $this->trimmed('screenname'); $transport = $this->trimmed('transport'); // Some validation - if (!$screenname) { - $this->showForm(_('No screenname.')); - return; + if (empty($screenname)) { + // TRANS: Message given saving IM address without having provided one. + throw new ClientException(_('No screenname.')); } - if (!$transport) { - $this->showForm(_('No transport.')); - return; + 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 (!$screenname) { - $this->showForm(_('Cannot normalize that screenname')); - return; + 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) { - $this->showForm(_('Not a valid screenname')); - return; + // TRANS: Message given saving IM address that not valid. + throw new ClientException(_('Not a valid screenname.')); } else if ($this->screennameExists($transport, $screenname)) { - $this->showForm(_('Screenname already belongs to another user.')); - return; + // 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 = $user->id; + $confirm->user_id = $this->scoped->getID(); $confirm->code = common_confirmation_code(64); $confirm->sent = common_sql_now(); $confirm->claimed = common_sql_now(); @@ -337,16 +326,14 @@ class ImsettingsAction extends ConnectSettingsAction if ($result === false) { common_log_db_error($confirm, 'INSERT', __FILE__); - $this->serverError(_('Couldn\'t insert confirmation code.')); - return; + // 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, $user)); - - $msg = _('A confirmation code was sent '. - 'to the IM address you added.'); + Event::handle('SendImConfirmationCode', array($transport, $screenname, $confirm->code, $this->scoped)); - $this->showForm($msg, true); + // TRANS: Message given saving valid IM address that is to be confirmed. + return _('A confirmation code was sent to the IM address you added.'); } /** @@ -356,32 +343,32 @@ class ImsettingsAction extends ConnectSettingsAction * * @return void */ - function cancelConfirmation() { $screenname = $this->trimmed('screenname'); $transport = $this->trimmed('transport'); - $confirm = $this->getConfirmation($transport); - - if (!$confirm) { - $this->showForm(_('No pending confirmation to cancel.')); - return; - } - if ($confirm->address != $screenname) { - $this->showForm(_('That is the wrong IM address.')); - return; + 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) { + if ($result === false) { common_log_db_error($confirm, 'DELETE', __FILE__); - $this->serverError(_('Couldn\'t delete confirmation.')); - return; + // TRANS: Server error thrown on database error canceling IM address confirmation. + throw new ServerException(_('Could not delete confirmation.')); } - $this->showForm(_('Confirmation cancelled.'), true); + // TRANS: Message given after successfully canceling IM address confirmation. + return _('IM confirmation cancelled.'); } /** @@ -391,34 +378,34 @@ class ImsettingsAction extends ConnectSettingsAction * * @return void */ - function removeAddress() { - $user = common_current_user(); - $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 = $user->id; - if(! ($user_im_prefs->find() && $user_im_prefs->fetch())) { - $this->showForm(_('That is not your screenname.')); - return; + $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) { - common_log_db_error($user, 'UPDATE', __FILE__); - $this->serverError(_('Couldn\'t update user im prefs.')); - return; + 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.')); } // XXX: unsubscribe to the old address - $this->showForm(_('The address was removed.'), true); + // TRANS: Message given after successfully removing a registered Instant Messaging address. + return _('The IM address was removed.'); } /** @@ -434,15 +421,9 @@ class ImsettingsAction extends ConnectSettingsAction function screennameExists($transport, $screenname) { - $user = common_current_user(); - $user_im_prefs = new User_im_prefs(); $user_im_prefs->transport = $transport; $user_im_prefs->screenname = $screenname; - if($user_im_prefs->find() && $user_im_prefs->fetch()){ - return true; - }else{ - return false; - } + return $user_im_prefs->find(true) ? true : false; } }