]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/emailsettings.php
Added missing isPrivateScope().
[quix0rs-gnu-social.git] / actions / emailsettings.php
index cc513c2b4007c93511e1cb55d94053e55aa93e30..dfdbe1bad066cac4dcb6f93156f3537fe1bcb699 100644 (file)
@@ -32,7 +32,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
     exit(1);
 }
 
-require_once INSTALLDIR.'/lib/accountsettingsaction.php';
+
 
 /**
  * Settings for email
@@ -47,14 +47,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 +65,6 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return instructions for use
      */
-
     function getInstructions()
     {
         // XXX: For consistency of parameters in messages, this should be a
@@ -91,10 +89,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',
@@ -118,8 +115,8 @@ class EmailsettingsAction extends AccountSettingsAction
             $confirm = $this->getConfirmation();
             if ($confirm) {
                 $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.'));
@@ -173,7 +170,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 +205,40 @@ 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');
+            $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, $this->scoped));
+        }
         $this->elementEnd('ul');
         // TRANS: Button label to save e-mail preferences.
         $this->submit('save', _m('BUTTON','Save'));
@@ -262,7 +252,6 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return Confirm_address Email address confirmation for user, or null
      */
-
     function getConfirmation()
     {
         $user = common_current_user();
@@ -288,12 +277,12 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @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->show_form(_('There was a problem with your session token. '.
                                'Try again, please.'));
             return;
@@ -322,51 +311,45 @@ 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(_('Could not 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);
-       }
+        $user = $this->scoped->getUser();
+
+        if (Event::handle('StartEmailSaveForm', array($this, $this->scoped))) {
+            $emailnotifysub   = $this->booleanintstring('emailnotifysub');
+            $emailnotifymsg   = $this->booleanintstring('emailnotifymsg');
+            $emailnotifynudge = $this->booleanintstring('emailnotifynudge');
+            $emailnotifyattn  = $this->booleanintstring('emailnotifyattn');
+            $emailmicroid     = $this->booleanintstring('emailmicroid');
+            $emailpost        = $this->booleanintstring('emailpost');
+
+            $user->query('BEGIN');
+
+            $original = clone($user);
+
+            $user->emailnotifysub   = $emailnotifysub;
+            $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__);
+                $user->query('ROLLBACK');
+                // TRANS: Server error thrown on database error updating e-mail preferences.
+                $this->serverError(_('Could not update user.'));
+            }
+
+            $user->query('COMMIT');
+
+            Event::handle('EndEmailSaveForm', array($this, $this->scoped));
+
+            // TRANS: Confirmation message for successful e-mail preferences save.
+            $this->showForm(_('Email preferences saved.'), true);
+        }
     }
 
     /**
@@ -374,7 +357,6 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function addAddress()
     {
         $user = common_current_user();
@@ -393,7 +375,7 @@ class EmailsettingsAction extends AccountSettingsAction
 
         if (!$email) {
             // TRANS: Message given saving e-mail address that cannot be normalised.
-            $this->showForm(_('Cannot normalize that email address'));
+            $this->showForm(_('Cannot normalize that email address.'));
             return;
         }
         if (!Validate::email($email, common_config('email', 'check_domain'))) {
@@ -411,23 +393,27 @@ class EmailsettingsAction extends AccountSettingsAction
             return;
         }
 
-        $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->id;
+            $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(_('Could not 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.
+                $this->serverError(_('Could not insert confirmation code.'));
+            }
 
-        mail_confirm_address($user, $confirm->code, $user->nickname, $email);
+            mail_confirm_address($user, $confirm->code, $user->nickname, $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. '.
@@ -442,7 +428,6 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function cancelConfirmation()
     {
         $email = $this->arg('email');
@@ -466,7 +451,6 @@ class EmailsettingsAction extends AccountSettingsAction
             common_log_db_error($confirm, 'DELETE', __FILE__);
             // TRANS: Server error thrown on database error canceling e-mail address confirmation.
             $this->serverError(_('Could not delete email confirmation.'));
-            return;
         }
 
         // TRANS: Message given after successfully canceling e-mail address confirmation.
@@ -478,7 +462,6 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function removeAddress()
     {
         $user = common_current_user();
@@ -494,21 +477,12 @@ class EmailsettingsAction extends AccountSettingsAction
             return;
         }
 
-        $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(_('Could not 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);
@@ -519,12 +493,12 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function removeIncoming()
     {
         $user = common_current_user();
 
         if (!$user->incomingemail) {
+            // TRANS: Form validation error displayed when trying to remove an incoming e-mail address while no address has been set.
             $this->showForm(_('No incoming email address.'));
             return;
         }
@@ -534,11 +508,8 @@ class EmailsettingsAction extends AccountSettingsAction
         $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(_("Could not 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);
@@ -549,7 +520,6 @@ class EmailsettingsAction extends AccountSettingsAction
      *
      * @return void
      */
-
     function newIncoming()
     {
         $user = common_current_user();
@@ -559,11 +529,8 @@ class EmailsettingsAction extends AccountSettingsAction
         $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(_("Could not 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);
@@ -583,7 +550,7 @@ class EmailsettingsAction extends AccountSettingsAction
     {
         $user = common_current_user();
 
-        $other = User::staticGet('email', $email);
+        $other = User::getKV('email', $email);
 
         if (!$other) {
             return false;