wikimedia/mediawiki-core

View on GitHub
maintenance/resetUserEmail.php

Summary

Maintainability
A
2 hrs
Test Coverage
<?php
/**
 * Reset user email.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup Maintenance
 */

require_once __DIR__ . '/Maintenance.php';

use MediaWiki\Parser\Sanitizer;
use MediaWiki\Status\Status;
use MediaWiki\User\User;

/**
 * Maintenance script that resets user email.
 *
 * @since 1.27
 * @ingroup Maintenance
 */
class ResetUserEmail extends Maintenance {
    public function __construct() {
        parent::__construct();

        $this->addDescription( "Resets a user's email" );

        $this->addArg( 'user', 'Username or user ID, if starts with #' );
        $this->addArg( 'email', 'Email to assign' );

        $this->addOption( 'no-reset-password', 'Don\'t reset the user\'s password' );
        $this->addOption( 'email-password', 'Send a temporary password to the user\'s new email address' );
    }

    public function execute() {
        $userName = $this->getArg( 0 );
        if ( preg_match( '/^#\d+$/', $userName ) ) {
            $user = User::newFromId( (int)substr( $userName, 1 ) );
        } else {
            $user = User::newFromName( $userName );
        }
        if ( !$user || !$user->isRegistered() || !$user->loadFromId() ) {
            $this->fatalError( "Error: user '$userName' does not exist\n" );
        }

        $email = $this->getArg( 1, '' );
        if ( $email !== '' && !Sanitizer::validateEmail( $email ) ) {
            $this->fatalError( "Error: email '$email' is not valid\n" );
        }

        // Code from https://wikitech.wikimedia.org/wiki/Password_reset
        $user->setEmail( $email );
        $user->setEmailAuthenticationTimestamp( wfTimestampNow() );
        $user->saveSettings();

        if ( !$this->hasOption( 'no-reset-password' ) ) {
            // Kick whomever is currently controlling the account off if possible
            $password = PasswordFactory::generateRandomPasswordString( 128 );
            $status = $user->changeAuthenticationData( [
                'username' => $user->getName(),
                'password' => $password,
                'retype' => $password,
            ] );
            if ( !$status->isGood() ) {
                $this->error( "Password couldn't be reset because:\n"
                    . $status->getMessage( false, false, 'en' )->text() );
            }
        }

        if ( $this->hasOption( 'email-password' ) ) {
            $passReset = $this->getServiceContainer()->getPasswordReset();
            $sysUser = User::newSystemUser( 'Maintenance script', [ 'steal' => true ] );
            $status = Status::wrap( $passReset->execute( $sysUser, $user->getName(), $email ) );
            if ( !$status->isGood() ) {
                $this->error( "Email couldn't be sent because:\n"
                    . $status->getMessage( false, false, 'en' )->text() );
            }
        }
        $this->output( "Done!\n" );
    }
}

$maintClass = ResetUserEmail::class;
require_once RUN_MAINTENANCE_IF_MAIN;