LocaleModule.java

/**
 * Titanium SDK
 * Copyright TiDev, Inc. 04/07/2022-Present. All Rights Reserved.
 * Licensed under the terms of the Apache Public License
 * Please see the LICENSE included with this distribution for details.
 */
package ti.modules.titanium.locale;

import java.text.Collator;
import java.text.DateFormat;
import java.text.NumberFormat;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.Locale;

import org.appcelerator.kroll.KrollDict;
import org.appcelerator.kroll.KrollModule;
import org.appcelerator.kroll.annotations.Kroll;
import org.appcelerator.kroll.common.Log;
import org.appcelerator.titanium.TiApplication;
import org.appcelerator.titanium.util.TiConvert;
import org.appcelerator.titanium.util.TiLocaleManager;
import org.appcelerator.titanium.util.TiPlatformHelper;
import org.appcelerator.titanium.util.TiRHelper;

import android.os.Build;
import android.telephony.PhoneNumberUtils;

import androidx.appcompat.app.AppCompatDelegate;
import androidx.core.os.LocaleListCompat;

@Kroll.module
public class LocaleModule extends KrollModule
{
	private static final String TAG = "LocaleModule";

	public LocaleModule()
	{
		super("Locale");
	}

	@Kroll.getProperty
	public String getCurrentLanguage()
	{
		return Locale.getDefault().getLanguage();
	}

	@Kroll.getProperty
	public String getCurrentCountry()
	{
		return Locale.getDefault().getCountry();
	}

	@Kroll.getProperty
	public String getCurrentLocale()
	{
		return TiPlatformHelper.getInstance().getLocale();
	}

	@Kroll.setProperty
	public void setApplicationLocale(String locales)
	{
		if (Build.VERSION.SDK_INT >= 33) {
			LocaleListCompat appLocale = LocaleListCompat.forLanguageTags(locales);
			AppCompatDelegate.setApplicationLocales(appLocale);
		} else {
			Log.w(TAG, "Only available for Android 33 and later");
		}
	}

	@Kroll.getProperty
	public KrollDict[] getApplicationLocales()
	{
		if (Build.VERSION.SDK_INT < 33) {
			Log.w(TAG, "Only available for Android 33 and later");
			return null;
		}

		LocaleListCompat localeListCompat = AppCompatDelegate.getApplicationLocales();
		int size = localeListCompat.size();
		KrollDict[] locales = new KrollDict[size];
		for (int i = 0; i < size; i++) {
			Locale locale = localeListCompat.get(i);
			if (locale != null) {
				KrollDict localeObj = new KrollDict();
				localeObj.put("country", locale.getCountry());
				localeObj.put("iso3_country", locale.getISO3Country());
				localeObj.put("display_country", locale.getDisplayCountry());
				localeObj.put("language", locale.getLanguage());
				localeObj.put("iso3_language", locale.getISO3Language());
				localeObj.put("display_language", locale.getDisplayLanguage());
				localeObj.put("variant", locale.getVariant());
				localeObj.put("display_variant", locale.getDisplayVariant());
				localeObj.put("script", locale.getScript());
				localeObj.put("display_script", locale.getDisplayScript());
				localeObj.put("display_name", locale.getDisplayName());
				localeObj.put("language_tag", locale.toLanguageTag());
				Character[] extensionKeys = new Character[locale.getExtensionKeys().size()];
				String[] extensions = new String[locale.getExtensionKeys().size()];
				Iterator<Character> extensionKeysSize = locale.getExtensionKeys().iterator();
				int l = 0;
				while (extensionKeysSize.hasNext()) {
					extensionKeys[l] = extensionKeysSize.next();
					extensions[l] = locale.getExtension(extensionKeys[l]);
					l++;
				}
				localeObj.put("extension_keys", extensionKeys);
				localeObj.put("extensions", extensions);
				locales[i] = localeObj;
			} else {
				locales[i] = null;
			}
		}
		return locales;
	}

	@Kroll.method
	public String getCurrencyCode(String localeString)
	{
		if (localeString == null) {
			return null;
		}
		Locale locale = TiPlatformHelper.getInstance().getLocale(localeString);
		return TiPlatformHelper.getInstance().getCurrencyCode(locale);
	}

	@Kroll.method
	public String getCurrencySymbol(String currencyCode)
	{
		return TiPlatformHelper.getInstance().getCurrencySymbol(currencyCode);
	}

	@Kroll.method
	public String getLocaleCurrencySymbol(String localeString)
	{
		if (localeString == null) {
			return null;
		}
		Locale locale = TiPlatformHelper.getInstance().getLocale(localeString);
		return TiPlatformHelper.getInstance().getCurrencySymbol(locale);
	}

	/**
	 * Undocumented method used to implement the JavaScript Intl.getCanonicalLocales() static method.
	 * @param locales
	 * Can be a string or array of strings providing locale IDs to convert to canonical locale IDs. Can be null.
	 * @return
	 * Returns the given locale string IDs converted to "canonical" string IDs. Duplicate locales are removed.
	 * Returns an empty array if given locales are invalid/unsupported or if given a null locales argument.
	 */
	@Kroll.method
	public String[] getCanonicalLocales(@Kroll.argument(optional = true) Object locales)
	{
		String[] requestedLocaleStrings = getLocaleStringArrayFrom(locales);
		ArrayList<String> canonicalLocaleStrings = new ArrayList<>(requestedLocaleStrings.length);
		for (String nextLocaleString : requestedLocaleStrings) {
			Locale locale = TiPlatformHelper.getInstance().getLocale(nextLocaleString);
			if (locale != null) {
				String canonicalString = locale.toString().replace('_', '-');
				if (!canonicalLocaleStrings.contains(canonicalString)) {
					canonicalLocaleStrings.add(canonicalString);
				}
			}
		}
		return canonicalLocaleStrings.toArray(new String[0]);
	}

	/**
	 * Undocumented method used to implement the JavaScript Intl.Collator.supportedLocalesOf() static method.
	 * @param locales Can be a string or array of strings providing the locale IDs to search for. Can be null.
	 * @param options The Intl.Collator.supportedLocalesOf() argument. Currently ignored.
	 * @return
	 * Returns a subset of locale IDs from the given argument that are supported by the system.
	 * Returns an empty array if none of the locales are supported or if given a null locales argument.
	 */
	@Kroll.method
	public String[] getSupportedCollatorLocales(Object locales, @Kroll.argument(optional = true) String options)
	{
		String[] requestedLocaleStrings = getLocaleStringArrayFrom(locales);
		Locale[] availableLocales = Collator.getAvailableLocales();
		return getSupportedFormatLocales(requestedLocaleStrings, availableLocales);
	}

	/**
	 * Undocumented method used to implement the JavaScript Intl.DateTimeFormat.supportedLocalesOf() static method.
	 * @param locales Can be a string or array of strings providing the locale IDs to search for. Can be null.
	 * @param options The Intl.DateTimeFormat.supportedLocalesOf() argument. Currently ignored.
	 * @return
	 * Returns a subset of locale IDs from the given argument that are supported by the system.
	 * Returns an empty array if none of the locales are supported or if given a null locales argument.
	 */
	@Kroll.method
	public String[] getSupportedDateTimeFormatLocales(Object locales, @Kroll.argument(optional = true) String options)
	{
		String[] requestedLocaleStrings = getLocaleStringArrayFrom(locales);
		Locale[] availableLocales = DateFormat.getAvailableLocales();
		return getSupportedFormatLocales(requestedLocaleStrings, availableLocales);
	}

	/**
	 * Undocumented method used to implement the JavaScript Intl.NumberFormat.supportedLocalesOf() static method.
	 * @param locales Can be a string or array of strings providing the locale IDs to search for. Can be null.
	 * @param options The Intl.NumberFormat.supportedLocalesOf() argument. Currently ignored.
	 * @return
	 * Returns a subset of locale IDs from the given argument that are supported by the system.
	 * Returns an empty array if none of the locales are supported or if given a null locales argument.
	 */
	@Kroll.method
	public String[] getSupportedNumberFormatLocales(Object locales, @Kroll.argument(optional = true) String options)
	{
		String[] requestedLocaleStrings = getLocaleStringArrayFrom(locales);
		Locale[] availableLocales = NumberFormat.getAvailableLocales();
		return getSupportedFormatLocales(requestedLocaleStrings, availableLocales);
	}

	@SuppressWarnings("deprecation")
	@Kroll.method
	public String formatTelephoneNumber(String telephoneNumber)
	{
		return PhoneNumberUtils.formatNumber(telephoneNumber);
	}

	@Kroll.method
	public double parseDecimal(String text, @Kroll.argument(optional = true) String localeString)
	{
		double result = Double.NaN;
		try {
			// Create a number format parser using given locale if provided or current locale.
			Locale locale = TiPlatformHelper.getInstance().getLocale(localeString);
			NumberFormat numberFormat;
			if (locale != null) {
				numberFormat = NumberFormat.getInstance(locale);
			} else {
				numberFormat = NumberFormat.getInstance();
			}

			// Enable thousands separator parsing support. (ex: "1,234,567")
			numberFormat.setGroupingUsed(true);

			// Remove leading spaces and plus sign. Number format will fail to parse if there.
			text = text.trim();
			if ((text != null) && text.startsWith("+")) {
				text = text.substring(1);
			}

			// Attempt to parse a decimal value from given string.
			Number number = numberFormat.parse(text);
			if (number != null) {
				result = number.doubleValue();
			}
		} catch (Exception ex) {
		}
		return result;
	}

	@Kroll.method
	public String makeLowerCase(String text, @Kroll.argument(optional = true) Object locales)
	{
		if (text == null) {
			return null;
		}
		Locale locale = getLocaleFrom(locales, Locale.getDefault());
		return text.toLowerCase(locale);
	}

	@Kroll.method
	public String makeUpperCase(String text, @Kroll.argument(optional = true) Object locales)
	{
		if (text == null) {
			return null;
		}
		Locale locale = getLocaleFrom(locales, Locale.getDefault());
		return text.toUpperCase(locale);
	}

	@Kroll.method
	@Kroll.setProperty
	public void setLanguage(String language)
	{
		try {
			String[] parts = language.split("-");
			Locale locale = null;

			if (parts.length > 1) {
				locale = new Locale(parts[0], parts[1]);
			} else {
				locale = new Locale(parts[0]);
			}

			TiLocaleManager.setLocale(locale);

		} catch (Exception e) {
			Log.e(TAG, "Error trying to set language '" + language + "':", e);
		}
	}

	@Kroll.method
	@Kroll.topLevel("L")
	public String getString(String key, @Kroll.argument(optional = true) String defaultValue)
	{
		if (defaultValue == null) {
			defaultValue = key;
		}

		try {
			int resid = TiRHelper.getResource("string." + key.replace(".", "_"));
			if (resid != 0) {
				return TiApplication.getInstance().getString(resid);
			} else {
				return defaultValue;
			}
		} catch (TiRHelper.ResourceNotFoundException e) {
			Log.d(TAG, "Resource string with key '" + key + "' not found.  Returning default value.", Log.DEBUG_MODE);
			return defaultValue;
		} catch (Exception e) {
			Log.e(TAG, "Error trying to get resource string with key '" + key + "':", e);
			return defaultValue;
		}
	}

	private Locale getLocaleFrom(Object value, Locale defaultLocale)
	{
		String localeName = null;
		if (value instanceof String) {
			localeName = (String) value;
		} else if ((value != null) && value.getClass().isArray()) {
			String[] stringArray = TiConvert.toStringArray((Object[]) value);
			if (stringArray.length > 0) {
				localeName = stringArray[0];
			}
		}

		Locale locale = TiPlatformHelper.getInstance().getLocale(localeName);
		return (locale != null) ? locale : defaultLocale;
	}

	private String[] getLocaleStringArrayFrom(Object value)
	{
		String[] stringArray = null;
		if (value instanceof String) {
			stringArray = new String[] { (String) value };
		} else if ((value != null) && value.getClass().isArray()) {
			stringArray = TiConvert.toStringArray((Object[]) value);
		}
		if (stringArray == null) {
			return new String[] {};
		}
		return stringArray;
	}

	private String[] getSupportedFormatLocales(String[] requestedLocaleStrings, Locale[] availableLocales)
	{
		// Validate arguments.
		if ((requestedLocaleStrings == null) || (availableLocales == null)) {
			return new String[0];
		}

		// Create a list of all requested locales contained in the available locale list.
		ArrayList<String> supportedLocaleStrings = new ArrayList<>(32);
		for (String nextLocaleString : requestedLocaleStrings) {
			Locale requestedLocale = TiPlatformHelper.getInstance().getLocale(nextLocaleString);
			for (Locale nextAvailableLocale : availableLocales) {
				if (requestedLocale.equals(nextAvailableLocale)) {
					supportedLocaleStrings.add(nextLocaleString);
					break;
				}
			}
		}

		// Return an array of locale string IDs supported.
		return supportedLocaleStrings.toArray(new String[0]);
	}

	@Override
	public String getApiName()
	{
		return "Ti.Locale";
	}
}