Page MenuHomeWickedGov Phorge
Files F5975570

attachAccount.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

attachAccount.php
View Options

<?php
/**
* @section LICENSE
* 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
*/
namespace MediaWiki\Extension\CentralAuth\Maintenance;
$IP = getenv( 'MW_INSTALL_PATH' );
if ( $IP === false ) {
$IP = __DIR__ . '/../../..';
}
require_once "$IP/maintenance/Maintenance.php";
use Exception;
use MediaWiki\Extension\CentralAuth\User\CentralAuthUser;
use MediaWiki\Maintenance\Maintenance;
use Wikimedia\Rdbms\IDBAccessObject;
/**
* @copyright © 2016 Wikimedia Foundation and contributors.
*/
class AttachAccount extends Maintenance {
/** @var float */
protected $start;
/** @var int */
protected $missing;
/** @var int */
protected $partial;
/** @var int */
protected $failed;
/** @var int */
protected $attached;
/** @var int */
protected $ok;
/** @var int */
protected $total;
/** @var bool */
protected $dryRun;
/** @var bool */
protected $quiet;
public function __construct() {
parent::__construct();
$this->requireExtension( 'CentralAuth' );
$this->addDescription( 'Attaches the specified usernames to a global account' );
$this->start = microtime( true );
$this->missing = 0;
$this->partial = 0;
$this->failed = 0;
$this->attached = 0;
$this->ok = 0;
$this->total = 0;
$this->dryRun = false;
$this->quiet = false;
$this->addOption( 'userlist',
'File with the list of usernames to attach, one per line', true, true );
$this->addOption( 'dry-run', 'Do not update database' );
$this->addOption( 'quiet',
'Only report database changes and final statistics' );
$this->setBatchSize( 1000 );
}
public function execute() {
$this->dryRun = $this->hasOption( 'dry-run' );
$this->quiet = $this->hasOption( 'quiet' );
$list = $this->getOption( 'userlist' );
if ( !is_file( $list ) ) {
$this->fatalError( "ERROR - File not found: {$list}" );
}
$file = fopen( $list, 'r' );
if ( $file === false ) {
$this->fatalError( "ERROR - Could not open file: {$list}" );
}
// phpcs:ignore Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
while ( strlen( $username = trim( fgets( $file ) ) ) ) {
$this->attach( $username );
if ( $this->total % $this->mBatchSize == 0 ) {
$this->output( "Waiting for replicas to catch up ... " );
$this->waitForReplication();
$this->output( "done\n" );
}
}
fclose( $file );
$this->report();
$this->output( "done.\n" );
}
/**
* @param string $username
*/
protected function attach( $username ) {
$this->total++;
if ( !$this->quiet ) {
$this->output( "CentralAuth account attach for: {$username}\n" );
}
$central = new CentralAuthUser(
$username, IDBAccessObject::READ_LATEST );
if ( !$central->exists() ) {
$this->missing++;
$this->output( "ERROR: No CA account found for: {$username}\n" );
return;
}
try {
$unattached = $central->listUnattached();
} catch ( Exception $e ) {
// This might happen due to localnames inconsistencies (T69350)
$this->missing++;
$this->output(
"ERROR: Fetching unattached accounts for {$username} failed.\n"
);
return;
}
if ( count( $unattached ) === 0 ) {
$this->ok++;
if ( !$this->quiet ) {
$this->output( "OK: {$username}\n" );
}
return;
}
foreach ( $unattached as $wikiID ) {
$this->output( "ATTACHING: {$username}@{$wikiID}\n" );
if ( !$this->dryRun ) {
$central->attach(
$wikiID,
'login',
false
);
}
}
if ( $this->dryRun ) {
// Don't recheck if we aren't changing the db
return;
}
$unattachedAfter = $central->listUnattached();
$numUnattached = count( $unattachedAfter );
if ( $numUnattached === 0 ) {
$this->attached++;
} elseif ( $numUnattached == count( $unattached ) ) {
$this->failed++;
$this->output(
"WARN: No accounts attached for {$username}; " .
"({$numUnattached} unattached)\n" );
} else {
$this->partial++;
$this->output(
"INFO: Incomplete attachment for {$username}; " .
"({$numUnattached} unattached)\n" );
}
}
/**
* @param int|float $val
*
* @return float|int
*/
protected function reportPcnt( $val ) {
if ( $this->total > 0 ) {
return $val / $this->total * 100.0;
}
return 0;
}
protected function report() {
$delta = microtime( true ) - $this->start;
$format = '[%s]' .
' processed: %d (%.1f/sec);' .
' ok: %d (%.1f%%);' .
' attached: %d (%.1f%%);' .
' partial: %d (%.1f%%);' .
' failed: %d (%.1f%%);' .
' missing: %d (%.1f%%);' .
"\n";
$this->output( sprintf( $format,
wfTimestamp( TS_DB ),
$this->total, $this->total / $delta,
$this->ok, $this->reportPcnt( $this->ok ),
$this->attached, $this->reportPcnt( $this->attached ),
$this->partial, $this->reportPcnt( $this->partial ),
$this->failed, $this->reportPcnt( $this->failed ),
$this->missing, $this->reportPcnt( $this->missing )
) );
}
}
$maintClass = AttachAccount::class;
require_once RUN_MAINTENANCE_IF_MAIN;

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 18:21 (1 h, 34 m ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
68/73/133782a83b6bbdb2c4d57b40ad65
Default Alt Text
attachAccount.php (5 KB)

Event Timeline