<?php
/**
- * Laconica, the distributed open-source microblogging tool
+ * StatusNet, the distributed open-source microblogging tool
*
* Settings for SMS
*
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Settings
- * @package Laconica
- * @author Evan Prodromou <evan@controlyourself.ca>
- * @copyright 2008-2009 Control Yourself, Inc.
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @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://laconi.ca/
+ * @link http://status.net/
*/
-if (!defined('LACONICA')) {
- exit(1);
-}
-
-require_once INSTALLDIR.'/lib/connectsettingsaction.php';
+if (!defined('GNUSOCIAL')) { exit(1); }
/**
* Settings for SMS
*
* @category Settings
- * @package Laconica
- * @author Evan Prodromou <evan@controlyourself.ca>
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link http://laconi.ca/
+ * @link http://status.net/
*
* @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()
{
- return _('SMS Settings');
+ // TRANS: Title for SMS settings.
+ return _('SMS settings');
}
/**
*
* @return instructions for use
*/
-
function getInstructions()
{
+ // XXX: For consistency of parameters in messages, this should be a
+ // regular parameters, replaced with sprintf().
+ // TRANS: SMS settings page instructions.
+ // TRANS: %%site.name%% is the name of the site.
return _('You can receive SMS messages through email from %%site.name%%.');
}
+ function showScripts()
+ {
+ parent::showScripts();
+ $this->autofocus('sms');
+ }
+
/**
* Content area of the page
*
*
* @return void
*/
-
function showContent()
{
- if (!common_config('sms', 'enabled')) {
- $this->element('div', array('class' => 'error'),
- _('SMS is not available.'));
- return;
- }
-
- $user = common_current_user();
+ $user = $this->scoped->getUser();
$this->elementStart('form', array('method' => 'post',
'id' => 'form_settings_sms',
common_local_url('smssettings')));
$this->elementStart('fieldset', array('id' => 'settings_sms_address'));
- $this->element('legend', null, _('Address'));
+ // TRANS: Form legend for SMS settings form.
+ $this->element('legend', null, _('SMS address'));
$this->hidden('token', common_session_token());
if ($user->sms) {
$this->element('p', 'form_confirmed',
$user->sms . ' (' . $carrier->name . ')');
$this->element('p', 'form_guide',
+ // TRANS: Form guide in SMS settings form.
_('Current confirmed SMS-enabled phone number.'));
$this->hidden('sms', $user->sms);
$this->hidden('carrier', $user->carrier);
- $this->submit('remove', _('Remove'));
+ // 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',
+ // TRANS: Form guide in IM settings form.
_('Awaiting confirmation on this phone number.'));
$this->hidden('sms', $confirm->address);
$this->hidden('carrier', $confirm->address_extra);
- $this->submit('cancel', _('Cancel'));
+ // TRANS: Button label to cancel a SMS address confirmation procedure.
+ $this->submit('cancel', _m('BUTTON','Cancel'));
$this->elementStart('ul', 'form_data');
$this->elementStart('li');
+ // TRANS: Field label for SMS address input in SMS settings form.
$this->input('code', _('Confirmation code'), null,
+ // TRANS: Form field instructions in SMS settings form.
_('Enter the code you received on your phone.'));
$this->elementEnd('li');
$this->elementEnd('ul');
- $this->submit('confirm', _('Confirm'));
- } else {
+ // TRANS: Button label to confirm SMS confirmation code in SMS settings.
+ $this->submit('confirm', _m('BUTTON','Confirm'));
+ } catch (NoResultException $e) {
$this->elementStart('ul', 'form_data');
$this->elementStart('li');
- $this->input('sms', _('SMS Phone number'),
+ // TRANS: Field label for SMS phone number input in SMS settings form.
+ $this->input('sms', _('SMS phone number'),
($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();
- $this->submit('add', _('Add'));
+ // TRANS: Button label for adding a SMS phone number in SMS settings form.
+ $this->submit('add', _m('BUTTON','Add'));
}
}
$this->elementEnd('fieldset');
if ($user->sms) {
$this->elementStart('fieldset', array('id' => 'settings_sms_incoming_email'));
+ // XXX: Confused! This is about SMS. Should this message be updated?
+ // TRANS: Form legend for incoming SMS settings form.
$this->element('legend', null, _('Incoming email'));
if ($user->incomingemail) {
$this->element('p', 'form_unconfirmed', $user->incomingemail);
$this->element('p', 'form_note',
+ // XXX: Confused! This is about SMS. Should this message be updated?
+ // TRANS: Form instructions for incoming SMS e-mail address form in SMS settings.
_('Send email to this address to post new notices.'));
- $this->submit('removeincoming', _('Remove'));
+ // TRANS: Button label for removing a set sender SMS e-mail address to post notices from.
+ $this->submit('removeincoming', _m('BUTTON','Remove'));
}
$this->element('p', 'form_guide',
+ // XXX: Confused! This is about SMS. Should this message be updated?
+ // TRANS: Instructions for incoming SMS e-mail address input form.
_('Make a new email address for posting to; '.
'cancels the old one.'));
- $this->submit('newincoming', _('New'));
+ // TRANS: Button label for adding an SMS e-mail address to send notices from.
+ $this->submit('newincoming', _m('BUTTON','New'));
$this->elementEnd('fieldset');
}
$this->elementStart('fieldset', array('id' => 'settings_sms_preferences'));
- $this->element('legend', null, _('Preferences'));
+ // TRANS: Form legend for SMS preferences form.
+ $this->element('legend', null, _('SMS preferences'));
$this->elementStart('ul', 'form_data');
$this->elementStart('li');
$this->checkbox('smsnotify',
+ // TRANS: Checkbox label in SMS preferences form.
_('Send me notices through SMS; '.
'I understand I may incur '.
'exorbitant charges from my carrier.'),
$this->elementEnd('li');
$this->elementEnd('ul');
- $this->submit('save', _('Save'));
+ // TRANS: Button label to save SMS preferences.
+ $this->submit('save', _m('BUTTON','Save'));
$this->elementEnd('fieldset');
$this->elementEnd('form');
*
* @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 {
- $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.'));
}
/**
*
* @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__);
- $this->serverError(_('Couldn\'t update user.'));
- return;
+ // TRANS: Server error thrown on database error updating SMS preferences.
+ throw new ServerException(_('Could not update user.'));
}
$user->query('COMMIT');
- $this->showForm(_('Preferences saved.'), true);
+ // TRANS: Confirmation message for successful SMS preferences save.
+ return _('SMS preferences saved.');
}
/**
*
* @return void
*/
-
function addAddress()
{
$user = common_current_user();
// Some validation
- if (!$sms) {
- $this->showForm(_('No phone number.'));
- return;
+ if (empty($sms)) {
+ // TRANS: Message given saving SMS phone number without having provided one.
+ throw new ClientException(_('No phone number.'));
}
- if (!$carrier_id) {
- $this->showForm(_('No carrier selected.'));
- return;
+ if (empty($carrier_id)) {
+ // TRANS: Message given saving SMS phone number without having selected a carrier.
+ throw new ClientException(_('No carrier selected.'));
}
$sms = common_canonical_sms($sms);
- if ($user->sms == $sms) {
- $this->showForm(_('That is already your phone number.'));
- return;
+ if ($user->sms === $sms) {
+ // TRANS: Message given saving SMS phone number that is already set.
+ throw new AlreadyFulfilledException(_('That is already your phone number.'));
} else if ($this->smsExists($sms)) {
- $this->showForm(_('That phone number already belongs to another user.'));
- return;
+ // TRANS: Message given saving SMS phone number that is already set for another user.
+ throw new ClientException(_('That phone number already belongs to another user.'));
}
$confirm = new Confirm_address();
$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();
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 SMS confirmation code.
+ $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));
- $msg = _('A confirmation code was sent to the phone number you added. '.
+ // TRANS: Message given saving valid SMS phone number that is to be confirmed.
+ 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);
}
/**
*
* @return void
*/
-
function cancelConfirmation()
{
$sms = $this->trimmed('sms');
$carrier = $this->trimmed('carrier');
- $confirm = $this->getConfirmation();
-
- if (!$confirm) {
- $this->showForm(_('No pending confirmation to cancel.'));
- return;
- }
- if ($confirm->address != $sms) {
- $this->showForm(_('That is the wrong confirmation number.'));
- return;
+ 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.
+ 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 email confirmation.'));
- return;
+ // TRANS: Server error thrown on database error canceling SMS phone number confirmation.
+ throw new ServerException(_('Could not delete SMS confirmation.'));
}
- $this->showForm(_('Confirmation cancelled.'), true);
+ // TRANS: Message given after successfully canceling SMS phone number confirmation.
+ return _('SMS confirmation cancelled.');
}
/**
*
* @return void
*/
-
function removeAddress()
{
- $user = common_current_user();
+ $user = $this->scoped->getUser();
$sms = $this->arg('sms');
$carrier = $this->arg('carrier');
// Maybe an old tab open...?
if ($user->sms != $sms) {
- $this->showForm(_('That is not your phone number.'));
- return;
+ // TRANS: Message given trying to remove an SMS phone number that is not
+ // TRANS: registered for the active user.
+ 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__);
- $this->serverError(_('Couldn\'t update user.'));
- return;
- }
- $user->query('COMMIT');
+ // Throws exception on failure. Also performs it within a transaction.
+ $user->updateWithKeys($original);
- $this->showForm(_('The address was removed.'), true);
+ // TRANS: Message given after successfully removing a registered SMS phone number.
+ return _('The SMS phone number was removed.');
}
/**
*
* @return boolean does the number exist
*/
-
function smsExists($sms)
{
- $user = common_current_user();
+ $other = User::getKV('sms', $sms);
- $other = User::staticGet('sms', $sms);
-
- if (!$other) {
+ if (!$other instanceof User) {
return false;
- } else {
- return $other->id != $user->id;
}
+
+ return !$this->scoped->sameAs($other->getProfile());
}
/**
*
* @return void
*/
-
function carrierSelect()
{
$carrier = new Sms_carrier();
$this->elementStart('ul', 'form_data');
$this->elementStart('li');
+ // TRANS: Label for mobile carrier dropdown menu in SMS settings.
$this->element('label', array('for' => 'carrier'), _('Mobile carrier'));
$this->elementStart('select', array('name' => 'carrier',
'id' => 'carrier'));
$this->element('option', array('value' => 0),
+ // TRANS: Default option for mobile carrier dropdown menu in SMS settings.
_('Select a carrier'));
while ($carrier->fetch()) {
$this->element('option', array('value' => $carrier->id),
}
$this->elementEnd('select');
$this->element('p', 'form_guide',
+ // TRANS: Form instructions for mobile carrier dropdown menu in SMS settings.
+ // TRANS: %s is an administrative contact's e-mail address.
sprintf(_('Mobile carrier for your phone. '.
'If you know a carrier that accepts ' .
'SMS over email but isn\'t listed here, ' .
*
* @return void
*/
-
function confirmCode()
{
$code = $this->trimmed('code');
- if (!$code) {
- $this->showForm(_('No code entered'));
- return;
+ if (empty($code)) {
+ // TRANS: Message given saving SMS phone number confirmation code without having provided one.
+ 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);
}
/**
*
* @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.');
}
/**
*
* @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.');
}
}