/*
* 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.myfaces.tobago.renderkit.util;
import org.apache.myfaces.tobago.component.Attributes;
import org.apache.myfaces.tobago.config.Configurable;
import org.apache.myfaces.tobago.context.ResourceManagerUtils;
import org.apache.myfaces.tobago.internal.component.AbstractUICommandBase;
import org.apache.myfaces.tobago.internal.component.AbstractUIData;
import org.apache.myfaces.tobago.internal.util.StringUtils;
import org.apache.myfaces.tobago.layout.Measure;
import org.apache.myfaces.tobago.model.ExpandedState;
import org.apache.myfaces.tobago.model.SelectedState;
import org.apache.myfaces.tobago.model.TreePath;
import org.apache.myfaces.tobago.renderkit.html.HtmlAttributes;
import org.apache.myfaces.tobago.renderkit.html.HtmlElements;
import org.apache.myfaces.tobago.renderkit.html.HtmlInputTypes;
import org.apache.myfaces.tobago.util.ComponentUtils;
import org.apache.myfaces.tobago.util.DebugUtils;
import org.apache.myfaces.tobago.webapp.TobagoResponseWriter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.faces.application.Application;
import javax.faces.application.ViewHandler;
import javax.faces.component.EditableValueHolder;
import javax.faces.component.UIComponent;
import javax.faces.component.UIParameter;
import javax.faces.component.UISelectItem;
import javax.faces.component.UISelectItems;
import javax.faces.component.ValueHolder;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;
import javax.faces.convert.Converter;
import javax.faces.convert.ConverterException;
import javax.faces.model.SelectItem;
import java.io.IOException;
import java.net.URLDecoder;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
public class RenderUtils {
private static final Logger LOG = LoggerFactory.getLogger(RenderUtils.class);
/**
* @deprecated since 2.0.0
*/
@Deprecated
public static final String COMPONENT_IN_REQUEST = "org.apache.myfaces.tobago.component";
public static final String SCROLL_POSTFIX = ComponentUtils.SUB_SEPARATOR + "scrollPosition";
private RenderUtils() {
// to prevent instantiation
}
public static boolean contains(final Object[] list, final Object value) {
if (list == null) {
return false;
}
for (final Object aList : list) {
if (aList != null && aList.equals(value)) {
return true;
}
}
return false;
}
public static void encodeChildren(final FacesContext facesContext, final UIComponent panel) throws IOException {
for (final UIComponent child : panel.getChildren()) {
encode(facesContext, child);
}
}
public static void encode(final FacesContext facesContext, final UIComponent component) throws IOException {
encode(facesContext, component, null);
}
public static void encode(
final FacesContext facesContext, final UIComponent component,
final List<? extends Class<? extends UIComponent>> only)
throws IOException {
if (only != null && !matchFilter(component, only)) {
return;
}
if (component.isRendered()) {
if (LOG.isDebugEnabled()) {
LOG.debug("rendering " + component.getRendererType() + " " + component);
}
component.encodeBegin(facesContext);
if (component.getRendersChildren()) {
component.encodeChildren(facesContext);
} else {
for (final UIComponent child : component.getChildren()) {
encode(facesContext, child, only);
}
}
component.encodeEnd(facesContext);
}
}
private static boolean matchFilter(
final UIComponent component, final List<? extends Class<? extends UIComponent>> only) {
for (final Class<? extends UIComponent> clazz : only) {
if (clazz.isAssignableFrom(component.getClass())) {
return true;
}
}
return false;
}
/**
* @deprecated since 2.0.0, please use EncodeUtils.prepareRendererAll()
*/
@Deprecated
public static void prepareRendererAll(final FacesContext facesContext, final UIComponent component)
throws IOException {
EncodeUtils.prepareRendererAll(facesContext, component);
}
public static String getFormattedValue(final FacesContext facesContext, final UIComponent component) {
Object value = null;
if (component instanceof ValueHolder) {
value = ((ValueHolder) component).getLocalValue();
if (value == null) {
value = ((ValueHolder) component).getValue();
}
}
return getFormattedValue(facesContext, component, value);
}
// Copy from RendererBase
public static String getFormattedValue(
final FacesContext context, final UIComponent component, final Object currentValue)
throws ConverterException {
if (currentValue == null) {
return "";
}
if (!(component instanceof ValueHolder)) {
return currentValue.toString();
}
Converter converter = ((ValueHolder) component).getConverter();
if (converter == null) {
if (currentValue instanceof String) {
return (String) currentValue;
}
final Class converterType = currentValue.getClass();
converter = context.getApplication().createConverter(converterType);
}
if (converter == null) {
return currentValue.toString();
} else {
return converter.getAsString(context, component, currentValue);
}
}
public static Measure calculateStringWidth(
final FacesContext facesContext, final UIComponent component, final String text) {
return calculateStringWidth(facesContext, (Configurable) component, text, "tobago.font.widths");
}
public static Measure calculateStringWidth2(
final FacesContext facesContext, final UIComponent component, final String text) {
return calculateStringWidth(facesContext, (Configurable) component, text, "tobago.font2.widths");
}
private static Measure calculateStringWidth(
final FacesContext facesContext, final Configurable component, final String text, final String type) {
if (text == null) {
return Measure.ZERO;
}
int width = 0;
int defaultCharWidth = 10;
try {
defaultCharWidth = ResourceManagerUtils.getThemeMeasure(facesContext, component, "fontWidth").getPixel();
} catch (final NullPointerException e) {
LOG.warn("no value for 'fontWidth' for type '" + component.getRendererType() + "' found in theme-config");
}
final String fontWidths = ResourceManagerUtils.getProperty(facesContext, "tobago", type);
for (final char c : text.toCharArray()) {
if (c >= 32 && c < 128) { // "normal" char in precomputed range
final int begin = (c - 32) * 2;
width += Integer.parseInt(fontWidths.substring(begin, begin + 2), 16);
} else {
width += defaultCharWidth;
}
}
width += text.length(); // fixes the problem, that sometime some browsers add some pixels
return Measure.valueOf(width);
}
/**
* @deprecated Since Tobago 2.0.0. Please use SelectItemUtils
*/
@Deprecated
public static List<SelectItem> getItemsToRender(final javax.faces.component.UISelectOne component) {
return getItems(component);
}
/**
* @deprecated Since Tobago 2.0.0. Please use SelectItemUtils
*/
@Deprecated
public static List<SelectItem> getItemsToRender(final javax.faces.component.UISelectMany component) {
return getItems(component);
}
/**
* @deprecated Since Tobago 2.0.0. Please use SelectItemUtils
*/
@Deprecated
public static List<SelectItem> getItems(final javax.faces.component.UIInput component) {
final List<SelectItem> selectItems = getSelectItems(component);
String renderRange = (String) component.getAttributes().get(Attributes.RENDER_RANGE_EXTERN);
if (renderRange == null) {
renderRange = (String) component.getAttributes().get(Attributes.RENDER_RANGE);
}
if (renderRange == null) {
return selectItems;
}
final int[] indices = StringUtils.getIndices(renderRange);
final List<SelectItem> items = new ArrayList<SelectItem>(indices.length);
if (selectItems.size() != 0) {
for (final int index : indices) {
items.add(selectItems.get(index));
}
} else {
LOG.warn("No items found! rendering dummies instead!");
for (int i = 0; i < indices.length; i++) {
items.add(new SelectItem(Integer.toString(i), "Item " + i, ""));
}
}
return items;
}
public static String currentValue(final UIComponent component) {
String currentValue = null;
if (component instanceof ValueHolder) {
Object value;
if (component instanceof EditableValueHolder) {
value = ((EditableValueHolder) component).getSubmittedValue();
if (value != null) {
return (String) value;
}
}
value = ((ValueHolder) component).getValue();
if (value != null) {
Converter converter = ((ValueHolder) component).getConverter();
if (converter == null) {
final FacesContext context = FacesContext.getCurrentInstance();
converter = context.getApplication().createConverter(value.getClass());
}
if (converter != null) {
currentValue =
converter.getAsString(FacesContext.getCurrentInstance(),
component, value);
} else {
currentValue = value.toString();
}
}
}
return currentValue;
}
/**
* @deprecated Since Tobago 2.0.0. Please use SelectItemUtils
*/
@Deprecated
public static List<SelectItem> getSelectItems(final UIComponent component) {
final ArrayList<SelectItem> list = new ArrayList<SelectItem>();
for (final UIComponent child : component.getChildren()) {
if (LOG.isDebugEnabled()) {
LOG.debug("kid " + child);
LOG.debug("kid " + child.getClass().getName());
}
if (child instanceof UISelectItem) {
final Object value = ((UISelectItem) child).getValue();
if (value == null) {
final UISelectItem item = (UISelectItem) child;
if (child instanceof org.apache.myfaces.tobago.component.UISelectItem) {
list.add(getSelectItem(
(org.apache.myfaces.tobago.component.UISelectItem) child));
} else {
list.add(new SelectItem(item.getItemValue() == null ? "" : item.getItemValue(),
item.getItemLabel() != null ? item.getItemLabel() : item.getItemValue().toString(),
item.getItemDescription()));
}
} else if (value instanceof SelectItem) {
list.add((SelectItem) value);
} else {
final String message
= "TYPE ERROR: value NOT instanceof SelectItem. type="
+ value.getClass().getName() + " value=" + value;
LOG.error(message);
DebugUtils.addDevelopmentMessage(FacesContext.getCurrentInstance(), message);
}
} else if (child instanceof UISelectItems) {
final Object value = ((UISelectItems) child).getValue();
if (LOG.isDebugEnabled()) {
LOG.debug("value " + value);
if (value != null) {
LOG.debug("value " + value.getClass().getName());
}
}
if (value == null) {
if (LOG.isDebugEnabled()) {
LOG.debug("value is null");
}
} else if (value instanceof SelectItem) {
list.add((SelectItem) value);
} else if (value instanceof SelectItem[]) {
final SelectItem[] items = (SelectItem[]) value;
list.addAll(Arrays.asList(items));
} else if (value instanceof Collection) {
for (final Object o : ((Collection) value)) {
list.add((SelectItem) o);
}
} else if (value instanceof Map) {
for (final Object key : ((Map) value).keySet()) {
if (key != null) {
final Object val = ((Map) value).get(key);
if (val != null) {
list.add(new SelectItem(val.toString(), key.toString(), null));
}
}
}
} else {
final String message
= "TYPE ERROR: value NOT instanceof SelectItem, SelectItem[], Collection, Map. type="
+ value.getClass().getName() + " value=" + value;
LOG.error(message);
DebugUtils.addDevelopmentMessage(FacesContext.getCurrentInstance(), message);
}
}
}
return list;
}
/**
* @deprecated Since Tobago 2.0.0. Please use SelectItemUtils
*/
@Deprecated
private static SelectItem getSelectItem(final org.apache.myfaces.tobago.component.UISelectItem component) {
return
new org.apache.myfaces.tobago.model.SelectItem(component.getItemValue() == null ? "" : component.getItemValue(),
component.getItemLabel(), component.getItemDescription(),
component.isItemDisabled(), component.getItemImage(), component.getMarkup());
}
public static void decodedStateOfTreeData(final FacesContext facesContext, final AbstractUIData data) {
if (!data.isTreeModel()) {
return;
}
// selected
final List<Integer> selectedIndices = decodeIndices(facesContext, data, AbstractUIData.SUFFIX_SELECTED);
// expanded
final List<Integer> expandedIndices = decodeIndices(facesContext, data, AbstractUIData.SUFFIX_EXPANDED);
final int last = data.isRowsUnlimited() ? Integer.MAX_VALUE : data.getFirst() + data.getRows();
for (int rowIndex = data.getFirst(); rowIndex < last; rowIndex++) {
data.setRowIndex(rowIndex);
if (!data.isRowAvailable()) {
break;
}
final TreePath path = data.getPath();
// selected
final SelectedState selectedState = data.getSelectedState();
final boolean oldSelected = selectedState.isSelected(path);
final boolean newSelected = selectedIndices.contains(rowIndex);
if (newSelected != oldSelected) {
if (newSelected) {
selectedState.select(path);
} else {
selectedState.unselect(path);
}
}
// expanded
if (expandedIndices != null) {
final ExpandedState expandedState = data.getExpandedState();
final boolean oldExpanded = expandedState.isExpanded(path);
final boolean newExpanded = expandedIndices.contains(rowIndex);
if (newExpanded != oldExpanded) {
if (newExpanded) {
expandedState.expand(path);
} else {
expandedState.collapse(path);
}
}
}
}
data.setRowIndex(-1);
}
private static List<Integer> decodeIndices(
final FacesContext facesContext, final AbstractUIData data, final String suffix) {
String string = null;
final String key = data.getClientId(facesContext) + ComponentUtils.SUB_SEPARATOR + suffix;
try {
string = facesContext.getExternalContext().getRequestParameterMap().get(key);
if (string != null) {
return StringUtils.parseIntegerList(string);
}
} catch (final Exception e) {
// should not happen
LOG.warn("Can't parse " + suffix + ": '" + string + "' from parameter '" + key + "'", e);
}
return null;
}
public static void writeScrollPosition(
final FacesContext facesContext, final TobagoResponseWriter writer, final UIComponent component)
throws IOException {
Integer[] scrollPosition = (Integer[]) component.getAttributes().get(Attributes.SCROLL_POSITION);
if (scrollPosition == null) {
final String key = component.getClientId(facesContext) + SCROLL_POSTFIX;
scrollPosition = parseScrollPosition(facesContext.getExternalContext().getRequestParameterMap().get(key));
}
writeScrollPosition(facesContext, writer, component, scrollPosition);
}
public static void writeScrollPosition(
final FacesContext facesContext, final TobagoResponseWriter writer, final UIComponent component,
final Integer[] scrollPosition)
throws IOException {
final String clientId = component.getClientId(facesContext);
writer.startElement(HtmlElements.INPUT, null);
writer.writeIdAttribute(clientId + SCROLL_POSTFIX);
writer.writeNameAttribute(clientId + SCROLL_POSTFIX);
writer.writeAttribute(HtmlAttributes.TYPE, HtmlInputTypes.HIDDEN, false);
if (scrollPosition != null) {
final String scroll = scrollPosition[0] + ";" + scrollPosition[1];
writer.writeAttribute(HtmlAttributes.VALUE, scroll, false);
} else {
writer.writeAttribute(HtmlAttributes.VALUE, "", false);
}
writer.writeAttribute("data-tobago-scroll-position", "true", true);
writer.endElement(HtmlElements.INPUT);
}
public static void decodeScrollPosition(final FacesContext facesContext, final UIComponent component) {
final String key = component.getClientId(facesContext) + SCROLL_POSTFIX;
final String value = facesContext.getExternalContext().getRequestParameterMap().get(key);
if (value != null) {
final Integer[] scrollPosition = parseScrollPosition(value);
if (scrollPosition != null) {
//noinspection unchecked
component.getAttributes().put(Attributes.SCROLL_POSITION, scrollPosition);
}
}
}
public static Integer[] parseScrollPosition(final String value) {
Integer[] position = null;
if (!StringUtils.isBlank(value)) {
final int sep = value.indexOf(";");
if (LOG.isInfoEnabled()) {
LOG.info("value = \"" + value + "\" sep = " + sep + "");
}
if (sep == -1) {
throw new NumberFormatException(value);
}
final int left = Integer.parseInt(value.substring(0, sep));
final int top = Integer.parseInt(value.substring(sep + 1));
position = new Integer[2];
position[0] = left;
position[1] = top;
}
return position;
}
public static String generateUrl(final FacesContext facesContext, final AbstractUICommandBase component) {
final Application application = facesContext.getApplication();
final ViewHandler viewHandler = application.getViewHandler();
final ExternalContext externalContext = facesContext.getExternalContext();
String url = null;
if (component.getResource() != null) {
final boolean jsfResource = component.isJsfResource();
url = ResourceManagerUtils.getPageWithoutContextPath(facesContext, component.getResource());
if (url != null) {
if (jsfResource) {
url = viewHandler.getActionURL(facesContext, url);
url = externalContext.encodeActionURL(url);
} else {
url = viewHandler.getResourceURL(facesContext, url);
url = externalContext.encodeResourceURL(url);
}
} else {
url = "";
}
} else if (component.getLink() != null) {
final String link = component.getLink();
if (link.startsWith("/")) { // internal absolute link
url = externalContext.encodeResourceURL(externalContext.getRequestContextPath() + link);
} else if (StringUtils.isUrl(link)) { // external link
url = link;
} else { // internal relative link
url = externalContext.encodeResourceURL(link);
}
final StringBuilder builder = new StringBuilder(url);
boolean firstParameter = !url.contains("?");
for (final UIComponent child : component.getChildren()) {
if (child instanceof UIParameter) {
final UIParameter parameter = (UIParameter) child;
if (firstParameter) {
builder.append("?");
firstParameter = false;
} else {
builder.append("&");
}
builder.append(parameter.getName());
builder.append("=");
final Object value = parameter.getValue();
// TODO encoding
builder.append(value != null ? URLDecoder.decode(value.toString()) : null);
}
}
url = builder.toString();
}
return url;
}
}