X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Fsmssettings.php;h=ca6a7d04efdec803cd5ebe2a2483b10d8b60e8be;hb=31c8416a8f97a7fa7bd8e84252403d00f669a759;hp=6af1872a0ec1d88bcf117ff20ba4ef2cadc57a6b;hpb=065ecc5573607d21ae005ff2649d04558256fc7e;p=quix0rs-gnu-social.git diff --git a/actions/smssettings.php b/actions/smssettings.php index 6af1872a0e..ca6a7d04ef 100644 --- a/actions/smssettings.php +++ b/actions/smssettings.php @@ -27,11 +27,7 @@ * @link http://status.net/ */ -if (!defined('STATUSNET') && !defined('LACONICA')) { - exit(1); -} - -require_once INSTALLDIR.'/lib/connectsettingsaction.php'; +if (!defined('GNUSOCIAL')) { exit(1); } /** * Settings for SMS @@ -45,14 +41,21 @@ require_once INSTALLDIR.'/lib/connectsettingsaction.php'; * @see SettingsAction */ -class SmssettingsAction extends ConnectSettingsAction +class SmssettingsAction extends SettingsAction { + protected function doPreparation() + { + if (!common_config('sms', 'enabled')) { + // TRANS: Message given in the SMS settings if SMS is not enabled on the site. + throw new ServerException(_('SMS is not available.')); + } + } + /** * Title of the page * * @return string Title of the page */ - function title() { // TRANS: Title for SMS settings. @@ -64,7 +67,6 @@ class SmssettingsAction extends ConnectSettingsAction * * @return instructions for use */ - function getInstructions() { // XXX: For consistency of parameters in messages, this should be a @@ -88,17 +90,9 @@ class SmssettingsAction extends ConnectSettingsAction * * @return void */ - function showContent() { - if (!common_config('sms', 'enabled')) { - $this->element('div', array('class' => 'error'), - // TRANS: Message given in the SMS settings if SMS is not enabled on the site. - _('SMS is not available.')); - return; - } - - $user = common_current_user(); + $user = $this->scoped->getUser(); $this->elementStart('form', array('method' => 'post', 'id' => 'form_settings_sms', @@ -123,9 +117,9 @@ class SmssettingsAction extends ConnectSettingsAction // TRANS: Button label to remove a confirmed SMS address. $this->submit('remove', _m('BUTTON','Remove')); } else { - $confirm = $this->getConfirmation(); - if ($confirm) { - $carrier = Sms_carrier::staticGet($confirm->address_extra); + try { + $confirm = $this->getConfirmation(); + $carrier = Sms_carrier::getKV($confirm->address_extra); $this->element('p', 'form_unconfirmed', $confirm->address . ' (' . $carrier->name . ')'); $this->element('p', 'form_guide', @@ -146,7 +140,7 @@ class SmssettingsAction extends ConnectSettingsAction $this->elementEnd('ul'); // TRANS: Button label to confirm SMS confirmation code in SMS settings. $this->submit('confirm', _m('BUTTON','Confirm')); - } else { + } catch (NoResultException $e) { $this->elementStart('ul', 'form_data'); $this->elementStart('li'); // TRANS: Field label for SMS phone number input in SMS settings form. @@ -154,7 +148,7 @@ class SmssettingsAction extends ConnectSettingsAction ($this->arg('sms')) ? $this->arg('sms') : null, // TRANS: SMS phone number input field instructions in SMS settings form. _('Phone number, no punctuation or spaces, '. - 'with area code')); + 'with area code.')); $this->elementEnd('li'); $this->elementEnd('ul'); $this->carrierSelect(); @@ -219,63 +213,40 @@ class SmssettingsAction extends ConnectSettingsAction * * @todo very similar to EmailsettingsAction::getConfirmation(); refactor? */ - function getConfirmation() { - $user = common_current_user(); - $confirm = new Confirm_address(); - $confirm->user_id = $user->id; + $confirm->user_id = $this->scoped->getID(); $confirm->address_type = 'sms'; 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(); + return $this->removeAddress(); } else if ($this->arg('removeincoming')) { - $this->removeIncoming(); + return $this->removeIncoming(); } else if ($this->arg('newincoming')) { - $this->newIncoming(); + return $this->newIncoming(); } else if ($this->arg('confirm')) { - $this->confirmCode(); - } else { - // TRANS: Message given submitting a form with an unknown action in SMS settings. - $this->showForm(_('Unexpected form submission.')); + return $this->confirmCode(); } + // TRANS: Message given submitting a form with an unknown action in SMS settings. + throw new ClientException(_('Unexpected form submission.')); } /** @@ -285,34 +256,28 @@ class SmssettingsAction extends ConnectSettingsAction * * @return void */ - function savePreferences() { - $smsnotify = $this->boolean('smsnotify'); - - $user = common_current_user(); - - assert(!is_null($user)); // should already be checked + $user = $this->scoped->getUser(); $user->query('BEGIN'); $original = clone($user); - $user->smsnotify = $smsnotify; + $user->smsnotify = $this->boolean('smsnotify'); $result = $user->update($original); if ($result === false) { common_log_db_error($user, 'UPDATE', __FILE__); // TRANS: Server error thrown on database error updating SMS preferences. - $this->serverError(_('Couldn\'t update user.')); - return; + throw new ServerException(_('Could not update user.')); } $user->query('COMMIT'); // TRANS: Confirmation message for successful SMS preferences save. - $this->showForm(_('SMS preferences saved.'), true); + return _('SMS preferences saved.'); } /** @@ -323,7 +288,6 @@ class SmssettingsAction extends ConnectSettingsAction * * @return void */ - function addAddress() { $user = common_current_user(); @@ -333,28 +297,24 @@ class SmssettingsAction extends ConnectSettingsAction // Some validation - if (!$sms) { + if (empty($sms)) { // TRANS: Message given saving SMS phone number without having provided one. - $this->showForm(_('No phone number.')); - return; + throw new ClientException(_('No phone number.')); } - if (!$carrier_id) { + if (empty($carrier_id)) { // TRANS: Message given saving SMS phone number without having selected a carrier. - $this->showForm(_('No carrier selected.')); - return; + throw new ClientException(_('No carrier selected.')); } $sms = common_canonical_sms($sms); - if ($user->sms == $sms) { + if ($user->sms === $sms) { // TRANS: Message given saving SMS phone number that is already set. - $this->showForm(_('That is already your phone number.')); - return; + throw new AlreadyFulfilledException(_('That is already your phone number.')); } else if ($this->smsExists($sms)) { // TRANS: Message given saving SMS phone number that is already set for another user. - $this->showForm(_('That phone number already belongs to another user.')); - return; + throw new ClientException(_('That phone number already belongs to another user.')); } $confirm = new Confirm_address(); @@ -362,7 +322,7 @@ class SmssettingsAction extends ConnectSettingsAction $confirm->address = $sms; $confirm->address_extra = $carrier_id; $confirm->address_type = 'sms'; - $confirm->user_id = $user->id; + $confirm->user_id = $this->scoped->getID(); $confirm->code = common_confirmation_code(40); $result = $confirm->insert(); @@ -370,22 +330,19 @@ class SmssettingsAction extends ConnectSettingsAction if ($result === false) { common_log_db_error($confirm, 'INSERT', __FILE__); // TRANS: Server error thrown on database error adding SMS confirmation code. - $this->serverError(_('Couldn\'t insert confirmation code.')); - return; + $this->serverError(_('Could not insert confirmation code.')); } - $carrier = Sms_carrier::staticGet($carrier_id); + $carrier = Sms_carrier::getKV($carrier_id); mail_confirm_sms($confirm->code, $user->nickname, $carrier->toEmailAddress($sms)); // TRANS: Message given saving valid SMS phone number that is to be confirmed. - $msg = _('A confirmation code was sent to the phone number you added. '. + return _('A confirmation code was sent to the phone number you added. '. 'Check your phone for the code and instructions '. 'on how to use it.'); - - $this->showForm($msg, true); } /** @@ -395,36 +352,32 @@ class SmssettingsAction extends ConnectSettingsAction * * @return void */ - function cancelConfirmation() { $sms = $this->trimmed('sms'); $carrier = $this->trimmed('carrier'); - $confirm = $this->getConfirmation(); - - if (!$confirm) { + try { + $confirm = $this->getConfirmation(); + if ($confirm->address != $sms) { + // TRANS: Message given canceling SMS phone number confirmation for the wrong phone number. + throw new ClientException(_('That is the wrong confirmation number.')); + } + } catch (NoResultException $e) { // TRANS: Message given canceling SMS phone number confirmation that is not pending. - $this->showForm(_('No pending confirmation to cancel.')); - return; - } - if ($confirm->address != $sms) { - // TRANS: Message given canceling SMS phone number confirmation for the wrong phone number. - $this->showForm(_('That is the wrong confirmation number.')); - return; + throw new AlreadyFulfilledException(_('No pending confirmation to cancel.')); } $result = $confirm->delete(); - if (!$result) { + if ($result === false) { common_log_db_error($confirm, 'DELETE', __FILE__); // TRANS: Server error thrown on database error canceling SMS phone number confirmation. - $this->serverError(_('Couldn\'t delete email confirmation.')); - return; + throw new ServerException(_('Could not delete SMS confirmation.')); } // TRANS: Message given after successfully canceling SMS phone number confirmation. - $this->showForm(_('SMS confirmation cancelled.'), true); + return _('SMS confirmation cancelled.'); } /** @@ -432,10 +385,9 @@ class SmssettingsAction extends ConnectSettingsAction * * @return void */ - function removeAddress() { - $user = common_current_user(); + $user = $this->scoped->getUser(); $sms = $this->arg('sms'); $carrier = $this->arg('carrier'); @@ -445,29 +397,20 @@ class SmssettingsAction extends ConnectSettingsAction if ($user->sms != $sms) { // TRANS: Message given trying to remove an SMS phone number that is not // TRANS: registered for the active user. - $this->showForm(_('That is not your phone number.')); - return; + throw new ClientException(_('That is not your phone number.')); } - $user->query('BEGIN'); - $original = clone($user); $user->sms = null; $user->carrier = null; $user->smsemail = null; - $result = $user->updateKeys($original); - if (!$result) { - common_log_db_error($user, 'UPDATE', __FILE__); - // TRANS: Server error thrown on database error removing a registered SMS phone number. - $this->serverError(_('Couldn\'t update user.')); - return; - } - $user->query('COMMIT'); + // Throws exception on failure. Also performs it within a transaction. + $user->updateWithKeys($original); // TRANS: Message given after successfully removing a registered SMS phone number. - $this->showForm(_('The SMS phone number was removed.'), true); + return _('The SMS phone number was removed.'); } /** @@ -479,18 +422,15 @@ class SmssettingsAction extends ConnectSettingsAction * * @return boolean does the number exist */ - function smsExists($sms) { - $user = common_current_user(); - - $other = User::staticGet('sms', $sms); + $other = User::getKV('sms', $sms); - if (!$other) { + if (!$other instanceof User) { return false; - } else { - return $other->id != $user->id; } + + return !$this->scoped->sameAs($other->getProfile()); } /** @@ -498,7 +438,6 @@ class SmssettingsAction extends ConnectSettingsAction * * @return void */ - function carrierSelect() { $carrier = new Sms_carrier(); @@ -538,20 +477,16 @@ class SmssettingsAction extends ConnectSettingsAction * * @return void */ - function confirmCode() { $code = $this->trimmed('code'); - if (!$code) { + if (empty($code)) { // TRANS: Message given saving SMS phone number confirmation code without having provided one. - $this->showForm(_('No code entered')); - return; + throw new ClientException(_('No code entered.')); } - common_redirect(common_local_url('confirmaddress', - array('code' => $code)), - 303); + common_redirect(common_local_url('confirmaddress', array('code' => $code)), 303); } /** @@ -559,26 +494,24 @@ class SmssettingsAction extends ConnectSettingsAction * * @return void */ - function removeIncoming() { $user = common_current_user(); if (!$user->incomingemail) { - $this->showForm(_('No incoming email address.')); - return; + // TRANS: Form validation error displayed when trying to remove an incoming e-mail address while no address has been set. + throw new ClientException(_('No incoming email address.')); } $orig = clone($user); $user->incomingemail = null; - if (!$user->updateKeys($orig)) { - common_log_db_error($user, 'UPDATE', __FILE__); - $this->serverError(_("Couldn't update user record.")); - } + // Throws exception on failure. Also performs it within a transaction. + $user->updateWithKeys($orig); - $this->showForm(_('Incoming email address removed.'), true); + // TRANS: Confirmation text after updating SMS settings. + return _('Incoming email address removed.'); } /** @@ -588,20 +521,18 @@ class SmssettingsAction extends ConnectSettingsAction * * @see Emailsettings::newIncoming */ - function newIncoming() { - $user = common_current_user(); + $user = $this->scoped->getUser(); $orig = clone($user); $user->incomingemail = mail_new_incoming_address(); - if (!$user->updateKeys($orig)) { - common_log_db_error($user, 'UPDATE', __FILE__); - $this->serverError(_("Couldn't update user record.")); - } + // Throws exception on failure. Also performs it within a transaction. + $user->updateWithKeys($orig); - $this->showForm(_('New incoming email address added.'), true); + // TRANS: Confirmation text after updating SMS settings. + return _('New incoming email address added.'); } }