User:Nux/CategorySortKeys.js

Note: After saving, you have to bypass your browser's cache to see the changes. Google Chrome, Firefox, Microsoft Edge and Safari: Hold down the ⇧ Shift key and click the Reload toolbar button. For details and instructions about other browsers, see Wikipedia:Bypass your cache.

/**
 * CategorySortKeys.
 * 
 * Show sort keys on category pages on Wikipedia (or other MediaWiki).
 * 
 * Repository:
 * https://github.com/Eccenux/wikiCategorySortKeys
 * 
 * Authors:
 * Maciej Nux Jaros
 * 
 * Deployed with love using Wikiploy:
 * [[Wikipedia:Wikiploy]]
 * 
 * <nowiki>
 */
(function () {
	
const logTag = '[csk]';

/* Translatable strings */
let pl = mw.config.get('wgUserLanguage') === 'pl';
let lang = {
	missing: pl ? '__NN__' : '__NA__',
	buttonTitle: pl ? '🔤 Klucze sort.' : '🔤 Sort keys',
	buttonDesc: pl ? 'Pokaż klucze sortowania dla stron w bieżącej kategorii' : 'Show sort keys for pages in this category',
};
// usage:
//mw.hook('userjs.CategorySortKeys.lang.ready').add( (lang) => { lang = ... } );
mw.hook('userjs.CategorySortKeys.lang.ready').fire(lang);

// above in a separate file with en being default and pl when ``

class CategorySortKeys {
	constructor() {
		this.conf = {};
	}

	/**
	 * Enhance current category page.
	 */
	async enhance() {
		// css
		this.addStyle();

		// Object { ns: 0, title: "Gordon Allan", sortkeyprefix: "Allan, Gordon" }
		const data = await this.loadPage();
	
		// mapit
		let keys = {};
		data.forEach(d => {
			keys[d.title] = d.sortkeyprefix;
		});

		// remove old
		document.querySelectorAll('#mw-pages .mw-category-group csk').forEach((el)=>el.remove());
	
		// append
		let addSortKey = (a)=>{
			let title = a.textContent.trim();
			let sortkey = (title in keys) ? keys[title] : '';
			let attrs = '';
			if (!sortkey.length) {
				sortkey = lang.missing;
				attrs = ' m';
			}
			a.insertAdjacentHTML('afterend', ` <csk${attrs}>(${sortkey})</csk>`);
		};
		document.querySelectorAll('#mw-pages .mw-category-group a[href]').forEach(addSortKey);
		// NS:Category
		keys = {};
		data.filter(d=>d.ns == 14).forEach(d => {
			keys[d.title.replace(/.+?:/, '')] = d.sortkeyprefix;
		});
		document.querySelectorAll('#mw-subcategories .mw-category-group a[href]').forEach(addSortKey);
		// NS:File
		keys = {};
		data.filter(d=>d.ns == 6).forEach(d => {
			keys[d.title.replace(/.+?:/, '')] = d.sortkeyprefix;
		});
		document.querySelectorAll('#mw-category-media a.galleryfilename').forEach(addSortKey);
	}

	/** @private Add CSS. */
	addStyle() {
		const styleId = 'nug-csk-css';
		if (document.getElementById(styleId)) {
			// console.warn(logTag, 'addStyle repeat');
			return;
		}
		const css = /*css*/`
			csk[m] {
				color: mediumvioletred;
			}
		`;
		document.body.insertAdjacentHTML('beforeend', `<style id='${styleId}'>${css}</style>`);
	}

	/** @private Load keys from start to end letters. */
	async loadPage() {
		let {start, end} = this.findBounds();
		console.log(logTag, 'loadPage: ', {start, end});
		let data = await this.loadKeys(start, end);
		return data;
	}

	/** @private Find start/end letter. */
	findBounds() {
		let letters = Array.from(document.querySelectorAll('#mw-pages .mw-category-group h3')).map(el => el.textContent);
		if (!letters.length) {
			return false;
		}
		let start = letters[0];
		let end = letters.pop();
		return {start, end};
	}

	/** @private Load keys from start to end letters. */
	async loadKeys(start, end) {
		return new Promise((resolve, reject) => {
			const api = new mw.Api();
			let props = {
				action: 'query',
				list: 'categorymembers',
				format: 'json',

				cmtitle: mw.config.get('wgPageName'),
				cmsort: 'sortkey',
				cmdir: 'asc',

				cmprop: ['sortkeyprefix', 'title'],
				cmlimit: 'max',
			};
			if (start && end) {
				props['cmstartsortkeyprefix'] = `${start}`;
				props['cmendsortkeyprefix'] = `${end}ZZZ`;
			}
			api.get(props).done(function (data) {
				let members = data?.query?.categorymembers;
				if (Array.isArray(members)) {
					resolve(members)
				} else {
					reject({
						e: 'invalid data',
						data,
					});
				}
			});
		});
	}
}

// init
if ( mw.config.get('wgCanonicalNamespace') === 'Category' ) {
	mw.loader.using(['mediawiki.util'], function () {
		// link-button
		const title = lang.buttonTitle;
		const desc = lang.buttonDesc;
		const link = mw.util.addPortletLink( 'p-tb', '', title, 'pt-sortkeys', desc, null, '#t-info' );

		// action
		$( link ).click( function ( e ) {
			e.preventDefault();

			var cats = new CategorySortKeys();
			cats.enhance();
		} );
	} );
}

})();
//</nowiki>