libre.sh/keycloak-scim
4
0
Fork 0
Code Issues 15 Pull requests Releases 1 Activity Actions

KEYCLOAK-1933 Validate resource bundles for admin console

Browse source
This commit is contained in:
Stan Silvert 2015-10-13 18:25:14 -04:00
parent 14079b950a
commit 940c9f8bf1
1 changed files with 45 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
services/src/main/java/org/keycloak/services/resources/admin/AdminMessagesLoader.java
View file

@ -22,6 +22,7 @@ import java.util.HashMap;
import java.util.Locale; import java.util.Locale;
import java.util.Map; import java.util.Map;
import java.util.Properties; import java.util.Properties;
import org.jboss.logging.Logger;
import org.keycloak.freemarker.Theme; import org.keycloak.freemarker.Theme;
/** /**
@ -34,45 +35,73 @@ import org.keycloak.freemarker.Theme;
* @author Stan Silvert ssilvert@redhat.com (C) 2015 Red Hat Inc. * @author Stan Silvert ssilvert@redhat.com (C) 2015 Red Hat Inc.
*/ */
public class AdminMessagesLoader { public class AdminMessagesLoader {
private static final Map<String, Properties> allMessages = new HashMap<String, Properties>(); protected static final Logger logger = Logger.getLogger(AdminConsole.class);
// theme locale bundle
protected static final Map<String, Map<String, Properties>> allMessages = new HashMap<String, Map<String, Properties>>();
static Properties getMessages(Theme theme, String strLocale) throws IOException { static Properties getMessages(Theme theme, String strLocale) throws IOException {
String allMessagesKey = theme.getName() + "_" + strLocale; String themeName = theme.getName();
Properties messages = allMessages.get(allMessagesKey); Map bundlesForTheme = allMessages.get(themeName);
if (messages != null) return messages; if (bundlesForTheme == null) {
bundlesForTheme = new HashMap<String, Properties>();
allMessages.put(themeName, bundlesForTheme);
}
return findMessagesForTheme(theme, strLocale, bundlesForTheme);
}
private static Properties findMessagesForTheme(Theme theme,
String strLocale,
Map<String, Properties> bundlesForTheme) throws IOException {
Properties messages = bundlesForTheme.get(strLocale);
if (messages != null) return messages; // use cached bundle
// load bundle from theme
Locale locale = Locale.forLanguageTag(strLocale); Locale locale = Locale.forLanguageTag(strLocale);
messages = theme.getMessages("admin-messages", locale); messages = theme.getMessages("admin-messages", locale);
validateMessages(messages, strLocale); String themeName = theme.getName();
if (messages == null) throw new NullPointerException(themeName + ": Unable to find admin-messages bundle for locale=" + strLocale);
allMessages.put(allMessagesKey, messages); if (!bundlesForTheme.isEmpty()) {
// use first bundle as the standard
String standardLocale = bundlesForTheme.keySet().iterator().next();
Properties standardBundle = bundlesForTheme.get(standardLocale);
validateMessages(themeName, standardBundle, standardLocale, messages, strLocale);
}
bundlesForTheme.put(strLocale, messages);
return messages; return messages;
} }
private static void validateMessages(Properties messages, String strLocale) { private static void validateMessages(String themeName, Properties standardBundle, String standardLocale, Properties messages, String strLocale) {
if (messages == null) throw new NullPointerException("Unable to find admin-messages bundle for locale=" + strLocale);
if (allMessages.isEmpty()) return;
Properties standardBundle = allMessages.values().iterator().next();
if (standardBundle.keySet().containsAll(messages.keySet()) && if (standardBundle.keySet().containsAll(messages.keySet()) &&
(messages.keySet().containsAll(standardBundle.keySet()))) { (messages.keySet().containsAll(standardBundle.keySet()))) {
return; // it all checks out return; // it all checks out
} }
// otherwise, find the offending key // otherwise, find the offending keys
int warnCount = 0;
for (Object key : standardBundle.keySet()) { for (Object key : standardBundle.keySet()) {
if (!messages.containsKey(key)) { if (!messages.containsKey(key)) {
throw new RuntimeException("Key '" + key + "' not found in admin-messages bundle for locale=" + strLocale); logger.error(themeName + " theme: Key '" + key + "' not found in admin-messages bundle for locale=" + strLocale +
". However, this key exists in previously loaded bundle for locale=" + standardLocale);
warnCount++;
} }
if (warnCount > 4) return; // There could be lots of these. Don't fill up the log.
} }
for (Object key : messages.keySet()) { for (Object key : messages.keySet()) {
if (!standardBundle.containsKey(key)) { if (!standardBundle.containsKey(key)) {
throw new RuntimeException("Key '" + key + "' was found in admin-messages bundle for locale=" + strLocale + logger.error(themeName + " theme: Key '" + key + "' was found in admin-messages bundle for locale=" + strLocale +
". However, this key is not found in previously loaded bundle."); ". However, this key does not exist in previously loaded bundle for locale=" + standardLocale);
warnCount++;
} }
if (warnCount > 4) return; // There could be lots of these. Don't fill up the log.
} }
} }
} }