SessionlessTranslationManager.java
/*
** Module : SessionlessTranslationManager.java
** Abstract : Translation manager for the FWD server when no client session available.
**
** Copyright (c) 2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ------------------------------------Description-------------------------------------------
** 001 GBB 20230915 Created the first version.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.translation;
import com.goldencode.p2j.util.*;
import com.goldencode.p2j.util.logging.*;
import java.io.*;
import java.util.*;
import java.util.stream.*;
/** Translation manager for the FWD runtime */
public class SessionlessTranslationManager
{
/** Current languages set in directory */
public static final String CURRENT_LANGUAGES_CONFIG;
/** Current languages set in directory */
private static final List<String> CURRENT_LANGUAGES;
/** Default directory with translation resources, found in classpath */
private static final String DEFAULT_TRANSLATIONS_DIR =
"/" + SessionlessTranslationManager.class.getPackage().getName().replace('.', '/') + "/";
/** Custom package directory with translation resources, found in classpath */
private static final String CUSTOM_TRANSLATIONS_DIR = Utils.getLegacyPkgRootAsJarPath() + "translation/";
/** Logger */
private static final CentralLogger LOG = CentralLogger.get(SessionlessTranslationManager.class);
/** Locale / Language map to the corresponding bundles with translated texts */
private Map<String, ResourceBundle> translationsBundles = new HashMap<>();
/** Default language translations bundle */
private ResourceBundle defaultTranslationsBundle;
/** Bundle name */
private String bundleName;
static
{
CURRENT_LANGUAGES_CONFIG = Utils.getDirectoryNodeString(null, "currentLanguage", null);
CURRENT_LANGUAGES = CURRENT_LANGUAGES_CONFIG == null ? new ArrayList<>() :
Arrays.stream(CURRENT_LANGUAGES_CONFIG.split(","))
.map(String::trim)
.collect(Collectors.toList());
}
/**
* Public constructor for RuntimeTranslationManager.
*
* @param bundleName
* The name of the bundle.
*/
public SessionlessTranslationManager(String bundleName)
{
this.bundleName = bundleName;
defaultTranslationsBundle = loadBundle(bundleName);
}
/**
* Getter for {@link #CURRENT_LANGUAGES}
*
* @return See above.
*/
public static List<String> getCurrentLanguages()
{
return CURRENT_LANGUAGES;
}
/**
* Returns the translated text.
*
* @param key
* The key to find translated text for.
*
* @return See above.
*/
public String translate(String key)
{
String translatedText = null;
ResourceBundle bundle = null;
// TODO: accept requestedLang as an arg
// TODO: map the locale from request.getHeader(HttpHeader.ACCEPT_LANGUAGE.asString()) to
// currentLanguage from directory
String requestedLang = CURRENT_LANGUAGES.size() > 0 ? CURRENT_LANGUAGES.get(0) : null;
if (CURRENT_LANGUAGES.contains(requestedLang))
{
if (!translationsBundles.containsKey(requestedLang))
{
translationsBundles.put(requestedLang, loadBundle(bundleName + "_" + requestedLang));
}
bundle = translationsBundles.get(requestedLang);
}
if (bundle != null)
{
try
{
translatedText = bundle.getString(key);
}
catch (Throwable ignored)
{
}
}
if (defaultTranslationsBundle != null && translatedText == null)
{
try
{
translatedText = defaultTranslationsBundle.getString(key);
}
catch (Throwable ignored)
{
}
}
return translatedText == null ? key : translatedText;
}
/**
* Returns the loaded bundle.
*
* @param bundleName
* The name of the bundle to load.
*
* @return See above.
*/
private ResourceBundle loadBundle(String bundleName)
{
try
{
InputStream inputStream = getClass().getResourceAsStream(
CUSTOM_TRANSLATIONS_DIR + bundleName + ".properties");
if (inputStream == null)
{
inputStream = getClass().getResourceAsStream(
DEFAULT_TRANSLATIONS_DIR + bundleName + ".properties");
}
return new PropertyResourceBundle(inputStream);
}
catch (Throwable e)
{
LOG.warning("Can't load translations bundle " + bundleName);
}
return null;
}
}