26require_once __DIR__ .
'/Maintenance.php';
34 private static $permitRoles = [
'sysop',
'bureaucrat',
'interface-admin',
'bot' ];
37 parent::__construct();
38 $this->
addDescription(
'Create a new user account and/or grant it additional rights' );
41 'If acccount exists already, just grant it rights or change password.'
43 foreach ( self::$permitRoles as $role ) {
44 $this->
addOption( $role,
"Add the account to the {$role} group" );
49 'Comma-separated list of groups to add the user to',
54 $this->
addArg(
"username",
"Username of new user" );
55 $this->
addArg(
"password",
"Password to set (not required if --force is used)",
false );
59 $username = $this->
getArg( 0 );
60 $password = $this->
getArg( 1 );
65 if ( !is_object( $user ) ) {
69 $exists = ( $user->idForName() !== 0 );
71 if ( $exists && !$force ) {
72 $this->
fatalError(
"Account exists. Perhaps you want the --force option?" );
73 } elseif ( !$exists && !$password ) {
74 $this->
error(
"Argument <password> required!" );
76 } elseif ( $exists ) {
77 $inGroups = $user->getGroups();
80 $groups = array_filter( self::$permitRoles, [ $this,
'hasOption' ] );
81 if ( $this->
hasOption(
'custom-groups' ) ) {
83 $customGroupsText = $this->
getOption(
'custom-groups' );
84 if ( $customGroupsText !==
'' ) {
85 $customGroups = explode(
',', $customGroupsText );
86 foreach ( $customGroups as $customGroup ) {
87 if ( isset( $allGroups[$customGroup] ) ) {
88 $groups[] = trim( $customGroup );
90 $this->
output(
"$customGroup is not a valid group, ignoring!\n" );
96 $promotions = array_diff(
101 if ( $exists && !$password && count( $promotions ) === 0 ) {
102 $this->
output(
"Account exists and nothing to do.\n" );
105 } elseif ( count( $promotions ) !== 0 ) {
106 $dbDomain = WikiMap::getCurrentWikiDbDomain()->getId();
107 $promoText =
"User:{$username} into " . implode(
', ', $promotions ) .
"...\n";
109 $this->
output(
"$dbDomain: Promoting $promoText" );
111 $this->
output(
"$dbDomain: Creating and promoting $promoText" );
118 $status = MediaWiki\Auth\AuthManager::singleton()->autoCreateUser(
120 MediaWiki\Auth\AuthManager::AUTOCREATE_SOURCE_MAINT,
123 if ( !$status->isGood() ) {
124 $this->
fatalError( $status->getMessage(
false,
false,
'en' )->text() );
129 # Try to set the password
131 $status = $user->changeAuthenticationData( [
132 'username' => $user->getName(),
133 'password' => $password,
134 'retype' => $password,
136 if ( !$status->isGood() ) {
137 throw new PasswordError( $status->getMessage(
false,
false,
'en' )->text() );
140 $this->
output(
"Password set.\n" );
141 $user->saveSettings();
149 array_map( [ $user,
'addGroup' ], $promotions );
152 # Increment site_stats.ss_users
153 $ssu = SiteStatsUpdate::factory( [
'users' => 1 ] );
157 $this->
output(
"done.\n" );
const RUN_MAINTENANCE_IF_MAIN
getText()
Get the text to display when reporting the error on the command line.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
addArg( $arg, $description, $required=true)
Add some args that are needed.
output( $out, $channel=null)
Throw some output to the user.
hasOption( $name)
Checks to see if a particular option exists.
getArg( $argId=0, $default=null)
Get an argument.
addDescription( $text)
Set the description text.
maybeHelp( $force=false)
Maybe show the help.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Show an error when any operation involving passwords fails to run.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
static getAllGroups()
Return the set of defined explicit groups.