org.apache.struts2.util.TextProviderHelper.java Source code

Introduction

Here is the source code for org.apache.struts2.util.TextProviderHelper.java

Source

/*
 * $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 org.apache.struts2.util;

import com.opensymphony.xwork2.TextProvider;
import com.opensymphony.xwork2.util.ValueStack;
import org.apache.commons.lang3.StringEscapeUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import java.util.Collections;
import java.util.List;

/**
 * Helper methods to access text from TextProviders
 */
public class TextProviderHelper {

    private static final Logger LOG = LogManager.getLogger(TextProviderHelper.class);

    /**
    * <p>Get a message from the first TextProvider encountered in the stack.
    * If the first TextProvider doesn't provide the message the default message is returned.</p>
    * The stack is searched if if no TextProvider is found, or the message is not found.
    * @param key             the message key in the resource bundle
    * @param defaultMessage  the message to return if not found (evaluated for OGNL)
    * @param args            an array args to be used in a {@link java.text.MessageFormat} message
    * @param stack           the value stack to use for finding the text
    *
    * @return the message if found, otherwise the defaultMessage
    */
    public static String getText(String key, String defaultMessage, List<Object> args, ValueStack stack) {
        return getText(key, defaultMessage, args, stack, false);
    }

    /**
     * <p>Get a message from the first TextProvider encountered in the stack.
     * If the first TextProvider doesn't provide the message the default message is returned.</p>
     * <p>The search for a TextProvider is iterative from the root of the stack.</p>
     * <p>This method was refactored from  {@link org.apache.struts2.components.Text} to use a
     * consistent implementation across UIBean components.</p>
     * @param key             the message key in the resource bundle
     * @param defaultMessage  the message to return if not found (evaluated for OGNL)
     * @param args            an array args to be used in a {@link java.text.MessageFormat} message
     * @param stack           the value stack to use for finding the text
     * @param searchStack     search stack for the key
     *
     * @return the message if found, otherwise the defaultMessage
     */
    public static String getText(String key, String defaultMessage, List<Object> args, ValueStack stack,
            boolean searchStack) {
        String msg = null;
        TextProvider tp = null;

        for (Object o : stack.getRoot()) {
            if (o instanceof TextProvider) {
                tp = (TextProvider) o;
                msg = tp.getText(key, null, args, stack);

                break;
            }
        }

        if (msg == null) {
            // evaluate the defaultMessage as an OGNL expression
            if (searchStack)
                msg = stack.findString(defaultMessage);

            if (msg == null) {
                // use the defaultMessage literal value
                msg = defaultMessage;
                msg = StringEscapeUtils.escapeEcmaScript(msg);
                msg = StringEscapeUtils.escapeHtml4(msg);
                LOG.debug("Message for key '{}' is null, returns escaped default message [{}]", key, msg);
            }

            if (LOG.isWarnEnabled()) {
                if (tp != null) {
                    LOG.warn(
                            "The first TextProvider in the ValueStack ({}) could not locate the message resource with key '{}'",
                            tp.getClass().getName(), key);
                } else {
                    LOG.warn(
                            "Could not locate the message resource '{}' as there is no TextProvider in the ValueStack.",
                            key);
                }
                if (defaultMessage.equals(msg)) {
                    LOG.warn(
                            "The default value expression '{}' was evaluated and did not match a property. The literal value '{}' will be used.",
                            defaultMessage, defaultMessage);
                } else {
                    LOG.warn("The default value expression '{}' evaluated to '{}'", defaultMessage, msg);
                }
            }
        }
        return msg;
    }

    /**
     * <p>Get a message from the first TextProvider encountered in the stack.
     * If the first TextProvider doesn't provide the message the default message is returned.</p>
     * <p>The search for a TextProvider is iterative from the root of the stack.</p>
     * <p>This method was refactored from  {@link org.apache.struts2.components.Text} to use a
     * consistent implementation across UIBean components.</p>
     * @param key             the message key in the resource bundle
     * @param defaultMessage  the message to return if not found
     * @param stack           the value stack to use for finding the text
       *
     * @return the message if found, otherwise the defaultMessage
     */
    public static String getText(String key, String defaultMessage, ValueStack stack) {
        return getText(key, defaultMessage, Collections.emptyList(), stack);
    }
}