org.primefaces.context.PrimeRequestContext Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright (c) 2009-2023 PrimeTek Informatics
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.primefaces.context;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.el.ELContext;
import javax.el.ExpressionFactory;
import javax.el.ValueExpression;
import javax.faces.context.FacesContext;
import javax.servlet.http.HttpServletRequest;
import org.primefaces.util.*;
/**
* A {@link PrimeRequestContext} is a contextual store for the current request.
*
* It can be accessed via:
*
* PrimeRequestContext.getCurrentInstance(context)
*
*/
public class PrimeRequestContext {
public static final String INSTANCE_KEY = PrimeRequestContext.class.getName();
private static final String CALLBACK_PARAMS_KEY = "CALLBACK_PARAMS";
private static final String EXECUTE_INIT_SCRIPTS_KEY = "EXECUTE_INIT_SCRIPTS";
private static final String EXECUTE_SCRIPTS_KEY = "EXECUTE_SCRIPTS";
private static final Class[] EMPTY_PARAMS = new Class[0];
private WidgetBuilder widgetBuilder;
private StyleClassBuilder styleClassBuilder;
private StyleBuilder styleBuilder;
private AjaxRequestBuilder ajaxRequestBuilder;
private CSVBuilder csvBuilder;
private FacesContext context;
private PrimeApplicationContext applicationContext;
private Boolean ignoreAutoUpdate;
private Boolean rtl;
private Boolean touchable;
private Boolean secure;
private Boolean flex;
private Boolean hideResourceVersion;
public PrimeRequestContext(FacesContext context) {
this.context = context;
}
public static PrimeRequestContext getCurrentInstance() {
return getCurrentInstance(FacesContext.getCurrentInstance());
}
public static PrimeRequestContext getCurrentInstance(FacesContext facesContext) {
if (facesContext == null) {
return null;
}
PrimeRequestContext context = (PrimeRequestContext) facesContext.getAttributes().get(INSTANCE_KEY);
if (context == null) {
context = new PrimeRequestContext(facesContext);
setCurrentInstance(context, facesContext);
}
return context;
}
public static void setCurrentInstance(PrimeRequestContext context, FacesContext facesContext) {
if (context == null) {
if (facesContext != null) {
facesContext.getAttributes().remove(INSTANCE_KEY);
}
}
else {
facesContext.getAttributes().put(INSTANCE_KEY, context);
}
}
/**
* @return all callback parameters added in the current request.
*/
@SuppressWarnings("unchecked")
public Map getCallbackParams() {
Map callbackParams =
(Map) context.getAttributes().get(CALLBACK_PARAMS_KEY);
if (callbackParams == null) {
callbackParams = new HashMap<>();
context.getAttributes().put(CALLBACK_PARAMS_KEY, callbackParams);
}
return callbackParams;
}
/**
* @return all scripts added in the current request and called first before other scripts are executed.
*/
@SuppressWarnings("unchecked")
public List getInitScriptsToExecute() {
List initScriptsToExecute =
(List) context.getAttributes().get(EXECUTE_INIT_SCRIPTS_KEY);
if (initScriptsToExecute == null) {
initScriptsToExecute = new ArrayList<>(5);
context.getAttributes().put(EXECUTE_INIT_SCRIPTS_KEY, initScriptsToExecute);
}
return initScriptsToExecute;
}
/**
* @return all scripts added in the current request.
*/
@SuppressWarnings("unchecked")
public List getScriptsToExecute() {
List scriptsToExecute =
(List) context.getAttributes().get(EXECUTE_SCRIPTS_KEY);
if (scriptsToExecute == null) {
scriptsToExecute = new ArrayList<>();
context.getAttributes().put(EXECUTE_SCRIPTS_KEY, scriptsToExecute);
}
return scriptsToExecute;
}
/**
* @return Shared WidgetBuilder instance of the current request
*/
public WidgetBuilder getWidgetBuilder() {
if (this.widgetBuilder == null) {
this.widgetBuilder = new WidgetBuilder(context, getApplicationContext().getConfig());
}
return widgetBuilder;
}
/**
* @return Shared StyleClassBuilder instance of the current request
*/
public StyleClassBuilder getStyleClassBuilder() {
if (styleClassBuilder == null) {
styleClassBuilder = new StyleClassBuilder(context);
}
return styleClassBuilder;
}
/**
* @return Shared StyleBuilder instance of the current request
*/
public StyleBuilder getStyleBuilder() {
if (styleBuilder == null) {
styleBuilder = new StyleBuilder(context);
}
return styleBuilder;
}
/**
* @return Shared AjaxRequestBuilder instance of the current request
*/
public AjaxRequestBuilder getAjaxRequestBuilder() {
if (this.ajaxRequestBuilder == null) {
this.ajaxRequestBuilder = new AjaxRequestBuilder(context);
}
return ajaxRequestBuilder;
}
/**
* @return Shared Client Side Validation builder instance of the current request
*/
public CSVBuilder getCSVBuilder() {
if (this.csvBuilder == null) {
this.csvBuilder = new CSVBuilder(context);
}
return csvBuilder;
}
/**
* @return ApplicationContext instance.
*/
public PrimeApplicationContext getApplicationContext() {
if (this.applicationContext == null) {
this.applicationContext = PrimeApplicationContext.getCurrentInstance(context);
}
return applicationContext;
}
/**
* Clear resources.
*/
public void release() {
widgetBuilder = null;
ajaxRequestBuilder = null;
context = null;
applicationContext = null;
}
/**
* Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
*
* @return if secure or not.
*/
public boolean isSecure() {
if (secure == null) {
Object request = context.getExternalContext().getRequest();
if (request instanceof HttpServletRequest) {
secure = ((HttpServletRequest) request).isSecure();
}
else {
try {
Method method = request.getClass().getDeclaredMethod("isSecure", EMPTY_PARAMS);
secure = (Boolean) method.invoke(request, (Object[]) null);
}
catch (Exception e) {
secure = false;
}
}
}
return secure;
}
/**
* @return true if auto-updatable components should not be updated automatically in this request.
*/
public boolean isIgnoreAutoUpdate() {
if (ignoreAutoUpdate == null) {
Object ignoreAutoUpdateObject = context.getExternalContext().getRequestParameterMap().get(Constants.RequestParams.IGNORE_AUTO_UPDATE_PARAM);
ignoreAutoUpdate = (null != ignoreAutoUpdateObject && "true".equals(ignoreAutoUpdateObject));
}
return ignoreAutoUpdate;
}
/**
* Overrides eventually set ignoreAutoUpdate from client.
* May be used e.g. combined with server-side update via PrimeFaces.current().ajax().update("xxx")
* @param ignoreAutoUpdate
*/
public void setIgnoreAutoUpdate(Boolean ignoreAutoUpdate) {
this.ignoreAutoUpdate = ignoreAutoUpdate;
}
public boolean isRTL() {
if (rtl == null) {
String param = context.getExternalContext().getInitParameter(Constants.ContextParams.DIRECTION);
if (param == null) {
rtl = false;
}
else {
ELContext elContext = context.getELContext();
ExpressionFactory expressionFactory = context.getApplication().getExpressionFactory();
ValueExpression expression = expressionFactory.createValueExpression(elContext, param, String.class);
String expressionValue = (String) expression.getValue(elContext);
rtl = "rtl".equalsIgnoreCase(expressionValue);
}
}
return rtl;
}
public boolean isTouchable() {
if (touchable == null) {
touchable = evalBooleanExpression(Constants.ContextParams.TOUCHABLE, true);
}
return touchable;
}
public boolean isFlex() {
if (flex == null) {
flex = evalBooleanExpression(Constants.ContextParams.FLEX, false);
}
return flex;
}
public boolean isHideResourceVersion() {
if (hideResourceVersion == null) {
hideResourceVersion = evalBooleanExpression(Constants.ContextParams.HIDE_RESOURCE_VERSION, false);
}
return hideResourceVersion;
}
private boolean evalBooleanExpression(String param, boolean defaultValueIfNull) {
String paramValue = context.getExternalContext().getInitParameter(param);
if (paramValue == null) {
return defaultValueIfNull;
}
else {
ELContext elContext = context.getELContext();
ExpressionFactory expressionFactory = context.getApplication().getExpressionFactory();
ValueExpression expression = expressionFactory.createValueExpression(elContext, paramValue, String.class);
String expressionValue = (String) expression.getValue(elContext);
return expressionValue == null || Boolean.parseBoolean(expressionValue);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy