/*
* =============================================================================
*
* Copyright (c) 2011-2014, The THYMELEAF team (http://www.thymeleaf.org)
*
* 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.
*
* =============================================================================
*/
package org.thymeleaf.expression;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import org.thymeleaf.Arguments;
import org.thymeleaf.Configuration;
import org.thymeleaf.context.IContext;
import org.thymeleaf.context.IProcessingContext;
import org.thymeleaf.context.IWebContext;
/**
* <p>
* Utility class containing methods for creating utility
* objects that will be included into expression evaluation contexts.
* </p>
*
* @author Daniel Fernández
*
* @since 1.1
*
*/
public final class ExpressionEvaluatorObjects {
public static final String CONTEXT_VARIABLE_NAME = "ctx";
public static final String ROOT_VARIABLE_NAME = "root";
public static final String SELECTION_VARIABLE_NAME = "object";
public static final String LOCALE_EVALUATION_VARIABLE_NAME = "locale";
/**
* @since 2.0.14
*/
public static final String VARIABLES_EVALUATION_VARIABLE_NAME = "vars";
/**
* @since 1.1.2
*/
public static final String HTTP_SERVLET_REQUEST_VARIABLE_NAME = "httpServletRequest";
/**
* @since 1.1.2
*/
public static final String HTTP_SESSION_VARIABLE_NAME = "httpSession";
/**
* @since 2.1.0
*/
public static final String CONVERSIONS_EVALUATION_VARIABLE_NAME = "conversions";
/**
* @since 2.1.4
*/
public static final String URIS_EVALUATION_VARIABLE_NAME = "uris";
public static final String CALENDARS_EVALUATION_VARIABLE_NAME = "calendars";
public static final String DATES_EVALUATION_VARIABLE_NAME = "dates";
public static final String BOOLS_EVALUATION_VARIABLE_NAME = "bools";
public static final String NUMBERS_EVALUATION_VARIABLE_NAME = "numbers";
public static final String OBJECTS_EVALUATION_VARIABLE_NAME = "objects";
public static final String STRINGS_EVALUATION_VARIABLE_NAME = "strings";
public static final String ARRAYS_EVALUATION_VARIABLE_NAME = "arrays";
public static final String LISTS_EVALUATION_VARIABLE_NAME = "lists";
public static final String SETS_EVALUATION_VARIABLE_NAME = "sets";
public static final String MAPS_EVALUATION_VARIABLE_NAME = "maps";
public static final String AGGREGATES_EVALUATION_VARIABLE_NAME = "aggregates";
public static final String MESSAGES_EVALUATION_VARIABLE_NAME = "messages";
public static final String IDS_EVALUATION_VARIABLE_NAME = "ids";
private static final ConcurrentHashMap<Locale, Map<String,Object>> BASE_OBJECTS_BY_LOCALE_CACHE =
new ConcurrentHashMap<Locale, Map<String, Object>>(5, 1.0f, 3);
private static final ConcurrentHashMap<Configuration, Map<String,Object>> BASE_OBJECTS_BY_CONFIGURATION_CACHE =
new ConcurrentHashMap<Configuration, Map<String, Object>>(5, 1.0f, 3);
private ExpressionEvaluatorObjects() {
super();
}
/**
*
* @since 2.0.9
*/
public static Map<String,Object> computeEvaluationObjects(
final IProcessingContext processingContext) {
final IContext context = processingContext.getContext();
final Map<String,Object> variables = new HashMap<String, Object>(30);
variables.putAll(computeBaseObjectsByLocale(context.getLocale()));
variables.put(CONTEXT_VARIABLE_NAME, context);
variables.put(LOCALE_EVALUATION_VARIABLE_NAME, context.getLocale());
if (context instanceof IWebContext) {
final IWebContext webContext = (IWebContext) context;
// This gives access to the HttpServletRequest and HttpSession objects, if they exist
variables.put(
HTTP_SERVLET_REQUEST_VARIABLE_NAME, webContext.getHttpServletRequest());
variables.put(
HTTP_SESSION_VARIABLE_NAME, webContext.getHttpSession());
}
final Object evaluationRoot = processingContext.getExpressionEvaluationRoot();
/*
* #root and #vars are synonyms
*/
variables.put(ROOT_VARIABLE_NAME, evaluationRoot);
variables.put(VARIABLES_EVALUATION_VARIABLE_NAME, evaluationRoot);
if (processingContext.hasSelectionTarget()) {
variables.put(SELECTION_VARIABLE_NAME, processingContext.getSelectionTarget());
} else {
variables.put(SELECTION_VARIABLE_NAME, evaluationRoot);
}
if (processingContext instanceof Arguments) {
final Arguments arguments = (Arguments) processingContext;
final Messages messages = new Messages(arguments);
variables.put(MESSAGES_EVALUATION_VARIABLE_NAME, messages);
final Ids ids = new Ids(arguments);
variables.put(IDS_EVALUATION_VARIABLE_NAME, ids);
final Conversions conversions = new Conversions(arguments.getConfiguration(), arguments);
variables.put(CONVERSIONS_EVALUATION_VARIABLE_NAME, conversions);
}
return variables;
}
private static Map<String,Object> computeBaseObjectsByLocale(final Locale locale) {
Map<String,Object> objects = BASE_OBJECTS_BY_LOCALE_CACHE.get(locale);
if (objects == null) {
objects = new HashMap<String, Object>(15);
if (locale != null) {
objects.put(CALENDARS_EVALUATION_VARIABLE_NAME, new Calendars(locale));
objects.put(DATES_EVALUATION_VARIABLE_NAME, new Dates(locale));
objects.put(NUMBERS_EVALUATION_VARIABLE_NAME, new Numbers(locale));
objects.put(STRINGS_EVALUATION_VARIABLE_NAME, new Strings(locale));
}
objects.put(BOOLS_EVALUATION_VARIABLE_NAME, new Bools());
objects.put(OBJECTS_EVALUATION_VARIABLE_NAME, new Objects());
objects.put(ARRAYS_EVALUATION_VARIABLE_NAME, new Arrays());
objects.put(LISTS_EVALUATION_VARIABLE_NAME, new Lists());
objects.put(SETS_EVALUATION_VARIABLE_NAME, new Sets());
objects.put(MAPS_EVALUATION_VARIABLE_NAME, new Maps());
objects.put(AGGREGATES_EVALUATION_VARIABLE_NAME, new Aggregates());
objects.put(URIS_EVALUATION_VARIABLE_NAME, new Uris());
BASE_OBJECTS_BY_LOCALE_CACHE.put(locale, objects);
}
return objects;
}
}