includes/deferred/SendPasswordResetEmailUpdate.php

   1 <?php
   2 /**
   3  * Send an email to reset the password
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 use MediaWiki\Auth\AuthManager;
  24 use MediaWiki\Logger\LoggerFactory;
  25
  26 /**
  27  * Sends emails to all accounts associated with that email to reset the password
  28  * @since 1.35
  29  */
  30 class SendPasswordResetEmailUpdate implements DeferrableUpdate {
  31         /** @var AuthManager */
  32         private $authManager;
  33
  34         /** @var array */
  35         private $reqs;
  36
  37         /** @var array */
  38         private $logContext;
  39
  40         /**
  41          * @param AuthManager $authManager
  42          * @param array $reqs
  43          * @param array $logContext
  44          */
  45         public function __construct( AuthManager $authManager, array $reqs, array $logContext ) {
  46                 $this->authManager = $authManager;
  47                 $this->reqs = $reqs;
  48                 $this->logContext = $logContext;
  49         }
  50
  51         public function doUpdate() {
  52                 $logger = LoggerFactory::getInstance( 'authentication' );
  53                 foreach ( $this->reqs as $req ) {
  54                         // This is adding a new temporary password, not intentionally changing anything
  55                         // (even though it might technically invalidate an old temporary password).
  56                         $this->authManager->changeAuthenticationData( $req, /* $isAddition */ true );
  57                         $logger->info(
  58                                 "{requestingUser} did password reset of {targetUser} and an email was sent",
  59                                 $this->logContext + [ 'targetUser' => $req->username ]
  60                         );
  61                 }
  62         }
  63
  64 }