User:Zhaofeng Li/Reflinks.js

/*
	For more information on this tool, see https://en.wikipedia.org/wiki/User:Zhaofeng_Li/reFill
	Please contribute to the repo on GitHub: https://github.com/zhaofengli/refill/blob/master/web/scripts/wikitoolbox.js

	Note that on 2020-07-09 an edit was made here directly to fix the script, but was not made on the GitHub repo.
	This was to update the tool links to use `https://refill.toolforge.org/`, since the existing links broke.
	See T257481 on phabricator for more.
	Thanks, --[[User:DannyS712|DannyS712]] ([[User talk:DannyS712|talk]]) 23:03, 9 July 2020 (UTC)
*/
var rlWiki = mw.config.get( "wgContentLanguage" );
/*
	Copyright (c) 2014, Zhaofeng Li
	All rights reserved.
	Redistribution and use in source and binary forms, with or without
	modification, are permitted provided that the following conditions are met:
	* Redistributions of source code must retain the above copyright notice, this
	list of conditions and the following disclaimer.
	* Redistributions in binary form must reproduce the above copyright notice,
	this list of conditions and the following disclaimer in the documentation
	and/or other materials provided with the distribution.
	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
	AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
	FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
	SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
	CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

/*
	This script is intended to be included on-wiki!
	
	This script depends on jQuery and MediaWiki environment.
	
	Set rlServer to the URL of the tool, and rlWiki to the
	wiki identifier.
*/

/*global rlServer, rlWiki, mw, $ */
/*jshint multistr: true */

function ReflinksGadget() {
	this.server = typeof rlServer !== 'undefined' ? rlServer
	            : "https://refill.toolforge.org/";
	this.server2 = "https://refill.toolforge.org/ng";
	this.wiki = typeof rlWiki !== 'undefined' ? rlWiki
	          : null;

	this.portletLink = "";
	this.optionsLink = "";
	
	this.messages = {
		'appname': "reFill",
		'heading-options': "Options",
		'label-fixpage': "Fix page",
		'label-gadgetoptions': "(options)"
	};
	
	this.messagesLoaded = false;
	this.suppressConsole = false;
	
	this.log = function( message ) {
		if ( !this.suppressConsole ) {
			console.log( "Reflinks: " + message );
		}
	}
	
	this.isWatching = function() {
		// Let's use a little hack to determine whether the current page is watched or not
		if ( $( "#ca-unwatch" ).length !== 0 ) {
			return true;
		} else {
			return false;
		}
	}
	
	this.getSubmitUrl = function( defaults, server = this.server ) {
		var pagename = mw.config.get( "wgPageName" );
		var url = server + "/result.php?page=" + encodeURIComponent( pagename );
		if ( defaults ) {
			url += "&defaults=y";
		}
		if ( !this.isWatching() ) {
			url += "&nowatch=y";
		}
		if ( this.wiki !== null ) {
			url += "&wiki=" + encodeURIComponent( this.wiki );
		}
		return url;
	}
	
	this.msg = function( key ) {
		if ( !this.messagesLoaded ) {
			this.loadMessages( false );
		}
		// Even if it's "unloaded", we still have an incomplete set of English messages
		if ( this.messages.hasOwnProperty( key ) ) {
			return this.messages[key];
		} else {
			this.log( "Message not found: " + key );
			return "[" + key + "]";
		}
	}
	
	this.loadMessages = function( forceReload ) {
		var ts;

		try {
			ts = localStorage.getItem( "reflinks-messagests" );
		} catch (e) {
			// LocalStorage can be unavailable for many reasons (full, privacy mode etc)
			// Ignore such exceptions
		}

		if ( !ts || ts < (new Date).getTime() - 259200000 || forceReload ) { // older than 3 days
			this.log( "Loading messages from API" );
			var obj = this;
			$.getJSON( this.server + "/api.php?action=i18n&callback=?", function( data ) {
				obj.messages = data;
				obj.messagesLoaded = true;
				try {
					localStorage.setItem( "reflinks-messages", JSON.stringify( data ) );
					localStorage.setItem( "reflinks-messagests", (new Date).getTime() );
				} catch (e) {
				}
			} );
		} else if ( ts ) { // Cache exists
			this.log( "Loading messages from cache @ " + ts );
			this.messages = JSON.parse( localStorage.getItem( "reflinks-messages" ) );
			this.messagesLoaded = true;
		}
	}
	
	this.setUpForm = function() {
		this.tearDownForm();
		var formControls = 
		$( "#mw-content-text" ).prepend(
			$( "<div>" ).attr( "id", "reflinks" ).attr( "style", "border: 1px solid #ccc; border-radius: 2px; margin: 5px; padding: 0 10px 10px 10px;" ).prepend(
				$( "<h2>" ).text( this.msg( "heading-options" ) ),
				$( "<form>" ).attr( "id", "reflinks-form" ).attr( "method", "post" ).prepend(
					$( "<div>" ).attr( "id", "reflinks-options" ).text( this.msg( "loadingoptions" ) ),
					$( "<button>" ).addClass( "mw-ui-button mw-ui-progressive" ).text( this.msg( "label-fixpage" ) ),
					$( "<a>" ).addClass( "mw-ui-button mw-ui-quiet" ).attr( "href", this.server ).text( this.msg( "label-homepage" ) )
				)
			)
		);
		/*
		$( "#mw-content-text" ).prepend( "\
		<div id='reflinks' style='border: 1px solid #ccc; border-radius: 2px; margin: 5px; padding: 0 10px 10px 10px;'>\
			<h2>Options</h1>\
			<form id='reflinks-form' method='post'>\
				<div id='reflinks-options'>Loading options...</div>\
				<input name='method-wiki' type='submit' value='Fix page'/>\
				<a href='" + this.server + "' style='color: #555;'>Tool homepage</a>\
			</form>\
		</div>" );*/
		$( "#reflinks-form" ).attr( "action", this.getSubmitUrl( false ) );
		if ( !this.isWatching() ) {
			var nowatch = $( "<input>" ).attr( "name", "nowatch" ).attr( "type", "hidden" ).val( "y" );
			$( "#reflinks-form" ).append( nowatch );
		}
		$( "html, body" ).animate( {
			scrollTop: $( "#reflinks" ).offset().top - 10
		}, 250 );
	}
	
	this.loadRemoteOptions = function() {
		$.getJSON( this.server + "/api.php?action=optionsform&callback=?", function ( json ) {
			$( "#reflinks-options" ).html( json.form );
		} );
	}
	
	this.tearDownForm = function() {
		$( "#reflinks" ).remove();
	}
	
	this.init = function() {
		this.loadMessages( false );
		if ( this.wiki === "en" ) {
			var r2portlet = mw.util.addPortletLink( "p-tb", this.getSubmitUrl( true, this.server2 ), "reFill 2", "t-refill2" );
			$( r2portlet ).append( ' ', $( "<sup>" ).html( "New!" ) );
			console.log('Promoting reFill 2');
		}
		this.portletLink = mw.util.addPortletLink( "p-tb", this.getSubmitUrl( true ), this.msg( "appname" ), "t-reflinks" );
		var obj = this;
		var optionsText = this.wiki === 'en' ? '(o)' : this.msg( "label-gadgetoptions" );
		this.optionsLink = $( "<a>" ).attr( "href", "#" ).text( optionsText ).click( function() {
			obj.setUpForm();
			obj.loadRemoteOptions();
			obj.loadMessages( true );
		} );
		$( this.portletLink ).append( $( "<sup>").html( this.optionsLink ) );
	}
}

// Let's put it in global scope for easy debugging
var rlGadget = new ReflinksGadget();
mw.loader.using( 'mediawiki.util' ).then( function () {
	rlGadget.init();
} );