com.graphhopper.util.TranslationMap Maven / Gradle / Ivy
Show all versions of graphhopper-core Show documentation
/*
* Licensed to GraphHopper GmbH under one or more contributor
* license agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* GraphHopper GmbH licenses this file to you 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.
*/
package com.graphhopper.util;
import java.io.*;
import java.util.*;
import java.util.Map.Entry;
import static com.graphhopper.util.Helper.*;
/**
* A class which manages the translations in-memory. See here for more information:
* ./docs/core/translations.md
*
*
* @author Peter Karich
*/
public class TranslationMap {
// ISO codes (639-1), use 'en_US' as reference
private static final List LOCALES = Arrays.asList("ar", "ast", "bg", "bn_BN", "ca",
"cs_CZ", "da_DK", "de_DE", "el", "eo", "es", "en_US", "fa", "fil", "fi",
"fr_FR", "fr_CH", "gl", "he", "hr_HR", "hsb", "hu_HU", "in_ID", "it", "ja", "ko",
"kz", "lt_LT", "nb_NO", "ne", "nl", "pl_PL", "pt_BR", "pt_PT", "ro", "ru", "sk",
"sl_SI", "sr_RS", "sv_SE", "tr", "uk", "uz", "vi_VN", "zh_CN", "zh_HK", "zh_TW");
private final Map translations = new HashMap<>();
public static int countOccurence(String phrase, String splitter) {
if (isEmpty(phrase))
return 0;
return phrase.trim().split(splitter).length;
}
/**
* This loads the translation files from the specified folder.
*/
public TranslationMap doImport(File folder) {
try {
for (String locale : LOCALES) {
TranslationHashMap trMap = new TranslationHashMap(getLocale(locale));
trMap.doImport(new FileInputStream(new File(folder, locale + ".txt")));
add(trMap);
}
postImportHook();
return this;
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
/**
* This loads the translation files from classpath.
*/
public TranslationMap doImport() {
try {
for (String locale : LOCALES) {
TranslationHashMap trMap = new TranslationHashMap(getLocale(locale));
trMap.doImport(TranslationMap.class.getResourceAsStream(locale + ".txt"));
add(trMap);
}
postImportHook();
return this;
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
public void add(Translation tr) {
Locale locale = tr.getLocale();
translations.put(locale.toString(), tr);
if (!locale.getCountry().isEmpty() && !translations.containsKey(tr.getLanguage()))
translations.put(tr.getLanguage(), tr);
// Hebrew locale was "iw" in old JDKs but is now he
// required in old JDKs:
if ("iw".equals(locale.getLanguage())) translations.put("he", tr);
// required since jdk17 to still provide translation for "iw":
if ("he".equals(locale.getLanguage())) translations.put("iw", tr);
// Indonesia locale was "in_ID" in old JDKs but is now id_ID
// required in old JDKs:
if ("in".equals(locale.getLanguage())) translations.put("id", tr);
// required since jdk17 to still provide translation for "in":
if ("id".equals(locale.getLanguage())) translations.put("in", tr);
// Indian locales are: en-IN and hi-IN and are not overwritten by that
}
/**
* Returns the Translation object for the specified locale and falls back to English if the
* locale was not found.
*/
public Translation getWithFallBack(Locale locale) {
Translation tr = get(locale.toString());
if (tr == null) {
tr = get(locale.getLanguage());
if (tr == null)
tr = get("en");
}
return tr;
}
/**
* Returns the Translation object for the specified locale and returns null if not found.
*/
public Translation get(String locale) {
locale = locale.replace("-", "_");
Translation tr = translations.get(locale);
if (locale.contains("_") && tr == null)
tr = translations.get(locale.substring(0, 2));
return tr;
}
/**
* This method does some checks and fills missing translation from en
*/
private void postImportHook() {
Map enMap = get("en").asMap();
StringBuilder sb = new StringBuilder();
for (Translation tr : translations.values()) {
Map trMap = tr.asMap();
for (Entry enEntry : enMap.entrySet()) {
String value = trMap.get(enEntry.getKey());
if (isEmpty(value)) {
trMap.put(enEntry.getKey(), enEntry.getValue());
continue;
}
int expectedCount = countOccurence(enEntry.getValue(), "\\%");
if (expectedCount != countOccurence(value, "\\%")) {
sb.append(tr.getLocale()).append(" - error in ").
append(enEntry.getKey()).append("->").
append(value).append("\n");
} else {
// try if formatting works, many times e.g. '%1$' instead of '%1$s'
Object[] strs = new String[expectedCount];
Arrays.fill(strs, "tmp");
try {
String.format(Locale.ROOT, value, strs);
} catch (Exception ex) {
sb.append(tr.getLocale()).append(" - error ").append(ex.getMessage()).append("in ").
append(enEntry.getKey()).append("->").
append(value).append("\n");
}
}
}
}
if (sb.length() > 0) {
System.out.println(sb);
throw new IllegalStateException(sb.toString());
}
}
@Override
public String toString() {
return translations.toString();
}
public static class TranslationHashMap implements Translation {
final Locale locale;
private final Map map = new HashMap<>();
public TranslationHashMap(Locale locale) {
this.locale = locale;
}
public void clear() {
map.clear();
}
@Override
public Locale getLocale() {
return locale;
}
@Override
public String getLanguage() {
return locale.getLanguage();
}
@Override
public String tr(String key, Object... params) {
String val = map.get(toLowerCase(key));
if (isEmpty(val))
return key;
return String.format(Locale.ROOT, val, params);
}
public TranslationHashMap put(String key, String val) {
String existing = map.put(toLowerCase(key), val);
if (existing != null)
throw new IllegalStateException("Cannot overwrite key " + key + " with " + val + ", was: " + existing);
return this;
}
@Override
public String toString() {
return map.toString();
}
@Override
public Map asMap() {
return map;
}
public TranslationHashMap doImport(InputStream is) {
if (is == null)
throw new IllegalStateException("No input stream found in class path!?");
try {
for (String line : readFile(new InputStreamReader(is, UTF_CS))) {
if (line.isEmpty() || line.startsWith("//") || line.startsWith("#"))
continue;
int index = line.indexOf('=');
if (index < 0)
continue;
String key = line.substring(0, index);
if (key.isEmpty())
throw new IllegalStateException("No key provided:" + line);
String value = line.substring(index + 1);
if (!value.isEmpty())
put(key, value);
}
} catch (IOException ex) {
throw new RuntimeException(ex);
}
return this;
}
}
}