changePassword.php

Go to the documentation of this file.

<?php
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
 
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Maintenance\Maintenance;
 
class ChangePassword extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addOption( "user", "The username to operate on", false, true );
        $this->addOption( "userid", "The user id to operate on", false, true );
        $this->addOption( "password", "The password to use", false, true );
        // phpcs:ignore Generic.Files.LineLength.TooLong
        $this->addOption( "passwordstdin", "Makes the script read the password from stdin instead. Cannot be used alongside --password", false, false );
        $this->addOption( 'reason', 'Reason for the password change (ticket number etc)', false, true );
        $this->addDescription( "Change a user's password" );
    }
 
    public function execute() {
        $user = $this->validateUserOption( "A \"user\" or \"userid\" must be set to change the password for" );
        // phpcs:ignore Generic.Files.LineLength.TooLong
        $password = $this->validatePasswordOption( 'Set either --password or --passwordstdin', 'Either --password or --passwordstdin must be set, not both at once' );
        $status = $user->changeAuthenticationData( [
            'username' => $user->getName(),
            'password' => $password,
            'retype' => $password,
        ] );
        if ( $status->isGood() ) {
            $this->output( "Password set for " . $user->getName() . "\n" );
 
            LoggerFactory::getInstance( 'authentication' )->info(
                'Password for {user} changed via changePassword.php', [
                    'user' => $user->getName(),
                    'reason' => $this->getOption( 'reason', '' ),
                ]
            );
 
            $invalidator = $this->createChild( InvalidateUserSessions::class );
            $invalidator->setOption( 'user', $user->getName() );
            $invalidator->execute();
        } else {
            $this->fatalError( $status );
        }
    }
 
    private function validatePasswordOption( $errorMsgNoPassword, $errorMsgBothPasswords ) {
        if ( $this->hasOption( 'password' ) && $this->hasOption( 'passwordstdin' ) ) {
            $this->fatalError( $errorMsgBothPasswords );
        }
        if ( $this->hasOption( 'password' ) ) {
            return $this->getOption( 'password' );
        } elseif ( $this->hasOption( 'passwordstdin' ) ) {
            return $this->getStdin( Maintenance::STDIN_ALL );
        } else {
            $this->fatalError( $errorMsgNoPassword );
        }
    }
}
 
// @codeCoverageIgnoreStart
$maintClass = ChangePassword::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd