UtilsJsf.java

/**
 * Copyright 2005-2016 hdiv.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.hdiv.util;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.regex.Pattern;

import javax.faces.component.NamingContainer;
import javax.faces.component.UIComponent;
import javax.faces.component.UIData;
import javax.faces.component.UIForm;
import javax.faces.component.UIParameter;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.servlet.http.HttpServletRequest;

import org.hdiv.context.RequestContextHolder;

/**
 * General HDIV utility methods
 * 
 * @author Gotzon Illarramendi
 */
public abstract class UtilsJsf {

	private static final Pattern ROW_ID_PATTERN_MIDDLE = Pattern.compile(":\\d*:");

	private static final Pattern ROW_ID_PATTERN_END = Pattern.compile(":\\d$");

	private UtilsJsf() {
	}

	/**
	 * Checks if any of the names of the received parameters contains the ViewState.
	 * 
	 * @param paramNameSet parameter name group
	 * @return boolean
	 */
	public static boolean hasFacesViewParamName(final Set<String> paramNameSet) {
		String[] params = UtilsJsf.getFacesViewParamNames();

		for (int i = 0; i < params.length; i++) {
			if (paramNameSet.contains(params[i])) {
				return true;
			}
		}
		return false;
	}

	/**
	 * Checks if the parameter name contains the ViewState
	 * 
	 * @param paramName parameter name
	 * @return boolean
	 */
	public static boolean isFacesViewParamName(final String paramName) {
		String[] params = UtilsJsf.getFacesViewParamNames();

		for (int i = 0; i < params.length; i++) {
			if (paramName.equals(params[i])) {
				return true;
			}
		}
		return false;

	}

	/**
	 * Returns the names of the parameters that contain the ViewState
	 * 
	 * @return Param names
	 */
	public static String[] getFacesViewParamNames() {

		return ConstantsJsf.FACES_VIEWSTATE_PARAMNAMES;

	}

	/**
	 * Returns the list of parameters added by JSF implementations.
	 * 
	 * @param submitedFormClientId client id of the form sent in the last request.
	 * @return list of parameter names
	 */
	public static List<String> getJSFImplementationParamNames(final String submitedFormClientId) {

		List<String> list = new ArrayList<String>();

		// Adds parameter that indicates which component executed the event of MyFaces
		list.add(submitedFormClientId + ":_idcl");
		// SUN RI
		list.add(submitedFormClientId + ":_idcl");// Version 1.1
		list.add(submitedFormClientId + ":j_idcl");// Version 1.2 < 07

		// Rest of the parameters added by each implementation
		// Sun RI doesn't add any parameter
		// MyFaces added some extra parameters
		list.add(submitedFormClientId + "_SUBMIT");
		list.add(submitedFormClientId + ":_link_hidden_");

		return list;
	}

	/**
	 * Removes row identifier from client id. Converts: PageC:form2:tableid:0:link1 into: PageC:form2:tableid:link1
	 * 
	 * @param clientId ClientID
	 * @return clientId without row id
	 */
	public static String removeRowId(final String clientId) {
		if (clientId == null) {
			return null;
		}
		String result = ROW_ID_PATTERN_MIDDLE.matcher(clientId).replaceAll(":");
		return ROW_ID_PATTERN_END.matcher(result).replaceAll("");
	}

	/**
	 * Determines if the component id has an row id.
	 * 
	 * @param clientId ClientID
	 * @return true if the id has a row id
	 */
	public static boolean hasRowId(final String clientId) {
		if (clientId == null) {
			return false;
		}

		boolean found = ROW_ID_PATTERN_MIDDLE.matcher(clientId).find();
		if (found) {
			return true;
		}
		else {
			return ROW_ID_PATTERN_END.matcher(clientId).find();
		}
	}

	/**
	 * Searches in the parent components of comp if exists one of type UIData. Returns null if not found.
	 * 
	 * @param comp base component to start to find
	 * @return UIData component or null
	 */
	public static UIData findParentUIData(final UIComponent comp) {

		return (UIData) findParentOfType(comp, UIData.class);
	}

	/**
	 * Searches in the parent components of comp if exists one of type UIForm. Returns null if not found.
	 * 
	 * @param comp Base component
	 * @return UIForm component
	 */
	public static UIForm findParentForm(final UIComponent comp) {

		return (UIForm) findParentOfType(comp, UIForm.class);
	}

	/**
	 * Searches in the parent components of comp if exists one of type NamingContainer. Returns null if not found.
	 * 
	 * @param comp Base component
	 * @return NamingContainer component
	 */
	public static NamingContainer findParentNamingContainer(final UIComponent comp) {

		return (NamingContainer) findParentOfType(comp, NamingContainer.class);
	}

	/**
	 * Generic method to find parent component of a type
	 * @param comp Base component
	 * @param type Component type
	 * @return found component or null
	 */
	public static UIComponent findParentOfType(final UIComponent comp, final Class<?> type) {

		UIComponent parent = comp.getParent();
		while (!type.isAssignableFrom(parent.getClass())) {
			if (parent instanceof UIViewRoot) {
				return null;
			}
			parent = parent.getParent();
		}
		return parent;
	}

	/**
	 * Search component children for UIParameter components.
	 * 
	 * @param component {@link UIComponent} component
	 * @return if component has children
	 */
	public static boolean hasUIParameterChild(final UIComponent component) {

		boolean hasParams = false;
		for (UIComponent comp : component.getChildren()) {
			if (comp instanceof UIParameter) {
				hasParams = true;
				break;
			}
		}
		return hasParams;
	}

	public static String getTargetUrl(final FacesContext context) {

		HttpServletRequest request = (HttpServletRequest) context.getExternalContext().getRequest();
		RequestContextHolder requestContext = HDIVUtil.getRequestContext(request);
		String url = "";
		if (requestContext != null) {
			url = requestContext.getRequestURI();
		}
		else {
			url = request.getRequestURI();
		}
		return url.substring(request.getContextPath().length());
	}

	public static boolean isRequestInitialized(final FacesContext context) {

		HttpServletRequest request = (HttpServletRequest) context.getExternalContext().getRequest();
		RequestContextHolder requestContext = HDIVUtil.getRequestContext(request);
		if (requestContext == null) {
			return false;
		}
		else {
			return requestContext.getDataComposer() != null;
		}
	}

}