User:Novem Linguae/Scripts/UnblockReview.js
Appearance
Code that you insert on this page could contain malicious content capable of compromising your account. If you import a script from another page with "importScript", "mw.loader.load", "iusc", or "lusc", take note that this causes you to dynamically load a remote script, which could be changed by others. Editors are responsible for all edits and actions they perform, including by scripts. User scripts are not centrally supported and may malfunction or become inoperable due to software changes. A guide to help you find broken scripts is available. If you are unsure whether code you are adding to this page is safe, you can ask at the appropriate village pump. This code will be executed when previewing this page. |
Documentation for this user script can be added at User:Novem Linguae/Scripts/UnblockReview. |
/*
Fork of https://en.wikipedia.org/w/index.php?title=User:Enterprisey/unblock-review.js&oldid=1073685522
CHANGELOG:
- linted the code
- refactored
TODO:
- get rid of goto jump (matchLoop label)
- make tickets for the 4 issues that jpgordon and myself mentioned here: https://en.wikipedia.org/wiki/Wikipedia:User_scripts/Requests#User%3AEnterprisey%2Funblock-review. make the tickets at https://github.com/NovemLinguae/UserScripts/issues?q=is%3Aissue+is%3Aopen+label%3AUnblockReview
*/
/* global importStylesheet */
// <nowiki>
( function () {
const UNBLOCK_REQ_COLOR = 'rgb(235, 244, 255)';
const SIGNATURE = '~~~~';
const DECLINE_REASON_HERE = '{{subst:Decline reason here}}';
const ADVERT = ' ([[User:Novem Linguae/Scripts/UnblockReview.js|unblock-review]])';
function execute() {
const userTalkNamespace = 3;
if ( mw.config.get( 'wgNamespaceNumber' ) !== userTalkNamespace ) {
return;
}
$.when( $.ready, mw.loader.using( [ 'mediawiki.api', 'mediawiki.util' ] ) ).then( () => {
// add styles
mw.util.addCSS(
'.unblock-review td { padding: 0 }' +
'td.reason-container { padding-right: 1em; width: 30em }' +
'.unblock-review-reason { height: 5em }' );
importStylesheet( 'User:Enterprisey/mw-ui-button.css' );
importStylesheet( 'User:Enterprisey/mw-ui-input.css' );
// look for user-block HTML class, which will correspond to {{Unblock}} requests
const userBlockBoxes = document.querySelectorAll( 'div.user-block' );
for ( let i = 0, n = userBlockBoxes.length; i < n; i++ ) {
if ( userBlockBoxes[ i ].style[ 'background-color' ] !== UNBLOCK_REQ_COLOR ) {
continue;
}
// We now have a pending unblock request - add UI
const unblockDiv = userBlockBoxes[ i ];
const [ container, hrEl ] = addTextBoxAndButtons( unblockDiv );
listenForAcceptAndDecline( container, hrEl );
}
} );
}
function addTextBoxAndButtons( unblockDiv ) {
const container = document.createElement( 'table' );
container.className = 'unblock-review';
// Note: The innerHtml of the button is sensitive. Is used to figure out which accept/decline wikitext to use. Don't add whitespace to it.
container.innerHTML = `
<tr>
<td class='reason-container' rowspan='2'>
<textarea class='unblock-review-reason mw-ui-input' placeholder='Reason for accepting/declining here'>${ DECLINE_REASON_HERE }</textarea>
</td>
<td>
<button class='unblock-review-accept mw-ui-button mw-ui-progressive'>Accept</button>
</td>
</tr>
<tr>
<td>
<button class='unblock-review-decline mw-ui-button mw-ui-destructive'>Decline</button>
</td>
</tr>`;
const hrEl = unblockDiv.querySelector( 'hr' );
unblockDiv.insertBefore( container, hrEl.previousElementSibling );
return [ container, hrEl ];
}
function listenForAcceptAndDecline( container, hrEl ) {
const reasonArea = container.querySelector( 'textarea' );
$( container ).find( 'button' ).on( 'click', function () {
// look at the innerHtml of the button to see if it says "Accept" or "Decline"
const action = $( this ).text().toLowerCase();
const appealReason = hrEl.nextElementSibling.nextElementSibling.childNodes[ 0 ].textContent;
$.getJSON(
mw.util.wikiScript( 'api' ),
{
format: 'json',
action: 'query',
prop: 'revisions',
rvprop: 'content',
rvlimit: 1,
titles: mw.config.get( 'wgPageName' )
}
).done( ( data ) => {
// Extract wikitext from API response
const pageId = Object.keys( data.query.pages )[ 0 ];
let wikitext = data.query.pages[ pageId ].revisions[ 0 ][ '*' ];
// build wikitext
const initialText = getLeftHalfOfUnblockTemplate( wikitext, appealReason );
let reason = reasonArea.value;
if ( !reason.trim() ) {
reason = DECLINE_REASON_HERE + ' ' + SIGNATURE;
} else if ( !hasSignature( reason ) ) {
reason = reason + ' ' + SIGNATURE;
}
wikitext = wikitext.replace(
initialText + appealReason,
'{{unblock reviewed|' + action + '=' + reason + '|1=' + appealReason
);
// build edit summary
const acceptingOrDeclining = ( action === 'accept' ? 'Accepting' : 'Declining' );
const summary = acceptingOrDeclining + ' unblock request' + ADVERT;
// make edit
( new mw.Api() ).postWithToken( 'csrf', {
action: 'edit',
title: mw.config.get( 'wgPageName' ),
summary: summary,
text: wikitext
} ).done( ( data ) => {
if ( data && data.edit && data.edit.result && data.edit.result === 'Success' ) {
window.location.reload( true );
} else {
console.log( data );
}
} );
} );
} );
}
/**
* Given the wikitext of an entire page, and the |reason= parameter of one of the many unblock templates (e.g. {{Unblock}}, {{Unblock-un}}, {{Unblock-auto}}, {{Unblock-bot}}, etc.), return the wikitext of just the beginning of the template.
*
* For example, "Test {{unblock|reason=Your reason here [[User:Filipe46]]}} Test" as the wikitext and "Your reason here" as the appealReason will return "{{unblock|reason=".
*
* This can also handle 1=, and no parameter at all (just a pipe)
*/
function getLeftHalfOfUnblockTemplate( wikitext, appealReason ) {
// https://stackoverflow.com/a/6969486/3480193
function escapeRegExp( string ) {
// $& means the whole matched string
return string.replace( /[.*+?^${}()|[\]\\]/g, '\\$&' );
}
const regEx = new RegExp( escapeRegExp( appealReason ), 'g' );
let matches = wikitext.matchAll( regEx );
matches = [ ...matches ];
if ( matches.length === 0 ) {
throw new Error( 'Searching for target text failed!' );
}
for ( const match of matches ) {
const textIdx = match.index;
let startIdx = textIdx;
// check for {{tlx|unblock. if found, this isn't what we want, skip.
const startOfSplice = startIdx - 50 < 0 ? 0 : startIdx - 50;
const chunkFiftyCharactersWide = wikitext.substring( startOfSplice, startIdx );
if ( /\{\{\s*tlx\s*\|\s*unblock/i.test( chunkFiftyCharactersWide ) ) {
continue;
}
let i = 0;
while ( wikitext[ startIdx ] !== '{' && i < 50 ) {
startIdx--;
i++;
}
if ( i === 50 ) {
continue;
}
// templates start with two opening curly braces
startIdx--;
const initialText = wikitext.substring( startIdx, textIdx );
return initialText;
}
throw new Error( 'Searching backwards failed!' );
}
/**
* Is there a signature (four tildes) present in the given text,
* outside of a nowiki element?
*/
function hasSignature( text ) {
// no literal signature?
if ( text.indexOf( SIGNATURE ) < 0 ) {
return false;
}
// if there's a literal signature and no nowiki elements,
// there must be a real signature
if ( text.indexOf( '<nowiki>' ) < 0 ) {
return true;
}
// Save all nowiki spans
const nowikiSpanStarts = []; // list of ignored span beginnings
const nowikiSpanLengths = []; // list of ignored span lengths
const NOWIKI_RE = /<nowiki>.*?<\/nowiki>/g;
let spanMatch;
do {
spanMatch = NOWIKI_RE.exec( text );
if ( spanMatch ) {
nowikiSpanStarts.push( spanMatch.index );
nowikiSpanLengths.push( spanMatch[ 0 ].length );
}
} while ( spanMatch );
// So that we don't check every ignore span every time
let nowikiSpanStartIdx = 0;
const SIG_RE = new RegExp( SIGNATURE, 'g' );
let sigMatch;
matchLoop:
do {
sigMatch = SIG_RE.exec( text );
if ( sigMatch ) {
// Check that we're not inside a nowiki
for ( let nwIdx = nowikiSpanStartIdx; nwIdx <
nowikiSpanStarts.length; nwIdx++ ) {
if ( sigMatch.index > nowikiSpanStarts[ nwIdx ] ) {
if ( sigMatch.index + sigMatch[ 0 ].length <=
nowikiSpanStarts[ nwIdx ] + nowikiSpanLengths[ nwIdx ] ) {
// Invalid sig
continue matchLoop;
} else {
// We'll never encounter this span again, since
// headers only get later and later in the wikitext
nowikiSpanStartIdx = nwIdx;
}
}
}
// We aren't inside a nowiki
return true;
}
} while ( sigMatch );
return false;
}
execute();
}() );
// </nowiki>