<?php
-
/**
- * Maintenance script to create an account and grant it administrator rights
+ * Creates an account and grants it rights.
+ *
+ * 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
* @author Rob Church <robchur@gmail.com>
+ * @author Pablo Castellano <pablo@anche.no>
*/
-$options = array( 'help', 'bureaucrat' );
-require_once( 'commandLine.inc' );
+require_once __DIR__ . '/Maintenance.php';
-if( isset( $options['help'] ) ) {
- showHelp();
- exit( 1 );
-}
+/**
+ * Maintenance script to create an account and grant it rights.
+ *
+ * @ingroup Maintenance
+ */
+class CreateAndPromote extends Maintenance {
+ private static $permitRoles = [ 'sysop', 'bureaucrat', 'bot' ];
-if( count( $args ) < 2 ) {
- echo( "Please provide a username and password for the new account.\n" );
- die( 1 );
-}
+ 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" );
+ }
-$username = $args[0];
-$password = $args[1];
+ $this->addOption(
+ 'custom-groups',
+ 'Comma-separated list of groups to add the user to',
+ false,
+ true
+ );
-echo( wfWikiID() . ": Creating and promoting User:{$username}..." );
+ $this->addArg( "username", "Username of new user" );
+ $this->addArg( "password", "Password to set (not required if --force is used)", false );
+ }
-# Validate username and check it doesn't exist
-$user = User::newFromName( $username );
-if( !is_object( $user ) ) {
- echo( "invalid username.\n" );
- die( 1 );
-} elseif( 0 != $user->idForName() ) {
- echo( "account exists.\n" );
- die( 1 );
-}
+ 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->error( "invalid username.", true );
+ }
+
+ $exists = ( 0 !== $user->idForName() );
-# Insert the account into the database
-$user->addToDatabase();
-$user->setPassword( $password );
-$user->saveSettings();
+ if ( $exists && !$force ) {
+ $this->error( "Account exists. Perhaps you want the --force option?", true );
+ } elseif ( !$exists && !$password ) {
+ $this->error( "Argument <password> required!", false );
+ $this->maybeHelp( true );
+ } elseif ( $exists ) {
+ $inGroups = $user->getGroups();
+ }
-# Promote user
-$user->addGroup( 'sysop' );
-if( isset( $option['bureaucrat'] ) )
- $user->addGroup( 'bureaucrat' );
+ $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" );
+ }
+ }
+ }
+ }
-# Increment site_stats.ss_users
-$ssu = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
-$ssu->doUpdate();
+ $promotions = array_diff(
+ $groups,
+ $inGroups
+ );
-echo( "done.\n" );
+ if ( $exists && !$password && count( $promotions ) === 0 ) {
+ $this->output( "Account exists and nothing to do.\n" );
-function showHelp() {
- echo( <<<EOT
-Create a new user account with administrator rights
+ return;
+ } elseif ( count( $promotions ) !== 0 ) {
+ $promoText = "User:{$username} into " . implode( ', ', $promotions ) . "...\n";
+ if ( $exists ) {
+ $this->output( wfWikiID() . ": Promoting $promoText" );
+ } else {
+ $this->output( wfWikiID() . ": Creating and promoting $promoText" );
+ }
+ }
-USAGE: php createAndPromote.php [--bureaucrat|--help] <username> <password>
+ if ( !$exists ) {
+ # Insert the account into the database
+ $user->addToDatabase();
+ $user->saveSettings();
+ }
- --bureaucrat
- Grant the account bureaucrat rights
- --help
- Show this help information
+ 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->error( $pwe->getText(), true );
+ }
+ }
+
+ # Promote user
+ array_map( [ $user, 'addGroup' ], $promotions );
+
+ if ( !$exists ) {
+ # Increment site_stats.ss_users
+ $ssu = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
+ $ssu->doUpdate();
+ }
+
+ $this->output( "done.\n" );
+ }
+}
-EOT
- );
-}
\ No newline at end of file
+$maintClass = "CreateAndPromote";
+require_once RUN_MAINTENANCE_IF_MAIN;
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff