aboutsummaryrefslogtreecommitdiffstats
path: root/maintenance/changePassword.php
blob: 87b08c25cf4e891656a4561572b2bbfaf0379e88 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<?php
/**
 * Change the password of a given user
 *
 * Copyright © 2005, Ævar Arnfjörð Bjarmason
 *
 * 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
 * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
 * @ingroup Maintenance
 */

// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd

use MediaWiki\Maintenance\Maintenance;

/**
 * Maintenance script to change the password of a given user.
 *
 * @ingroup 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->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" );
		} else {
			$this->fatalError( $status );
		}
	}

	/**
	 * @param string $errorMsgNoPassword Error message to be displayed if neither --password or --stdin are set
	 * @param string $errorMsgBothPasswords Error message to be displayed if both --password and --stdin are set
	 *
	 * @since 1.44
	 *
	 * @return string The new password
	 */
	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