Introduce Api for loading jquery.i18n json files

To avoid CORS issue with old browsers

Bug: 45958
Change-Id: I37638e06f21ab573c9ce37a4e9fb20bc763ac98f

UniversalLanguageSelector.php

@@ -19,7 +19,7 @@
  */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
-	echo( "This file is an extension to the MediaWiki software and cannot be used standalone.\n" );
+	echo "This file is an extension to the MediaWiki software and cannot be used standalone.\n";
 	die( -1 );
 }
 /**
@@ -125,6 +125,7 @@ $wgExtensionMessagesFiles['UniversalLanguageSelector'] = "$dir/UniversalLanguage
 $wgAutoloadClasses['UniversalLanguageSelectorHooks'] = "$dir/UniversalLanguageSelector.hooks.php";
 $wgAutoloadClasses['ResourceLoaderULSModule'] = "$dir/ResourceLoaderULSModule.php";
 $wgAutoloadClasses['ApiLanguageSearch'] = "$dir/api/ApiLanguageSearch.php";
+$wgAutoloadClasses['ApiULSLocalization'] = "$dir/api/ApiULSLocalization.php";
 $wgAutoloadClasses['LanguageNameSearch'] = "$dir/data/LanguageNameSearch.php";
 
 $wgHooks['BeforePageDisplay'][] = 'UniversalLanguageSelectorHooks::addModules';
@@ -133,6 +134,7 @@ $wgHooks['ResourceLoaderTestModules'][] = 'UniversalLanguageSelectorHooks::addTe
 $wgHooks['ResourceLoaderGetConfigVars'][] = 'UniversalLanguageSelectorHooks::addConfig';
 $wgHooks['MakeGlobalVariablesScript'][] = 'UniversalLanguageSelectorHooks::addVariables';
 $wgAPIModules['languagesearch'] = 'ApiLanguageSearch';
+$wgAPIModules['ulslocalization'] = 'ApiULSLocalization';
 $wgHooks['UserGetLanguageObject'][] = 'UniversalLanguageSelectorHooks::getLanguage';
 $wgHooks['SkinTemplateOutputPageBeforeExec'][] = 'UniversalLanguageSelectorHooks::onSkinTemplateOutputPageBeforeExec';
 
@@ -152,4 +154,4 @@ $wgExtensionFunctions[] = function() {
 	return true;
 };
 
-require( "$dir/Resources.php" );
+require "$dir/Resources.php";

api/ApiULSLocalization.php

@@ -0,0 +1,98 @@
+<?php
+/**
+ * Localization API for ULS
+ *
+ * Copyright (C) 2013 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
+ */
+
+/**
+ * @ingroup API
+ */
+class ApiULSLocalization extends ApiBase {
+
+	public function execute() {
+		$this->getMain()->setCacheMode( 'public' );
+		$this->getMain()->setCacheMaxAge( 300 );
+
+		$params = $this->extractRequestParams();
+		$language = $params['language'];
+		$namespace = $params['namespace'];
+		if ( !Language::isValidCode( $language ) )  {
+			$this->dieUsage( 'Invalid language', 'invalidlanguage' );
+		}
+
+		if ( $namespace === 'uls' ) {
+			$filename = "lib/jquery.uls/i18n/$language.json";
+		} else {
+			$filename = "i18n/$language.json";
+		}
+
+		$localPath = __DIR__ . "/../$filename";
+		if ( !file_exists( $localPath ) ) {
+			$this->getResult()->addValue( null, 'text', '{}' );
+			$this->getResult()->addValue( null, 'mime', 'text/json' );
+		} else {
+			$contents = file_get_contents( $localPath );
+			// Output the file's contents raw
+			$this->getResult()->addValue( null, 'text', $contents );
+			$this->getResult()->addValue( null, 'mime', 'text/json' );
+		}
+	}
+
+	public function getCustomPrinter() {
+		return new ApiFormatRaw(
+			$this->getMain(),
+			$this->getMain()->createPrinterByName( 'json' )
+		);
+	}
+
+	public function getAllowedParams() {
+		return array(
+			'language' => array(
+				ApiBase::PARAM_REQUIRED => true,
+				ApiBase::PARAM_TYPE => 'string',
+			),
+			'namespace' => array(
+				ApiBase::PARAM_TYPE => 'string',
+				ApiBase::PARAM_REQUIRED => false,
+				ApiBase::PARAM_DFLT => 'ext-uls',
+			),
+		);
+	}
+
+	public function getParamDescription() {
+		return array(
+			'language' => 'Language string',
+			'namespace' => 'Namespace string.',
+		);
+	}
+
+	public function getDescription() {
+		return 'Get the localization of ULS in given language';
+	}
+
+	public function getExamples() {
+		return array(
+			'api.php?action=ulslocalization&language=ta',
+			'api.php?action=ulslocalization&language=hi',
+			'api.php?action=ulslocalization&language=or&namespace=ext-uls',
+		);
+	}
+
+	public function getVersion() {
+		return __CLASS__ . ': ' . ULS_VERSION;
+	}
+}

resources/js/ext.uls.init.js

@@ -122,34 +122,25 @@
 	 * i18n initialization
 	 */
 	function i18nInit() {
-		var extensionPath, locales, i18n;
+		var jsonLoader, locales, i18n;
-		if ( window.XDomainRequest ) {
+
-			// IE8 and IE9 does not support ajax with CORS. So make sure they
+		jsonLoader = mw.util.wikiScript( 'api' ) + '?action=ulslocalization&language=';
-			// load json files from same domain ( http://bugs.jquery.com/ticket/8283 )
-			extensionPath = mw.config.get( 'wgScriptPath' ) +
-				'/extensions/UniversalLanguageSelector/';
-		} else {
-			extensionPath = mw.config.get( 'wgExtensionAssetsPath' ) +
-				'/UniversalLanguageSelector/';
-		}
 		locales = mw.config.get( 'wgULSi18nLocales' );
 		i18n = $.i18n( {
 			locale: currentLang,
 			messageLocationResolver: function ( locale, messageKey ) {
 				// Namespaces are not available in jquery.i18n yet. Developers prefix
 				// the message key with a unique namespace like ext-uls-*
-
 				if ( messageKey.indexOf( 'uls' ) === 0 ) {
 					if ( $.inArray( locale, locales.uls ) >= 0 ) {
-						return extensionPath + 'lib/jquery.uls/i18n/' + locale + '.json';
+						return jsonLoader + locale + '&namespace=uls';
 					}
 
 					return false;
 				}
-
 				if ( messageKey.indexOf( 'ext-uls' ) === 0 ) {
 					if ( $.inArray( locale, locales['ext-uls'] ) >= 0 ) {
-						return extensionPath + 'i18n/' + locale + '.json';
+						return jsonLoader + locale + '&namespace=ext-uls';
 					}
 
 					return false;