ca.uhn.fhir.i18n.HapiLocalizer Maven / Gradle / Ivy
/*
* #%L
* HAPI FHIR - Core Library
* %%
* Copyright (C) 2014 - 2024 Smile CDR, Inc.
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package ca.uhn.fhir.i18n;
import ca.uhn.fhir.context.ConfigurationException;
import ca.uhn.fhir.util.UrlUtil;
import ca.uhn.fhir.util.VersionUtil;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import static org.apache.commons.lang3.StringUtils.isBlank;
import static org.apache.commons.lang3.StringUtils.isNotBlank;
import static org.apache.commons.lang3.StringUtils.trim;
/**
* This feature is not yet in its final state and should be considered an internal part of HAPI for now - use with caution
*/
public class HapiLocalizer {
@SuppressWarnings("WeakerAccess")
public static final String UNKNOWN_I18N_KEY_MESSAGE = "!MESSAGE!";
private static final org.slf4j.Logger ourLog = org.slf4j.LoggerFactory.getLogger(HapiLocalizer.class);
private static boolean ourFailOnMissingMessage;
private final Map myKeyToMessageFormat = new ConcurrentHashMap<>();
private List myBundle;
private final Map myHardcodedMessages = new HashMap<>();
private Locale myLocale = Locale.getDefault();
public HapiLocalizer() {
this(HapiLocalizer.class.getPackage().getName() + ".hapi-messages");
}
public HapiLocalizer(String... theBundleNames) {
init(theBundleNames);
addMessage("hapi.version", VersionUtil.getVersion());
}
/**
* Subclasses may use this to add hardcoded messages
*/
@SuppressWarnings("WeakerAccess")
protected void addMessage(String theKey, String theMessage) {
myHardcodedMessages.put(theKey, theMessage);
}
public Set getAllKeys() {
HashSet retVal = new HashSet<>();
for (ResourceBundle nextBundle : myBundle) {
Enumeration keysEnum = nextBundle.getKeys();
while (keysEnum.hasMoreElements()) {
retVal.add(keysEnum.nextElement());
}
}
return retVal;
}
/**
* @return Returns the raw message format string for the given key, or returns {@link #UNKNOWN_I18N_KEY_MESSAGE} if not found
*/
@SuppressWarnings("WeakerAccess")
public String getFormatString(String theQualifiedKey) {
String formatString = myHardcodedMessages.get(theQualifiedKey);
if (isBlank(formatString)) {
for (ResourceBundle nextBundle : myBundle) {
if (nextBundle.containsKey(theQualifiedKey)) {
formatString = nextBundle.getString(theQualifiedKey);
formatString = trim(formatString);
}
if (isNotBlank(formatString)) {
break;
}
}
}
if (formatString == null) {
ourLog.warn("Unknown localization key: {}", theQualifiedKey);
if (ourFailOnMissingMessage) {
throw new ConfigurationException(Msg.code(1908) + "Unknown localization key: " + theQualifiedKey);
}
formatString = UNKNOWN_I18N_KEY_MESSAGE;
}
return formatString;
}
public String getMessage(Class theType, String theKey, Object... theParameters) {
return getMessage(toKey(theType, theKey), theParameters);
}
/**
* Create the message and sanitize parameters using {@link }
*/
public String getMessageSanitized(Class theType, String theKey, Object... theParameters) {
if (theParameters != null) {
for (int i = 0; i < theParameters.length; i++) {
if (theParameters[i] instanceof CharSequence) {
theParameters[i] = UrlUtil.sanitizeUrlPart((CharSequence) theParameters[i]);
}
}
}
return getMessage(toKey(theType, theKey), theParameters);
}
public String getMessage(String theQualifiedKey, Object... theParameters) {
if (theParameters != null && theParameters.length > 0) {
MessageFormat format = myKeyToMessageFormat.get(theQualifiedKey);
if (format != null) {
return format.format(theParameters);
}
String formatString = getFormatString(theQualifiedKey);
format = newMessageFormat(formatString);
myKeyToMessageFormat.put(theQualifiedKey, format);
return format.format(theParameters);
}
return getFormatString(theQualifiedKey);
}
MessageFormat newMessageFormat(String theFormatString) {
StringBuilder pattern = new StringBuilder(theFormatString.trim());
for (int i = 0; i < (pattern.length() - 1); i++) {
if (pattern.charAt(i) == '{') {
char nextChar = pattern.charAt(i + 1);
if (nextChar >= '0' && nextChar <= '9') {
continue;
}
pattern.replace(i, i + 1, "'{'");
int closeBraceIndex = pattern.indexOf("}", i);
if (closeBraceIndex > 0) {
i = closeBraceIndex;
pattern.replace(i, i + 1, "'}'");
}
}
}
return new MessageFormat(pattern.toString());
}
protected void init(String[] theBundleNames) {
myBundle = new ArrayList<>();
for (String nextName : theBundleNames) {
myBundle.add(ResourceBundle.getBundle(nextName));
}
}
public Locale getLocale() {
return myLocale;
}
/**
* This global setting causes the localizer to fail if any attempts
* are made to retrieve a key that does not exist. This method is primarily for
* unit tests.
*/
public static void setOurFailOnMissingMessage(boolean ourFailOnMissingMessage) {
HapiLocalizer.ourFailOnMissingMessage = ourFailOnMissingMessage;
}
public static String toKey(Class theType, String theKey) {
return theType.getName() + '.' + theKey;
}
}