org.apache.empire.jakarta.app.FacesUtils Maven / Gradle / Ivy
The newest version!
/*
* 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.empire.jakarta.app;
import java.io.File;
import java.text.MessageFormat;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;
import org.apache.empire.commons.ObjectUtils;
import org.apache.empire.commons.StringUtils;
import org.apache.empire.data.Column;
import org.apache.empire.exceptions.InternalException;
import org.apache.empire.exceptions.InvalidArgumentException;
import org.apache.empire.exceptions.ItemNotFoundException;
import org.apache.empire.jakarta.impl.FacesImplementation;
import org.apache.empire.jakarta.pages.Page;
import org.apache.empire.jakarta.pages.PageDefinition;
import org.apache.empire.jakarta.pages.PageOutcome;
import org.apache.empire.jakarta.utils.HtmlUtils;
import org.apache.empire.jakarta.utils.ParameterMap;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import jakarta.el.ValueExpression;
import jakarta.faces.application.FacesMessage;
import jakarta.faces.application.FacesMessage.Severity;
import jakarta.faces.application.ProjectStage;
import jakarta.faces.component.UIComponent;
import jakarta.faces.component.UIInput;
import jakarta.faces.component.UIViewRoot;
import jakarta.faces.context.ExternalContext;
import jakarta.faces.context.FacesContext;
import jakarta.faces.event.ActionEvent;
import jakarta.servlet.ServletContext;
import jakarta.servlet.http.HttpServletRequest;
public class FacesUtils
{
private static final Logger log = LoggerFactory.getLogger(FacesUtils.class);
public static final String SKIP_INPUT_VALIDATION_PARAM = "empire.jsf.input.skipValidation";
/* Develpment stage */
public static boolean isDevelopmentStage(final FacesContext fc)
{
return fc.getApplication().getProjectStage()==ProjectStage.Development;
}
/* App */
public static WebApplication getWebApplication()
{
return WebApplication.getInstance();
}
public static FacesImplementation getFacesImplementation()
{
return getWebApplication().getFacesImplementation();
}
public static FacesContext getContext()
{
return FacesContext.getCurrentInstance();
}
public static Locale getContextLocale(final FacesContext fc)
{
return getWebApplication().getContextLocale(fc);
}
/* Session */
public static Map getSessionMap(final FacesContext fc)
{
return fc.getExternalContext().getSessionMap();
}
/* Request */
public static HttpServletRequest getHttpRequest(final FacesContext fc)
{
return (HttpServletRequest) fc.getExternalContext().getRequest();
}
public static String getRequestUri(FacesContext context)
{
ExternalContext ec = context.getExternalContext();
Object req = (ec!=null ? ec.getRequest() : null);
if (req instanceof HttpServletRequest) {
HttpServletRequest hr = (HttpServletRequest)req;
return hr.getRequestURI();
}
return "{No HttpServletRequest}";
}
public static String getRequestUserAgent(FacesContext context)
{
ExternalContext ec = context.getExternalContext();
Object req = (ec!=null ? ec.getRequest() : null);
if (req instanceof HttpServletRequest)
{ // get User-Agent
String agent = ((HttpServletRequest)req).getHeader("user-agent");
return agent;
}
return "{No HttpServletRequest}";
}
/* Should not be necessary
public static String getRequestContextPath()
{
ExternalContext ec = FacesContext.getCurrentInstance().getExternalContext();
return (ec!=null ? ec.getRequestContextPath() : null);
}
*/
public static Object getRequestAttribute(final String key)
{
FacesContext fc = getContext();
return getRequestAttribute(fc, key);
}
public static Object getRequestAttribute(final FacesContext fc, final String key)
{
return getHttpRequest(fc).getAttribute(key);
}
public static T getRequestAttribute(final FacesContext fc, final String key, Class clazz)
{
Object requestValue = getRequestAttribute(fc, key);
return (requestValue != null ? ObjectUtils.convert(clazz, requestValue) : null);
}
public static void setRequestAttribute(final String key, Object value)
{
FacesContext fc = getContext();
setRequestAttribute(fc, key, value);
}
public static void setRequestAttribute(final FacesContext fc, final String key, Object value)
{
if (value!=null)
getHttpRequest(fc).setAttribute(key, value);
else
getHttpRequest(fc).removeAttribute(key);
}
public static String getRequestParam(final FacesContext context, final String param)
{
return context.getExternalContext().getRequestParameterMap().get(param);
}
public static String getRequestParam(final String key)
{
FacesContext fc = getContext();
return getRequestParam(fc, key);
}
public static boolean isSkipInputValidation(final FacesContext fc)
{
// Skip validate
String val = FacesUtils.getRequestParam(fc, SKIP_INPUT_VALIDATION_PARAM);
return (val!=null && ObjectUtils.getBoolean(val));
}
public static boolean isSkipInputValidation()
{
FacesContext fc = getContext();
return isSkipInputValidation(fc);
}
public static T getActionEventAttribute(ActionEvent ae, String name, Class clazz)
{
Object item = ae.getComponent().getAttributes().get(name);
return ObjectUtils.convert(clazz, item);
}
/* Navigation */
public static void redirectDirectly(final FacesContext fc, final PageOutcome outcome)
{
getWebApplication().redirectDirectly(fc, outcome.toString());
}
public static void redirectDirectly(final FacesContext fc, final PageDefinition page)
{
FacesUtils.redirectDirectly(fc, page.getOutcome());
}
/* Connection
public DBContext getDBContext(final FacesContext fc, DBDatabase db)
{
return getWebApplication().getDBContextForRequest(fc, db);
}
public void releaseDBContext(final FacesContext fc, DBDatabase db, boolean commit)
{
getWebApplication().releaseDBContext(fc, db, commit);
}
public void releaseAllDBContexts(final FacesContext fc, boolean commit)
{
getWebApplication().releaseAllDBContexts(fc, commit);
}
*/
/* Pages */
@SuppressWarnings("unchecked")
public static T getPage(final FacesContext fc)
{
UIViewRoot vr = fc.getViewRoot();
if (vr==null)
throw new ItemNotFoundException("ViewRoot");
// find page
Page page = (Page)vr.getViewMap().get("page");
if (page==null)
throw new ItemNotFoundException("page");
// ok
return (T)page;
}
/* Parameter-map */
public static final String PARAMETER_MAP_ATTRIBUTE = "PARAMETER_MAP";
public static final String PARAMETER_MAP_CLASS_ATTRIBUTE = "PARAMETER_MAP_CLASS";
public static void setParameterMapClass(final FacesContext fc, Classclazz)
{
Map am = fc.getExternalContext().getApplicationMap();
am.put(PARAMETER_MAP_CLASS_ATTRIBUTE, clazz);
}
public static ParameterMap getParameterMap(final FacesContext fc)
{
Map sm = fc.getExternalContext().getSessionMap();
ParameterMap pm = (ParameterMap)sm.get(PARAMETER_MAP_ATTRIBUTE);
if (pm==null)
{ try
{ // Create Paramter Map
Map am = fc.getExternalContext().getApplicationMap();
Object pmClass = am.get(PARAMETER_MAP_CLASS_ATTRIBUTE);
if (pmClass instanceof Class) {
// ParamterMapClass provided as Object
pm = (ParameterMap)((Class)pmClass).newInstance();
}
else if (pmClass instanceof String) {
// ParamterMapClass provided as String
pm = (ParameterMap)Class.forName((String)pmClass).newInstance();
}
else {
// not provided, use default
pm = new ParameterMap();
}
}
catch (ClassNotFoundException e)
{
throw new InternalException(e);
}
catch (InstantiationException e)
{
throw new InternalException(e);
}
catch (IllegalAccessException e)
{
throw new InternalException(e);
}
// put on session
sm.put(PARAMETER_MAP_ATTRIBUTE, pm);
}
return pm;
}
public static ParameterMap getParameterMap()
{
return getParameterMap(getContext());
}
/* PageResource-map */
public static final String PAGE_RESOURCE_MAP_ATTRIBUTE = "pageResources"; /** use el-expression: #{pageResources.xxx} **/
/**
* returns the page resource map
* @param fc the faces context
* @return the ressource map
*/
@SuppressWarnings("unchecked")
public static Map getPageResourceMap(final FacesContext fc)
{
Map sm = fc.getExternalContext().getSessionMap();
Map rm = (Map)sm.get(PAGE_RESOURCE_MAP_ATTRIBUTE);
if (rm==null)
{ rm = new HashMap();
sm.put(PAGE_RESOURCE_MAP_ATTRIBUTE, rm);
}
return rm;
}
public static Map getPageResourceMap()
{
return getPageResourceMap(getContext());
}
/* Managed Beans */
public static Object getManagedBean(final FacesContext fc, final String name)
{
if (fc == null)
{
throw new NullPointerException("context must not be null");
}
if (name == null)
{
throw new NullPointerException("name must not be null");
}
/*
final ELContext elcontext = fc.getELContext();
final Application application = fc.getApplication();
return application.getELResolver().getValue(elcontext, null, name);
*/
return getWebApplication().getFacesImplementation().getManagedBean(name, fc);
}
public static T getManagedBean(final FacesContext fc, final Class cls, final String name)
{
@SuppressWarnings("unchecked")
T bean = (T)getManagedBean(fc, name);
if (bean==null)
{ log.warn("Managed Bean {} ist not available.", name);
throw new ItemNotFoundException(name);
}
return bean;
}
public static T getManagedBean(final FacesContext fc, final Class cls)
{
String name = cls.getName();
int i = name.lastIndexOf('.')+1;
name = name.substring(i, i+1).toLowerCase()+name.substring(i+1);
return getManagedBean(fc, cls, name);
}
public static T getManagedBean(final Class cls)
{
FacesContext fc = getContext();
return getManagedBean(fc, cls);
}
/*
@SuppressWarnings("unchecked")
public static T findBean(String beanName) {
FacesContext context = FacesContext.getCurrentInstance();
return (T) context.getApplication().evaluateExpressionGet(context, "#{" + beanName + "}", Object.class);
}
*/
/* file */
public static String getRealPath(final FacesContext fc, String path)
{
return (((ServletContext)fc.getExternalContext().getContext())).getRealPath(path);
}
public static String getFilePath(final FacesContext fc, String path, String file)
{
String realPath = getRealPath(fc, path);
return realPath.endsWith(File.separator) ? realPath+file : realPath + File.separator + file ;
}
/* Messages */
public static TextResolver getTextResolver(final FacesContext fc)
{
return getWebApplication().getTextResolver(fc);
}
public static String resolveText(final FacesContext fc, String text)
{
return getTextResolver(fc).resolveText(text);
}
public static String resolveText(String text)
{
return getTextResolver(getContext()).resolveText(text);
}
public static String getMessage(final FacesContext fc, String key)
{
if (StringUtils.isEmpty(key))
throw new InvalidArgumentException("key", key);
TextResolver tr = getTextResolver(fc);
return (key.startsWith(TextResolver.MSG_KEY_INDICATOR) ? tr.resolveText(key) : tr.resolveKey(key));
}
public static String getMessage(String messageKey)
{
return getMessage(getContext(), messageKey);
}
public static String formatMessage(final FacesContext fc, String msgKey, Object... params)
{
String pattern = getMessage(fc, msgKey);
return MessageFormat.format(pattern, params);
}
public static String formatMessage(String msgKey, Object... params)
{
return formatMessage(getContext(), msgKey, params);
}
/**
* Escapes Text for Html
* Uses HtmlUtils.getInstance() for escaping
* @param text the text to escape
* @return the escaped text
*/
public static String escapeHtml(String text)
{
return HtmlUtils.getInstance().escapeText(text);
}
/*
* indicates whether submitted values in InputControl should be cleared or preserved.
* Default is true.
* @param fc the faces context
* @return true if the submitted values should be cleared or false if they shold be preserved
public static boolean isClearSubmittedValues(FacesContext fc)
{
Object validate = fc.getExternalContext().getRequestMap().get("CLEAR_SUBMITTED_VALUES");
return (validate!=null ? ObjectUtils.getBoolean(validate) : false);
}
public static void setClearSubmittedValues(FacesContext fc, boolean validate)
{
fc.getExternalContext().getRequestMap().put("CLEAR_SUBMITTED_VALUES", validate);
}
*/
public static void addFacesMessage(FacesContext fc, UIComponent comp, FacesMessage facesMsg)
{
if (facesMsg==null)
return;
String clientId = (comp!=null ? comp.getClientId() : null);
fc.addMessage(clientId, facesMsg);
}
public static void addFacesMessage(UIComponent comp, Severity severity, String message, Object... params)
{
FacesContext fc = getContext();
addFacesMessage(fc, comp, getWebApplication().getFacesMessage(fc, severity, message, params));
}
public static void addInfoMessage(String msg, Object... params)
{
addFacesMessage(null, FacesMessage.SEVERITY_INFO, msg, params);
}
public static void addWarnMessage(String msg, Object... params)
{
addFacesMessage(null, FacesMessage.SEVERITY_WARN, msg, params);
}
public static void addErrorMessage(String msg, Object... params)
{
addFacesMessage(null, FacesMessage.SEVERITY_ERROR, msg, params);
}
public static void addErrorMessage(UIComponent comp, Throwable t)
{
FacesContext fc = getContext();
addFacesMessage(fc, comp, getFacesErrorMessage(fc, t));
}
public static void addErrorMessage(Throwable t)
{
addErrorMessage(null, t);
}
public static FacesMessage getFacesErrorMessage(FacesContext fc, Throwable t)
{
return getWebApplication().getFacesErrorMessage(fc, null, t);
}
public static void redirectFromError(Page page, FacesMessage errorMsg)
{
PageOutcome pageTarget = page.getPageDefinition().getOutcome();
// throw new InternalException(e);
FacesContext fc = FacesUtils.getContext();
boolean committed = fc.getExternalContext().isResponseCommitted();
if (committed)
{ log.warn("Cannot redirect to {} from an already committed response! Error is {}.", pageTarget, errorMsg.getSummary());
return;
}
// redirect to target page
if (errorMsg!=null) {
ExternalContext ec = fc.getExternalContext();
ec.getSessionMap().put(Page.SESSION_MESSAGE, errorMsg);
}
// redirect
FacesUtils.redirectDirectly(fc, pageTarget);
}
public static void redirectFromError(Page page, Throwable t)
{
FacesContext fc = FacesUtils.getContext();
FacesMessage facesMsg = getFacesErrorMessage(fc, t);
redirectFromError(page, facesMsg);
}
/* Component search */
public static UIInput findInputComponent(UIComponent parent, Column column)
{
// Get Children
Iterator children = parent.getFacetsAndChildren();
while (children.hasNext())
{ // Iterate through all children
UIComponent nextChild = children.next();
log.info("Checking child {}", nextChild.getClass().getName());
if (nextChild instanceof UIInput)
{ // Check Column Attribute
Object col = nextChild.getAttributes().get("column");
if (col==null)
{ // Check ID
ValueExpression ve = nextChild.getValueExpression("column");
if (ve!=null)
log.warn("TODO: evaluate Value Expression!");
}
else if (column.equals(col))
{ // check form
return (UIInput)nextChild;
}
}
else
{ // recurse children and facets
UIInput input = findInputComponent(nextChild, column);
if (input!=null)
return input;
}
}
// Not found
return null;
}
public static UIInput findInputComponent(FacesContext fc, String formId, Column column)
{
UIComponent parent = fc.getViewRoot();
if (StringUtils.isNotEmpty(formId))
{
parent = WebApplication.findChildComponent(parent, formId);
if (parent==null)
return null; // not found
}
// find
return findInputComponent(parent, column);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy