gnu-social/actions/recoverpassword.php

444 lines
16 KiB
PHP
Raw Normal View History

<?php
/*
2009-08-25 23:14:12 +01:00
* 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
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
# You have 24 hours to claim your password
2010-03-03 00:07:35 +00:00
define('MAX_RECOVERY_TIME', 24 * 60 * 60);
class RecoverpasswordAction extends Action
{
2009-01-23 00:00:01 +00:00
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')) {
2009-01-23 00:00:01 +00:00
$this->recoverPassword();
} else if ($this->arg('reset')) {
2009-01-23 00:00:01 +00:00
$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')) {
2009-01-23 00:00:01 +00:00
$this->checkCode();
} else {
2009-01-23 00:00:01 +00:00
$this->showForm();
}
}
}
2009-01-23 00:00:01 +00:00
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;
}
$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;
}
$touched = strtotime($confirm->modified);
$email = $confirm->address;
# 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!
if ((time() - $touched) > MAX_RECOVERY_TIME) {
2009-01-23 00:00:01 +00:00
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 (!$user->email) {
$orig = clone($user);
$user->email = $email;
$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!
2009-01-23 00:00:01 +00:00
$this->setTempUser($user);
$this->showPasswordForm();
}
2009-01-23 00:00:01 +00:00
function setTempUser(&$user)
{
common_ensure_session();
$_SESSION['tempuser'] = $user->id;
}
2009-01-23 00:00:01 +00:00
function getTempUser()
{
common_ensure_session();
$user_id = $_SESSION['tempuser'];
if ($user_id) {
$user = User::staticGet($user_id);
}
return $user;
}
2009-01-23 00:00:01 +00:00
function clearTempUser()
{
common_ensure_session();
unset($_SESSION['tempuser']);
}
2009-01-23 00:00:01 +00:00
function showPageNotice()
{
2009-01-23 00:00:01 +00:00
if ($this->msg) {
$this->element('div', ($this->success) ? 'success' : 'error', $this->msg);
} else {
$this->elementStart('div', 'instructions');
2009-01-23 00:00:01 +00:00
if ($this->mode == 'recover') {
$this->element('p', null,
// TRANS: Page notice for password recovery page.
2009-11-08 21:45:18 +00:00
_('If you have forgotten or lost your' .
2009-01-23 00:00:01 +00:00
' password, you can get a new one sent to' .
2009-05-01 12:12:13 +01:00
' the email address you have stored' .
2009-01-23 00:00:01 +00:00
' in your account.'));
} else if ($this->mode == 'reset') {
$this->element('p', null,
// TRANS: Page notice for password change page.
2009-11-08 21:45:18 +00:00
_('You have been identified. Enter a' .
' new password below.'));
2009-01-23 00:00:01 +00:00
}
$this->elementEnd('div');
}
}
2009-01-23 00:00:01 +00:00
function showForm($msg=null)
{
2009-01-23 00:00:01 +00:00
$this->msg = $msg;
$this->mode = 'recover';
$this->showPage();
}
2009-01-23 00:00:01 +00:00
function showContent()
{
2009-01-23 00:00:01 +00:00
if ($this->mode == 'recover') {
$this->showRecoverForm();
} else if ($this->mode == 'reset') {
$this->showResetForm();
}
}
2009-01-23 00:00:01 +00:00
function showRecoverForm()
{
$this->elementStart('form', array('method' => 'post',
'id' => 'form_password_recover',
'class' => 'form_settings',
'action' => common_local_url('recoverpassword')));
$this->elementStart('fieldset');
// TRANS: Fieldset legend for password recovery page.
2009-11-08 21:45:18 +00:00
$this->element('legend', null, _('Password recovery'));
$this->elementStart('ul', 'form_data');
$this->elementStart('li');
// TRANS: Field label on password recovery page.
2009-11-08 21:45:18 +00:00
$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->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');
}
2009-01-23 00:00:01 +00:00
function title()
{
2009-01-23 00:00:01 +00:00
switch ($this->mode) {
// TRANS: Title for password recovery page in password reset mode.
2009-01-23 00:00:01 +00:00
case 'reset': return _('Reset password');
// TRANS: Title for password recovery page in password recover mode.
2009-01-23 00:00:01 +00:00
case 'recover': return _('Recover password');
// TRANS: Title for password recovery page in email sent mode.
2009-01-23 00:00:01 +00:00
case 'sent': return _('Password recovery requested');
// TRANS: Title for password recovery page in password saved mode.
case 'saved': return _('Password saved');
2009-01-23 00:00:01 +00:00
default:
// TRANS: Title for password recovery page when an unknown action has been specified.
2009-01-23 00:00:01 +00:00
return _('Unknown action');
}
}
2009-01-23 00:00:01 +00:00
function showPasswordForm($msg=null)
{
$this->msg = $msg;
$this->mode = 'reset';
$this->showPage();
}
2009-01-23 00:00:01 +00:00
function showResetForm()
{
$this->elementStart('form', array('method' => 'post',
'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'),
// 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');
}
2009-01-23 00:00:01 +00:00
function recoverPassword()
{
$nore = $this->trimmed('nicknameoremail');
if (!$nore) {
// TRANS: Form instructions for password recovery form.
2009-01-23 00:00:01 +00:00
$this->showForm(_('Enter a nickname or email address.'));
return;
}
$user = User::staticGet('email', common_canonical_email($nore));
if (!$user) {
try {
$user = User::staticGet('nickname', common_canonical_nickname($nore));
} catch (NicknameException $e) {
// invalid
}
}
# See if it's an unconfirmed email address
if (!$user) {
// 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) {
// TRANS: Information on password recovery form if no known username or e-mail address was specified.
2009-01-23 00:00:01 +00:00
$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 = 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
$confirm = new Confirm_address();
$confirm->code = common_confirmation_code(128);
$confirm->address_type = 'recover';
$confirm->user_id = $user->id;
$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 ' .
'for this account on ' . common_config('site', 'name') . '.';
$body .= "\n\n";
$body .= 'If it was you, and you want to confirm, use the URL below:';
$body .= "\n\n";
$body .= "\t".common_local_url('recoverpassword',
array('code' => $confirm->code));
$body .= "\n\n";
$body .= 'If not, just ignore this message.';
$body .= "\n\n";
$body .= 'Thanks for your time, ';
$body .= "\n";
$body .= common_config('site', 'name');
$body .= "\n";
$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);
2009-01-23 00:00:01 +00:00
$this->mode = 'sent';
// TRANS: User notification after an e-mail with instructions was sent from the password recovery form.
2009-01-23 00:00:01 +00:00
$this->msg = _('Instructions for recovering your password ' .
'have been sent to the email address registered to your ' .
2009-01-23 00:00:01 +00:00
'account.');
$this->success = true;
$this->showPage();
}
2009-01-23 00:00:01 +00:00
function resetPassword()
{
# CSRF protection
$token = $this->trimmed('token');
if (!$token || $token != common_session_token()) {
// TRANS: Form validation error message.
2009-01-23 00:00:01 +00:00
$this->showForm(_('There was a problem with your session token. Try again, please.'));
return;
}
2009-01-23 00:00:01 +00:00
$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;
}
$newpassword = $this->trimmed('newpassword');
$confirm = $this->trimmed('confirm');
if (!$newpassword || strlen($newpassword) < 6) {
// TRANS: Reset password form validation error message.
$this->showPasswordForm(_('Password must be 6 characters or more.'));
return;
}
if ($newpassword != $confirm) {
// TRANS: Reset password form validation error message.
2009-01-23 00:00:01 +00:00
$this->showPasswordForm(_('Password and confirmation do not match.'));
return;
}
# OK, we're ready to go
$original = clone($user);
$user->password = common_munge_password($newpassword, $user->id);
if (!$user->update($original)) {
common_log_db_error($user, 'UPDATE', __FILE__);
// TRANS: Reset password form validation error message.
$this->serverError(_('Cannot save new password.'));
return;
}
2009-01-23 00:00:01 +00:00
$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);
2009-01-23 00:00:01 +00:00
$this->mode = 'saved';
// TRANS: Success message for user after password reset.
2009-01-23 00:00:01 +00:00
$this->msg = _('New password successfully saved. ' .
'You are now logged in.');
$this->success = true;
$this->showPage();
}
}