X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Frecoverpassword.php;h=71f673bd3bd659cb0826efbe0fca0f0924ade9ea;hb=20ca5027ccb30f094bc87189ef19ecdb59156137;hp=3d839e7514d6c45e154da5ef2035dc5378a032f6;hpb=4b9df58c90e25ea79aeec64c6e96f828fe06d7df;p=quix0rs-gnu-social.git diff --git a/actions/recoverpassword.php b/actions/recoverpassword.php index 3d839e7514..71f673bd3b 100644 --- a/actions/recoverpassword.php +++ b/actions/recoverpassword.php @@ -1,7 +1,7 @@ . */ -if (!defined('LACONICA')) { exit(1); } +if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } -# You have 24 hours to claim your password +// 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 { + var $mode = null; + var $msg = null; + var $success = null; function handle($args) { parent::handle($args); if (common_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 { + // 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) { + // TRANS: Client error displayed when password recovery code is not correct. $this->clientError(_('No such recovery code.')); return; } if ($confirm->address_type != 'recover') { + // TRANS: Client error displayed when no proper password recovery code was submitted. $this->clientError(_('Not a recovery code.')); return; } @@ -67,6 +73,7 @@ class RecoverpasswordAction extends Action $user = User::staticGet($confirm->user_id); if (!$user) { + // TRANS: Server error displayed trying to recover password without providing a user. $this->serverError(_('Recovery code for unknown user.')); return; } @@ -74,30 +81,32 @@ class RecoverpasswordAction extends Action $touched = strtotime($confirm->modified); $email = $confirm->address; - # Burn this code + // Burn this code $result = $confirm->delete(); if (!$result) { common_log_db_error($confirm, 'DELETE', __FILE__); + // TRANS: Server error displayed removing a password recovery code from the database. $this->serverError(_('Error with confirmation code.')); return; } - # These should be reaped, but for now we just check mod time - # Note: it's still deleted; let's avoid a second attempt! + // These should be reaped, but for now we just check mod time + // 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. '); + // 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; } - # If we used an outstanding confirmation to send the email, - # it's been confirmed at this point. + // If we used an outstanding confirmation to send the email, + // it's been confirmed at this point. if (!$user->email) { $orig = clone($user); @@ -105,24 +114,25 @@ class RecoverpasswordAction extends Action $result = $user->updateKeys($orig); if (!$result) { common_log_db_error($user, 'UPDATE', __FILE__); + // 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! + // 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']; @@ -132,132 +142,212 @@ class RecoverpasswordAction extends Action return $user; } - function clear_temp_user() + function clearTempUser() { common_ensure_session(); unset($_SESSION['tempuser']); } - function show_top($msg=null) + function showPageNotice() { - if ($msg) { - $this->element('div', 'error', $msg); + if ($this->msg) { + $this->element('div', ($this->success) ? 'success' : 'error', $this->msg); } else { $this->elementStart('div', 'instructions'); - $this->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.')); + 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') { + $this->element('p', null, + // TRANS: Page notice for password change page. + _('You have been identified. Enter a' . + ' new password below.')); + } $this->elementEnd('div'); } } - function show_password_top($msg=null) + function showForm($msg=null) { - if ($msg) { - $this->element('div', 'error', $msg); - } else { - $this->element('div', 'instructions', - _('You\'ve been identified. Enter a ' . - ' new password below. ')); - } + $this->msg = $msg; + $this->mode = 'recover'; + $this->showPage(); } - function show_form($msg=null) + function showContent() { + if ($this->mode == 'recover') { + $this->showRecoverForm(); + } else if ($this->mode == 'reset') { + $this->showResetForm(); + } + } - common_show_header(_('Recover password'), null, - $msg, array($this, 'show_top')); - + function showRecoverForm() + { $this->elementStart('form', array('method' => 'post', - 'id' => 'recoverpassword', + 'id' => 'form_password_recover', + 'class' => 'form_settings', 'action' => common_local_url('recoverpassword'))); - $this->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.')); - $this->submit('recover', _('Recover')); + $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'); - common_show_footer(); } - 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(); + } + function showResetForm() + { $this->elementStart('form', array('method' => 'post', - 'id' => 'recoverpassword', + 'id' => 'form_password_change', + 'class' => 'form_settings', 'action' => common_local_url('recoverpassword'))); + $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'), - _('6 or more characters, and don\'t forget it!')); + // 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'), - _('Same as password above')); - $this->submit('reset', _('Reset')); + // 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'); - common_show_footer(); } - 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; } $user = User::staticGet('email', common_canonical_email($nore)); if (!$user) { - $user = User::staticGet('nickname', common_canonical_nickname($nore)); + try { + $user = User::staticGet('nickname', common_canonical_nickname($nore)); + } catch (NicknameException $e) { + // invalid + } } - # See if it's an unconfirmed email address + // 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 + // 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) { + // 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; } - # Success! We have a valid user and a confirmed or unconfirmed email address + // Success! We have a valid user and a confirmed or unconfirmed email address $confirm = new Confirm_address(); $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__); + // 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 ' . @@ -275,29 +365,33 @@ 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')); - $this->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 + // 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) { + // TRANS: Client error displayed when trying to reset as password without providing a user. $this->clientError(_('Unexpected password reset.')); return; } @@ -306,15 +400,17 @@ 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; } - # OK, we're ready to go + // OK, we're ready to go $original = clone($user); @@ -322,22 +418,26 @@ class RecoverpasswordAction extends Action if (!$user->update($original)) { common_log_db_error($user, 'UPDATE', __FILE__); - $this->serverError(_('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)) { + // 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.')); - $this->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(); } }