actions/recoverpassword.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('STATUSNET')) { exit(1); }
  21
  22 # You have 24 hours to claim your password
  23
  24 define(MAX_RECOVERY_TIME, 24 * 60 * 60);
  25
  26 class RecoverpasswordAction extends Action
  27 {
  28     var $mode = null;
  29     var $msg = null;
  30     var $success = null;
  31
  32     function handle($args)
  33     {
  34         parent::handle($args);
  35         if (common_logged_in()) {
  36             $this->clientError(_('You are already logged in!'));
  37             return;
  38         } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
  39             if ($this->arg('recover')) {
  40                 $this->recoverPassword();
  41             } else if ($this->arg('reset')) {
  42                 $this->resetPassword();
  43             } else {
  44                 $this->clientError(_('Unexpected form submission.'));
  45             }
  46         } else {
  47             if ($this->trimmed('code')) {
  48                 $this->checkCode();
  49             } else {
  50                 $this->showForm();
  51             }
  52         }
  53     }
  54
  55     function checkCode()
  56     {
  57
  58         $code = $this->trimmed('code');
  59         $confirm = Confirm_address::staticGet('code', $code);
  60
  61         if (!$confirm) {
  62             $this->clientError(_('No such recovery code.'));
  63             return;
  64         }
  65         if ($confirm->address_type != 'recover') {
  66             $this->clientError(_('Not a recovery code.'));
  67             return;
  68         }
  69
  70         $user = User::staticGet($confirm->user_id);
  71
  72         if (!$user) {
  73             $this->serverError(_('Recovery code for unknown user.'));
  74             return;
  75         }
  76
  77         $touched = strtotime($confirm->modified);
  78         $email = $confirm->address;
  79
  80         # Burn this code
  81
  82         $result = $confirm->delete();
  83
  84         if (!$result) {
  85             common_log_db_error($confirm, 'DELETE', __FILE__);
  86             $this->serverError(_('Error with confirmation code.'));
  87             return;
  88         }
  89
  90         # These should be reaped, but for now we just check mod time
  91         # Note: it's still deleted; let's avoid a second attempt!
  92
  93         if ((time() - $touched) > MAX_RECOVERY_TIME) {
  94             common_log(LOG_WARNING,
  95                        'Attempted redemption on recovery code ' .
  96                        'that is ' . $touched . ' seconds old. ');
  97             $this->clientError(_('This confirmation code is too old. ' .
  98                                    'Please start again.'));
  99             return;
 100         }
 101
 102         # If we used an outstanding confirmation to send the email,
 103         # it's been confirmed at this point.
 104
 105         if (!$user->email) {
 106             $orig = clone($user);
 107             $user->email = $email;
 108             $result = $user->updateKeys($orig);
 109             if (!$result) {
 110                 common_log_db_error($user, 'UPDATE', __FILE__);
 111                 $this->serverError(_('Could not update user with confirmed email address.'));
 112                 return;
 113             }
 114         }
 115
 116         # Success!
 117
 118         $this->setTempUser($user);
 119         $this->showPasswordForm();
 120     }
 121
 122     function setTempUser(&$user)
 123     {
 124         common_ensure_session();
 125         $_SESSION['tempuser'] = $user->id;
 126     }
 127
 128     function getTempUser()
 129     {
 130         common_ensure_session();
 131         $user_id = $_SESSION['tempuser'];
 132         if ($user_id) {
 133             $user = User::staticGet($user_id);
 134         }
 135         return $user;
 136     }
 137
 138     function clearTempUser()
 139     {
 140         common_ensure_session();
 141         unset($_SESSION['tempuser']);
 142     }
 143
 144     function showPageNotice()
 145     {
 146         if ($this->msg) {
 147             $this->element('div', ($this->success) ? 'success' : 'error', $this->msg);
 148         } else {
 149             $this->elementStart('div', 'instructions');
 150             if ($this->mode == 'recover') {
 151                 $this->element('p', null,
 152                                _('If you\'ve forgotten or lost your' .
 153                                  ' password, you can get a new one sent to' .
 154                                  ' the email address you have stored' .
 155                                  ' in your account.'));
 156             } else if ($this->mode == 'reset') {
 157                 $this->element('p', null,
 158                                _('You\'ve been identified. Enter a' .
 159                                  ' new password below. '));
 160             }
 161             $this->elementEnd('div');
 162         }
 163     }
 164
 165     function showForm($msg=null)
 166     {
 167         $this->msg = $msg;
 168         $this->mode = 'recover';
 169         $this->showPage();
 170     }
 171
 172     function showContent()
 173     {
 174         if ($this->mode == 'recover') {
 175             $this->showRecoverForm();
 176         } else if ($this->mode == 'reset') {
 177             $this->showResetForm();
 178         }
 179     }
 180
 181     function showRecoverForm()
 182     {
 183         $this->elementStart('form', array('method' => 'post',
 184                                            'id' => 'form_password_recover',
 185                                            'class' => 'form_settings',
 186                                            'action' => common_local_url('recoverpassword')));
 187         $this->elementStart('fieldset');
 188         $this->element('legend', null, _('Password recover'));
 189         $this->elementStart('ul', 'form_data');
 190         $this->elementStart('li');
 191         $this->input('nicknameoremail', _('Nickname or email'),
 192                      $this->trimmed('nicknameoremail'),
 193                      _('Your nickname on this server, ' .
 194                         'or your registered email address.'));
 195         $this->elementEnd('li');
 196         $this->elementEnd('ul');
 197         $this->element('input', array('name' => 'recover',
 198                                       'type' => 'hidden',
 199                                       'value' => _('Recover')));
 200         $this->submit('recover', _('Recover'));
 201         $this->elementEnd('fieldset');
 202         $this->elementEnd('form');
 203     }
 204
 205     function title()
 206     {
 207         switch ($this->mode) {
 208          case 'reset': return _('Reset password');
 209          case 'recover': return _('Recover password');
 210          case 'sent': return _('Password recovery requested');
 211          case 'saved': return _('Password saved.');
 212          default:
 213             return _('Unknown action');
 214         }
 215     }
 216
 217     function showPasswordForm($msg=null)
 218     {
 219         $this->msg = $msg;
 220         $this->mode = 'reset';
 221         $this->showPage();
 222     }
 223
 224     function showResetForm()
 225     {
 226         $this->elementStart('form', array('method' => 'post',
 227                                            'id' => 'form_password_change',
 228                                            'class' => 'form_settings',
 229                                            'action' => common_local_url('recoverpassword')));
 230         $this->elementStart('fieldset');
 231         $this->element('legend', null, _('Password change'));
 232         $this->hidden('token', common_session_token());
 233         $this->elementStart('ul', 'form_data');
 234         $this->elementStart('li');
 235         $this->password('newpassword', _('New password'),
 236                         _('6 or more characters, and don\'t forget it!'));
 237         $this->elementEnd('li');
 238         $this->elementStart('li');
 239         $this->password('confirm', _('Confirm'),
 240                         _('Same as password above'));
 241         $this->elementEnd('li');
 242         $this->elementEnd('ul');
 243         $this->submit('reset', _('Reset'));
 244         $this->elementEnd('fieldset');
 245         $this->elementEnd('form');
 246     }
 247
 248     function recoverPassword()
 249     {
 250         $nore = $this->trimmed('nicknameoremail');
 251         if (!$nore) {
 252             $this->showForm(_('Enter a nickname or email address.'));
 253             return;
 254         }
 255
 256         $user = User::staticGet('email', common_canonical_email($nore));
 257
 258         if (!$user) {
 259             $user = User::staticGet('nickname', common_canonical_nickname($nore));
 260         }
 261
 262         # See if it's an unconfirmed email address
 263
 264         if (!$user) {
 265             $confirm_email = Confirm_address::staticGet('address', common_canonical_email($nore));
 266             if ($confirm_email && $confirm_email->address_type == 'email') {
 267                 $user = User::staticGet($confirm_email->user_id);
 268             }
 269         }
 270
 271         if (!$user) {
 272             $this->showForm(_('No user with that email address or username.'));
 273             return;
 274         }
 275
 276         # Try to get an unconfirmed email address if they used a user name
 277
 278         if (!$user->email && !$confirm_email) {
 279             $confirm_email = Confirm_address::staticGet('user_id', $user->id);
 280             if ($confirm_email && $confirm_email->address_type != 'email') {
 281                 # Skip non-email confirmations
 282                 $confirm_email = null;
 283             }
 284         }
 285
 286         if (!$user->email && !$confirm_email) {
 287             $this->clientError(_('No registered email address for that user.'));
 288             return;
 289         }
 290
 291         # Success! We have a valid user and a confirmed or unconfirmed email address
 292
 293         $confirm = new Confirm_address();
 294         $confirm->code = common_confirmation_code(128);
 295         $confirm->address_type = 'recover';
 296         $confirm->user_id = $user->id;
 297         $confirm->address = (isset($user->email)) ? $user->email : $confirm_email->address;
 298
 299         if (!$confirm->insert()) {
 300             common_log_db_error($confirm, 'INSERT', __FILE__);
 301             $this->serverError(_('Error saving address confirmation.'));
 302             return;
 303         }
 304
 305         $body = "Hey, $user->nickname.";
 306         $body .= "\n\n";
 307         $body .= 'Someone just asked for a new password ' .
 308                  'for this account on ' . common_config('site', 'name') . '.';
 309         $body .= "\n\n";
 310         $body .= 'If it was you, and you want to confirm, use the URL below:';
 311         $body .= "\n\n";
 312         $body .= "\t".common_local_url('recoverpassword',
 313                                    array('code' => $confirm->code));
 314         $body .= "\n\n";
 315         $body .= 'If not, just ignore this message.';
 316         $body .= "\n\n";
 317         $body .= 'Thanks for your time, ';
 318         $body .= "\n";
 319         $body .= common_config('site', 'name');
 320         $body .= "\n";
 321
 322         mail_to_user($user, _('Password recovery requested'), $body, $confirm->address);
 323
 324         $this->mode = 'sent';
 325         $this->msg = _('Instructions for recovering your password ' .
 326                           'have been sent to the email address registered to your ' .
 327                           'account.');
 328         $this->success = true;
 329         $this->showPage();
 330     }
 331
 332     function resetPassword()
 333     {
 334         # CSRF protection
 335         $token = $this->trimmed('token');
 336         if (!$token || $token != common_session_token()) {
 337             $this->showForm(_('There was a problem with your session token. Try again, please.'));
 338             return;
 339         }
 340
 341         $user = $this->getTempUser();
 342
 343         if (!$user) {
 344             $this->clientError(_('Unexpected password reset.'));
 345             return;
 346         }
 347
 348         $newpassword = $this->trimmed('newpassword');
 349         $confirm = $this->trimmed('confirm');
 350
 351         if (!$newpassword || strlen($newpassword) < 6) {
 352             $this->showPasswordForm(_('Password must be 6 chars or more.'));
 353             return;
 354         }
 355         if ($newpassword != $confirm) {
 356             $this->showPasswordForm(_('Password and confirmation do not match.'));
 357             return;
 358         }
 359
 360         # OK, we're ready to go
 361
 362         $original = clone($user);
 363
 364         $user->password = common_munge_password($newpassword, $user->id);
 365
 366         if (!$user->update($original)) {
 367             common_log_db_error($user, 'UPDATE', __FILE__);
 368             $this->serverError(_('Can\'t save new password.'));
 369             return;
 370         }
 371
 372         $this->clearTempUser();
 373
 374         if (!common_set_user($user->nickname)) {
 375             $this->serverError(_('Error setting user.'));
 376             return;
 377         }
 378
 379         common_real_login(true);
 380
 381         $this->mode = 'saved';
 382         $this->msg = _('New password successfully saved. ' .
 383                        'You are now logged in.');
 384         $this->success = true;
 385         $this->showPage();
 386     }
 387 }