eliseuamaro/gnu-social
1
0
Fork 0
forked from GNUsocial/gnu-social
Code Issues Pull Requests Releases Wiki Activity

ImSettings adapted to FormAction inheritance

Browse Source 
TODO: Get separate Form classes and move User_im_prefs to Profile_prefs
This commit is contained in:
Mikael Nordfeldth 2015-07-16 21:18:50 +02:00
parent 647171e089
commit f1d9d8a6ed
2 changed files with 55 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

146
actions/imsettings.php
View File

@ -27,9 +27,7 @@
* @link http://status.net/ * @link http://status.net/
*/ */
if (!defined('STATUSNET') && !defined('LACONICA')) { if (!defined('GNUSOCIAL')) { exit(1); }
exit(1);
}
/** /**
* Settings for Jabber/XMPP integration * Settings for Jabber/XMPP integration
@ -118,8 +116,8 @@ class ImsettingsAction extends SettingsAction
// TRANS: Button label to remove a confirmed IM address. // TRANS: Button label to remove a confirmed IM address.
$this->submit('remove', _m('BUTTON','Remove')); $this->submit('remove', _m('BUTTON','Remove'));
} else { } else {
$confirm = $this->getConfirmation($transport); try {
if ($confirm) { $confirm = $this->getConfirmation($transport);
$this->element('p', 'form_unconfirmed', $confirm->address); $this->element('p', 'form_unconfirmed', $confirm->address);
// TRANS: Form note in IM settings form. // TRANS: Form note in IM settings form.
$this->element('p', 'form_note', $this->element('p', 'form_note',
@ -134,7 +132,7 @@ class ImsettingsAction extends SettingsAction
$this->hidden('screenname', $confirm->address); $this->hidden('screenname', $confirm->address);
// TRANS: Button label to cancel an IM address confirmation procedure. // TRANS: Button label to cancel an IM address confirmation procedure.
$this->submit('cancel', _m('BUTTON','Cancel')); $this->submit('cancel', _m('BUTTON','Cancel'));
} else { } catch (NoResultException $e) {
$this->elementStart('ul', 'form_data'); $this->elementStart('ul', 'form_data');
$this->elementStart('li'); $this->elementStart('li');
// TRANS: Field label for IM address. // TRANS: Field label for IM address.
@ -209,57 +207,35 @@ class ImsettingsAction extends SettingsAction
*/ */
function getConfirmation($transport) function getConfirmation($transport)
{ {
$user = common_current_user();
$confirm = new Confirm_address(); $confirm = new Confirm_address();
$confirm->user_id = $user->id; $confirm->user_id = $this->scoped->getID();
$confirm->address_type = $transport; $confirm->address_type = $transport;
if ($confirm->find(true)) { if ($confirm->find(true)) {
return $confirm; return $confirm;
} else {
return null;
} }
throw new NoResultException($confirm);
} }
/** protected function doPost()
* 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()) {
// TRANS: Client error displayed when the session token does not match or is not given.
$this->showForm(_('There was a problem with your session token. '.
'Try again, please.'));
return;
}
if ($this->arg('save')) { if ($this->arg('save')) {
$this->savePreferences(); return $this->savePreferences();
} else if ($this->arg('add')) { } else if ($this->arg('add')) {
$this->addAddress(); return $this->addAddress();
} else if ($this->arg('cancel')) { } else if ($this->arg('cancel')) {
$this->cancelConfirmation(); return $this->cancelConfirmation();
} else if ($this->arg('remove')) { } else if ($this->arg('remove')) {
$this->removeAddress(); return $this->removeAddress();
} else {
// TRANS: Message given submitting a form with an unknown action in Instant Messaging settings.
$this->showForm(_('Unexpected form submission.'));
} }
// 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 * These are the checkboxes at the bottom of the page. They're used to
* set different settings * set different settings
@ -268,11 +244,9 @@ class ImsettingsAction extends SettingsAction
*/ */
function savePreferences() function savePreferences()
{ {
$user = common_current_user();
$user_im_prefs = new User_im_prefs(); $user_im_prefs = new User_im_prefs();
$user_im_prefs->query('BEGIN'); $user_im_prefs->query('BEGIN');
$user_im_prefs->user_id = $user->id; $user_im_prefs->user_id = $this->scoped->getID();
if($user_im_prefs->find() && $user_im_prefs->fetch()) if($user_im_prefs->find() && $user_im_prefs->fetch())
{ {
$preferences = array('notify', 'updatefrompresence', 'replies'); $preferences = array('notify', 'updatefrompresence', 'replies');
@ -287,15 +261,15 @@ class ImsettingsAction extends SettingsAction
$result = $new->update($original); $result = $new->update($original);
if ($result === false) { if ($result === false) {
common_log_db_error($user, 'UPDATE', __FILE__); common_log_db_error($user_im_prefs, 'UPDATE', __FILE__);
// TRANS: Server error thrown on database error updating IM preferences. // TRANS: Server error thrown on database error updating IM preferences.
$this->serverError(_('Could not update IM preferences.')); throw new ServerException(_('Could not update IM preferences.'));
} }
}while($user_im_prefs->fetch()); }while($user_im_prefs->fetch());
} }
$user_im_prefs->query('COMMIT'); $user_im_prefs->query('COMMIT');
// TRANS: Confirmation message for successful IM preferences save. // TRANS: Confirmation message for successful IM preferences save.
$this->showForm(_('Preferences saved.'), true); return _('Preferences saved.');
} }
/** /**
@ -308,49 +282,42 @@ class ImsettingsAction extends SettingsAction
*/ */
function addAddress() function addAddress()
{ {
$user = common_current_user();
$screenname = $this->trimmed('screenname'); $screenname = $this->trimmed('screenname');
$transport = $this->trimmed('transport'); $transport = $this->trimmed('transport');
// Some validation // Some validation
if (!$screenname) { if (empty($screenname)) {
// TRANS: Message given saving IM address without having provided one. // TRANS: Message given saving IM address without having provided one.
$this->showForm(_('No screenname.')); throw new ClientException(_('No screenname.'));
return;
} }
if (!$transport) { if (empty($transport)) {
// TRANS: Form validation error when no transport is available setting an IM address. // TRANS: Form validation error when no transport is available setting an IM address.
$this->showForm(_('No transport.')); throw new ClientException(_('No transport.'));
return;
} }
Event::handle('NormalizeImScreenname', array($transport, &$screenname)); Event::handle('NormalizeImScreenname', array($transport, &$screenname));
if (!$screenname) { if (empty($screenname)) {
// TRANS: Message given saving IM address that cannot be normalised. // TRANS: Message given saving IM address that cannot be normalised.
$this->showForm(_('Cannot normalize that screenname.')); throw new ClientException(_('Cannot normalize that screenname.'));
return;
} }
$valid = false; $valid = false;
Event::handle('ValidateImScreenname', array($transport, $screenname, &$valid)); Event::handle('ValidateImScreenname', array($transport, $screenname, &$valid));
if (!$valid) { if (!$valid) {
// TRANS: Message given saving IM address that not valid. // TRANS: Message given saving IM address that not valid.
$this->showForm(_('Not a valid screenname.')); throw new ClientException(_('Not a valid screenname.'));
return;
} else if ($this->screennameExists($transport, $screenname)) { } else if ($this->screennameExists($transport, $screenname)) {
// TRANS: Message given saving IM address that is already set for another user. // TRANS: Message given saving IM address that is already set for another user.
$this->showForm(_('Screenname already belongs to another user.')); throw new ClientException(_('Screenname already belongs to another user.'));
return;
} }
$confirm = new Confirm_address(); $confirm = new Confirm_address();
$confirm->address = $screenname; $confirm->address = $screenname;
$confirm->address_type = $transport; $confirm->address_type = $transport;
$confirm->user_id = $user->id; $confirm->user_id = $this->scoped->getID();
$confirm->code = common_confirmation_code(64); $confirm->code = common_confirmation_code(64);
$confirm->sent = common_sql_now(); $confirm->sent = common_sql_now();
$confirm->claimed = common_sql_now(); $confirm->claimed = common_sql_now();
@ -363,13 +330,10 @@ class ImsettingsAction extends SettingsAction
$this->serverError(_('Could not insert confirmation code.')); $this->serverError(_('Could not insert confirmation code.'));
} }
Event::handle('SendImConfirmationCode', array($transport, $screenname, $confirm->code, $user)); Event::handle('SendImConfirmationCode', array($transport, $screenname, $confirm->code, $this->scoped));
// TRANS: Message given saving valid IM address that is to be confirmed. // TRANS: Message given saving valid IM address that is to be confirmed.
$msg = _('A confirmation code was sent '. return _('A confirmation code was sent to the IM address you added.');
'to the IM address you added.');
$this->showForm($msg, true);
} }
/** /**
@ -384,29 +348,27 @@ class ImsettingsAction extends SettingsAction
$screenname = $this->trimmed('screenname'); $screenname = $this->trimmed('screenname');
$transport = $this->trimmed('transport'); $transport = $this->trimmed('transport');
$confirm = $this->getConfirmation($transport); try {
$confirm = $this->getConfirmation($transport);
if (!$confirm) { 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. // TRANS: Message given canceling Instant Messaging address confirmation that is not pending.
$this->showForm(_('No pending confirmation to cancel.')); throw new AlreadyFulfilledException(_('No pending confirmation to cancel.'));
return;
}
if ($confirm->address != $screenname) {
// TRANS: Message given canceling IM address confirmation for the wrong IM address.
$this->showForm(_('That is the wrong IM address.'));
return;
} }
$result = $confirm->delete(); $result = $confirm->delete();
if (!$result) { if ($result === false) {
common_log_db_error($confirm, 'DELETE', __FILE__); common_log_db_error($confirm, 'DELETE', __FILE__);
// TRANS: Server error thrown on database error canceling IM address confirmation. // TRANS: Server error thrown on database error canceling IM address confirmation.
$this->serverError(_('Could not delete confirmation.')); throw new ServerException(_('Could not delete confirmation.'));
} }
// TRANS: Message given after successfully canceling IM address confirmation. // TRANS: Message given after successfully canceling IM address confirmation.
$this->showForm(_('IM confirmation cancelled.'), true); return _('IM confirmation cancelled.');
} }
/** /**
@ -418,34 +380,32 @@ class ImsettingsAction extends SettingsAction
*/ */
function removeAddress() function removeAddress()
{ {
$user = common_current_user();
$screenname = $this->trimmed('screenname'); $screenname = $this->trimmed('screenname');
$transport = $this->trimmed('transport'); $transport = $this->trimmed('transport');
// Maybe an old tab open...? // Maybe an old tab open...?
$user_im_prefs = new User_im_prefs(); $user_im_prefs = new User_im_prefs();
$user_im_prefs->user_id = $user->id; $user_im_prefs->user_id = $this->scoped->getID();
if(! ($user_im_prefs->find() && $user_im_prefs->fetch())) { $user_im_prefs->transport = $transport;
if (!$user_im_prefs->find(true)) {
// TRANS: Message given trying to remove an IM address that is not // TRANS: Message given trying to remove an IM address that is not
// TRANS: registered for the active user. // TRANS: registered for the active user.
$this->showForm(_('That is not your screenname.')); throw new AlreadyFulfilledException(_('There were no preferences stored for this transport.'));
return;
} }
$result = $user_im_prefs->delete(); $result = $user_im_prefs->delete();
if (!$result) { if ($result === false) {
common_log_db_error($user, 'UPDATE', __FILE__); common_log_db_error($user_im_prefs, 'UPDATE', __FILE__);
// TRANS: Server error thrown on database error removing a registered IM address. // TRANS: Server error thrown on database error removing a registered IM address.
$this->serverError(_('Could not update user IM preferences.')); throw new ServerException(_('Could not update user IM preferences.'));
} }
// XXX: unsubscribe to the old address // XXX: unsubscribe to the old address
// TRANS: Message given after successfully removing a registered Instant Messaging address. // TRANS: Message given after successfully removing a registered Instant Messaging address.
$this->showForm(_('The IM address was removed.'), true); return _('The IM address was removed.');
} }
/** /**
@ -461,15 +421,9 @@ class ImsettingsAction extends SettingsAction
function screennameExists($transport, $screenname) function screennameExists($transport, $screenname)
{ {
$user = common_current_user();
$user_im_prefs = new User_im_prefs(); $user_im_prefs = new User_im_prefs();
$user_im_prefs->transport = $transport; $user_im_prefs->transport = $transport;
$user_im_prefs->screenname = $screenname; $user_im_prefs->screenname = $screenname;
if($user_im_prefs->find() && $user_im_prefs->fetch()){ return $user_im_prefs->find(true) ? true : false;
return true;
}else{
return false;
}
} }
} }

10
lib/implugin.php
View File

@ -243,11 +243,11 @@ abstract class ImPlugin extends Plugin
* *
* @param string $screenname screenname sending to * @param string $screenname screenname sending to
* @param string $code the confirmation code * @param string $code the confirmation code
* @param User $user user sending to * @param Profile $target For whom the code is valid for
* *
* @return boolean success value * @return boolean success value
*/ */
function sendConfirmationCode($screenname, $code, $user) function sendConfirmationCode($screenname, $code, Profile $target)
{ {
// TRANS: Body text for confirmation code e-mail. // TRANS: Body text for confirmation code e-mail.
// TRANS: %1$s is a user nickname, %2$s is the StatusNet sitename, // TRANS: %1$s is a user nickname, %2$s is the StatusNet sitename,
@ -258,7 +258,7 @@ abstract class ImPlugin extends Plugin
' . (If you cannot click it, copy-and-paste it into the ' . ' . (If you cannot click it, copy-and-paste it into the ' .
'address bar of your browser). If that user is not you, ' . 'address bar of your browser). If that user is not you, ' .
'or if you did not request this confirmation, just ignore this message.'), 'or if you did not request this confirmation, just ignore this message.'),
$user->nickname, common_config('site', 'name'), $this->getDisplayName(), common_local_url('confirmaddress', null, array('code' => $code))); $target->getNickname(), common_config('site', 'name'), $this->getDisplayName(), common_local_url('confirmaddress', null, array('code' => $code)));
return $this->sendMessage($screenname, $body); return $this->sendMessage($screenname, $body);
} }
@ -594,11 +594,11 @@ abstract class ImPlugin extends Plugin
'daemonScreenname' => $this->daemonScreenname()); 'daemonScreenname' => $this->daemonScreenname());
} }
function onSendImConfirmationCode($transport, $screenname, $code, $user) function onSendImConfirmationCode($transport, $screenname, $code, Profile $target)
{ {
if($transport == $this->transport) if($transport == $this->transport)
{ {
$this->sendConfirmationCode($screenname, $code, $user); $this->sendConfirmationCode($screenname, $code, $target);
return false; return false;
} }
} }