e7393b3cc7
Why: * Maintenance scripts in core have bolierplate code that is added before and after the class to allow directly running the maintenance script. * Running the maintenance script directly has been deprecated since 1.40, so this boilerplate code is only to support a now deprecated method of running maintenance scripts. * This code cannot also be marked as covered, due to PHPUnit not recognising code coverage for files. * Therefore, it is best to ignore this boilerplate code in code coverage reports as it cannot be marked as covered and also is for deprecated code. What: * Wrap the boilerplate code (requiring Maintenance.php and then later defining the maintenance script class and running if the maintenance script was called directly) with @codeCoverageIgnore comments. * Some files use a different boilerplate code, however, these should also be marked as ignored for coverage for the same reason that coverage is not properly reported for files. Bug: T371167 Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
102 lines
3.2 KiB
PHP
102 lines
3.2 KiB
PHP
<?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
|
|
*/
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
use MediaWiki\Parser\Sanitizer;
|
|
use MediaWiki\Password\PasswordFactory;
|
|
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:" );
|
|
$this->error( $status );
|
|
}
|
|
}
|
|
|
|
if ( $this->hasOption( 'email-password' ) ) {
|
|
$passReset = $this->getServiceContainer()->getPasswordReset();
|
|
$sysUser = User::newSystemUser( 'Maintenance script', [ 'steal' => true ] );
|
|
$status = $passReset->execute( $sysUser, $user->getName(), $email );
|
|
if ( !$status->isGood() ) {
|
|
$this->error( "Email couldn't be sent because:" );
|
|
$this->error( $status );
|
|
}
|
|
}
|
|
$this->output( "Done!\n" );
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = ResetUserEmail::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|