]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/emailsettings.php
Don't send multiple error responses in ApiMediaUpload :)
[quix0rs-gnu-social.git] / actions / emailsettings.php
index 4a7dc1b871b450c1a8148037f95d495123655c66..c02f1cdfad27b861739e5c47737097c115e9ad5a 100644 (file)
  * @link      http://status.net/
  */
 
-if (!defined('STATUSNET') && !defined('LACONICA')) {
-    exit(1);
-}
-
-require_once INSTALLDIR.'/lib/accountsettingsaction.php';
+if (!defined('GNUSOCIAL')) { exit(1); }
 
 /**
  * Settings for email
@@ -47,14 +43,13 @@ require_once INSTALLDIR.'/lib/accountsettingsaction.php';
  * @see      Widget
  */
 
-class EmailsettingsAction extends AccountSettingsAction
+class EmailsettingsAction extends SettingsAction
 {
     /**
      * Title of the page
      *
      * @return string Title of the page
      */
-
     function title()
     {
         // TRANS: Title for e-mail settings.
@@ -66,7 +61,6 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return instructions for use
      */
-
     function getInstructions()
     {
         // XXX: For consistency of parameters in messages, this should be a
@@ -91,10 +85,9 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function showContent()
     {
-        $user = common_current_user();
+        $user = $this->scoped->getUser();
 
         $this->elementStart('form', array('method' => 'post',
                                           'id' => 'form_settings_email',
@@ -115,23 +108,23 @@ class EmailsettingsAction extends AccountSettingsAction
             // TRANS: Button label to remove a confirmed e-mail address.
             $this->submit('remove', _m('BUTTON','Remove'));
         } else {
-            $confirm = $this->getConfirmation();
-            if ($confirm) {
+            try {
+                $confirm = $this->getConfirmation();
                 $this->element('p', array('id' => 'form_unconfirmed'), $confirm->address);
-                // TRANS: Form note in e-mail settings form.
                 $this->element('p', array('class' => 'form_note'),
+                                        // TRANS: Form note in e-mail settings form.
                                         _('Awaiting confirmation on this address. '.
                                         'Check your inbox (and spam box!) for a message '.
                                         'with further instructions.'));
                 $this->hidden('email', $confirm->address);
                 // TRANS: Button label to cancel an e-mail address confirmation procedure.
                 $this->submit('cancel', _m('BUTTON','Cancel'));
-            } else {
+            } catch (NoResultException $e) {
                 $this->elementStart('ul', 'form_data');
                 $this->elementStart('li');
                 // TRANS: Field label for e-mail address input in e-mail settings form.
                 $this->input('email', _('Email address'),
-                             ($this->arg('email')) ? $this->arg('email') : null,
+                             $this->trimmed('email') ?: null,
                              // TRANS: Instructions for e-mail address input form. Do not translate
                              // TRANS: "example.org". It is one of the domain names reserved for
                              // TRANS: use in examples by http://www.rfc-editor.org/rfc/rfc2606.txt.
@@ -173,7 +166,7 @@ class EmailsettingsAction extends AccountSettingsAction
             if ($user->incomingemail) {
                 $this->elementStart('p');
                 $this->element('span', 'address', $user->incomingemail);
-                // XXX: Looks a little awkward in the UI.
+                // @todo XXX: Looks a little awkward in the UI.
                 //      Something like "xxxx@identi.ca  Send email ..". Needs improvement.
                 $this->element('span', 'input_instructions',
                                // TRANS: Form instructions for incoming e-mail form in e-mail settings.
@@ -208,47 +201,34 @@ class EmailsettingsAction extends AccountSettingsAction
         $this->element('legend', null, _('Email preferences'));
 
         $this->elementStart('ul', 'form_data');
-       
-        if (Event::handle('StartEmailFormData', array($this))) {
-           $this->elementStart('li');
-           $this->checkbox('emailnotifysub',
-                           // TRANS: Checkbox label in e-mail preferences form.
-                           _('Send me notices of new subscriptions through email.'),
-                           $user->emailnotifysub);
-           $this->elementEnd('li');
-           $this->elementStart('li');
-           $this->checkbox('emailnotifyfav',
-                           // TRANS: Checkbox label in e-mail preferences form.
-                           _('Send me email when someone '.
-                             'adds my notice as a favorite.'),
-                           $user->emailnotifyfav);
-           $this->elementEnd('li');
-           $this->elementStart('li');
-           $this->checkbox('emailnotifymsg',
-                           // TRANS: Checkbox label in e-mail preferences form.
-                           _('Send me email when someone sends me a private message.'),
-                           $user->emailnotifymsg);
-           $this->elementEnd('li');
-           $this->elementStart('li');
-           $this->checkbox('emailnotifyattn',
-                           // TRANS: Checkbox label in e-mail preferences form.
-                           _('Send me email when someone sends me an "@-reply".'),
-                           $user->emailnotifyattn);
-           $this->elementEnd('li');
-           $this->elementStart('li');
-           $this->checkbox('emailnotifynudge',
-                           // TRANS: Checkbox label in e-mail preferences form.
-                           _('Allow friends to nudge me and send me an email.'),
-                           $user->emailnotifynudge);
-           $this->elementEnd('li');
-           $this->elementStart('li');
-           $this->checkbox('emailmicroid',
-                           // TRANS: Checkbox label in e-mail preferences form.
-                           _('Publish a MicroID for my email address.'),
-                           $user->emailmicroid);
-           $this->elementEnd('li');
-           Event::handle('EndEmailFormData', array($this));
-       }
+
+        if (Event::handle('StartEmailFormData', array($this, $this->scoped))) {
+            $this->elementStart('li');
+            $this->checkbox('emailnotifysub',
+                            // TRANS: Checkbox label in e-mail preferences form.
+                            _('Send me notices of new subscriptions through email.'),
+                            $user->emailnotifysub);
+            $this->elementEnd('li');
+            $this->elementStart('li');
+            $this->checkbox('emailnotifymsg',
+                            // TRANS: Checkbox label in e-mail preferences form.
+                            _('Send me email when someone sends me a private message.'),
+                            $user->emailnotifymsg);
+            $this->elementEnd('li');
+            $this->elementStart('li');
+            $this->checkbox('emailnotifyattn',
+                            // TRANS: Checkbox label in e-mail preferences form.
+                            _('Send me email when someone sends me an "@-reply".'),
+                            $user->emailnotifyattn);
+            $this->elementEnd('li');
+            $this->elementStart('li');
+            $this->checkbox('emailnotifynudge',
+                            // TRANS: Checkbox label in e-mail preferences form.
+                            _('Allow friends to nudge me and send me an email.'),
+                            $user->emailnotifynudge);
+            $this->elementEnd('li');
+            Event::handle('EndEmailFormData', array($this, $this->scoped));
+        }
         $this->elementEnd('ul');
         // TRANS: Button label to save e-mail preferences.
         $this->submit('save', _m('BUTTON','Save'));
@@ -262,59 +242,38 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return Confirm_address Email address confirmation for user, or null
      */
-
     function getConfirmation()
     {
-        $user = common_current_user();
-
         $confirm = new Confirm_address();
 
-        $confirm->user_id      = $user->id;
+        $confirm->user_id      = $this->scoped->getID();
         $confirm->address_type = 'email';
 
         if ($confirm->find(true)) {
             return $confirm;
-        } else {
-            return null;
         }
-    }
 
-    /**
-     * Handle posts
-     *
-     * Since there are a lot of different options on the page, we
-     * figure out what we're supposed to do based on which button was
-     * pushed
-     *
-     * @return void
-     */
+        throw new NoResultException($confirm);
+    }
 
-    function handlePost()
+    protected function doPost()
     {
-        // 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.'));
-            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();
-        } else {
-            // TRANS: Message given submitting a form with an unknown action in e-mail settings.
-            $this->showForm(_('Unexpected form submission.'));
+            return $this->newIncoming();
         }
+
+        // TRANS: Message given submitting a form with an unknown action in e-mail settings.
+        throw new ClientException(_('Unexpected form submission.'));
     }
 
     /**
@@ -322,51 +281,40 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function savePreferences()
     {
-       $user = common_current_user();
-       
-       if (Event::handle('StartEmailSaveForm', array($this, &$user))) {
-           
-           $emailnotifysub   = $this->boolean('emailnotifysub');
-           $emailnotifyfav   = $this->boolean('emailnotifyfav');
-           $emailnotifymsg   = $this->boolean('emailnotifymsg');
-           $emailnotifynudge = $this->boolean('emailnotifynudge');
-           $emailnotifyattn  = $this->boolean('emailnotifyattn');
-           $emailmicroid     = $this->boolean('emailmicroid');
-           $emailpost        = $this->boolean('emailpost');
-           
-           assert(!is_null($user)); // should already be checked
-           
-           $user->query('BEGIN');
-           
-           $original = clone($user);
-           
-           $user->emailnotifysub   = $emailnotifysub;
-           $user->emailnotifyfav   = $emailnotifyfav;
-           $user->emailnotifymsg   = $emailnotifymsg;
-           $user->emailnotifynudge = $emailnotifynudge;
-           $user->emailnotifyattn  = $emailnotifyattn;
-           $user->emailmicroid     = $emailmicroid;
-           $user->emailpost        = $emailpost;
-           
-           $result = $user->update($original);
-           
-           if ($result === false) {
-               common_log_db_error($user, 'UPDATE', __FILE__);
-               // TRANS: Server error thrown on database error updating e-mail preferences.
-               $this->serverError(_('Couldn\'t update user.'));
-               return;
-           }
-           
-           $user->query('COMMIT');
-           
-           Event::handle('EndEmailSaveForm', array($this));
-           
-           // TRANS: Confirmation message for successful e-mail preferences save.
-           $this->showForm(_('Email preferences saved.'), true);
-       }
+        if (Event::handle('StartEmailSaveForm', array($this, $this->scoped))) {
+            $emailnotifysub   = $this->booleanintstring('emailnotifysub');
+            $emailnotifymsg   = $this->booleanintstring('emailnotifymsg');
+            $emailnotifynudge = $this->booleanintstring('emailnotifynudge');
+            $emailnotifyattn  = $this->booleanintstring('emailnotifyattn');
+            $emailpost        = $this->booleanintstring('emailpost');
+
+            $user = $this->scoped->getUser();
+            $user->query('BEGIN');
+            $original = clone($user);
+
+            $user->emailnotifysub   = $emailnotifysub;
+            $user->emailnotifymsg   = $emailnotifymsg;
+            $user->emailnotifynudge = $emailnotifynudge;
+            $user->emailnotifyattn  = $emailnotifyattn;
+            $user->emailpost        = $emailpost;
+
+            $result = $user->update($original);
+
+            if ($result === false) {
+                common_log_db_error($user, 'UPDATE', __FILE__);
+                $user->query('ROLLBACK');
+                // TRANS: Server error thrown on database error updating e-mail preferences.
+                throw new ServerException(_('Could not update user.'));
+            }
+
+            $user->query('COMMIT');
+
+            Event::handle('EndEmailSaveForm', array($this, $this->scoped));
+        }
+        // TRANS: Confirmation message for successful e-mail preferences save.
+        return _('Email preferences saved.');
     }
 
     /**
@@ -374,67 +322,63 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function addAddress()
     {
-        $user = common_current_user();
+        $user = $this->scoped->getUser();
 
         $email = $this->trimmed('email');
 
         // Some validation
 
-        if (!$email) {
+        if (empty($email)) {
             // TRANS: Message given saving e-mail address without having provided one.
-            $this->showForm(_('No email address.'));
-            return;
+            throw new ClientException(_('No email address.'));
         }
 
         $email = common_canonical_email($email);
 
-        if (!$email) {
+        if (empty($email)) {
             // TRANS: Message given saving e-mail address that cannot be normalised.
-            $this->showForm(_('Cannot normalize that email address'));
-            return;
+            throw new ClientException(_('Cannot normalize that email address.'));
         }
         if (!Validate::email($email, common_config('email', 'check_domain'))) {
             // TRANS: Message given saving e-mail address that not valid.
-            $this->showForm(_('Not a valid email address.'));
-            return;
+            throw new ClientException(_('Not a valid email address.'));
         } else if ($user->email == $email) {
             // TRANS: Message given saving e-mail address that is already set.
-            $this->showForm(_('That is already your email address.'));
-            return;
+            throw new ClientException(_('That is already your email address.'));
         } else if ($this->emailExists($email)) {
             // TRANS: Message given saving e-mail address that is already set for another user.
-            $this->showForm(_('That email address already belongs '.
-                              'to another user.'));
-            return;
+            throw new ClientException(_('That email address already belongs to another user.'));
         }
 
-        $confirm = new Confirm_address();
+        if (Event::handle('StartAddEmailAddress', array($user, $email))) {
 
-        $confirm->address      = $email;
-        $confirm->address_type = 'email';
-        $confirm->user_id      = $user->id;
-        $confirm->code         = common_confirmation_code(64);
+            $confirm = new Confirm_address();
 
-        $result = $confirm->insert();
+            $confirm->address      = $email;
+            $confirm->address_type = 'email';
+            $confirm->user_id      = $user->getID();
+            $confirm->code         = common_confirmation_code(64);
 
-        if ($result === false) {
-            common_log_db_error($confirm, 'INSERT', __FILE__);
-            // TRANS: Server error thrown on database error adding e-mail confirmation code.
-            $this->serverError(_('Couldn\'t insert confirmation code.'));
-            return;
-        }
+            $result = $confirm->insert();
+
+            if ($result === false) {
+                common_log_db_error($confirm, 'INSERT', __FILE__);
+                // TRANS: Server error thrown on database error adding e-mail confirmation code.
+                throw new ServerException(_('Could not insert confirmation code.'));
+            }
 
-        mail_confirm_address($user, $confirm->code, $user->nickname, $email);
+            common_debug('Sending confirmation address for user '.$user->getID().' to email '.$email);
+            mail_confirm_address($user, $confirm->code, $user->getNickname(), $email);
+
+            Event::handle('EndAddEmailAddress', array($user, $email));
+        }
 
         // TRANS: Message given saving valid e-mail address that is to be confirmed.
-        $msg = _('A confirmation code was sent to the email address you added. '.
+        return _('A confirmation code was sent to the email address you added. '.
                  'Check your inbox (and spam box!) for the code and instructions '.
                  'on how to use it.');
-
-        $this->showForm($msg, true);
     }
 
     /**
@@ -442,35 +386,31 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function cancelConfirmation()
     {
-        $email = $this->arg('email');
-
-        $confirm = $this->getConfirmation();
+        $email = $this->trimmed('email');
 
-        if (!$confirm) {
+        try {
+            $confirm = $this->getConfirmation();
+            if ($confirm->address !== $email) {
+                // TRANS: Message given canceling e-mail address confirmation for the wrong e-mail address.
+                throw new ClientException(_('That is the wrong email address.'));
+            }
+        } catch (NoResultException $e) {
             // TRANS: Message given canceling e-mail address confirmation that is not pending.
-            $this->showForm(_('No pending confirmation to cancel.'));
-            return;
-        }
-        if ($confirm->address != $email) {
-            // TRANS: Message given canceling e-mail address confirmation for the wrong e-mail address.
-            $this->showForm(_('That is the wrong email address.'));
-            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 e-mail address confirmation.
-            $this->serverError(_('Couldn\'t delete email confirmation.'));
-            return;
+            throw new ServerException(_('Could not delete email confirmation.'));
         }
 
         // TRANS: Message given after successfully canceling e-mail address confirmation.
-        $this->showForm(_('Email confirmation cancelled.'), true);
+        return _('Email confirmation cancelled.');
     }
 
     /**
@@ -478,40 +418,26 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function removeAddress()
     {
         $user = common_current_user();
 
-        $email = $this->arg('email');
+        $email = $this->trimmed('email');
 
         // Maybe an old tab open...?
-
-        if ($user->email != $email) {
+        if ($user->email !== $email) {
             // TRANS: Message given trying to remove an e-mail address that is not
             // TRANS: registered for the active user.
-            $this->showForm(_('That is not your email address.'));
-            return;
+            throw new ClientException(_('That is not your email address.'));
         }
 
-        $user->query('BEGIN');
-
         $original = clone($user);
-
         $user->email = null;
-
-        $result = $user->updateKeys($original);
-
-        if (!$result) {
-            common_log_db_error($user, 'UPDATE', __FILE__);
-            // TRANS: Server error thrown on database error removing a registered e-mail address.
-            $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 e-mail address.
-        $this->showForm(_('The email address was removed.'), true);
+        return _('The email address was removed.');
     }
 
     /**
@@ -519,29 +445,23 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function removeIncoming()
     {
         $user = common_current_user();
 
-        if (!$user->incomingemail) {
-            $this->showForm(_('No incoming email address.'));
-            return;
+        if (empty($user->incomingemail)) {
+            // TRANS: Form validation error displayed when trying to remove an incoming e-mail address while no address has been set.
+            throw new AlreadyFulfilledException(_('No incoming email address.'));
         }
 
         $orig = clone($user);
-
         $user->incomingemail = null;
         $user->emailpost = 0;
-
-        if (!$user->updateKeys($orig)) {
-            common_log_db_error($user, 'UPDATE', __FILE__);
-            // TRANS: Server error thrown on database error removing incoming e-mail address.
-            $this->serverError(_("Couldn't update user record."));
-        }
+        // Throws exception on failure. Also performs it within a transaction.
+        $user->updateWithKeys($orig);
 
         // TRANS: Message given after successfully removing an incoming e-mail address.
-        $this->showForm(_('Incoming email address removed.'), true);
+        return _('Incoming email address removed.');
     }
 
     /**
@@ -549,24 +469,17 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function newIncoming()
     {
         $user = common_current_user();
-
         $orig = clone($user);
-
         $user->incomingemail = mail_new_incoming_address();
         $user->emailpost = 1;
-
-        if (!$user->updateKeys($orig)) {
-            common_log_db_error($user, 'UPDATE', __FILE__);
-            // TRANS: Server error thrown on database error adding incoming e-mail address.
-            $this->serverError(_("Couldn't update user record."));
-        }
+        // Throws exception on failure. Also performs it within a transaction.
+        $user->updateWithKeys($orig);
 
         // TRANS: Message given after successfully adding an incoming e-mail address.
-        $this->showForm(_('New incoming email address added.'), true);
+        return _('New incoming email address added.');
     }
 
     /**
@@ -583,12 +496,12 @@ class EmailsettingsAction extends AccountSettingsAction
     {
         $user = common_current_user();
 
-        $other = User::staticGet('email', $email);
+        $other = User::getKV('email', $email);
 
-        if (!$other) {
+        if (!$other instanceof User) {
             return false;
-        } else {
-            return $other->id != $user->id;
         }
+
+        return $other->id != $user->id;
     }
 }