org.apache.myfaces.renderkit.html.base.HtmlInputFileRendererBase Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of myfaces-impl Show documentation
Show all versions of myfaces-impl Show documentation
The private implementation classes of the Apache MyFaces Core JSF-2.3-next Implementation
/*
* 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.renderkit.html.base;
import org.apache.myfaces.renderkit.html.util.HtmlRendererUtils;
import org.apache.myfaces.renderkit.html.util.ClientBehaviorRendererUtils;
import org.apache.myfaces.renderkit.html.util.CommonPropertyUtils;
import org.apache.myfaces.renderkit.html.util.CommonEventUtils;
import javax.faces.component.UIComponent;
import javax.faces.component.UIInput;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.convert.ConverterException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.Part;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.faces.FacesException;
import javax.faces.application.FacesMessage;
import javax.faces.application.ProjectStage;
import javax.faces.component.UIForm;
import javax.faces.component.UIViewRoot;
import javax.faces.component.behavior.ClientBehavior;
import javax.faces.component.behavior.ClientBehaviorHolder;
import javax.faces.component.html.HtmlForm;
import javax.faces.component.html.HtmlInputText;
import org.apache.myfaces.core.api.shared.ComponentUtils;
import org.apache.myfaces.renderkit.RendererUtils;
import org.apache.myfaces.renderkit.html.util.HttpPartWrapper;
import org.apache.myfaces.renderkit.html.util.HTML;
import org.apache.myfaces.renderkit.html.util.JSFAttr;
import org.apache.myfaces.util.lang.Assert;
public class HtmlInputFileRendererBase extends HtmlRenderer
{
private static final Logger log = Logger.getLogger(HtmlInputFileRendererBase.class.getName());
private static final String AUTOCOMPLETE_VALUE_OFF = "off";
@Override
public void decode(FacesContext facesContext, UIComponent component)
{
try
{
Part part = ((HttpServletRequest) facesContext.getExternalContext().getRequest()).
getPart(component.getClientId());
if (part == null)
{
return;
}
((UIInput) component).setSubmittedValue(new HttpPartWrapper(part));
}
catch (IOException | ServletException e)
{
throw new FacesException(e);
}
if (component instanceof ClientBehaviorHolder && !HtmlRendererUtils.isDisabled(component))
{
ClientBehaviorRendererUtils.decodeClientBehaviors(facesContext, component);
}
}
@Override
public void encodeEnd(FacesContext facesContext, UIComponent component)
throws IOException
{
renderInput(facesContext, component);
if(!facesContext.isProjectStage(ProjectStage.Production)
&& facesContext.isPostback()
&& (facesContext.getPartialViewContext().isPartialRequest() ||
facesContext.getPartialViewContext().isAjaxRequest()))
{
UIForm form = ComponentUtils.findClosest(UIForm.class, component);
if (form != null && form instanceof HtmlForm)
{
String content = ((HtmlForm) form).getEnctype();
if (content == null || !content.contains("multipart/form-data"))
{
FacesMessage message = new FacesMessage("file upload requires a form with"+
" enctype equal to multipart/form-data");
facesContext.addMessage(component.getClientId(), message);
}
}
}
}
@Override
public Object getConvertedValue(FacesContext context, UIComponent component, Object submittedValue)
throws ConverterException
{
Assert.notNull(context, "context");
Assert.notNull(component, "component");
return submittedValue;
}
/**
* Returns the HTML type attribute of HTML input element, which is being rendered.
*/
protected String getInputHtmlType(UIComponent component)
{
//subclasses may act on properties of the component
return HTML.INPUT_TYPE_FILE;
}
protected void renderValue(FacesContext facesContext, UIComponent component, ResponseWriter writer)
throws IOException
{
//the input file element cannot render a value it is readonly
}
protected boolean isRenderOutputEventAttributes()
{
return true;
}
protected void renderInput(FacesContext facesContext, UIComponent component)
throws IOException
{
//allow subclasses to render custom attributes by separating rendering begin and end
renderInputBegin(facesContext, component);
renderInputEnd(facesContext, component);
}
//Subclasses can set the value of an attribute before, or can render a custom attribute after calling this method
protected void renderInputBegin(FacesContext facesContext, UIComponent component) throws IOException
{
ResponseWriter writer = facesContext.getResponseWriter();
String clientId = component.getClientId(facesContext);
writer.startElement(HTML.INPUT_ELEM, component);
writer.writeAttribute(HTML.ID_ATTR, clientId, null);
writer.writeAttribute(HTML.NAME_ATTR, clientId, null);
//allow extending classes to modify html input element's type
String inputHtmlType = getInputHtmlType(component);
writer.writeAttribute(HTML.TYPE_ATTR, inputHtmlType, null);
renderValue(facesContext, component, writer);
Map> behaviors = null;
if (component instanceof ClientBehaviorHolder)
{
behaviors = ((ClientBehaviorHolder) component).getClientBehaviors();
long commonPropertiesMarked = 0L;
if (isCommonPropertiesOptimizationEnabled(facesContext))
{
commonPropertiesMarked = CommonPropertyUtils.getCommonPropertiesMarked(component);
}
if (behaviors.isEmpty() && isCommonPropertiesOptimizationEnabled(facesContext))
{
CommonPropertyUtils.renderChangeEventProperty(writer,
commonPropertiesMarked, component);
CommonPropertyUtils.renderEventProperties(writer,
commonPropertiesMarked, component);
CommonPropertyUtils.renderFieldEventPropertiesWithoutOnchange(writer,
commonPropertiesMarked, component);
}
else
{
HtmlRendererUtils.renderBehaviorizedOnchangeEventHandler(facesContext, writer, component, behaviors);
if (isCommonEventsOptimizationEnabled(facesContext))
{
Long commonEventsMarked = CommonEventUtils.getCommonEventsMarked(component);
CommonEventUtils.renderBehaviorizedEventHandlers(facesContext, writer,
commonPropertiesMarked, commonEventsMarked, component, behaviors);
CommonEventUtils.renderBehaviorizedFieldEventHandlersWithoutOnchange(
facesContext, writer, commonPropertiesMarked, commonEventsMarked, component, behaviors);
}
else
{
HtmlRendererUtils.renderBehaviorizedEventHandlers(facesContext, writer, component, behaviors);
HtmlRendererUtils.renderBehaviorizedFieldEventHandlersWithoutOnchange(
facesContext, writer, component, behaviors);
}
}
if (isCommonPropertiesOptimizationEnabled(facesContext))
{
CommonPropertyUtils.renderInputPassthroughPropertiesWithoutDisabledAndEvents(writer,
commonPropertiesMarked, component);
}
else
{
HtmlRendererUtils.renderHTMLAttributes(writer, component,
HTML.INPUT_PASSTHROUGH_ATTRIBUTES_WITHOUT_DISABLED_AND_EVENTS);
}
}
else
{
if (isCommonPropertiesOptimizationEnabled(facesContext))
{
CommonPropertyUtils.renderInputPassthroughPropertiesWithoutDisabled(writer,
CommonPropertyUtils.getCommonPropertiesMarked(component), component);
}
else
{
HtmlRendererUtils.renderHTMLAttributes(writer, component,
HTML.INPUT_PASSTHROUGH_ATTRIBUTES_WITHOUT_DISABLED);
}
}
if (isDisabled(facesContext, component))
{
writer.writeAttribute(HTML.DISABLED_ATTR, HTML.DISABLED_ATTR, null);
}
if (isAutocompleteOff(facesContext, component))
{
writer.writeAttribute(HTML.AUTOCOMPLETE_ATTR, AUTOCOMPLETE_VALUE_OFF, HTML.AUTOCOMPLETE_ATTR);
}
}
protected void renderInputEnd(FacesContext facesContext, UIComponent component) throws IOException
{
ResponseWriter writer = facesContext.getResponseWriter();
writer.endElement(HTML.INPUT_ELEM);
}
protected boolean isDisabled(FacesContext facesContext, UIComponent component)
{
if (component instanceof HtmlInputText)
{
return ((HtmlInputText)component).isDisabled();
}
return RendererUtils.getBooleanAttribute(component, HTML.DISABLED_ATTR, false);
}
/**
* If autocomplete is "on" or not set, do not render it
*/
protected boolean isAutocompleteOff(FacesContext facesContext, UIComponent component)
{
if (component instanceof HtmlInputText)
{
String autocomplete = ((HtmlInputText)component).getAutocomplete();
if (autocomplete != null)
{
return autocomplete.equals(AUTOCOMPLETE_VALUE_OFF);
}
}
return false;
}
public static void renderOutputText(FacesContext facesContext, UIComponent component, String text, boolean escape)
throws IOException
{
if (text != null)
{
ResponseWriter writer = facesContext.getResponseWriter();
boolean span = false;
if (component.getId() != null && !component.getId().startsWith(UIViewRoot.UNIQUE_ID_PREFIX))
{
span = true;
writer.startElement(HTML.SPAN_ELEM, component);
HtmlRendererUtils.writeIdIfNecessary(writer, component, facesContext);
HtmlRendererUtils.renderHTMLAttributes(writer, component, HTML.COMMON_PASSTROUGH_ATTRIBUTES);
}
else
{
span = HtmlRendererUtils.renderHTMLAttributesWithOptionalStartElement(writer,
component, HTML.SPAN_ELEM, HTML.COMMON_PASSTROUGH_ATTRIBUTES);
}
if (escape)
{
if (log.isLoggable(Level.FINE))
{
log.fine("renderOutputText writing '" + text + '\'');
}
writer.writeText(text, JSFAttr.VALUE_ATTR);
}
else
{
writer.write(text);
}
if (span)
{
writer.endElement(HTML.SPAN_ELEM);
}
}
}
}