mediawiki-extensions-UniversalLanguageSelector/resources/js/ext.uls.ime.js

/**
 * ULS - jQuery IME integration
 *
 * Copyright (C) 2012 Alolita Sharma, Amir Aharoni, Arun Ganesh, Brandon Harris,
 * Niklas Laxström, Pau Giner, Santhosh Thottingal, Siebrand Mazeland and other
 * contributors. See CREDITS for a list.
 *
 * UniversalLanguageSelector is dual licensed GPLv2 or later and MIT. You don't
 * have to do anything special to choose one license or the other and you don't
 * have to notify anyone which license you are using. You are free to use
 * UniversalLanguageSelector in commercial projects as long as the copyright
 * header is left intact. See files GPL-LICENSE and MIT-LICENSE for details.
 *
 * @file
 * @ingroup Extensions
 * @licence GNU General Public Licence 2.0 or later
 * @licence MIT License
 */
( function ( $, mw, document, undefined ) {
	'use strict';

	var mwImeRulesPath, inputSelector, inputPreferences, ulsIMEPreferences, customHelpLink;

	mwImeRulesPath = mw.config.get( 'wgExtensionAssetsPath' ) +
		'/UniversalLanguageSelector/lib/jquery.ime/';
	inputSelector = 'input:not([type]), input[type=text], input[type=search], textarea';

	inputPreferences = mw.uls.preferences();

	mw.ime = mw.ime || {};

	mw.ime.getLanguagesWithIME = function () {
		var language,
			availableLanguages = {};

		for ( language in $.ime.languages ) {
			availableLanguages[language] = mw.config.get( 'wgULSLanguages' )[language];
		}

		return availableLanguages;
	};

	mw.ime.getIMELanguageList = function () {
		var unique = [],
			imeLanguageList,
			previousIMELanguages;

		previousIMELanguages = $.ime.preferences.getPreviousLanguages() || [];
		imeLanguageList = previousIMELanguages.concat( mw.uls.getFrequentLanguageList() );

		$.each( imeLanguageList, function ( i, v ) {
			if ( $.inArray( v, unique ) === -1 ) {
				unique.push( v );
			}
		} );

		return unique.slice( 0, 6 );
	};

	ulsIMEPreferences = {

		save: function ( callback ) {
			if ( !this.registry.isDirty ) {
				if ( callback ) {
					callback.call( this, true );
				}

				return;
			}

			inputPreferences.set( 'ime', this.registry );
			inputPreferences.save( callback );
			// reset the dirty bit
			this.registry.isDirty = false;
		},

		load: function () {
			this.registry = inputPreferences.get( 'ime' ) || this.registry;
		},

		disable: function () {
			this.registry.isDirty = true;
			this.registry.enable = false;
			mw.uls.logEvent( { action: 'ime-disable' } );
		},

		enable: function () {
			this.registry.isDirty = true;
			this.registry.enable = true;
			mw.uls.logEvent( { action: 'ime-enable' } );
		},

		isEnabled: function () {
			if ( this.registry.enable === undefined ) {
				return mw.config.get( 'wgULSIMEEnabled' );
			} else {
				return this.registry.enable;
			}
		},

		getDefaultLanguage: function () {
			return mw.config.get( 'wgContentLanguage' );
		}
	};

	// Add a 'more settings' link that takes to input settings of ULS
	customHelpLink = function () {
		var $disableInputToolsLink, $moreSettingsLink,
			imeselector = this;

		$disableInputToolsLink = $( '<span>' )
			.addClass( 'uls-ime-disable-link' )
			.attr( 'data-i18n', 'ext-uls-input-disable' );

		$moreSettingsLink = $( '<span>' )
			.addClass( 'uls-ime-more-settings-link' );

		mw.loader.using( mw.uls.languageSettingsModules, function () {
			$moreSettingsLink.languagesettings( {
				defaultModule: 'input',
				onClose: function () {
					// on close of input settings, keep focus in input area.
					imeselector.$element.focus();
				},
				top: imeselector.$element.offset().top
			} );
		} );

		// Hide the menu.
		$moreSettingsLink.on( 'click', function ( e ) {
			var languageSettings = $( this ).data( 'languagesettings' );
			imeselector.hide();
			if ( !languageSettings ) {
				$( this ).languagesettings( {
					defaultModule: 'input',
					onClose: function () {
						// on close of input settings, keep focus in input area.
						imeselector.$element.focus();
					},
					top: imeselector.$element.offset().top
				} ).click();
			}
			e.stopPropagation();
		} );

		$disableInputToolsLink.i18n();

		$disableInputToolsLink.on( 'click', function ( e ) {
			$.ime.preferences.disable();
			imeselector.hide();
			imeselector.$imeSetting.hide();
			$.ime.preferences.save( function () {
				mw.ime.disable();
				imeNotification();
			} );
			e.stopPropagation();
		} );

		// apply fonts to this
		imeselector.$menu.webfonts();
		return $( '<div>' )
			.addClass( 'uls-ime-menu-settings-item' )
			.append( $disableInputToolsLink, $moreSettingsLink );
	};

	mw.ime.disable = function () {
		$( inputSelector ).trigger( 'destroy.ime' );
	};

	mw.ime.init = function () {
		if ( !$.ime ) {
			// jquery.ime not loaded yet.
			return;
		}
		if ( $.ime.preferences.isEnabled ) {
			// mw.ime already initialized.
			return;
		}
		// Extend the ime preference system
		$.extend( $.ime.preferences, ulsIMEPreferences );
		// MediaWiki specific overrides for jquery.ime
		$.extend( $.ime.defaults, {
			imePath: mwImeRulesPath
		} );
		// Load the ime preferences
		$.ime.preferences.load();
		$.fn.imeselector.Constructor.prototype.helpLink = customHelpLink;
	};

	mw.ime.setup = function () {
		mw.ime.init();
		$( 'body' ).on( 'focus.ime', inputSelector, function () {
			var imeselector, $input, noImeSelector;

			noImeSelector = mw.config.get( 'wgULSNoImeSelectors' ).join( ', ' );
			$input = $( this );

			if ( !$.ime ) {
				mw.loader.using( 'jquery.ime', function () {
					$input.trigger( 'focus.ime' );
				} );
				return;
			}

			mw.ime.init();

			if ( $input.is( '.noime' ) || !$.ime.preferences.isEnabled() ) {
				return;
			}

			if ( noImeSelector.length && $input.is( noImeSelector ) ) {
				$input.addClass( 'noime' );
				return;
			}

			$input.ime( {
				languages: mw.ime.getIMELanguageList(),
				languageSelector: function () {
					var $ulsTrigger;

					$ulsTrigger = $( '<a>' ).text( '...' )
						.addClass( 'ime-selector-more-languages selectable-row selectable-row-item' )
						.attr( {
							title: $.i18n( 'ext-uls-input-settings-more-languages-tooltip' )
						} );
					$ulsTrigger.uls( {
						onSelect: function ( language ) {
							$input.data( 'imeselector' ).selectLanguage( language );
							$input.focus();
						},
						lazyload: false,
						languages: mw.ime.getLanguagesWithIME()
					} );

					return $ulsTrigger;
				},
				helpHandler: function ( ime ) {
					return $( '<a>' )
						.attr( {
							href: mw.msg( 'uls-ime-helppage' ).replace( '$1', ime ),
							target: '_blank',
							title: $.i18n( 'ext-uls-ime-help' )
						} )
						.addClass( 'ime-perime-help' )
						.click( function ( event ) {
							event.stopPropagation();
						} );
				}
			} );

			// Some fields may be uninitialized
			imeselector = $input.data( 'imeselector' );
			if ( imeselector ) {
				imeselector.selectLanguage( $.ime.preferences.getLanguage() );
			}
		} );

	};

	$( document ).ready( function () {
		mw.uls.init( function () {
			mw.ime.setup();
		} );
	} );

	function imeNotification () {
		var notificationMsg = ( mw.config.get( 'wgULSPosition' ) === 'personal' ) ?
				'ext-uls-input-disable-notification-info-personal' :
				'ext-uls-input-disable-notification-info-interlanguage',
			$notification = $( '<div>' )
			.addClass( 'uls-ime-notification-bubble' )
			.append(
				$( '<div>' )
					.attr( 'data-i18n', 'ext-uls-input-disable-notification' ),
				$( '<div>' )
					.addClass( 'link' )
					.attr( 'data-i18n', 'ext-uls-input-disable-notification-undo' )
					.on( 'click', function() {
						$.ime.preferences.enable();
						$.ime.preferences.save( function () {
							mw.ime.setup();
						} );
					} ),
				$( '<div>' ).attr( 'data-i18n', notificationMsg )
			);

		mw.notify( $notification.i18n() );
	}

}( jQuery, mediaWiki, document ) );