Common.js – MediaWiki

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix enfusion:// links getting skin persistence argument)
m (Fix typo)
 
(12 intermediate revisions by the same user not shown)
Line 4: Line 4:
  *****************************************************************************************/
  *****************************************************************************************/


mw.loader.using( ["mediawiki.util", "jquery.client"], function() { /* BEGIN mw.loader WRAPPER */
mw.loader.using( ['mediawiki.util', 'jquery.client'], function() { /* BEGIN mw.loader WRAPPER */


/*****************************************************************************************
/*****************************************************************************************
Line 11: Line 11:


function conditionallyImport() {
function conditionallyImport() {
if ( mw.config.get( "wgAction" ) === "edit" || mw.config.get( "wgAction" ) === "submit" ) {
if ( mw.config.get( 'wgAction' ) === 'edit' || mw.config.get( 'wgAction' ) === 'submit' ) {
importScript( "MediaWiki:Editing.js" );
importScript( 'MediaWiki:Editing.js' );
// mw.loader.load( '/wiki/index.php?title=MediaWiki:Editing.js&action=raw&ctype=text/javascript' ); // proper thing to do - for future reference
// mw.loader.load( '/wiki/index.php?title=MediaWiki:Editing.js&action=raw&ctype=text/javascript' ); // proper thing to do - for future reference
}
}
if ( mw.config.get( "wgCanonicalNamespace" ) != "MediaWiki" && mw.config.get( "wgArticleId" ) === 0 ) {
if ( mw.config.get( 'wgCanonicalNamespace' ) != 'MediaWiki' && mw.config.get( 'wgArticleId' ) === 0 ) {
importScript( "MediaWiki:Creation.js" );
importScript( 'MediaWiki:Creation.js' );
}
}
if ( mw.config.get( "wgPageName" ) === "Special:Version" ) {
if ( mw.config.get( 'wgPageName' ) === 'Special:Version' ) {
importScript( "MediaWiki:SpecialVersion.js" );
importScript( 'MediaWiki:SpecialVersion.js' );
}
}
}
}
mw.hook( "wikipage.content" ).add( conditionallyImport );
mw.hook( 'wikipage.content' ).add( conditionallyImport );


/*****************************************************************************************
/*****************************************************************************************
Line 30: Line 30:


function offerPurgeButton() {
function offerPurgeButton() {
var protectButton = document.getElementById("ca-protect");
var protectButton = document.getElementById('ca-protect');
if (protectButton == null) {
if (protectButton == null) {
protectButton = document.getElementById("ca-unprotect");
protectButton = document.getElementById('ca-unprotect');
if (protectButton == null) {
if (protectButton == null) {
return; // quick'n'not that dirty
return; // quick'n'not that dirty
Line 38: Line 38:
}
}
var newButton = protectButton.cloneNode(true),
var newButton = protectButton.cloneNode(true),
link = newButton.getElementsByTagName("a")[0];
link = newButton.getElementsByTagName('a')[0];
link.removeAttribute("accesskey");
link.removeAttribute('accesskey');
link.setAttribute("title", "Purge the page's cache");
link.setAttribute('title', 'Purge the page\'s cache');
link.setAttribute("href", document.location.href + (document.location.href.indexOf("?") === -1 ? "?action=purge" : "&action=purge"));
link.setAttribute('href', document.location.href + (document.location.href.indexOf('?') === -1 ? '?action=purge' : '&action=purge'));
link.innerHTML = "Purge";
link.innerHTML = 'Purge';
protectButton.parentNode.appendChild(newButton);
protectButton.parentNode.appendChild(newButton);
}
}
mw.hook( "wikipage.content" ).add( offerPurgeButton );
mw.hook( 'wikipage.content' ).add( offerPurgeButton );


/*****************************************************************************************
/*****************************************************************************************
Line 53: Line 53:


function offerDeleteSessionCookieButton() {
function offerDeleteSessionCookieButton() {
var protectButton = document.getElementById("ca-protect");
var protectButton = document.getElementById('ca-protect');
if (protectButton == null) {
if (protectButton == null) {
protectButton = document.getElementById("ca-unprotect");
protectButton = document.getElementById('ca-unprotect');
if (protectButton == null) {
if (protectButton == null) {
return; // quick'n'not that dirty
return; // quick'n'not that dirty
Line 61: Line 61:
}
}
var newButton = protectButton.cloneNode(true),
var newButton = protectButton.cloneNode(true),
link = newButton.getElementsByTagName("a")[0];
link = newButton.getElementsByTagName('a')[0];
link.removeAttribute("accesskey");
link.removeAttribute('accesskey');
link.setAttribute("title", "Delete the community_session cookie to fix the DbQueryError issue");
link.setAttribute('title', 'Delete the community_session cookie to fix the DbQueryError issue');
link.setAttribute("href", "/clearcookie.php?url=" + document.location.href);
link.setAttribute('href', '/clearcookie.php?url=' + document.location.href);
link.innerHTML = "Fix access";
link.innerHTML = 'Fix access';
protectButton.parentNode.appendChild(newButton);
protectButton.parentNode.appendChild(newButton);
}
}
// mw.hook( "wikipage.content" ).add( offerDeleteSessionCookieButton ); // disabled for now, -should- be fixed
// mw.hook( 'wikipage.content' ).add( offerDeleteSessionCookieButton ); // disabled for now, -should- be fixed


/*****************************************************************************************
/*****************************************************************************************
Line 76: Line 76:


function disableTalkPages() {
function disableTalkPages() {
if ($.inArray("sysop", mw.config.get("wgUserGroups")) === -1) { // not admin
if ($.inArray('sysop', mw.config.get('wgUserGroups')) === -1) { // not admin
if (mw.config.get("wgCanonicalNamespace").indexOf("talk") !== -1 && // talk page
mw.config.get("wgNamespaceNumber") !== 3) { // User Talk exception


if (document.getElementById("ca-edit") != null) {
if (mw.config.get('wgCanonicalNamespace').indexOf('talk') !== -1 && // talk page
document.getElementById("ca-edit").remove();
mw.config.get('wgNamespaceNumber') !== 3) { // User Talk exception
 
if (document.getElementById('ca-edit') != null) {
document.getElementById('ca-edit').remove();
}
}


if (document.getElementById("ca-addsection") != null) {
if (document.getElementById('ca-addsection') != null) {
document.getElementById("ca-addsection").remove();
document.getElementById('ca-addsection').remove();
}
}
}
}


var talkTab = document.getElementById("ca-talk");
var talkTab = document.getElementById('ca-talk');
if (talkTab != null && talkTab.classList.contains("new")) {
if (talkTab != null && talkTab.classList.contains('new')) {
talkTab.remove();
talkTab.remove();
}
}
}
}
}
}
mw.hook( "wikipage.content" ).add( disableTalkPages );
mw.hook( 'wikipage.content' ).add( disableTalkPages );


/*****************************************************************************************
/*****************************************************************************************
Line 104: Line 104:


function addSandboxButton() {
function addSandboxButton() {
var userpageLink = document.getElementById("pt-userpage");
var userpageLink = document.getElementById('pt-userpage');
var talkLink = document.getElementById("pt-mytalk");
var talkLink = document.getElementById('pt-mytalk');
if (talkLink == null) {
if (talkLink == null) {
return;
return;
}
}
var sandboxLink = talkLink.cloneNode(true),
var sandboxLink = talkLink.cloneNode(true),
link = sandboxLink.getElementsByTagName("a")[0];
link = sandboxLink.getElementsByTagName('a')[0];
link.removeAttribute("accesskey");
link.removeAttribute('accesskey');
link.setAttribute("title", "Your Sandbox");
link.setAttribute('title', 'Your Sandbox');
link.setAttribute("href", userpageLink.getElementsByTagName("a")[0].href + "/Sandbox");
link.setAttribute('href', userpageLink.getElementsByTagName('a')[0].href + '/Sandbox');
link.innerHTML = "Sandbox";
link.innerHTML = 'Sandbox';
talkLink.parentNode.insertBefore(sandboxLink, talkLink);
talkLink.parentNode.insertBefore(sandboxLink, talkLink);
}
}
mw.hook( "wikipage.content" ).add( addSandboxButton );
mw.hook( 'wikipage.content' ).add( addSandboxButton );


/*****************************************************************************************
/*****************************************************************************************
Line 128: Line 128:
var i;
var i;
for (i = 0; i < titles.length; i++) {
for (i = 0; i < titles.length; i++) {
titles[i].classList.remove("selected");
titles[i].classList.remove('selected');
}
}
for (i = 0; i < contents.length; i++) {
for (i = 0; i < contents.length; i++) {
contents[i].style.display = "none";
contents[i].style.display = 'none';
}
}


Line 137: Line 137:
return;
return;
}
}
titles[tabIndex].classList.add("selected");
titles[tabIndex].classList.add('selected');
contents[tabIndex].style.display = "block";
contents[tabIndex].style.display = 'block';
}
}


function tabSystem_implementTabs() {
function tabSystem_implementTabs() {


var tabBlocks = document.getElementsByClassName("biki-tabs");
var tabBlocks = document.getElementsByClassName('biki-tabs');


for (var i = 0; i < tabBlocks.length; i++) {
for (var i = 0; i < tabBlocks.length; i++) {
Line 149: Line 149:
var tabBlock = tabBlocks[i];
var tabBlock = tabBlocks[i];


var titles = tabBlock.getElementsByClassName("biki-tab-title");
var titles = tabBlock.getElementsByClassName('biki-tab-title');
var contents = tabBlock.getElementsByClassName("biki-tab-content");
var contents = tabBlock.getElementsByClassName('biki-tab-content');
if (titles.length < 1 || contents.length < 1 || titles.length != contents.length) {
if (titles.length < 1 || contents.length < 1 || titles.length != contents.length) {
continue;
continue;
Line 157: Line 157:
for (var j = 0; j < titles.length; j++) {
for (var j = 0; j < titles.length; j++) {
(function(titles, contents, index) {
(function(titles, contents, index) {
titles[j].addEventListener("click", function () { tabSystem_selectTab(titles, contents, index) })
titles[j].addEventListener('click', function () { tabSystem_selectTab(titles, contents, index) })
})(titles, contents, j);
})(titles, contents, j);
}
}
Line 172: Line 172:
}
}
}
}
mw.hook( 'wikipage.content' ).add( tabSystem_implementTabs );


/*****************************************************************************************
/*****************************************************************************************
Line 189: Line 190:
return;
return;


var firstButton = leftTabHolder .children[0];// <li>
var firstButton = leftTabHolder .children[0]; // <li>
if (firstButton == null)
if (firstButton == null)
return; // quick'n'not that dirty
return; // quick'n'not that dirty
Line 213: Line 214:


var newButton = firstButton.cloneNode(true),
var newButton = firstButton.cloneNode(true),
link = newButton.getElementsByTagName("a")[0];
link = newButton.getElementsByTagName('a')[0];


newButton.removeAttribute('class');
newButton.removeAttribute('class');
Line 223: Line 224:
leftTabHolder.appendChild(newButton);
leftTabHolder.appendChild(newButton);
}
}
/*****************************************************************************************
* Function that adds the currently-used 'useskin' URL parameter to all relevant links in the page
* Maintainer: [[User:Lou Montana]]
*/


function setAllLinksToUseForcedSkin() {
function setAllLinksToUseForcedSkin() {
Line 236: Line 242:
link = allLinks[i];
link = allLinks[i];
href = link.href;
href = link.href;
if (href == '')
if (href == null || href == '')
continue;
 
if (href.startsWith('#') || href.startsWith('javascript:'))
continue;
continue;


// if (href.startsWith('enfusion://'))
// only httpS wiki links, no javascript:, no #, no enfusion:// or other protocol
if (!href.startsWith('https://') && !href.startsWith('http://')) // only http(s) links
if (!(href.startsWith('https://community.bistudio.com/') || href.startsWith('https://community.bohemia.net/') || href.startsWith('/wiki/')))
continue;
continue;


// only wiki links, thanks
if (href.indexOf(SKIN_USAGE) !== -1)
if (!(href.startsWith('https://community.bistudio.com/') || href.startsWith('https://community.bohemia.net/') || href.startsWith('#')))
continue;
 
if (href.includes(SKIN_USAGE))
continue; // already has a skin assigned
continue; // already has a skin assigned


if (href.includes('?'))
var poundIndex = href.indexOf('#');
href += '&' + SKIN_USAGE + usedSkin;
if (href.indexOf('?') !== -1)
else
{
href += '?' + SKIN_USAGE + usedSkin;
if (poundIndex !== -1)
href = href.replace('#', '&' + SKIN_USAGE + usedSkin + '#');
else
href += '&' + SKIN_USAGE + usedSkin;
}
else // no ?x=y parameters
{
if (poundIndex !== -1)
href = href.replace('#', '?' + SKIN_USAGE + usedSkin + '#');
else
href += '?' + SKIN_USAGE + usedSkin;
}


link.href = href;
link.href = href;
Line 262: Line 272:
}
}


// if 'useskin' is used, apply it to all links
if (mw.util.getParamValue('useskin'))
if (mw.util.getParamValue('useskin'))
mw.hook( "wikipage.content" ).add( setAllLinksToUseForcedSkin );
mw.hook( 'wikipage.content' ).add( setAllLinksToUseForcedSkin );


if (document.getElementById('pt-userpage') == null) // not logged in
// no ES5 promise, use jQuery
{
$.getJSON('/wikidata/api.php?action=query&meta=userinfo&format=json').done(function(response) {
// -after- so the URL is not changed by the above method
if (response != null && response.query.userinfo.id === 0) { // not logged in
mw.hook( "wikipage.content" ).add( addDarkOrDefaultModeButton );
mw.hook( 'wikipage.content' ).add( addDarkOrDefaultModeButton );
}
// hopefully -after- setAllLinksToUseForcedSkin so the button's URL is not changed by it
}
});


}); /* END mw.loader WRAPPER */
}); /* END mw.loader WRAPPER */

Latest revision as of 23:46, 10 March 2024

/*****************************************************************************************
 * This JavaScript file will be loaded for all users on every page load
 * Its content must be kept as minimal as possible.
 *****************************************************************************************/

mw.loader.using( ['mediawiki.util', 'jquery.client'], function() { /* BEGIN mw.loader WRAPPER */

	/*****************************************************************************************
	 * Conditionally import further JavaScript for specific situations.
	 */

	function conditionallyImport() {
		if ( mw.config.get( 'wgAction' ) === 'edit' || mw.config.get( 'wgAction' ) === 'submit' ) {
			importScript( 'MediaWiki:Editing.js' );
			// mw.loader.load( '/wiki/index.php?title=MediaWiki:Editing.js&action=raw&ctype=text/javascript' ); // proper thing to do - for future reference
		}
		if ( mw.config.get( 'wgCanonicalNamespace' ) != 'MediaWiki' && mw.config.get( 'wgArticleId' ) === 0 ) {
			importScript( 'MediaWiki:Creation.js' );
		}
		if ( mw.config.get( 'wgPageName' ) === 'Special:Version' ) {
			importScript( 'MediaWiki:SpecialVersion.js' );
		}
	}
	mw.hook( 'wikipage.content' ).add( conditionallyImport );

	/*****************************************************************************************
	 * Add a Purge button
	 * Maintainer: [[User:Lou Montana]]
	 */

	function offerPurgeButton() {
		var protectButton = document.getElementById('ca-protect');
		if (protectButton == null) {
			protectButton = document.getElementById('ca-unprotect');
			if (protectButton == null) {
				return; // quick'n'not that dirty
			}
		}
		var newButton = protectButton.cloneNode(true),
			link = newButton.getElementsByTagName('a')[0];
		link.removeAttribute('accesskey');
		link.setAttribute('title', 'Purge the page\'s cache');
		link.setAttribute('href', document.location.href + (document.location.href.indexOf('?') === -1 ? '?action=purge' : '&action=purge'));
		link.innerHTML = 'Purge';
		protectButton.parentNode.appendChild(newButton);
	}
	mw.hook( 'wikipage.content' ).add( offerPurgeButton );

	/*****************************************************************************************
	 * Add a Fix access button
	 * Maintainer: [[User:Lou Montana]]
	 */

	function offerDeleteSessionCookieButton() {
		var protectButton = document.getElementById('ca-protect');
		if (protectButton == null) {
			protectButton = document.getElementById('ca-unprotect');
			if (protectButton == null) {
				return; // quick'n'not that dirty
			}
		}
		var newButton = protectButton.cloneNode(true),
			link = newButton.getElementsByTagName('a')[0];
		link.removeAttribute('accesskey');
		link.setAttribute('title', 'Delete the community_session cookie to fix the DbQueryError issue');
		link.setAttribute('href', '/clearcookie.php?url=' + document.location.href);
		link.innerHTML = 'Fix access';
		protectButton.parentNode.appendChild(newButton);
	}
	// mw.hook( 'wikipage.content' ).add( offerDeleteSessionCookieButton ); // disabled for now, -should- be fixed

	/*****************************************************************************************
	 * Disable Talk pages
	 * Maintainer: [[User:Lou Montana]]
	 */

	function disableTalkPages() {
		if ($.inArray('sysop', mw.config.get('wgUserGroups')) === -1) { // not admin

			if (mw.config.get('wgCanonicalNamespace').indexOf('talk') !== -1 && // talk page
				mw.config.get('wgNamespaceNumber') !== 3) { // User Talk exception

				if (document.getElementById('ca-edit') != null) {
					document.getElementById('ca-edit').remove();
				}

				if (document.getElementById('ca-addsection') != null) {
					document.getElementById('ca-addsection').remove();
				}
			}

			var talkTab = document.getElementById('ca-talk');
			if (talkTab != null && talkTab.classList.contains('new')) {
				talkTab.remove();
			}
		}
	}
	mw.hook( 'wikipage.content' ).add( disableTalkPages );

	/*****************************************************************************************
	 * Function that adds a Sandbox button
	 * Maintainer: [[User:Lou Montana]]
	 */

	function addSandboxButton() {
		var userpageLink = document.getElementById('pt-userpage');
		var talkLink = document.getElementById('pt-mytalk');
		if (talkLink == null) {
			return;
		}
		var sandboxLink = talkLink.cloneNode(true),
			link = sandboxLink.getElementsByTagName('a')[0];
		link.removeAttribute('accesskey');
		link.setAttribute('title', 'Your Sandbox');
		link.setAttribute('href', userpageLink.getElementsByTagName('a')[0].href + '/Sandbox');
		link.innerHTML = 'Sandbox';
		talkLink.parentNode.insertBefore(sandboxLink, talkLink);
	}
	mw.hook( 'wikipage.content' ).add( addSandboxButton );

	/*****************************************************************************************
	 * Functions that adds Tabs
	 * Maintainer: [[User:Lou Montana]]
	 */

	function tabSystem_selectTab(titles, contents, tabIndex) {

		var i;
		for (i = 0; i < titles.length; i++) {
			titles[i].classList.remove('selected');
		}
		for (i = 0; i < contents.length; i++) {
			contents[i].style.display = 'none';
		}

		if (tabIndex < 0 || tabIndex > titles.length -1 || tabIndex > contents.length -1) {
			return;
		}
		titles[tabIndex].classList.add('selected');
		contents[tabIndex].style.display = 'block';
	}

	function tabSystem_implementTabs() {

		var tabBlocks = document.getElementsByClassName('biki-tabs');

		for (var i = 0; i < tabBlocks.length; i++) {

			var tabBlock = tabBlocks[i];

			var titles = tabBlock.getElementsByClassName('biki-tab-title');
			var contents = tabBlock.getElementsByClassName('biki-tab-content');
			if (titles.length < 1 || contents.length < 1 || titles.length != contents.length) {
				continue;
			}

			for (var j = 0; j < titles.length; j++) {
				(function(titles, contents, index) {
					titles[j].addEventListener('click', function () { tabSystem_selectTab(titles, contents, index) })
				})(titles, contents, j);
			}

			var selectedTab = 0;
			if (tabBlock.dataset && tabBlock.dataset.selectedtab) {
				var dataSelectedTab = +tabBlock.dataset.selectedtab;
				if (!isNaN(dataSelectedTab)) {
					selectedTab = Math.max(0, Math.min(dataSelectedTab, titles.length -1));
				}
			}

			tabSystem_selectTab(titles, contents, selectedTab);
		}
	}
	mw.hook( 'wikipage.content' ).add( tabSystem_implementTabs );

	/*****************************************************************************************
	 * Function that adds Dark/Default Mode button for non logged-in users
	 * (logged-in users can select their skin in Parameters)
	 * Maintainer: [[User:Lou Montana]]
	 */

	const SKIN_USAGE = 'useskin=';

	function addDarkOrDefaultModeButton() {
		const DARKMODE_SKIN = 'darkvector';
		const DARKMODE_SKIN_USAGE = SKIN_USAGE + DARKMODE_SKIN;

		var leftTabHolder = document.getElementById('p-namespaces').getElementsByTagName('ul')[0]; // <ul>
		if (leftTabHolder == null)
			return;

		var firstButton = leftTabHolder .children[0]; // <li>
		if (firstButton == null)
			return; // quick'n'not that dirty

		var buttonName;
		var title;
		var href = document.documentURI;
		if (href.indexOf(DARKMODE_SKIN_USAGE) !== -1)
		{
			buttonName = 'Default Mode';
			title = 'Go back to the default skin';
			href = href.replace(/[?&]useskin=[a-zA-Z0-9_]+/, '');
		}
		else // not in URL
		{
			buttonName = 'Dark Mode';
			title = 'Use Dark Mode';
			if (href.includes('?'))
				href += '&' + DARKMODE_SKIN_USAGE;
			else
				href += '?' + DARKMODE_SKIN_USAGE;
		}

		var newButton = firstButton.cloneNode(true),
			link = newButton.getElementsByTagName('a')[0];

		newButton.removeAttribute('class');
		link.removeAttribute('accesskey');
		link.removeAttribute('rel');
		link.setAttribute('title', title);
		link.setAttribute('href', href);
		link.innerHTML = buttonName;
		leftTabHolder.appendChild(newButton);
	}

	/*****************************************************************************************
	 * Function that adds the currently-used 'useskin' URL parameter to all relevant links in the page
	 * Maintainer: [[User:Lou Montana]]
	 */

	function setAllLinksToUseForcedSkin() {
		var usedSkin = mw.util.getParamValue('useskin');
		if (usedSkin == null || usedSkin == '')
			return;

		var allLinks = document.getElementsByTagName('a');
		var link;
		var href;
		for (var i = 0, count = allLinks.length - 1; i < count; i++)
		{
			link = allLinks[i];
			href = link.href;
			if (href == null || href == '')
				continue;

			// only httpS wiki links, no javascript:, no #, no enfusion:// or other protocol
			if (!(href.startsWith('https://community.bistudio.com/') || href.startsWith('https://community.bohemia.net/') || href.startsWith('/wiki/')))
				continue;

			if (href.indexOf(SKIN_USAGE) !== -1)
				continue; // already has a skin assigned

			var poundIndex = href.indexOf('#');
			if (href.indexOf('?') !== -1)
			{
				if (poundIndex !== -1)
					href = href.replace('#', '&' + SKIN_USAGE + usedSkin + '#');
				else
					href += '&' + SKIN_USAGE + usedSkin;
			}
			else // no ?x=y parameters
			{
				if (poundIndex !== -1)
					href = href.replace('#', '?' + SKIN_USAGE + usedSkin + '#');
				else
					href += '?' + SKIN_USAGE + usedSkin;
			}

			link.href = href;
		}
	}

	// if 'useskin' is used, apply it to all links
	if (mw.util.getParamValue('useskin'))
		mw.hook( 'wikipage.content' ).add( setAllLinksToUseForcedSkin );

	// no ES5 promise, use jQuery
	$.getJSON('/wikidata/api.php?action=query&meta=userinfo&format=json').done(function(response) {
		if (response != null && response.query.userinfo.id === 0) {	// not logged in
			mw.hook( 'wikipage.content' ).add( addDarkOrDefaultModeButton );
			// hopefully -after- setAllLinksToUseForcedSkin so the button's URL is not changed by it
		}
	});

}); /* END mw.loader WRAPPER */