createAndPromote.php

Go to the documentation of this file.

<?php
require_once __DIR__ . '/Maintenance.php';

class CreateAndPromote extends Maintenance {
    private static $permitRoles = [ 'sysop', 'bureaucrat', 'interface-admin', 'bot' ];

    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Create a new user account and/or grant it additional rights' );
        $this->addOption(
            'force',
            'If acccount exists already, just grant it rights or change password.'
        );
        foreach ( self::$permitRoles as $role ) {
            $this->addOption( $role, "Add the account to the {$role} group" );
        }

        $this->addOption(
            'custom-groups',
            'Comma-separated list of groups to add the user to',
            false,
            true
        );

        $this->addArg( "username", "Username of new user" );
        $this->addArg( "password", "Password to set (not required if --force is used)", false );
    }

    public function execute() {
        $username = $this->getArg( 0 );
        $password = $this->getArg( 1 );
        $force = $this->hasOption( 'force' );
        $inGroups = [];

        $user = User::newFromName( $username );
        if ( !is_object( $user ) ) {
            $this->fatalError( "invalid username." );
        }

        $exists = ( $user->idForName() !== 0 );

        if ( $exists && !$force ) {
            $this->fatalError( "Account exists. Perhaps you want the --force option?" );
        } elseif ( !$exists && !$password ) {
            $this->error( "Argument <password> required!" );
            $this->maybeHelp( true );
        } elseif ( $exists ) {
            $inGroups = $user->getGroups();
        }

        $groups = array_filter( self::$permitRoles, [ $this, 'hasOption' ] );
        if ( $this->hasOption( 'custom-groups' ) ) {
            $allGroups = array_flip( User::getAllGroups() );
            $customGroupsText = $this->getOption( 'custom-groups' );
            if ( $customGroupsText !== '' ) {
                $customGroups = explode( ',', $customGroupsText );
                foreach ( $customGroups as $customGroup ) {
                    if ( isset( $allGroups[$customGroup] ) ) {
                        $groups[] = trim( $customGroup );
                    } else {
                        $this->output( "$customGroup is not a valid group, ignoring!\n" );
                    }
                }
            }
        }

        $promotions = array_diff(
            $groups,
            $inGroups
        );

        if ( $exists && !$password && count( $promotions ) === 0 ) {
            $this->output( "Account exists and nothing to do.\n" );

            return;
        } elseif ( count( $promotions ) !== 0 ) {
            $dbDomain = WikiMap::getCurrentWikiDbDomain()->getId();
            $promoText = "User:{$username} into " . implode( ', ', $promotions ) . "...\n";
            if ( $exists ) {
                $this->output( "$dbDomain: Promoting $promoText" );
            } else {
                $this->output( "$dbDomain: Creating and promoting $promoText" );
            }
        }

        if ( !$exists ) {
            // Create the user via AuthManager as there may be various side
            // effects that are performed by the configured AuthManager chain.
            $status = MediaWiki\Auth\AuthManager::singleton()->autoCreateUser(
                $user,
                MediaWiki\Auth\AuthManager::AUTOCREATE_SOURCE_MAINT,
                false
            );
            if ( !$status->isGood() ) {
                $this->fatalError( $status->getWikiText( null, null, 'en' ) );
            }
        }

        if ( $password ) {
            # Try to set the password
            try {
                $status = $user->changeAuthenticationData( [
                    'username' => $user->getName(),
                    'password' => $password,
                    'retype' => $password,
                ] );
                if ( !$status->isGood() ) {
                    throw new PasswordError( $status->getWikiText( null, null, 'en' ) );
                }
                if ( $exists ) {
                    $this->output( "Password set.\n" );
                    $user->saveSettings();
                }
            } catch ( PasswordError $pwe ) {
                $this->fatalError( $pwe->getText() );
            }
        }

        # Promote user
        array_map( [ $user, 'addGroup' ], $promotions );

        if ( !$exists ) {
            # Increment site_stats.ss_users
            $ssu = SiteStatsUpdate::factory( [ 'users' => 1 ] );
            $ssu->doUpdate();
        }

        $this->output( "done.\n" );
    }
}

$maintClass = CreateAndPromote::class;
require_once RUN_MAINTENANCE_IF_MAIN;