User:Justarandomamerican/globalUserLock.js: Difference between revisions

const TOOL_ID      = 'global-user-lock-tool';

const TOOL_TITLE  = 'Global User Lock Tool';

const API_ENDPOINT = mw.config.get( 'wgScriptPath' ) + '/api.php';

// Maximum accounts to process in a single run (safety cap)

const MAX_ACCOUNTS = 200;

// ── Styles ─────────────────────────────────────────────────────────────────

 

mw.util.addCSS( `

#${ TOOL_ID } {

font-family: inherit;

margin: 1.5em auto;

background: #f8f9fa;

#${ TOOL_ID } .gul-header {

#${ TOOL_ID } .gul-results-table th,

#${ TOOL_ID } .gul-summary {

font-size: 0.9em;

` );

function buildUI() {

const $container = $( '<div>' ).attr( 'id', TOOL_ID );

// Header

$container.append( `

<div class="gul-header">

<svg width="18" height="18" viewBox="0 0 20 20" fill="currentColor">

<path d="M10 2a4 4 0 0 1 4 4v1h1a2 2 0 0 1 2 2v7a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V9a2 2 0 0 1 2-2h1V6a4 4 0 0 1 4-4zm0 9a1.5 1.5 0 1 0 0 3 1.5 1.5 0 0 0 0-3zm0-7a2 2 0 0 0-2 2v1h4V6a2 2 0 0 0-2-2z"/>

</svg>

${ TOOL_TITLE }

</div>

` );

const $body = $( '<div>' ).addClass( 'gul-body' );

// ── Search fieldset

const $searchFs = $( '<fieldset>' ).append( '<legend>Search Parameters</legend>' );

$searchFs.append( `

<label for="gul-query">Username contains (substring match, case-insensitive):</label>

<input type="text" id="gul-query" placeholder="e.g. spambot, vandal2024" autocomplete="off" />

` );

$searchFs.append( `

<label style="margin-top:10px;" for="gul-from">

Start from username (optional, for pagination):

</label>

<input type="text" id="gul-from" placeholder="Leave blank to start from beginning" autocomplete="off" />

` );

$body.append( $searchFs );

// ── Lock options fieldset

const $lockFs = $( '<fieldset>' ).append( '<legend>Lock Options</legend>' );

$lockFs.append( `

<label for="gul-reason">Lock reason (will appear in CentralAuth log):</label>

<textarea id="gul-reason" rows="2" placeholder="e.g. Cross-wiki spam; username policy violation"></textarea>

` );

$lockFs.append( `

<input type="checkbox" id="gul-hide" />

<label for="gul-hide" style="margin:0;">Hide username (sets <code>hidden</code> flag — requires suppressor right)</label>

</div>

<div class="gul-checkbox-row">

<label for="gul-suppress" style="margin:0;">Suppress username (sets <code>suppressed</code> flag — requires suppressor right)</label>

<div class="gul-checkbox-row">

` );

$body.append( $lockFs );

const $actions = $( '<div>' ).addClass( 'gul-actions' );

const $btnSearch = $( '<button>' ).addClass( 'gul-primary' ).attr( 'id', 'gul-btn-search' ).text( '🔍 Search Accounts' );

const $btnLock  = $( '<button>' ).addClass( 'gul-danger' ).attr( 'id', 'gul-btn-lock' ).text( '🔒 Lock Selected' ).prop( 'disabled', true );

const $btnClear  = $( '<button>' ).attr( 'id', 'gul-btn-clear' ).text( 'Clear' );

$actions.append( $btnSearch, $btnLock, $btnClear );

$body.append( $actions );

const $status = $( '<div>' ).addClass( 'gul-status' ).attr( 'id', 'gul-status' );

$body.append( $status );

const $progress = $( '<div>' ).addClass( 'gul-progress' ).attr( 'id', 'gul-progress' );

$progress.append( $( '<div>' ).addClass( 'gul-progress-bar' ).attr( 'id', 'gul-progress-bar' ) );

$body.append( $progress );

const $resultsWrap = $( '<div>' ).addClass( 'gul-results-wrap' ).attr( 'id', 'gul-results-wrap' );

$body.append( $resultsWrap );

$container.append( $body );

return $container;

}

// ── Helpers ────────────────────────────────────────────────────────────────

function setStatus( msg, type ) {

const $s = $( '#gul-status' );

$s.removeClass( 'info success error warning' ).addClass( type ).html( msg );

$( '#gul-status' ).removeClass( 'info success error warning' ).hide().html( '' );

function setBadge( username, type, text ) {

const $cell = $( `#gul-row-${ CSS.escape( username ) } .gul-status-cell` );

$cell.html( `<span class="badge badge-${ type }">${ text }</span>` );

}

function setProgress( done, total ) {

const pct = total > 0 ? Math.round( ( done / total ) * 100 ) : 0;

$( '#gul-progress-bar' ).css( 'width', pct + '%' );

}

* Fetch a CSRF token for CentralAuth write operations.

function getCsrfToken() {

return $.ajax( {

} ).then( function ( data ) {

return data.query.tokens.csrftoken;

} );

* and filter client-side since the API doesn't support substring

* page through results and filter locally.

*

function fetchMatchingUsers( query, fromUser ) {

 

setStatus( 'Searching CentralAuth for matching usernames…', 'info' );

 

if ( done || results.length >= MAX_ACCOUNTS ) {

deferred.resolve( results.slice( 0, MAX_ACCOUNTS ) );

 

action:    'query',

list:      'globalallusers',

if ( continueToken ) {

params.agufrom = continueToken;

$.ajax( { url: API_ENDPOINT, data: params } )

.done( function ( data ) {

const users = ( data.query || {} ).globalallusers || [];

 

if ( users.length === 0 ) {

done = true;

deferred.resolve( results.slice( 0, MAX_ACCOUNTS ) );

return;

}

 

users.forEach( function ( u ) {

if ( u.name.toLowerCase().includes( queryLc ) ) {

results.push( u );

 

fetchPage();

deferred.reject( 'API request failed: ' + xhr.statusText );

} );

fetchPage();

}

if ( suppress ) {

states.hidden = 'suppress';

} else if ( hide ) {

states.hidden = 'hide';

 

 

.map( ( [ k, v ] ) => `${ k }=${ v }` )

return $.ajax( {

method: 'POST',

 

 

 

$wrap.addClass( 'visible' );

return;

// Select-all row

const $selRow = $( '<div>' ).addClass( 'gul-select-all-row' );

const $selAll = $( '<input type="checkbox" id="gul-select-all">' ).prop( 'checked', true );

$( '<label>' ).attr( 'for', 'gul-select-all' ).css( 'margin', '0' ).text( 'Select / deselect all' ),

$( '<span>' ).addClass( 'gul-count' ).text( `${ users.length } account(s) found` )

$wrap.append( $selRow );

const $table = $( '<table>' ).addClass( 'gul-results-table' );

$table.append( `

<tr>

<th style="width:28px;"></th>

<th>Username</th>

<th>Registered</th>

` );

 

const $tbody = $( '<tbody>' );

const isLocked = !!u.locked;

const rowId    = `gul-row-${ CSS.escape( u.name ) }`;

 

$row.append(

$( '<td>' ).append( $cb ),

$( '<td>' ).text( u.name ),

$( '<td>' ).text( u.registration ? u.registration.slice( 0, 10 ) : '—' ),

$( '<td style="text-align:center;">' ).html(

? '<span class="badge badge-locked">Locked</span>'

: '<span class="badge badge-pending">Active</span>'

),

$( '<td>' ).addClass( 'gul-status-cell' )

.html( '<span class="badge badge-pending">Pending</span>' )

$table.append( $tbody );

$wrap.append( $table );

$wrap.addClass( 'visible' );

$( '#gul-select-all' ).on( 'change', function () {

$( '.gul-user-cb' ).prop( 'checked', this.checked );

} );

}

 

function onSearch() {

const query = $( '#gul-query' ).val().trim();

if ( !query ) {

setStatus( 'Please enter a search string.', 'error' );

return;

$( '#gul-btn-search' ).prop( 'disabled', true );

$( '#gul-btn-lock' ).prop( 'disabled', true );

$( '#gul-results-wrap' ).removeClass( 'visible' ).empty();

$( '#gul-progress' ).removeClass( 'visible' );

clearStatus();

fetchMatchingUsers( query, $( '#gul-from' ).val().trim() )

$( '#gul-btn-lock' ).prop( 'disabled', false );

setStatus( 'Search failed: ' + mw.html.escape( err ), 'error' );

} )

$( '#gul-btn-search' ).prop( 'disabled', false );

} );

function onLock() {

const reason  = $( '#gul-reason' ).val().trim();

const hide    = $( '#gul-hide' ).prop( 'checked' );

const suppress = $( '#gul-suppress' ).prop( 'checked' );

const skipLocked = $( '#gul-skip-locked' ).prop( 'checked' );

 

if ( !reason ) {

setStatus( 'A lock reason is required.', 'error' );

return;

// Collect selected usernames

const selected = [];

$( '.gul-user-cb:checked' ).each( function () {

selected.push( $( this ).val() );

} );

if ( selected.length === 0 ) {

setStatus( 'No accounts selected.', 'warning' );

return;

}

`You are about to globally lock ${ selected.length } account(s).\n\n` +

`Reason: ${ reason }\n` +

( hide    ? 'Hide username: YES\n'    : '' ) +

( suppress ? 'Suppress username: YES\n' : '' ) +

'\nThis action will be logged. Proceed?'

) ) {

return;

}

$( '#gul-btn-lock, #gul-btn-search' ).prop( 'disabled', true );

setProgress( 0, selected.length );

setStatus( 'Fetching CSRF token…', 'info' );

.then( function ( token ) {

setStatus( `Locking ${ selected.length } account(s)…`, 'info' );

let locked  = 0;

let failed  = 0;

// Sequential processing to avoid API rate limits

setStatus(

`Done. <strong>${ locked }</strong> locked, ` +

`<strong>${ skipped }</strong> skipped, ` +

failed > 0 ? 'warning' : 'success'

$( '#gul-btn-search' ).prop( 'disabled', false );

// Add summary row

const $existing = $( '#gul-lock-summary' );

if ( $existing.length ) $existing.remove();

$( '#gul-results-wrap' ).append(

$( '<div>' ).attr( 'id', 'gul-lock-summary' ).addClass( 'gul-summary' ).html(

`<strong>Summary:</strong> ${ locked } locked · ${ skipped } skipped · ${ failed } failed`

)

);

return;

const username = selected[ index ];

const $row    = $( `#gul-row-${ CSS.escape( username ) }` );

const isLocked = $row.find( 'td:nth-child(4)' ).text().trim() === 'Locked';

if ( skipLocked && isLocked ) {

skipped++;

done++;

setBadge( username, 'skipped', 'Skipped' );

setProgress( done, selected.length );

processNext( index + 1 );

return;

}

setBadge( username, 'pending', 'Locking…' );

if ( data.centralauth && data.centralauth.status === 'ok' ) {

locked++;

failed++;

setBadge( username, 'failed', 'Error: ' + mw.html.escape( data.error.info || data.error.code ) );

setProgress( done, selected.length );

processNext( index + 1 );

} );

processNext( 0 );

setStatus( 'Failed to obtain CSRF token. Are you logged in with sufficient rights?', 'error' );

$( '#gul-btn-lock, #gul-btn-search' ).prop( 'disabled', false );

} );

function onClear() {

$( '#gul-query, #gul-from, #gul-reason' ).val( '' );

$( '#gul-hide, #gul-suppress' ).prop( 'checked', false );

$( '#gul-skip-locked' ).prop( 'checked', true );

$( '#gul-results-wrap' ).removeClass( 'visible' ).empty();

$( '#gul-progress' ).removeClass( 'visible' );

$( '#gul-progress-bar' ).css( 'width', '0%' );

clearStatus();

$( '#gul-btn-lock' ).prop( 'disabled', true );

 

 

function init() {

// (or remove the guard below to load everywhere)

const special = mw.config.get( 'wgCanonicalSpecialPageName' );

if ( special !== 'CentralAuth' && special !== 'GlobalUserRights' ) {

// Load on any page via mw.util.addPortletLink trigger

// Uncomment to restrict:

// return;

const $ui = buildUI();

// Try to insert after the heading on Special pages, else append to content

const $heading = $( '#firstHeading, h1.firstHeading' ).first();

if ( $heading.length ) {

$heading.after( $ui );

$( '#mw-content-text' ).prepend( $ui );

$( '#gul-btn-clear'  ).on( 'click', onClear  );

 

// Allow Enter key in the query field to trigger search

$( '#gul-query' ).on( 'keydown', function ( e ) {

if ( e.key === 'Enter' ) onSearch();