]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/recoverpassword.php
* improve L10n consistency for English. For example proper punctuation for all button...
[quix0rs-gnu-social.git] / actions / recoverpassword.php
index 068d582fa4de114ed0ebe3870737ebe94bccd20d..9019d6fb227359ba0b17c37801577e8458462b4f 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2008, 2009, StatusNet, Inc.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
 
 # You have 24 hours to claim your password
 
-define(MAX_RECOVERY_TIME, 24 * 60 * 60);
+define('MAX_RECOVERY_TIME', 24 * 60 * 60);
 
-class RecoverpasswordAction extends Action {
+class RecoverpasswordAction extends Action
+{
+    var $mode = null;
+    var $msg = null;
+    var $success = null;
 
-    function handle($args) {
+    function handle($args)
+    {
         parent::handle($args);
         if (common_logged_in()) {
-            $this->client_error(_('You are already logged in!'));
+            // TRANS: Client error displayed trying to recover password while already logged in.
+            $this->clientError(_('You are already logged in!'));
             return;
         } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
             if ($this->arg('recover')) {
-                $this->recover_password();
+                $this->recoverPassword();
             } else if ($this->arg('reset')) {
-                $this->reset_password();
+                $this->resetPassword();
             } else {
-                $this->client_error(_('Unexpected form submission.'));
+                // TRANS: Client error displayed when unexpected data is posted in the password recovery form.
+                $this->clientError(_('Unexpected form submission.'));
             }
         } else {
             if ($this->trimmed('code')) {
-                $this->check_code();
+                $this->checkCode();
             } else {
-                $this->show_form();
+                $this->showForm();
             }
         }
     }
 
-    function check_code() {
-
+    function checkCode()
+    {
         $code = $this->trimmed('code');
         $confirm = Confirm_address::staticGet('code', $code);
 
         if (!$confirm) {
-            $this->client_error(_('No such recovery code.'));
+            // TRANS: Client error displayed when password recovery code is not correct.
+            $this->clientError(_('No such recovery code.'));
             return;
         }
         if ($confirm->address_type != 'recover') {
-            $this->client_error(_('Not a recovery code.'));
+            // TRANS: Client error displayed when no proper password recovery code was submitted.
+            $this->clientError(_('Not a recovery code.'));
             return;
         }
 
         $user = User::staticGet($confirm->user_id);
 
         if (!$user) {
-            $this->server_error(_('Recovery code for unknown user.'));
+            // TRANS: Server error displayed trying to recover password without providing a user.
+            $this->serverError(_('Recovery code for unknown user.'));
             return;
         }
 
@@ -77,7 +87,8 @@ class RecoverpasswordAction extends Action {
 
         if (!$result) {
             common_log_db_error($confirm, 'DELETE', __FILE__);
-            common_server_error(_('Error with confirmation code.'));
+            // TRANS: Server error displayed removing a password recovery code from the database.
+            $this->serverError(_('Error with confirmation code.'));
             return;
         }
 
@@ -85,10 +96,11 @@ class RecoverpasswordAction extends Action {
         # Note: it's still deleted; let's avoid a second attempt!
 
         if ((time() - $touched) > MAX_RECOVERY_TIME) {
-            common_log(LOG_WARNING, 
+            common_log(LOG_WARNING,
                        'Attempted redemption on recovery code ' .
                        'that is ' . $touched . ' seconds old. ');
-            $this->client_error(_('This confirmation code is too old. ' .
+            // TRANS: Client error displayed trying to recover password with too old a recovery code.
+            $this->clientError(_('This confirmation code is too old. ' .
                                    'Please start again.'));
             return;
         }
@@ -102,23 +114,26 @@ class RecoverpasswordAction extends Action {
             $result = $user->updateKeys($orig);
             if (!$result) {
                 common_log_db_error($user, 'UPDATE', __FILE__);
-                $this->server_error(_('Could not update user with confirmed email address.'));
+                // TRANS: Server error displayed when updating a user's e-mail address in the database fails while recovering a password.
+                $this->serverError(_('Could not update user with confirmed email address.'));
                 return;
             }
         }
 
         # Success!
 
-        $this->set_temp_user($user);
-        $this->show_password_form();
+        $this->setTempUser($user);
+        $this->showPasswordForm();
     }
 
-    function set_temp_user(&$user) {
+    function setTempUser(&$user)
+    {
         common_ensure_session();
         $_SESSION['tempuser'] = $user->id;
     }
 
-    function get_temp_user() {
+    function getTempUser()
+    {
         common_ensure_session();
         $user_id = $_SESSION['tempuser'];
         if ($user_id) {
@@ -127,74 +142,140 @@ class RecoverpasswordAction extends Action {
         return $user;
     }
 
-    function clear_temp_user() {
+    function clearTempUser()
+    {
         common_ensure_session();
         unset($_SESSION['tempuser']);
     }
 
-    function show_top($msg=null) {
-        if ($msg) {
-            common_element('div', 'error', $msg);
+    function showPageNotice()
+    {
+        if ($this->msg) {
+            $this->element('div', ($this->success) ? 'success' : 'error', $this->msg);
         } else {
-            common_element_start('div', 'instructions');
-            common_element('p', null, 
-                           _('If you\'ve forgotten or lost your' .
-                              ' password, you can get a new one sent to' .
-                              ' the email address you have stored ' .
-                              ' in your account.'));
-            common_element_end('div');
+            $this->elementStart('div', 'instructions');
+            if ($this->mode == 'recover') {
+                $this->element('p', null,
+                               // TRANS: Page notice for password recovery page.
+                               _('If you have forgotten or lost your' .
+                                 ' password, you can get a new one sent to' .
+                                 ' the email address you have stored' .
+                                 ' in your account.'));
+            } else if ($this->mode == 'reset') {
+                // TRANS: Page notice for password change page.
+                $this->element('p', null,
+                               _('You have been identified. Enter a' .
+                                 ' new password below.'));
+            }
+            $this->elementEnd('div');
         }
     }
 
-    function show_password_top($msg=null) {
-        if ($msg) {
-            common_element('div', 'error', $msg);
-        } else {
-            common_element('div', 'instructions',
-                           _('You\'ve been identified. Enter a ' .
-                              ' new password below. '));
-        }
+    function showForm($msg=null)
+    {
+        $this->msg = $msg;
+        $this->mode = 'recover';
+        $this->showPage();
     }
 
-    function show_form($msg=null) {
-
-        common_show_header(_('Recover password'), null,
-        $msg, array($this, 'show_top'));
+    function showContent()
+    {
+        if ($this->mode == 'recover') {
+            $this->showRecoverForm();
+        } else if ($this->mode == 'reset') {
+            $this->showResetForm();
+        }
+    }
 
-        common_element_start('form', array('method' => 'post',
-                                           'id' => 'recoverpassword',
+    function showRecoverForm()
+    {
+        $this->elementStart('form', array('method' => 'post',
+                                           'id' => 'form_password_recover',
+                                           'class' => 'form_settings',
                                            'action' => common_local_url('recoverpassword')));
-        common_input('nicknameoremail', _('Nickname or email'),
+        $this->elementStart('fieldset');
+        // TRANS: Fieldset legend for password recovery page.
+        $this->element('legend', null, _('Password recovery'));
+        $this->elementStart('ul', 'form_data');
+        $this->elementStart('li');
+        // TRANS: Field label on password recovery page.
+        $this->input('nicknameoremail', _('Nickname or email address'),
                      $this->trimmed('nicknameoremail'),
+                     // TRANS: Title for field label on password recovery page.
                      _('Your nickname on this server, ' .
                         'or your registered email address.'));
-        common_submit('recover', _('Recover'));
-        common_element_end('form');
-        common_show_footer();
+        $this->elementEnd('li');
+        $this->elementEnd('ul');
+        $this->element('input', array('name' => 'recover',
+                                      'type' => 'hidden',
+                                      // TRANS: Field label on password recovery page.
+                                      'value' => _('Recover')));
+        // TRANS: Button text on password recovery page.
+        $this->submit('recover', _m('BUTTON','Recover'));
+        $this->elementEnd('fieldset');
+        $this->elementEnd('form');
     }
 
-    function show_password_form($msg=null) {
+    function title()
+    {
+        switch ($this->mode) {
+         // TRANS: Title for password recovery page in password reset mode.
+         case 'reset': return _('Reset password');
+         // TRANS: Title for password recovery page in password recover mode.
+         case 'recover': return _('Recover password');
+         // TRANS: Title for password recovery page in email sent mode.
+         case 'sent': return _('Password recovery requested');
+         // TRANS: Title for password recovery page in password saved mode.
+         case 'saved': return _('Password saved');
+         default:
+            // TRANS: Title for password recovery page when an unknown action has been specified.
+            return _('Unknown action');
+        }
+    }
 
-        common_show_header(_('Reset password'), null,
-        $msg, array($this, 'show_password_top'));
+    function showPasswordForm($msg=null)
+    {
+        $this->msg = $msg;
+        $this->mode = 'reset';
+        $this->showPage();
+    }
 
-        common_element_start('form', array('method' => 'post',
-                                           'id' => 'recoverpassword',
+    function showResetForm()
+    {
+        $this->elementStart('form', array('method' => 'post',
+                                           'id' => 'form_password_change',
+                                           'class' => 'form_settings',
                                            'action' => common_local_url('recoverpassword')));
-        common_hidden('token', common_session_token());
-        common_password('newpassword', _('New password'),
-                        _('6 or more characters, and don\'t forget it!'));
-        common_password('confirm', _('Confirm'),
-                        _('Same as password above'));
-        common_submit('reset', _('Reset'));
-        common_element_end('form');
-        common_show_footer();
+        $this->elementStart('fieldset');
+         // TRANS: Fieldset legend for password reset form.
+        $this->element('legend', null, _('Password change'));
+        $this->hidden('token', common_session_token());
+        $this->elementStart('ul', 'form_data');
+        $this->elementStart('li');
+         // TRANS: Field label for password reset form.
+        $this->password('newpassword', _('New password'),
+                        // TRANS: Title for field label for password reset form.
+                        _('6 or more characters, and do not forget it!'));
+        $this->elementEnd('li');
+        $this->elementStart('li');
+         // TRANS: Field label for password reset form where the password has to be typed again.
+        $this->password('confirm', _('Confirm'),
+                        // TRANS: Ttile for field label for password reset form where the password has to be typed again.
+                        _('Same as password above.'));
+        $this->elementEnd('li');
+        $this->elementEnd('ul');
+         // TRANS: Button text for password reset form.
+        $this->submit('reset', _m('BUTTON','Reset'));
+        $this->elementEnd('fieldset');
+        $this->elementEnd('form');
     }
 
-    function recover_password() {
+    function recoverPassword()
+    {
         $nore = $this->trimmed('nicknameoremail');
         if (!$nore) {
-            $this->show_form(_('Enter a nickname or email address.'));
+            // TRANS: Form instructions for password recovery form.
+            $this->showForm(_('Enter a nickname or email address.'));
             return;
         }
 
@@ -207,29 +288,43 @@ class RecoverpasswordAction extends Action {
         # See if it's an unconfirmed email address
 
         if (!$user) {
-            $confirm_email = Confirm_address::staticGet('address', common_canonical_email($nore));
-            if ($confirm_email && $confirm_email->address_type == 'email') {
+            // Warning: it may actually be legit to have multiple folks
+            // who have claimed, but not yet confirmed, the same address.
+            // We'll only send to the first one that comes up.
+            $confirm_email = new Confirm_address();
+            $confirm_email->address = common_canonical_email($nore);
+            $confirm_email->address_type = 'email';
+            $confirm_email->find();
+            if ($confirm_email->fetch()) {
                 $user = User::staticGet($confirm_email->user_id);
+            } else {
+                $confirm_email = null;
             }
+        } else {
+            $confirm_email = null;
         }
 
         if (!$user) {
-            $this->show_form(_('No user with that email address or username.'));
+            // TRANS: Information on password recovery form if no known username or e-mail address was specified.
+            $this->showForm(_('No user with that email address or username.'));
             return;
         }
 
         # Try to get an unconfirmed email address if they used a user name
 
         if (!$user->email && !$confirm_email) {
-            $confirm_email = Confirm_address::staticGet('user_id', $user->id);
-            if ($confirm_email && $confirm_email->address_type != 'email') {
-                # Skip non-email confirmations
+            $confirm_email = new Confirm_address();
+            $confirm_email->user_id = $user->id;
+            $confirm_email->address_type = 'email';
+            $confirm_email->find();
+            if (!$confirm_email->fetch()) {
                 $confirm_email = null;
             }
         }
 
         if (!$user->email && !$confirm_email) {
-            $this->client_error(_('No registered email address for that user.'));
+            // TRANS: Client error displayed on password recovery form if a user does not have a registered e-mail address.
+            $this->clientError(_('No registered email address for that user.'));
             return;
         }
 
@@ -239,14 +334,16 @@ class RecoverpasswordAction extends Action {
         $confirm->code = common_confirmation_code(128);
         $confirm->address_type = 'recover';
         $confirm->user_id = $user->id;
-        $confirm->address = (isset($user->email)) ? $user->email : $confirm_email->address;
+        $confirm->address = (!empty($user->email)) ? $user->email : $confirm_email->address;
 
         if (!$confirm->insert()) {
             common_log_db_error($confirm, 'INSERT', __FILE__);
-            $this->server_error(_('Error saving address confirmation.'));
+            // TRANS: Server error displayed if e-mail address confirmation fails in the database on the password recovery form.
+            $this->serverError(_('Error saving address confirmation.'));
             return;
         }
 
+         // @todo FIXME: needs i18n.
         $body = "Hey, $user->nickname.";
         $body .= "\n\n";
         $body .= 'Someone just asked for a new password ' .
@@ -264,29 +361,34 @@ class RecoverpasswordAction extends Action {
         $body .= common_config('site', 'name');
         $body .= "\n";
 
-        mail_to_user($user, _('Password recovery requested'), $body, $confirm->address);
+        $headers = _mail_prepare_headers('recoverpassword', $user->nickname, $user->nickname);
+        // TRANS: Subject for password recovery e-mail.
+        mail_to_user($user, _('Password recovery requested'), $body, $headers, $confirm->address);
 
-        common_show_header(_('Password recovery requested'));
-        common_element('p', null,
-                       _('Instructions for recovering your password ' .
+        $this->mode = 'sent';
+        // TRANS: User notification after an e-mail with instructions was sent from the password recovery form.
+        $this->msg = _('Instructions for recovering your password ' .
                           'have been sent to the email address registered to your ' .
-                          'account.'));
-        common_show_footer();
+                          'account.');
+        $this->success = true;
+        $this->showPage();
     }
 
-    function reset_password() {
-
+    function resetPassword()
+    {
         # 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.'));
+            // TRANS: Form validation error message.
+            $this->showForm(_('There was a problem with your session token. Try again, please.'));
             return;
         }
 
-        $user = $this->get_temp_user();
+        $user = $this->getTempUser();
 
         if (!$user) {
-            $this->client_error(_('Unexpected password reset.'));
+            // TRANS: Client error displayed when trying to reset as password without providing a user.
+            $this->clientError(_('Unexpected password reset.'));
             return;
         }
 
@@ -294,11 +396,13 @@ class RecoverpasswordAction extends Action {
         $confirm = $this->trimmed('confirm');
 
         if (!$newpassword || strlen($newpassword) < 6) {
-            $this->show_password_form(_('Password must be 6 chars or more.'));
+            // TRANS: Reset password form validation error message.
+            $this->showPasswordForm(_('Password must be 6 characters or more.'));
             return;
         }
         if ($newpassword != $confirm) {
-            $this->show_password_form(_('Password and confirmation do not match.'));
+            // TRANS: Reset password form validation error message.
+            $this->showPasswordForm(_('Password and confirmation do not match.'));
             return;
         }
 
@@ -310,22 +414,26 @@ class RecoverpasswordAction extends Action {
 
         if (!$user->update($original)) {
             common_log_db_error($user, 'UPDATE', __FILE__);
-            common_server_error(_('Can\'t save new password.'));
+            // TRANS: Reset password form validation error message.
+            $this->serverError(_('Cannot save new password.'));
             return;
         }
 
-        $this->clear_temp_user();
+        $this->clearTempUser();
 
         if (!common_set_user($user->nickname)) {
-            common_server_error(_('Error setting user.'));
+            // TRANS: Server error displayed when something does wrong with the user object during password reset.
+            $this->serverError(_('Error setting user.'));
             return;
         }
 
         common_real_login(true);
 
-        common_show_header(_('Password saved.'));
-        common_element('p', null, _('New password successfully saved. ' .
-                                     'You are now logged in.'));
-        common_show_footer();
+        $this->mode = 'saved';
+        // TRANS: Success message for user after password reset.
+        $this->msg = _('New password successfully saved. ' .
+                       'You are now logged in.');
+        $this->success = true;
+        $this->showPage();
     }
 }