You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@struts.apache.org by lu...@apache.org on 2017/03/14 18:36:14 UTC
[21/24] struts git commit: Renames LocalizedTextUtil into
DefaultLocalizedTextProvider
Renames LocalizedTextUtil into DefaultLocalizedTextProvider
Project: http://git-wip-us.apache.org/repos/asf/struts/repo
Commit: http://git-wip-us.apache.org/repos/asf/struts/commit/008c28ac
Tree: http://git-wip-us.apache.org/repos/asf/struts/tree/008c28ac
Diff: http://git-wip-us.apache.org/repos/asf/struts/diff/008c28ac
Branch: refs/heads/master
Commit: 008c28ac67cbd477abe4761de34610d6de7cfda0
Parents: c3416e8
Author: Lukasz Lenart <lu...@apache.org>
Authored: Tue Mar 14 09:50:13 2017 +0100
Committer: Lukasz Lenart <lu...@apache.org>
Committed: Tue Mar 14 09:50:13 2017 +0100
----------------------------------------------------------------------
.../xwork2/DefaultLocaleProvider.java | 4 +-
.../xwork2/DefaultTextProvider.java | 4 +-
.../config/impl/DefaultConfiguration.java | 2 +-
.../providers/XWorkConfigurationProvider.java | 4 +-
.../util/DefaultLocalizedTextProvider.java | 1040 ++++++++++++++++++
.../xwork2/util/LocalizedTextUtil.java | 1035 -----------------
.../org/apache/struts2/components/Date.java | 1 -
.../org/apache/struts2/components/I18n.java | 4 +-
.../config/DefaultBeanSelectionProvider.java | 3 -
.../apache/struts2/dispatcher/Dispatcher.java | 7 +-
.../multipart/JakartaMultiPartRequest.java | 1 -
.../multipart/MultiPartRequestWrapper.java | 2 -
.../struts2/factory/StrutsActionProxy.java | 1 -
.../struts2/interceptor/I18nInterceptor.java | 4 +-
.../struts2/util/StrutsTestCaseHelper.java | 4 +-
.../org/apache/struts2/util/TokenHelper.java | 1 -
core/src/main/resources/struts-default.xml | 2 +-
.../xwork2/TextProviderSupportTest.java | 2 -
.../util/DefaultLocalizedTextProviderTest.java | 267 +++++
.../xwork2/util/LocalizedTextUtilTest.java | 267 -----
.../struts2/components/ComponentTest.java | 1 -
.../DefaultBeanSelectionProviderTest.java | 3 -
.../PropertiesConfigurationProviderTest.java | 6 +-
.../org/apache/struts2/config/SettingsTest.java | 1 -
.../multipart/PellMultiPartRequest.java | 2 -
.../portlet/dispatcher/Jsr168Dispatcher.java | 5 +-
26 files changed, 1329 insertions(+), 1344 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/struts/blob/008c28ac/core/src/main/java/com/opensymphony/xwork2/DefaultLocaleProvider.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/DefaultLocaleProvider.java b/core/src/main/java/com/opensymphony/xwork2/DefaultLocaleProvider.java
index 1d687bc..f28ef03 100644
--- a/core/src/main/java/com/opensymphony/xwork2/DefaultLocaleProvider.java
+++ b/core/src/main/java/com/opensymphony/xwork2/DefaultLocaleProvider.java
@@ -1,6 +1,6 @@
package com.opensymphony.xwork2;
-import com.opensymphony.xwork2.util.LocalizedTextUtil;
+import com.opensymphony.xwork2.util.DefaultLocalizedTextProvider;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
@@ -26,7 +26,7 @@ public class DefaultLocaleProvider implements LocaleProvider {
@Override
public boolean isValidLocaleString(String localeStr) {
- return isValidLocale(LocalizedTextUtil.localeFromString(localeStr, getLocale()));
+ return isValidLocale(DefaultLocalizedTextProvider.localeFromString(localeStr, getLocale()));
}
@Override
http://git-wip-us.apache.org/repos/asf/struts/blob/008c28ac/core/src/main/java/com/opensymphony/xwork2/DefaultTextProvider.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/DefaultTextProvider.java b/core/src/main/java/com/opensymphony/xwork2/DefaultTextProvider.java
index b82c42a..2c885a1 100644
--- a/core/src/main/java/com/opensymphony/xwork2/DefaultTextProvider.java
+++ b/core/src/main/java/com/opensymphony/xwork2/DefaultTextProvider.java
@@ -16,7 +16,7 @@
package com.opensymphony.xwork2;
import com.opensymphony.xwork2.inject.Inject;
-import com.opensymphony.xwork2.util.LocalizedTextUtil;
+import com.opensymphony.xwork2.util.DefaultLocalizedTextProvider;
import com.opensymphony.xwork2.util.ValueStack;
import java.io.Serializable;
@@ -32,7 +32,7 @@ import java.util.ResourceBundle;
*
* @author Jason Carreira jcarreira@gmail.com
* @author Rainer Hermanns
- * @see LocalizedTextUtil#addDefaultResourceBundle(String)
+ * @see DefaultLocalizedTextProvider#addDefaultResourceBundle(String)
*/
public class DefaultTextProvider implements TextProvider, Serializable, Unchainable {
http://git-wip-us.apache.org/repos/asf/struts/blob/008c28ac/core/src/main/java/com/opensymphony/xwork2/config/impl/DefaultConfiguration.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/impl/DefaultConfiguration.java b/core/src/main/java/com/opensymphony/xwork2/config/impl/DefaultConfiguration.java
index 937a561..358eb5c 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/impl/DefaultConfiguration.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/impl/DefaultConfiguration.java
@@ -245,7 +245,7 @@ public class DefaultConfiguration implements Configuration {
builder.factory(ReflectionProvider.class, OgnlReflectionProvider.class, Scope.SINGLETON);
builder.factory(ValueStackFactory.class, OgnlValueStackFactory.class, Scope.SINGLETON);
- builder.factory(LocalizedTextProvider.class, LocalizedTextUtil.class, Scope.SINGLETON);
+ builder.factory(LocalizedTextProvider.class, DefaultLocalizedTextProvider.class, Scope.SINGLETON);
builder.factory(XWorkConverter.class, Scope.SINGLETON);
builder.factory(ConversionPropertiesProcessor.class, DefaultConversionPropertiesProcessor.class, Scope.SINGLETON);
http://git-wip-us.apache.org/repos/asf/struts/blob/008c28ac/core/src/main/java/com/opensymphony/xwork2/config/providers/XWorkConfigurationProvider.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/config/providers/XWorkConfigurationProvider.java b/core/src/main/java/com/opensymphony/xwork2/config/providers/XWorkConfigurationProvider.java
index 407a96d..853f50e 100644
--- a/core/src/main/java/com/opensymphony/xwork2/config/providers/XWorkConfigurationProvider.java
+++ b/core/src/main/java/com/opensymphony/xwork2/config/providers/XWorkConfigurationProvider.java
@@ -72,7 +72,7 @@ import com.opensymphony.xwork2.ognl.accessor.XWorkMapPropertyAccessor;
import com.opensymphony.xwork2.ognl.accessor.XWorkMethodAccessor;
import com.opensymphony.xwork2.util.CompoundRoot;
import com.opensymphony.xwork2.LocalizedTextProvider;
-import com.opensymphony.xwork2.util.LocalizedTextUtil;
+import com.opensymphony.xwork2.util.DefaultLocalizedTextProvider;
import com.opensymphony.xwork2.util.OgnlTextParser;
import com.opensymphony.xwork2.util.PatternMatcher;
import com.opensymphony.xwork2.util.TextParser;
@@ -182,7 +182,7 @@ public class XWorkConfigurationProvider implements ConfigurationProvider {
.factory(ActionValidatorManager.class, "no-annotations", DefaultActionValidatorManager.class, Scope.SINGLETON)
.factory(TextProviderFactory.class, Scope.SINGLETON)
- .factory(LocalizedTextProvider.class, LocalizedTextUtil.class, Scope.SINGLETON)
+ .factory(LocalizedTextProvider.class, DefaultLocalizedTextProvider.class, Scope.SINGLETON)
.factory(TextProvider.class, "system", DefaultTextProvider.class, Scope.SINGLETON)
.factory(TextProvider.class, TextProviderSupport.class, Scope.SINGLETON)
http://git-wip-us.apache.org/repos/asf/struts/blob/008c28ac/core/src/main/java/com/opensymphony/xwork2/util/DefaultLocalizedTextProvider.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/com/opensymphony/xwork2/util/DefaultLocalizedTextProvider.java b/core/src/main/java/com/opensymphony/xwork2/util/DefaultLocalizedTextProvider.java
new file mode 100644
index 0000000..1e55fdd
--- /dev/null
+++ b/core/src/main/java/com/opensymphony/xwork2/util/DefaultLocalizedTextProvider.java
@@ -0,0 +1,1040 @@
+/*
+ * $Id$
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF 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.opensymphony.xwork2.util;
+
+import com.opensymphony.xwork2.ActionContext;
+import com.opensymphony.xwork2.ActionInvocation;
+import com.opensymphony.xwork2.LocalizedTextProvider;
+import com.opensymphony.xwork2.ModelDriven;
+import com.opensymphony.xwork2.conversion.impl.XWorkConverter;
+import com.opensymphony.xwork2.inject.Inject;
+import com.opensymphony.xwork2.util.reflection.ReflectionProviderFactory;
+import org.apache.commons.lang3.ObjectUtils;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.apache.logging.log4j.message.ParameterizedMessage;
+import org.apache.struts2.StrutsConstants;
+
+import java.beans.PropertyDescriptor;
+import java.lang.reflect.Field;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.text.MessageFormat;
+import java.util.*;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
+import java.util.concurrent.CopyOnWriteArrayList;
+
+
+/**
+ * Provides support for localization in XWork.
+ *
+ * <!-- START SNIPPET: searchorder -->
+ * <p>Resource bundles are searched in the following order:</p>
+ *
+ * <ol>
+ * <li>ActionClass.properties</li>
+ * <li>Interface.properties (every interface and sub-interface)</li>
+ * <li>BaseClass.properties (all the way to Object.properties)</li>
+ * <li>ModelDriven's model (if implements ModelDriven), for the model object repeat from 1</li>
+ * <li>package.properties (of the directory where class is located and every parent directory all the way to the root directory)</li>
+ * <li>search up the i18n message key hierarchy itself</li>
+ * <li>global resource properties</li>
+ * </ol>
+ *
+ * <!-- END SNIPPET: searchorder -->
+ *
+ * <!-- START SNIPPET: packagenote -->
+ * <p>To clarify #5, while traversing the package hierarchy, Struts 2 will look for a file package.properties:</p>
+ * com/<br>
+ * acme/<br>
+ * package.properties<br>
+ * actions/<br>
+ * package.properties<br>
+ * FooAction.java<br>
+ * FooAction.properties<br>
+ * <p>
+ * If FooAction.properties does not exist, com/acme/action/package.properties will be searched for, if
+ * not found com/acme/package.properties, if not found com/package.properties, etc.
+ * </p>
+ * <!-- END SNIPPET: packagenote -->
+ *
+ * <!-- START SNIPPET: globalresource -->
+ * <p>
+ * A global resource bundle could be specified programmatically, as well as the locale.
+ * </p>
+ * <!-- END SNIPPET: globalresource -->
+ *
+ * @author Jason Carreira
+ * @author Mark Woon
+ * @author Rainer Hermanns
+ * @author tm_jee
+ */
+public class DefaultLocalizedTextProvider implements LocalizedTextProvider {
+
+ private static final Logger LOG = LogManager.getLogger(DefaultLocalizedTextProvider.class);
+
+ public static final String XWORK_MESSAGES_BUNDLE = "com/opensymphony/xwork2/xwork-messages";
+ public static final String STRUTS_MESSAGES_BUNDLE = "org/apache/struts2/struts-messages";
+
+ private static final String TOMCAT_RESOURCE_ENTRIES_FIELD = "resourceEntries";
+
+ private final ConcurrentMap<Integer, List<String>> classLoaderMap = new ConcurrentHashMap<>();
+
+ private boolean reloadBundles = false;
+ private boolean devMode = false;
+
+ private final ConcurrentMap<String, ResourceBundle> bundlesMap = new ConcurrentHashMap<>();
+ private final ConcurrentMap<MessageFormatKey, MessageFormat> messageFormats = new ConcurrentHashMap<>();
+ private final ConcurrentMap<Integer, ClassLoader> delegatedClassLoaderMap = new ConcurrentHashMap<>();
+ private final Set<String> missingBundles = Collections.synchronizedSet(new HashSet<String>());
+
+ private final String RELOADED = "com.opensymphony.xwork2.util.LocalizedTextUtil.reloaded";
+
+
+ /**
+ * Clears the internal list of resource bundles.
+ *
+ * @deprecated used only in tests
+ */
+ @Deprecated
+ public static void clearDefaultResourceBundles() {
+ // no-op
+ }
+
+ public DefaultLocalizedTextProvider() {
+
+ addDefaultResourceBundle(XWORK_MESSAGES_BUNDLE);
+ addDefaultResourceBundle(STRUTS_MESSAGES_BUNDLE);
+ }
+
+ /**
+ * Should resorce bundles be reloaded.
+ *
+ * @param reloadBundles reload bundles?
+ */
+ @Inject(value = StrutsConstants.STRUTS_I18N_RELOAD, required = false)
+ public void setReloadBundles(String reloadBundles) {
+ this.reloadBundles = Boolean.parseBoolean(reloadBundles);
+ }
+
+ @Inject(value = StrutsConstants.STRUTS_DEVMODE, required = false)
+ public void setDevMode(String devMode) {
+ this.devMode = Boolean.parseBoolean(devMode);
+ }
+
+ @Inject(value = StrutsConstants.STRUTS_CUSTOM_I18N_RESOURCES, required = false)
+ public void setCustomI18NResources(String bundles) {
+ if (bundles != null && bundles.length() > 0) {
+ StringTokenizer customBundles = new StringTokenizer(bundles, ", ");
+
+ while (customBundles.hasMoreTokens()) {
+ String name = customBundles.nextToken();
+ try {
+ LOG.trace("Loading global messages from [{}]", name);
+ addDefaultResourceBundle(name);
+ } catch (Exception e) {
+ LOG.error(new ParameterizedMessage("Could not find messages file {}.properties. Skipping", name), e);
+ }
+ }
+ }
+ }
+
+ /**
+ * Add's the bundle to the internal list of default bundles.
+ * <p>
+ * If the bundle already exists in the list it will be readded.
+ * </p>
+ *
+ * @param resourceBundleName the name of the bundle to add.
+ */
+ @Override
+ public void addDefaultResourceBundle(String resourceBundleName) {
+ //make sure this doesn't get added more than once
+ final ClassLoader ccl = getCurrentThreadContextClassLoader();
+ synchronized (XWORK_MESSAGES_BUNDLE) {
+ List<String> bundles = classLoaderMap.get(ccl.hashCode());
+ if (bundles == null) {
+ bundles = new CopyOnWriteArrayList<>();
+ classLoaderMap.put(ccl.hashCode(), bundles);
+ }
+ bundles.remove(resourceBundleName);
+ bundles.add(0, resourceBundleName);
+ }
+
+ if (LOG.isDebugEnabled()) {
+ LOG.debug("Added default resource bundle '{}' to default resource bundles for the following classloader '{}'", resourceBundleName, ccl.toString());
+ }
+ }
+
+ /**
+ * Builds a {@link java.util.Locale} from a String of the form en_US_foo into a Locale
+ * with language "en", country "US" and variant "foo". This will parse the output of
+ * {@link java.util.Locale#toString()}.
+ *
+ * @param localeStr The locale String to parse.
+ * @param defaultLocale The locale to use if localeStr is <tt>null</tt>.
+ * @return requested Locale
+ */
+ public static Locale localeFromString(String localeStr, Locale defaultLocale) {
+ if ((localeStr == null) || (localeStr.trim().length() == 0) || ("_".equals(localeStr))) {
+ if (defaultLocale != null) {
+ return defaultLocale;
+ }
+ return Locale.getDefault();
+ }
+
+ int index = localeStr.indexOf('_');
+ if (index < 0) {
+ return new Locale(localeStr);
+ }
+
+ String language = localeStr.substring(0, index);
+ if (index == localeStr.length()) {
+ return new Locale(language);
+ }
+
+ localeStr = localeStr.substring(index + 1);
+ index = localeStr.indexOf('_');
+ if (index < 0) {
+ return new Locale(language, localeStr);
+ }
+
+ String country = localeStr.substring(0, index);
+ if (index == localeStr.length()) {
+ return new Locale(language, country);
+ }
+
+ localeStr = localeStr.substring(index + 1);
+ return new Locale(language, country, localeStr);
+ }
+
+ /**
+ * Returns a localized message for the specified key, aTextName. Neither the key nor the
+ * message is evaluated.
+ *
+ * @param aTextName the message key
+ * @param locale the locale the message should be for
+ * @return a localized message based on the specified key, or null if no localized message can be found for it
+ */
+ @Override
+ public String findDefaultText(String aTextName, Locale locale) {
+ List<String> localList = classLoaderMap.get(Thread.currentThread().getContextClassLoader().hashCode());
+
+ for (String bundleName : localList) {
+ ResourceBundle bundle = findResourceBundle(bundleName, locale);
+ if (bundle != null) {
+ reloadBundles();
+ try {
+ return bundle.getString(aTextName);
+ } catch (MissingResourceException e) {
+ // will be logged when not found in any bundle
+ }
+ }
+ }
+
+ if (devMode) {
+ LOG.warn("Missing key [{}] in bundles [{}]!", aTextName, localList);
+ } else {
+ LOG.debug("Missing key [{}] in bundles [{}]!", aTextName, localList);
+ }
+
+ return null;
+ }
+
+ /**
+ * Returns a localized message for the specified key, aTextName, substituting variables from the
+ * array of params into the message. Neither the key nor the message is evaluated.
+ *
+ * @param aTextName the message key
+ * @param locale the locale the message should be for
+ * @param params an array of objects to be substituted into the message text
+ * @return A formatted message based on the specified key, or null if no localized message can be found for it
+ */
+ @Override
+ public String findDefaultText(String aTextName, Locale locale, Object[] params) {
+ String defaultText = findDefaultText(aTextName, locale);
+ if (defaultText != null) {
+ MessageFormat mf = buildMessageFormat(defaultText, locale);
+ return formatWithNullDetection(mf, params);
+ }
+ return null;
+ }
+
+ /**
+ * Finds the given resource bundle by it's name.
+ * <p>
+ * Will use <code>Thread.currentThread().getContextClassLoader()</code> as the classloader.
+ * </p>
+ *
+ * @param aBundleName the name of the bundle (usually it's FQN classname).
+ * @param locale the locale.
+ * @return the bundle, <tt>null</tt> if not found.
+ */
+ @Override
+ public ResourceBundle findResourceBundle(String aBundleName, Locale locale) {
+ ClassLoader classLoader = getCurrentThreadContextClassLoader();
+ String key = createMissesKey(String.valueOf(classLoader.hashCode()), aBundleName, locale);
+
+ if (missingBundles.contains(key)) {
+ return null;
+ }
+
+ ResourceBundle bundle = null;
+ try {
+ if (bundlesMap.containsKey(key)) {
+ bundle = bundlesMap.get(key);
+ } else {
+ bundle = ResourceBundle.getBundle(aBundleName, locale, classLoader);
+ bundlesMap.putIfAbsent(key, bundle);
+ }
+ } catch (MissingResourceException ex) {
+ if (delegatedClassLoaderMap.containsKey(classLoader.hashCode())) {
+ try {
+ if (bundlesMap.containsKey(key)) {
+ bundle = bundlesMap.get(key);
+ } else {
+ bundle = ResourceBundle.getBundle(aBundleName, locale, delegatedClassLoaderMap.get(classLoader.hashCode()));
+ bundlesMap.putIfAbsent(key, bundle);
+ }
+ } catch (MissingResourceException e) {
+ LOG.debug("Missing resource bundle [{}]!", aBundleName, e);
+ missingBundles.add(key);
+ }
+ } else {
+ LOG.debug("Missing resource bundle [{}]!", aBundleName);
+ missingBundles.add(key);
+ }
+ }
+ return bundle;
+ }
+
+ /**
+ * @param classLoader a {@link ClassLoader} to look up the bundle from if none can be found on the current thread's classloader
+ */
+ public void setDelegatedClassLoader(final ClassLoader classLoader) {
+ synchronized (bundlesMap) {
+ delegatedClassLoaderMap.put(getCurrentThreadContextClassLoader().hashCode(), classLoader);
+ }
+ }
+
+ /**
+ * @param bundleName Removes the bundle from any cached "misses"
+ */
+ public void clearBundle(final String bundleName) {
+ bundlesMap.remove(getCurrentThreadContextClassLoader().hashCode() + bundleName);
+ }
+
+
+ /**
+ * Creates a key to used for lookup/storing in the bundle misses cache.
+ *
+ * @param prefix the prefix for the returning String - it is supposed to be the ClassLoader hash code.
+ * @param aBundleName the name of the bundle (usually it's FQN classname).
+ * @param locale the locale.
+ * @return the key to use for lookup/storing in the bundle misses cache.
+ */
+ private String createMissesKey(String prefix, String aBundleName, Locale locale) {
+ return prefix + aBundleName + "_" + locale.toString();
+ }
+
+ /**
+ * Calls {@link #findText(Class aClass, String aTextName, Locale locale, String defaultMessage, Object[] args)}
+ * with aTextName as the default message.
+ *
+ * @param aClass class name
+ * @param aTextName text name
+ * @param locale the locale
+ *
+ * @return the localized text, or null if none can be found and no defaultMessage is provided
+ * @see #findText(Class aClass, String aTextName, Locale locale, String defaultMessage, Object[] args)
+ */
+ @Override
+ public String findText(Class aClass, String aTextName, Locale locale) {
+ return findText(aClass, aTextName, locale, aTextName, new Object[0]);
+ }
+
+ /**
+ * <p>
+ * Finds a localized text message for the given key, aTextName. Both the key and the message
+ * itself is evaluated as required. The following algorithm is used to find the requested
+ * message:
+ * </p>
+ *
+ * <ol>
+ * <li>Look for message in aClass' class hierarchy.
+ * <ol>
+ * <li>Look for the message in a resource bundle for aClass</li>
+ * <li>If not found, look for the message in a resource bundle for any implemented interface</li>
+ * <li>If not found, traverse up the Class' hierarchy and repeat from the first sub-step</li>
+ * </ol></li>
+ * <li>If not found and aClass is a {@link ModelDriven} Action, then look for message in
+ * the model's class hierarchy (repeat sub-steps listed above).</li>
+ * <li>If not found, look for message in child property. This is determined by evaluating
+ * the message key as an OGNL expression. For example, if the key is
+ * <i>user.address.state</i>, then it will attempt to see if "user" can be resolved into an
+ * object. If so, repeat the entire process fromthe beginning with the object's class as
+ * aClass and "address.state" as the message key.</li>
+ * <li>If not found, look for the message in aClass' package hierarchy.</li>
+ * <li>If still not found, look for the message in the default resource bundles.</li>
+ * <li>Return defaultMessage</li>
+ * </ol>
+ *
+ * <p>
+ * When looking for the message, if the key indexes a collection (e.g. user.phone[0]) and a
+ * message for that specific key cannot be found, the general form will also be looked up
+ * (i.e. user.phone[*]).
+ * </p>
+ *
+ * <p>
+ * If a message is found, it will also be interpolated. Anything within <code>${...}</code>
+ * will be treated as an OGNL expression and evaluated as such.
+ * </p>
+ *
+ * @param aClass the class whose name to use as the start point for the search
+ * @param aTextName the key to find the text message for
+ * @param locale the locale the message should be for
+ * @param defaultMessage the message to be returned if no text message can be found in any
+ * resource bundle
+ * @param args arguments
+ * resource bundle
+ * @return the localized text, or null if none can be found and no defaultMessage is provided
+ */
+ @Override
+ public String findText(Class aClass, String aTextName, Locale locale, String defaultMessage, Object[] args) {
+ ValueStack valueStack = ActionContext.getContext().getValueStack();
+ return findText(aClass, aTextName, locale, defaultMessage, args, valueStack);
+
+ }
+
+ /**
+ * <p>
+ * Finds a localized text message for the given key, aTextName. Both the key and the message
+ * itself is evaluated as required. The following algorithm is used to find the requested
+ * message:
+ * </p>
+ *
+ * <ol>
+ * <li>Look for message in aClass' class hierarchy.
+ * <ol>
+ * <li>Look for the message in a resource bundle for aClass</li>
+ * <li>If not found, look for the message in a resource bundle for any implemented interface</li>
+ * <li>If not found, traverse up the Class' hierarchy and repeat from the first sub-step</li>
+ * </ol></li>
+ * <li>If not found and aClass is a {@link ModelDriven} Action, then look for message in
+ * the model's class hierarchy (repeat sub-steps listed above).</li>
+ * <li>If not found, look for message in child property. This is determined by evaluating
+ * the message key as an OGNL expression. For example, if the key is
+ * <i>user.address.state</i>, then it will attempt to see if "user" can be resolved into an
+ * object. If so, repeat the entire process fromthe beginning with the object's class as
+ * aClass and "address.state" as the message key.</li>
+ * <li>If not found, look for the message in aClass' package hierarchy.</li>
+ * <li>If still not found, look for the message in the default resource bundles.</li>
+ * <li>Return defaultMessage</li>
+ * </ol>
+ *
+ * <p>
+ * When looking for the message, if the key indexes a collection (e.g. user.phone[0]) and a
+ * message for that specific key cannot be found, the general form will also be looked up
+ * (i.e. user.phone[*]).
+ * </p>
+ *
+ * <p>
+ * If a message is found, it will also be interpolated. Anything within <code>${...}</code>
+ * will be treated as an OGNL expression and evaluated as such.
+ * </p>
+ *
+ * <p>
+ * If a message is <b>not</b> found a WARN log will be logged.
+ * </p>
+ *
+ * @param aClass the class whose name to use as the start point for the search
+ * @param aTextName the key to find the text message for
+ * @param locale the locale the message should be for
+ * @param defaultMessage the message to be returned if no text message can be found in any
+ * resource bundle
+ * @param args arguments
+ * @param valueStack the value stack to use to evaluate expressions instead of the
+ * one in the ActionContext ThreadLocal
+ * @return the localized text, or null if none can be found and no defaultMessage is provided
+ */
+ @Override
+ public String findText(Class aClass, String aTextName, Locale locale, String defaultMessage, Object[] args,
+ ValueStack valueStack) {
+ String indexedTextName = null;
+ if (aTextName == null) {
+ LOG.warn("Trying to find text with null key!");
+ aTextName = "";
+ }
+ // calculate indexedTextName (collection[*]) if applicable
+ if (aTextName.contains("[")) {
+ int i = -1;
+
+ indexedTextName = aTextName;
+
+ while ((i = indexedTextName.indexOf("[", i + 1)) != -1) {
+ int j = indexedTextName.indexOf("]", i);
+ String a = indexedTextName.substring(0, i);
+ String b = indexedTextName.substring(j);
+ indexedTextName = a + "[*" + b;
+ }
+ }
+
+ // search up class hierarchy
+ String msg = findMessage(aClass, aTextName, indexedTextName, locale, args, null, valueStack);
+
+ if (msg != null) {
+ return msg;
+ }
+
+ if (ModelDriven.class.isAssignableFrom(aClass)) {
+ ActionContext context = ActionContext.getContext();
+ // search up model's class hierarchy
+ ActionInvocation actionInvocation = context.getActionInvocation();
+
+ // ActionInvocation may be null if we're being run from a Sitemesh filter, so we won't get model texts if this is null
+ if (actionInvocation != null) {
+ Object action = actionInvocation.getAction();
+ if (action instanceof ModelDriven) {
+ Object model = ((ModelDriven) action).getModel();
+ if (model != null) {
+ msg = findMessage(model.getClass(), aTextName, indexedTextName, locale, args, null, valueStack);
+ if (msg != null) {
+ return msg;
+ }
+ }
+ }
+ }
+ }
+
+ // nothing still? alright, search the package hierarchy now
+ for (Class clazz = aClass;
+ (clazz != null) && !clazz.equals(Object.class);
+ clazz = clazz.getSuperclass()) {
+
+ String basePackageName = clazz.getName();
+ while (basePackageName.lastIndexOf('.') != -1) {
+ basePackageName = basePackageName.substring(0, basePackageName.lastIndexOf('.'));
+ String packageName = basePackageName + ".package";
+ msg = getMessage(packageName, locale, aTextName, valueStack, args);
+
+ if (msg != null) {
+ return msg;
+ }
+
+ if (indexedTextName != null) {
+ msg = getMessage(packageName, locale, indexedTextName, valueStack, args);
+
+ if (msg != null) {
+ return msg;
+ }
+ }
+ }
+ }
+
+ // see if it's a child property
+ int idx = aTextName.indexOf(".");
+
+ if (idx != -1) {
+ String newKey = null;
+ String prop = null;
+
+ if (aTextName.startsWith(XWorkConverter.CONVERSION_ERROR_PROPERTY_PREFIX)) {
+ idx = aTextName.indexOf(".", XWorkConverter.CONVERSION_ERROR_PROPERTY_PREFIX.length());
+
+ if (idx != -1) {
+ prop = aTextName.substring(XWorkConverter.CONVERSION_ERROR_PROPERTY_PREFIX.length(), idx);
+ newKey = XWorkConverter.CONVERSION_ERROR_PROPERTY_PREFIX + aTextName.substring(idx + 1);
+ }
+ } else {
+ prop = aTextName.substring(0, idx);
+ newKey = aTextName.substring(idx + 1);
+ }
+
+ if (prop != null) {
+ Object obj = valueStack.findValue(prop);
+ try {
+ Object actionObj = ReflectionProviderFactory.getInstance().getRealTarget(prop, valueStack.getContext(), valueStack.getRoot());
+ if (actionObj != null) {
+ PropertyDescriptor propertyDescriptor = ReflectionProviderFactory.getInstance().getPropertyDescriptor(actionObj.getClass(), prop);
+
+ if (propertyDescriptor != null) {
+ Class clazz = propertyDescriptor.getPropertyType();
+
+ if (clazz != null) {
+ if (obj != null) {
+ valueStack.push(obj);
+ }
+ msg = findText(clazz, newKey, locale, null, args);
+ if (obj != null) {
+ valueStack.pop();
+ }
+ if (msg != null) {
+ return msg;
+ }
+ }
+ }
+ }
+ } catch (Exception e) {
+ LOG.debug("unable to find property {}", prop, e);
+ }
+ }
+ }
+
+ // get default
+ GetDefaultMessageReturnArg result;
+ if (indexedTextName == null) {
+ result = getDefaultMessage(aTextName, locale, valueStack, args, defaultMessage);
+ } else {
+ result = getDefaultMessage(aTextName, locale, valueStack, args, null);
+ if (result != null && result.message != null) {
+ return result.message;
+ }
+ result = getDefaultMessage(indexedTextName, locale, valueStack, args, defaultMessage);
+ }
+
+ // could we find the text, if not log a warn
+ if (unableToFindTextForKey(result) && LOG.isDebugEnabled()) {
+ String warn = "Unable to find text for key '" + aTextName + "' ";
+ if (indexedTextName != null) {
+ warn += " or indexed key '" + indexedTextName + "' ";
+ }
+ warn += "in class '" + aClass.getName() + "' and locale '" + locale + "'";
+ LOG.debug(warn);
+ }
+
+ return result != null ? result.message : null;
+ }
+
+ /**
+ * Determines if we found the text in the bundles.
+ *
+ * @param result the result so far
+ * @return <tt>true</tt> if we could <b>not</b> find the text, <tt>false</tt> if the text was found (=success).
+ */
+ private static boolean unableToFindTextForKey(GetDefaultMessageReturnArg result) {
+ if (result == null || result.message == null) {
+ return true;
+ }
+
+ // did we find it in the bundle, then no problem?
+ if (result.foundInBundle) {
+ return false;
+ }
+
+ // not found in bundle
+ return true;
+ }
+
+ /**
+ * <p>
+ * Finds a localized text message for the given key, aTextName, in the specified resource bundle
+ * with aTextName as the default message.
+ * </p>
+ *
+ * <p>
+ * If a message is found, it will also be interpolated. Anything within <code>${...}</code>
+ * will be treated as an OGNL expression and evaluated as such.
+ * </p>
+ *
+ * @param bundle a resource bundle name
+ * @param aTextName text name
+ * @param locale the locale
+ *
+ * @return the localized text, or null if none can be found and no defaultMessage is provided
+ * @see #findText(java.util.ResourceBundle, String, java.util.Locale, String, Object[])
+ */
+ @Override
+ public String findText(ResourceBundle bundle, String aTextName, Locale locale) {
+ return findText(bundle, aTextName, locale, aTextName, new Object[0]);
+ }
+
+ /**
+ * <p>
+ * Finds a localized text message for the given key, aTextName, in the specified resource
+ * bundle.
+ * </p>
+ *
+ * <p>
+ * If a message is found, it will also be interpolated. Anything within <code>${...}</code>
+ * will be treated as an OGNL expression and evaluated as such.
+ * </p>
+ *
+ * <p>
+ * If a message is <b>not</b> found a WARN log will be logged.
+ * </p>
+ *
+ * @param bundle the bundle
+ * @param aTextName the key
+ * @param locale the locale
+ * @param defaultMessage the default message to use if no message was found in the bundle
+ * @param args arguments for the message formatter.
+ * @return the localized text, or null if none can be found and no defaultMessage is provided
+ */
+ @Override
+ public String findText(ResourceBundle bundle, String aTextName, Locale locale, String defaultMessage, Object[] args) {
+ ValueStack valueStack = ActionContext.getContext().getValueStack();
+ return findText(bundle, aTextName, locale, defaultMessage, args, valueStack);
+ }
+
+ /**
+ * <p>
+ * Finds a localized text message for the given key, aTextName, in the specified resource
+ * bundle.
+ * </p>
+ *
+ * <p>
+ * If a message is found, it will also be interpolated. Anything within <code>${...}</code>
+ * will be treated as an OGNL expression and evaluated as such.
+ * </p>
+ *
+ * <p>
+ * If a message is <b>not</b> found a WARN log will be logged.
+ * </p>
+ *
+ * @param bundle the bundle
+ * @param aTextName the key
+ * @param locale the locale
+ * @param defaultMessage the default message to use if no message was found in the bundle
+ * @param args arguments for the message formatter.
+ * @param valueStack the OGNL value stack.
+ * @return the localized text, or null if none can be found and no defaultMessage is provided
+ */
+ @Override
+ public String findText(ResourceBundle bundle, String aTextName, Locale locale, String defaultMessage, Object[] args,
+ ValueStack valueStack) {
+ try {
+ reloadBundles(valueStack.getContext());
+
+ String message = TextParseUtil.translateVariables(bundle.getString(aTextName), valueStack);
+ MessageFormat mf = buildMessageFormat(message, locale);
+
+ return formatWithNullDetection(mf, args);
+ } catch (MissingResourceException ex) {
+ if (devMode) {
+ LOG.warn("Missing key [{}] in bundle [{}]!", aTextName, bundle);
+ } else {
+ LOG.debug("Missing key [{}] in bundle [{}]!", aTextName, bundle);
+ }
+ }
+
+ GetDefaultMessageReturnArg result = getDefaultMessage(aTextName, locale, valueStack, args, defaultMessage);
+ if (unableToFindTextForKey(result)) {
+ LOG.warn("Unable to find text for key '{}' in ResourceBundles for locale '{}'", aTextName, locale);
+ }
+ return result != null ? result.message : null;
+ }
+
+ /**
+ * @return the default message.
+ */
+ private GetDefaultMessageReturnArg getDefaultMessage(String key, Locale locale, ValueStack valueStack, Object[] args,
+ String defaultMessage) {
+ GetDefaultMessageReturnArg result = null;
+ boolean found = true;
+
+ if (key != null) {
+ String message = findDefaultText(key, locale);
+
+ if (message == null) {
+ message = defaultMessage;
+ found = false; // not found in bundles
+ }
+
+ // defaultMessage may be null
+ if (message != null) {
+ MessageFormat mf = buildMessageFormat(TextParseUtil.translateVariables(message, valueStack), locale);
+
+ String msg = formatWithNullDetection(mf, args);
+ result = new GetDefaultMessageReturnArg(msg, found);
+ }
+ }
+
+ return result;
+ }
+
+ /**
+ * @return the message from the named resource bundle.
+ */
+ private String getMessage(String bundleName, Locale locale, String key, ValueStack valueStack, Object[] args) {
+ ResourceBundle bundle = findResourceBundle(bundleName, locale);
+ if (bundle == null) {
+ return null;
+ }
+ if (valueStack != null)
+ reloadBundles(valueStack.getContext());
+ try {
+ String message = bundle.getString(key);
+ if (valueStack != null)
+ message = TextParseUtil.translateVariables(bundle.getString(key), valueStack);
+ MessageFormat mf = buildMessageFormat(message, locale);
+ return formatWithNullDetection(mf, args);
+ } catch (MissingResourceException e) {
+ if (devMode) {
+ LOG.warn("Missing key [{}] in bundle [{}]!", key, bundleName);
+ } else {
+ LOG.debug("Missing key [{}] in bundle [{}]!", key, bundleName);
+ }
+ return null;
+ }
+ }
+
+ private String formatWithNullDetection(MessageFormat mf, Object[] args) {
+ String message = mf.format(args);
+ if ("null".equals(message)) {
+ return null;
+ } else {
+ return message;
+ }
+ }
+
+ private MessageFormat buildMessageFormat(String pattern, Locale locale) {
+ MessageFormatKey key = new MessageFormatKey(pattern, locale);
+ MessageFormat format = messageFormats.get(key);
+ if (format == null) {
+ format = new MessageFormat(pattern);
+ format.setLocale(locale);
+ format.applyPattern(pattern);
+ messageFormats.put(key, format);
+ }
+
+ return format;
+ }
+
+ /**
+ * Traverse up class hierarchy looking for message. Looks at class, then implemented interface,
+ * before going up hierarchy.
+ *
+ * @return the message
+ */
+ private String findMessage(Class clazz, String key, String indexedKey, Locale locale, Object[] args, Set<String> checked,
+ ValueStack valueStack) {
+ if (checked == null) {
+ checked = new TreeSet<String>();
+ } else if (checked.contains(clazz.getName())) {
+ return null;
+ }
+
+ // look in properties of this class
+ String msg = getMessage(clazz.getName(), locale, key, valueStack, args);
+
+ if (msg != null) {
+ return msg;
+ }
+
+ if (indexedKey != null) {
+ msg = getMessage(clazz.getName(), locale, indexedKey, valueStack, args);
+
+ if (msg != null) {
+ return msg;
+ }
+ }
+
+ // look in properties of implemented interfaces
+ Class[] interfaces = clazz.getInterfaces();
+
+ for (Class anInterface : interfaces) {
+ msg = getMessage(anInterface.getName(), locale, key, valueStack, args);
+
+ if (msg != null) {
+ return msg;
+ }
+
+ if (indexedKey != null) {
+ msg = getMessage(anInterface.getName(), locale, indexedKey, valueStack, args);
+
+ if (msg != null) {
+ return msg;
+ }
+ }
+ }
+
+ // traverse up hierarchy
+ if (clazz.isInterface()) {
+ interfaces = clazz.getInterfaces();
+
+ for (Class anInterface : interfaces) {
+ msg = findMessage(anInterface, key, indexedKey, locale, args, checked, valueStack);
+
+ if (msg != null) {
+ return msg;
+ }
+ }
+ } else {
+ if (!clazz.equals(Object.class) && !clazz.isPrimitive()) {
+ return findMessage(clazz.getSuperclass(), key, indexedKey, locale, args, checked, valueStack);
+ }
+ }
+
+ return null;
+ }
+
+ private void reloadBundles() {
+ reloadBundles(ActionContext.getContext() != null ? ActionContext.getContext().getContextMap() : null);
+ }
+
+ private void reloadBundles(Map<String, Object> context) {
+ if (reloadBundles) {
+ try {
+ Boolean reloaded;
+ if (context != null) {
+ reloaded = (Boolean) ObjectUtils.defaultIfNull(context.get(RELOADED), Boolean.FALSE);
+ }else {
+ reloaded = Boolean.FALSE;
+ }
+ if (!reloaded) {
+ bundlesMap.clear();
+ try {
+ clearMap(ResourceBundle.class, null, "cacheList");
+ } catch (NoSuchFieldException e) {
+ // happens in IBM JVM, that has a different ResourceBundle impl
+ // it has a 'cache' member
+ clearMap(ResourceBundle.class, null, "cache");
+ }
+
+ // now, for the true and utter hack, if we're running in tomcat, clear
+ // it's class loader resource cache as well.
+ clearTomcatCache();
+ if(context!=null) {
+ context.put(RELOADED, true);
+ }
+ LOG.debug("Resource bundles reloaded");
+ }
+ } catch (Exception e) {
+ LOG.error("Could not reload resource bundles", e);
+ }
+ }
+ }
+
+
+ private static void clearTomcatCache() {
+ ClassLoader loader = getCurrentThreadContextClassLoader();
+ // no need for compilation here.
+ Class cl = loader.getClass();
+
+ try {
+ if ("org.apache.catalina.loader.WebappClassLoader".equals(cl.getName())) {
+ clearMap(cl, loader, TOMCAT_RESOURCE_ENTRIES_FIELD);
+ } else {
+ LOG.debug("Class loader {} is not tomcat loader.", cl.getName());
+ }
+ } catch (NoSuchFieldException nsfe) {
+ if ("org.apache.catalina.loader.WebappClassLoaderBase".equals(cl.getSuperclass().getName())) {
+ LOG.debug("Base class {} doesn't contain '{}' field, trying with parent!", cl.getName(), TOMCAT_RESOURCE_ENTRIES_FIELD, nsfe);
+ try {
+ clearMap(cl.getSuperclass(), loader, TOMCAT_RESOURCE_ENTRIES_FIELD);
+ } catch (Exception e) {
+ LOG.warn("Couldn't clear tomcat cache using {}", cl.getSuperclass().getName(), e);
+ }
+ }
+ } catch (Exception e) {
+ LOG.warn("Couldn't clear tomcat cache", cl.getName(), e);
+ }
+ }
+
+
+ private static void clearMap(Class cl, Object obj, String name)
+ throws NoSuchFieldException, IllegalAccessException, NoSuchMethodException, InvocationTargetException {
+
+ Field field = cl.getDeclaredField(name);
+ field.setAccessible(true);
+
+ Object cache = field.get(obj);
+
+ synchronized (cache) {
+ Class ccl = cache.getClass();
+ Method clearMethod = ccl.getMethod("clear");
+ clearMethod.invoke(cache);
+ }
+ }
+
+ /**
+ * Clears all the internal lists.
+ *
+ * @deprecated used only in tests
+ */
+ @Override
+ @Deprecated
+ public void reset() {
+ // no-op
+ }
+
+ static class MessageFormatKey {
+ String pattern;
+ Locale locale;
+
+ MessageFormatKey(String pattern, Locale locale) {
+ this.pattern = pattern;
+ this.locale = locale;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (!(o instanceof MessageFormatKey)) return false;
+
+ final MessageFormatKey messageFormatKey = (MessageFormatKey) o;
+
+ if (locale != null ? !locale.equals(messageFormatKey.locale) : messageFormatKey.locale != null)
+ return false;
+ if (pattern != null ? !pattern.equals(messageFormatKey.pattern) : messageFormatKey.pattern != null)
+ return false;
+
+ return true;
+ }
+
+ @Override
+ public int hashCode() {
+ int result;
+ result = (pattern != null ? pattern.hashCode() : 0);
+ result = 29 * result + (locale != null ? locale.hashCode() : 0);
+ return result;
+ }
+ }
+
+ private static ClassLoader getCurrentThreadContextClassLoader() {
+ return Thread.currentThread().getContextClassLoader();
+ }
+
+ static class GetDefaultMessageReturnArg {
+ String message;
+ boolean foundInBundle;
+
+ public GetDefaultMessageReturnArg(String message, boolean foundInBundle) {
+ this.message = message;
+ this.foundInBundle = foundInBundle;
+ }
+ }
+
+ private static class EmptyResourceBundle extends ResourceBundle {
+ @Override
+ public Enumeration<String> getKeys() {
+ return null; // dummy
+ }
+
+ @Override
+ protected Object handleGetObject(String key) {
+ return null; // dummy
+ }
+ }
+
+}