Coverage Report

Coverage Report - org.apache.myfaces.shared_impl.renderkit.html.HtmlLinkRendererBase

Classes in this File

Line Coverage

Branch Coverage

Complexity

HtmlLinkRendererBase

0/226

0/108

3.85

 /*
  *  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.shared_impl.renderkit.html;
 
 import org.apache.myfaces.shared_impl.renderkit.JSFAttr;
 import org.apache.myfaces.shared_impl.renderkit.RendererUtils;
 import org.apache.myfaces.shared_impl.renderkit.html.util.FormInfo;
 import org.apache.myfaces.shared_impl.renderkit.html.util.JavascriptUtils;
 import org.apache.myfaces.shared_impl.util._ComponentUtils;
 import org.apache.myfaces.shared_impl.config.MyfacesConfig;
 
 import javax.faces.application.ViewHandler;
 import javax.faces.component.UICommand;
 import javax.faces.component.UIComponent;
 import javax.faces.component.UIOutput;
 import javax.faces.component.UIParameter;
 import javax.faces.component.html.HtmlCommandLink;
 import javax.faces.context.FacesContext;
 import javax.faces.context.ResponseWriter;
 import javax.faces.event.ActionEvent;
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
 import java.util.Iterator;
 
 /**
  * @author Manfred Geiler
  * @version $Revision: 947903 $ $Date: 2010-05-24 22:40:23 -0500 (Mon, 24 May 2010) $
  */
 public abstract class HtmlLinkRendererBase
     extends HtmlRenderer
 {
     /* this one is never used
     public static final String URL_STATE_MARKER      = "JSF_URL_STATE_MARKER=DUMMY";
     public static final int    URL_STATE_MARKER_LEN  = URL_STATE_MARKER.length();
     */
 
     //private static final Log log = LogFactory.getLog(HtmlLinkRenderer.class);
 
     public boolean getRendersChildren()
     {
         // We must be able to render the children without a surrounding anchor
         // if the Link is disabled
         return true;
     }
 
     public void decode(FacesContext facesContext, UIComponent component)
     {
         super.decode(facesContext, component);  //check for NP
 
         if (component instanceof UICommand)
         {
             String clientId = component.getClientId(facesContext);
             FormInfo formInfo = findNestingForm(component, facesContext);
             String reqValue = (String) facesContext.getExternalContext().getRequestParameterMap().get(
                 HtmlRendererUtils.getHiddenCommandLinkFieldName(formInfo));
             if (reqValue != null && reqValue.equals(clientId))
             {
                 component.queueEvent(new ActionEvent(component));
 
                 RendererUtils.initPartialValidationAndModelUpdate(component, facesContext);
             }
         }
         else if (component instanceof UIOutput)
         {
             //do nothing
         }
         else
         {
             throw new IllegalArgumentException("Unsupported component class " + component.getClass().getName());
         }
     }
 
 
     public void encodeBegin(FacesContext facesContext, UIComponent component) throws IOException
     {
         super.encodeBegin(facesContext, component);  //check for NP
 
         if (component instanceof UICommand)
         {
             renderCommandLinkStart(facesContext, component,
                                    component.getClientId(facesContext),
                                    ((UICommand)component).getValue(),
                                    getStyle(facesContext, component),
                                    getStyleClass(facesContext, component));
         }
         else if (component instanceof UIOutput)
         {
             renderOutputLinkStart(facesContext, (UIOutput)component);
         }
         else
         {
             throw new IllegalArgumentException("Unsupported component class " + component.getClass().getName());
         }
     }
 
 
     /**
      * Can be overwritten by derived classes to overrule the style to be used.
      */
     protected String getStyle(FacesContext facesContext, UIComponent link)
     {
         if (link instanceof HtmlCommandLink)
         {
             return ((HtmlCommandLink)link).getStyle();
         }
 
         return (String)link.getAttributes().get(HTML.STYLE_ATTR);
 
     }
 
     /**
      * Can be overwritten by derived classes to overrule the style class to be used.
      */
     protected String getStyleClass(FacesContext facesContext, UIComponent link)
     {
         if (link instanceof HtmlCommandLink)
         {
             return ((HtmlCommandLink)link).getStyleClass();
         }
 
         return (String)link.getAttributes().get(HTML.STYLE_CLASS_ATTR);
 
     }
 
     public void encodeChildren(FacesContext facesContext, UIComponent component) throws IOException
     {
         RendererUtils.renderChildren(facesContext, component);
     }
 
     public void encodeEnd(FacesContext facesContext, UIComponent component) throws IOException
     {
         super.encodeEnd(facesContext, component);  //check for NP
 
         if (component instanceof UICommand)
         {
                 renderCommandLinkEnd(facesContext, component);
 
             HtmlFormRendererBase.renderScrollHiddenInputIfNecessary(
                 findNestingForm(component, facesContext).getForm(), facesContext, facesContext.getResponseWriter());
         }
         else if (component instanceof UIOutput)
         {
             renderOutputLinkEnd(facesContext, component);
         }
         else
         {
             throw new IllegalArgumentException("Unsupported component class " + component.getClass().getName());
         }
     }
 
     protected void renderCommandLinkStart(FacesContext facesContext, UIComponent component,
                                           String clientId,
                                           Object value,
                                           String style,
                                           String styleClass)
             throws IOException
     {
         ResponseWriter writer = facesContext.getResponseWriter();
 
         if (HtmlRendererUtils.isDisabled(component))
         {
             writer.startElement(HTML.SPAN_ELEM, component);
             HtmlRendererUtils.writeIdIfNecessary(writer, component, facesContext);
             HtmlRendererUtils.renderHTMLAttributes(writer, component, HTML.ANCHOR_PASSTHROUGH_ATTRIBUTES);
         }
         else
         {
             String[] anchorAttrsToRender;
             if (JavascriptUtils.isJavascriptAllowed(facesContext.getExternalContext()))
             {
                 renderJavaScriptAnchorStart(facesContext, writer, component, clientId);
                 anchorAttrsToRender = HTML.ANCHOR_PASSTHROUGH_ATTRIBUTES_WITHOUT_ONCLICK_WITHOUT_STYLE;
             }
             else
             {
                 renderNonJavaScriptAnchorStart(facesContext, writer, component, clientId);
                 anchorAttrsToRender = HTML.ANCHOR_PASSTHROUGH_ATTRIBUTES_WITHOUT_STYLE;
             }
 
             HtmlRendererUtils.writeIdIfNecessary(writer, component, facesContext);
             HtmlRendererUtils.renderHTMLAttributes(writer, component,
                                                    anchorAttrsToRender);
             HtmlRendererUtils.renderHTMLAttribute(writer, HTML.STYLE_ATTR, HTML.STYLE_ATTR,
                                                   style);
             HtmlRendererUtils.renderHTMLAttribute(writer, HTML.STYLE_CLASS_ATTR, HTML.STYLE_CLASS_ATTR,
                                                   styleClass);
         }
 
         // render value as required by JSF 1.1 renderkitdocs
         if(value != null)
         {
             writer.writeText(value.toString(), JSFAttr.VALUE_ATTR);
         }
     }
 
     protected void renderJavaScriptAnchorStart(FacesContext facesContext,
                                                ResponseWriter writer,
                                                UIComponent component,
                                                String clientId)
         throws IOException
     {
         //Find form
         FormInfo formInfo = findNestingForm(component, facesContext);
         if (formInfo == null)
         {
             String path = RendererUtils.getPathToComponent(component);
             String msg = "Link is not embedded in a form. Change component/tag '" + clientId + "' from javax.faces.*/<h:tagName /> " +
                 "to org.apache.myfaces.*/<t:tagName />, or embed it in a form.  This is not a bug. " +
                 "Please see: http://wiki.apache.org/myfaces/Upgrading_to_Tomahawk_1.1.3 " +
                 "The path to this component is " + path + ". If you need to render a special form and a JSF-form's attributes are not enough," +
                 "consider using the s:form tag of the MyFaces sandbox.";
             throw new IllegalArgumentException(msg);
         }
         UIComponent nestingForm = formInfo.getForm();
         String formName = formInfo.getFormName();
 
         StringBuffer onClick = new StringBuffer();
 
         String commandOnclick;
         if (component instanceof HtmlCommandLink)
         {
             commandOnclick = ((HtmlCommandLink)component).getOnclick();
         }
         else
         {
             commandOnclick = (String)component.getAttributes().get(HTML.ONCLICK_ATTR);
         }
         if (commandOnclick != null)
         {
             onClick.append("var cf = function(){");
             onClick.append(commandOnclick);
             onClick.append('}');
             onClick.append(';');
             onClick.append("var oamSF = function(){");
         }
 
         if (RendererUtils.isAdfOrTrinidadForm(formInfo.getForm())) {
             onClick.append("submitForm('");
             onClick.append(formInfo.getForm().getClientId(facesContext));
             onClick.append("',1,{source:'");
             onClick.append(component.getClientId(facesContext));
             onClick.append("'});return false;");
         }
         else {
             HtmlRendererUtils.renderFormSubmitScript(facesContext);
 
             StringBuffer params = addChildParameters(facesContext, component, nestingForm);
 
             String target = getTarget(component);
 
             onClick.append("return ").
                 append(HtmlRendererUtils.SUBMIT_FORM_FN_NAME).append("('").
                 append(formName).append("','").
                 append(clientId).append("'");
 
             if (params.length() > 2 || target != null) {
                 onClick.append(",").
                     append(target == null ? "null" : ("'" + target + "'")).append(",").
                     append(params);
             }
             onClick.append(");");
 
             //Not necessary since we are using oamSetHiddenInput to create input hidden fields
             //render hidden field - todo: in here for backwards compatibility
             if (MyfacesConfig.getCurrentInstance(facesContext.getExternalContext()).isRenderHiddenFieldsForLinkParams())
             {
                 String hiddenFieldName = HtmlRendererUtils.getHiddenCommandLinkFieldName(formInfo);
                 addHiddenCommandParameter(facesContext, nestingForm, hiddenFieldName);
             }
 
         }
         
         if (commandOnclick != null)
         {
             onClick.append('}');
             onClick.append(';');
             onClick.append("return (cf()==false)? false : oamSF();");
         }        
 
         writer.startElement(HTML.ANCHOR_ELEM, component);
         writer.writeURIAttribute(HTML.HREF_ATTR, "#", null);
         writer.writeAttribute(HTML.ONCLICK_ATTR, onClick.toString(), null);
     }
 
     private String getTarget(UIComponent component) {
         // for performance reason: double check for the target attribute
         String target;
         if (component instanceof HtmlCommandLink) {
             target = ((HtmlCommandLink) component).getTarget();
         }
         else {
             target = (String) component.getAttributes().get(HTML.TARGET_ATTR);
         }
         return target;
     }
 
     private StringBuffer addChildParameters(FacesContext context, UIComponent component, UIComponent nestingForm) {
         //add child parameters
         StringBuffer params = new StringBuffer();
         params.append("[");
         for (Iterator it = getChildren(component).iterator(); it.hasNext();) {
 
             UIComponent child = (UIComponent) it.next();
             if (child instanceof UIParameter) {
                 String name = ((UIParameter) child).getName();
 
                 if (name == null) {
                     throw new IllegalArgumentException("Unnamed parameter value not allowed within command link.");
                 }
 
                 //Not necessary, since we are using oamSetHiddenInput to create hidden fields
                 if (MyfacesConfig.getCurrentInstance(context.getExternalContext()).isRenderHiddenFieldsForLinkParams())
                 {
                     addHiddenCommandParameter(context, nestingForm, name);
                 }
 
                 Object value = ((UIParameter) child).getValue();
 
                 //UIParameter is no ValueHolder, so no conversion possible - calling .toString on value....
                 // MYFACES-1832 bad charset encoding for f:param
                 // if HTMLEncoder.encode is called, then
                 // when is called on writer.writeAttribute, encode method
                 // is called again so we have a duplicated encode
                 // call.
                 // MYFACES-2726 All '\' and "'" chars must be escaped 
                 // because there will be inside "'" javascript quotes, 
                 // otherwise the value will not correctly restored when
                 // the command is post.
                 //String strParamValue = value != null ? org.apache.myfaces.shared_impl.renderkit.html.util.HTMLEncoder.encode(value.toString(), false, false) : "";
                 String strParamValue = "";
                 if (value != null)
                 {
                     strParamValue = value.toString();
                     StringBuffer buff = null;
                     for (int i = 0; i < strParamValue.length(); i++)
                     {
                         char c = strParamValue.charAt(i); 
                         if (c == '\'' || c == '\\')
                         {
                             if (buff == null)
                             {
                                 buff = new StringBuffer();
                                 buff.append(strParamValue.substring(0,i));
                             }
                             buff.append('\\');
                             buff.append(c);
                         }
                         else if (buff != null)
                         {
                             buff.append(c);
                         }
                     }
                     if (buff != null)
                     {
                         strParamValue = buff.toString();
                     }
                 }
 
                 if (params.length() > 1) {
                     params.append(",");
                 }
 
                 params.append("['");
                 params.append(name);
                 params.append("','");
                 params.append(strParamValue);
                 params.append("']");
             }
         }
         params.append("]");
         return params;
     }
 
     /**
      * find nesting form<br />
      * need to be overrideable to deal with dummyForm stuff in tomahawk.
      */
     protected FormInfo findNestingForm(UIComponent uiComponent, FacesContext facesContext)
     {
         return _ComponentUtils.findNestingForm(uiComponent, facesContext);
     }
 
     protected void addHiddenCommandParameter(FacesContext facesContext, UIComponent nestingForm, String hiddenFieldName)
     {
         if (nestingForm != null)
         {
             HtmlFormRendererBase.addHiddenCommandParameter(facesContext, nestingForm, hiddenFieldName);
         }
     }
 
 
     protected void renderNonJavaScriptAnchorStart(FacesContext facesContext,
                                                   ResponseWriter writer,
                                                   UIComponent component,
                                                   String clientId)
         throws IOException
     {
         ViewHandler viewHandler = facesContext.getApplication().getViewHandler();
         String viewId = facesContext.getViewRoot().getViewId();
         String path = viewHandler.getActionURL(facesContext, viewId);
 
         boolean strictXhtmlLinks
                 = MyfacesConfig.getCurrentInstance(facesContext.getExternalContext()).isStrictXhtmlLinks();
 
         StringBuffer hrefBuf = new StringBuffer(path);
 
         //add clientId parameter for decode
 
         if (path.indexOf('?') == -1)
         {
             hrefBuf.append('?');
         }
         else
         {
             if (strictXhtmlLinks) {
                 hrefBuf.append("&amp;");
             } else {
                 hrefBuf.append('&');
             }
         }
         String hiddenFieldName = HtmlRendererUtils.getHiddenCommandLinkFieldName(findNestingForm(component, facesContext));
         hrefBuf.append(hiddenFieldName);
         hrefBuf.append('=');
         hrefBuf.append(clientId);
 
         if (getChildCount(component) > 0)
         {
             addChildParametersToHref(facesContext, component, hrefBuf,
                                      false, //not the first url parameter
                                      writer.getCharacterEncoding());
         }
 
         String href = facesContext.getExternalContext().encodeActionURL(hrefBuf.toString());
         writer.startElement(HTML.ANCHOR_ELEM, component);
         writer.writeURIAttribute(HTML.HREF_ATTR,
                                  facesContext.getExternalContext().encodeActionURL(href),
                                  null);
     }
 
     private void addChildParametersToHref(FacesContext facesContext,
                                           UIComponent linkComponent,
                                           StringBuffer hrefBuf,
                                           boolean firstParameter,
                                           String charEncoding)
             throws IOException
     {
         boolean strictXhtmlLinks
                 = MyfacesConfig.getCurrentInstance(facesContext.getExternalContext()).isStrictXhtmlLinks();
         for (Iterator it = getChildren(linkComponent).iterator(); it.hasNext(); )
         {
             UIComponent child = (UIComponent)it.next();
             if (child instanceof UIParameter)
             {
                 String name = ((UIParameter)child).getName();
                 Object value = ((UIParameter)child).getValue();
                 addParameterToHref(name, value, hrefBuf, firstParameter, charEncoding, strictXhtmlLinks);
                 firstParameter = false;
             }
         }
     }
 
     protected void renderOutputLinkStart(FacesContext facesContext, UIOutput output)
             throws IOException
     {
         ResponseWriter writer = facesContext.getResponseWriter();
 
         if (HtmlRendererUtils.isDisabled(output))
         {
             writer.startElement(HTML.SPAN_ELEM, output);
             HtmlRendererUtils.writeIdIfNecessary(writer, output, facesContext);
             HtmlRendererUtils.renderHTMLAttributes(writer, output, HTML.ANCHOR_PASSTHROUGH_ATTRIBUTES);
         }
         else
         {
             //calculate href
             String href = org.apache.myfaces.shared_impl.renderkit.RendererUtils.getStringValue(facesContext, output);
             //check if there is an anchor # in it
             int index = href.indexOf('#');
             String anchorString = null;
             if (index > -1)
             {
                 // remove anchor element and add it again after the parameter are encoded
                 anchorString = href.substring(index,href.length());
                 href = href.substring(0,index);
             }
             if (getChildCount(output) > 0)
             {
                 StringBuffer hrefBuf = new StringBuffer(href);
                 addChildParametersToHref(facesContext, output, hrefBuf,
                                      (href.indexOf('?') == -1), //first url parameter?
                                      writer.getCharacterEncoding());
                 href = hrefBuf.toString();
             }
             if (index > -1)
             {
                 href += anchorString;
             }
             href = facesContext.getExternalContext().encodeResourceURL(href);    //TODO: or encodeActionURL ?
 
             //write anchor
             writer.startElement(HTML.ANCHOR_ELEM, output);
             HtmlRendererUtils.writeIdAndNameIfNecessary(writer, output, facesContext);
             writer.writeURIAttribute(HTML.HREF_ATTR, href, null);
             HtmlRendererUtils.renderHTMLAttributes(writer, output, org.apache.myfaces.shared_impl.renderkit.html.HTML.ANCHOR_PASSTHROUGH_ATTRIBUTES);
             writer.flush();
         }
     }
 
     private void renderLinkParameter(String name,
                                      Object value,
                                      StringBuffer onClick,
                                      String jsForm,
                                      UIComponent nestingForm)
     {
         if (name == null)
         {
             throw new IllegalArgumentException("Unnamed parameter value not allowed within command link.");
         }
         onClick.append(jsForm);
         onClick.append(".elements['").append(name).append("']");
         //UIParameter is no ValueHolder, so no conversion possible
         String strParamValue = value != null ? org.apache.myfaces.shared_impl.renderkit.html.util.HTMLEncoder.encode(value.toString(), false, false) : "";
         onClick.append(".value='").append(strParamValue).append("';");
 
         addHiddenCommandParameter(FacesContext.getCurrentInstance(), nestingForm, name);
     }
 
     private static void addParameterToHref(String name,
                                            Object value,
                                            StringBuffer hrefBuf,
                                            boolean firstParameter,
                                            String charEncoding,
                                            boolean strictXhtmlLinks) throws UnsupportedEncodingException {
         if (name == null) {
             throw new IllegalArgumentException("Unnamed parameter value not allowed within command link.");
         }
 
         if (firstParameter) {
             hrefBuf.append('?');
         } else {
             if (strictXhtmlLinks) {
                 hrefBuf.append("&amp;");
             } else {
                 hrefBuf.append('&');
             }
         }
 
         hrefBuf.append(URLEncoder.encode(name, charEncoding));
         hrefBuf.append('=');
         if (value != null)
         {
             //UIParameter is no ConvertibleValueHolder, so no conversion possible
             hrefBuf.append(URLEncoder.encode(value.toString(), charEncoding));
         }
     }
 
 
     protected void renderOutputLinkEnd(FacesContext facesContext, UIComponent component)
             throws IOException
     {
         ResponseWriter writer = facesContext.getResponseWriter();
 
         if (HtmlRendererUtils.isDisabled(component))
         {
             writer.endElement(HTML.SPAN_ELEM);
         }
         else
         {
             // force separate end tag
             writer.writeText("", null);
             writer.endElement(HTML.ANCHOR_ELEM);
         }
     }
 
     protected void renderCommandLinkEnd(FacesContext facesContext, UIComponent component)
             throws IOException
     {
         ResponseWriter writer = facesContext.getResponseWriter();
         if (HtmlRendererUtils.isDisabled(component))
         {
 
             writer.endElement(HTML.SPAN_ELEM);
         }
         else
         {
             writer.writeText("", null);
             writer.endElement(HTML.ANCHOR_ELEM);
         }
     }
 
 }

1		/*
2		* Licensed to the Apache Software Foundation (ASF) under one
3		* or more contributor license agreements. See the NOTICE file
4		* distributed with this work for additional information
5		* regarding copyright ownership. The ASF licenses this file
6		* to you under the Apache License, Version 2.0 (the
7		* "License"); you may not use this file except in compliance
8		* with the License. You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing,
13		* software distributed under the License is distributed on an
14		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15		* KIND, either express or implied. See the License for the
16		* specific language governing permissions and limitations
17		* under the License.
18		*/
19		package org.apache.myfaces.shared_impl.renderkit.html;
20
21		import org.apache.myfaces.shared_impl.renderkit.JSFAttr;
22		import org.apache.myfaces.shared_impl.renderkit.RendererUtils;
23		import org.apache.myfaces.shared_impl.renderkit.html.util.FormInfo;
24		import org.apache.myfaces.shared_impl.renderkit.html.util.JavascriptUtils;
25		import org.apache.myfaces.shared_impl.util._ComponentUtils;
26		import org.apache.myfaces.shared_impl.config.MyfacesConfig;
27
28		import javax.faces.application.ViewHandler;
29		import javax.faces.component.UICommand;
30		import javax.faces.component.UIComponent;
31		import javax.faces.component.UIOutput;
32		import javax.faces.component.UIParameter;
33		import javax.faces.component.html.HtmlCommandLink;
34		import javax.faces.context.FacesContext;
35		import javax.faces.context.ResponseWriter;
36		import javax.faces.event.ActionEvent;
37		import java.io.IOException;
38		import java.io.UnsupportedEncodingException;
39		import java.net.URLEncoder;
40		import java.util.Iterator;
41
42		/**
43		* @author Manfred Geiler
44		* @version $Revision: 947903 $ $Date: 2010-05-24 22:40:23 -0500 (Mon, 24 May 2010) $
45		*/
46	0	public abstract class HtmlLinkRendererBase
47		extends HtmlRenderer
48		{
49		/* this one is never used
50		public static final String URL_STATE_MARKER = "JSF_URL_STATE_MARKER=DUMMY";
51		public static final int URL_STATE_MARKER_LEN = URL_STATE_MARKER.length();
52		*/
53
54		//private static final Log log = LogFactory.getLog(HtmlLinkRenderer.class);
55
56		public boolean getRendersChildren()
57		{
58		// We must be able to render the children without a surrounding anchor
59		// if the Link is disabled
60	0	return true;
61		}
62
63		public void decode(FacesContext facesContext, UIComponent component)
64		{
65	0	super.decode(facesContext, component); //check for NP
66
67	0	if (component instanceof UICommand)
68		{
69	0	String clientId = component.getClientId(facesContext);
70	0	FormInfo formInfo = findNestingForm(component, facesContext);
71	0	String reqValue = (String) facesContext.getExternalContext().getRequestParameterMap().get(
72		HtmlRendererUtils.getHiddenCommandLinkFieldName(formInfo));
73	0	if (reqValue != null && reqValue.equals(clientId))
74		{
75	0	component.queueEvent(new ActionEvent(component));
76
77	0	RendererUtils.initPartialValidationAndModelUpdate(component, facesContext);
78		}
79	0	}
80	0	else if (component instanceof UIOutput)
81		{
82		//do nothing
83		}
84		else
85		{
86	0	throw new IllegalArgumentException("Unsupported component class " + component.getClass().getName());
87		}
88	0	}
89
90
91		public void encodeBegin(FacesContext facesContext, UIComponent component) throws IOException
92		{
93	0	super.encodeBegin(facesContext, component); //check for NP
94
95	0	if (component instanceof UICommand)
96		{
97	0	renderCommandLinkStart(facesContext, component,
98		component.getClientId(facesContext),
99		((UICommand)component).getValue(),
100		getStyle(facesContext, component),
101		getStyleClass(facesContext, component));
102		}
103	0	else if (component instanceof UIOutput)
104		{
105	0	renderOutputLinkStart(facesContext, (UIOutput)component);
106		}
107		else
108		{
109	0	throw new IllegalArgumentException("Unsupported component class " + component.getClass().getName());
110		}
111	0	}
112
113
114		/**
115		* Can be overwritten by derived classes to overrule the style to be used.
116		*/
117		protected String getStyle(FacesContext facesContext, UIComponent link)
118		{
119	0	if (link instanceof HtmlCommandLink)
120		{
121	0	return ((HtmlCommandLink)link).getStyle();
122		}
123
124	0	return (String)link.getAttributes().get(HTML.STYLE_ATTR);
125
126		}
127
128		/**
129		* Can be overwritten by derived classes to overrule the style class to be used.
130		*/
131		protected String getStyleClass(FacesContext facesContext, UIComponent link)
132		{
133	0	if (link instanceof HtmlCommandLink)
134		{
135	0	return ((HtmlCommandLink)link).getStyleClass();
136		}
137
138	0	return (String)link.getAttributes().get(HTML.STYLE_CLASS_ATTR);
139
140		}
141
142		public void encodeChildren(FacesContext facesContext, UIComponent component) throws IOException
143		{
144	0	RendererUtils.renderChildren(facesContext, component);
145	0	}
146
147		public void encodeEnd(FacesContext facesContext, UIComponent component) throws IOException
148		{
149	0	super.encodeEnd(facesContext, component); //check for NP
150
151	0	if (component instanceof UICommand)
152		{
153	0	renderCommandLinkEnd(facesContext, component);
154
155	0	HtmlFormRendererBase.renderScrollHiddenInputIfNecessary(
156		findNestingForm(component, facesContext).getForm(), facesContext, facesContext.getResponseWriter());
157		}
158	0	else if (component instanceof UIOutput)
159		{
160	0	renderOutputLinkEnd(facesContext, component);
161		}
162		else
163		{
164	0	throw new IllegalArgumentException("Unsupported component class " + component.getClass().getName());
165		}
166	0	}
167
168		protected void renderCommandLinkStart(FacesContext facesContext, UIComponent component,
169		String clientId,
170		Object value,
171		String style,
172		String styleClass)
173		throws IOException
174		{
175	0	ResponseWriter writer = facesContext.getResponseWriter();
176
177	0	if (HtmlRendererUtils.isDisabled(component))
178		{
179	0	writer.startElement(HTML.SPAN_ELEM, component);
180	0	HtmlRendererUtils.writeIdIfNecessary(writer, component, facesContext);
181	0	HtmlRendererUtils.renderHTMLAttributes(writer, component, HTML.ANCHOR_PASSTHROUGH_ATTRIBUTES);
182		}
183		else
184		{
185		String[] anchorAttrsToRender;
186	0	if (JavascriptUtils.isJavascriptAllowed(facesContext.getExternalContext()))
187		{
188	0	renderJavaScriptAnchorStart(facesContext, writer, component, clientId);
189	0	anchorAttrsToRender = HTML.ANCHOR_PASSTHROUGH_ATTRIBUTES_WITHOUT_ONCLICK_WITHOUT_STYLE;
190		}
191		else
192		{
193	0	renderNonJavaScriptAnchorStart(facesContext, writer, component, clientId);
194	0	anchorAttrsToRender = HTML.ANCHOR_PASSTHROUGH_ATTRIBUTES_WITHOUT_STYLE;
195		}
196
197	0	HtmlRendererUtils.writeIdIfNecessary(writer, component, facesContext);
198	0	HtmlRendererUtils.renderHTMLAttributes(writer, component,
199		anchorAttrsToRender);
200	0	HtmlRendererUtils.renderHTMLAttribute(writer, HTML.STYLE_ATTR, HTML.STYLE_ATTR,
201		style);
202	0	HtmlRendererUtils.renderHTMLAttribute(writer, HTML.STYLE_CLASS_ATTR, HTML.STYLE_CLASS_ATTR,
203		styleClass);
204		}
205
206		// render value as required by JSF 1.1 renderkitdocs
207	0	if(value != null)
208		{
209	0	writer.writeText(value.toString(), JSFAttr.VALUE_ATTR);
210		}
211	0	}
212
213		protected void renderJavaScriptAnchorStart(FacesContext facesContext,
214		ResponseWriter writer,
215		UIComponent component,
216		String clientId)
217		throws IOException
218		{
219		//Find form
220	0	FormInfo formInfo = findNestingForm(component, facesContext);
221	0	if (formInfo == null)
222		{
223	0	String path = RendererUtils.getPathToComponent(component);
224	0	String msg = "Link is not embedded in a form. Change component/tag '" + clientId + "' from javax.faces.*/<h:tagName /> " +
225		"to org.apache.myfaces.*/<t:tagName />, or embed it in a form. This is not a bug. " +
226		"Please see: http://wiki.apache.org/myfaces/Upgrading_to_Tomahawk_1.1.3 " +
227		"The path to this component is " + path + ". If you need to render a special form and a JSF-form's attributes are not enough," +
228		"consider using the s:form tag of the MyFaces sandbox.";
229	0	throw new IllegalArgumentException(msg);
230		}
231	0	UIComponent nestingForm = formInfo.getForm();
232	0	String formName = formInfo.getFormName();
233
234	0	StringBuffer onClick = new StringBuffer();
235
236		String commandOnclick;
237	0	if (component instanceof HtmlCommandLink)
238		{
239	0	commandOnclick = ((HtmlCommandLink)component).getOnclick();
240		}
241		else
242		{
243	0	commandOnclick = (String)component.getAttributes().get(HTML.ONCLICK_ATTR);
244		}
245	0	if (commandOnclick != null)
246		{
247	0	onClick.append("var cf = function(){");
248	0	onClick.append(commandOnclick);
249	0	onClick.append('}');
250	0	onClick.append(';');
251	0	onClick.append("var oamSF = function(){");
252		}
253
254	0	if (RendererUtils.isAdfOrTrinidadForm(formInfo.getForm())) {
255	0	onClick.append("submitForm('");
256	0	onClick.append(formInfo.getForm().getClientId(facesContext));
257	0	onClick.append("',1,{source:'");
258	0	onClick.append(component.getClientId(facesContext));
259	0	onClick.append("'});return false;");
260		}
261		else {
262	0	HtmlRendererUtils.renderFormSubmitScript(facesContext);
263
264	0	StringBuffer params = addChildParameters(facesContext, component, nestingForm);
265
266	0	String target = getTarget(component);
267
268	0	onClick.append("return ").
269		append(HtmlRendererUtils.SUBMIT_FORM_FN_NAME).append("('").
270		append(formName).append("','").
271		append(clientId).append("'");
272
273	0	if (params.length() > 2 \|\| target != null) {
274	0	onClick.append(",").
275		append(target == null ? "null" : ("'" + target + "'")).append(",").
276		append(params);
277		}
278	0	onClick.append(");");
279
280		//Not necessary since we are using oamSetHiddenInput to create input hidden fields
281		//render hidden field - todo: in here for backwards compatibility
282	0	if (MyfacesConfig.getCurrentInstance(facesContext.getExternalContext()).isRenderHiddenFieldsForLinkParams())
283		{
284	0	String hiddenFieldName = HtmlRendererUtils.getHiddenCommandLinkFieldName(formInfo);
285	0	addHiddenCommandParameter(facesContext, nestingForm, hiddenFieldName);
286		}
287
288		}
289
290	0	if (commandOnclick != null)
291		{
292	0	onClick.append('}');
293	0	onClick.append(';');
294	0	onClick.append("return (cf()==false)? false : oamSF();");
295		}
296
297	0	writer.startElement(HTML.ANCHOR_ELEM, component);
298	0	writer.writeURIAttribute(HTML.HREF_ATTR, "#", null);
299	0	writer.writeAttribute(HTML.ONCLICK_ATTR, onClick.toString(), null);
300	0	}
301
302		private String getTarget(UIComponent component) {
303		// for performance reason: double check for the target attribute
304		String target;
305	0	if (component instanceof HtmlCommandLink) {
306	0	target = ((HtmlCommandLink) component).getTarget();
307		}
308		else {
309	0	target = (String) component.getAttributes().get(HTML.TARGET_ATTR);
310		}
311	0	return target;
312		}
313
314		private StringBuffer addChildParameters(FacesContext context, UIComponent component, UIComponent nestingForm) {
315		//add child parameters
316	0	StringBuffer params = new StringBuffer();
317	0	params.append("[");
318	0	for (Iterator it = getChildren(component).iterator(); it.hasNext();) {
319
320	0	UIComponent child = (UIComponent) it.next();
321	0	if (child instanceof UIParameter) {
322	0	String name = ((UIParameter) child).getName();
323
324	0	if (name == null) {
325	0	throw new IllegalArgumentException("Unnamed parameter value not allowed within command link.");
326		}
327
328		//Not necessary, since we are using oamSetHiddenInput to create hidden fields
329	0	if (MyfacesConfig.getCurrentInstance(context.getExternalContext()).isRenderHiddenFieldsForLinkParams())
330		{
331	0	addHiddenCommandParameter(context, nestingForm, name);
332		}
333
334	0	Object value = ((UIParameter) child).getValue();
335
336		//UIParameter is no ValueHolder, so no conversion possible - calling .toString on value....
337		// MYFACES-1832 bad charset encoding for f:param
338		// if HTMLEncoder.encode is called, then
339		// when is called on writer.writeAttribute, encode method
340		// is called again so we have a duplicated encode
341		// call.
342		// MYFACES-2726 All '\' and "'" chars must be escaped
343		// because there will be inside "'" javascript quotes,
344		// otherwise the value will not correctly restored when
345		// the command is post.
346		//String strParamValue = value != null ? org.apache.myfaces.shared_impl.renderkit.html.util.HTMLEncoder.encode(value.toString(), false, false) : "";
347	0	String strParamValue = "";
348	0	if (value != null)
349		{
350	0	strParamValue = value.toString();
351	0	StringBuffer buff = null;
352	0	for (int i = 0; i < strParamValue.length(); i++)
353		{
354	0	char c = strParamValue.charAt(i);
355	0	if (c == '\'' \|\| c == '\\')
356		{
357	0	if (buff == null)
358		{
359	0	buff = new StringBuffer();
360	0	buff.append(strParamValue.substring(0,i));
361		}
362	0	buff.append('\\');
363	0	buff.append(c);
364		}
365	0	else if (buff != null)
366		{
367	0	buff.append(c);
368		}
369		}
370	0	if (buff != null)
371		{
372	0	strParamValue = buff.toString();
373		}
374		}
375
376	0	if (params.length() > 1) {
377	0	params.append(",");
378		}
379
380	0	params.append("['");
381	0	params.append(name);
382	0	params.append("','");
383	0	params.append(strParamValue);
384	0	params.append("']");
385		}
386	0	}
387	0	params.append("]");
388	0	return params;
389		}
390
391		/**
392		* find nesting form<br />
393		* need to be overrideable to deal with dummyForm stuff in tomahawk.
394		*/
395		protected FormInfo findNestingForm(UIComponent uiComponent, FacesContext facesContext)
396		{
397	0	return _ComponentUtils.findNestingForm(uiComponent, facesContext);
398		}
399
400		protected void addHiddenCommandParameter(FacesContext facesContext, UIComponent nestingForm, String hiddenFieldName)
401		{
402	0	if (nestingForm != null)
403		{
404	0	HtmlFormRendererBase.addHiddenCommandParameter(facesContext, nestingForm, hiddenFieldName);
405		}
406	0	}
407
408
409		protected void renderNonJavaScriptAnchorStart(FacesContext facesContext,
410		ResponseWriter writer,
411		UIComponent component,
412		String clientId)
413		throws IOException
414		{
415	0	ViewHandler viewHandler = facesContext.getApplication().getViewHandler();
416	0	String viewId = facesContext.getViewRoot().getViewId();
417	0	String path = viewHandler.getActionURL(facesContext, viewId);
418
419	0	boolean strictXhtmlLinks
420		= MyfacesConfig.getCurrentInstance(facesContext.getExternalContext()).isStrictXhtmlLinks();
421
422	0	StringBuffer hrefBuf = new StringBuffer(path);
423
424		//add clientId parameter for decode
425
426	0	if (path.indexOf('?') == -1)
427		{
428	0	hrefBuf.append('?');
429		}
430		else
431		{
432	0	if (strictXhtmlLinks) {
433	0	hrefBuf.append("&");
434		} else {
435	0	hrefBuf.append('&');
436		}
437		}
438	0	String hiddenFieldName = HtmlRendererUtils.getHiddenCommandLinkFieldName(findNestingForm(component, facesContext));
439	0	hrefBuf.append(hiddenFieldName);
440	0	hrefBuf.append('=');
441	0	hrefBuf.append(clientId);
442
443	0	if (getChildCount(component) > 0)
444		{
445	0	addChildParametersToHref(facesContext, component, hrefBuf,
446		false, //not the first url parameter
447		writer.getCharacterEncoding());
448		}
449
450	0	String href = facesContext.getExternalContext().encodeActionURL(hrefBuf.toString());
451	0	writer.startElement(HTML.ANCHOR_ELEM, component);
452	0	writer.writeURIAttribute(HTML.HREF_ATTR,
453		facesContext.getExternalContext().encodeActionURL(href),
454		null);
455	0	}
456
457		private void addChildParametersToHref(FacesContext facesContext,
458		UIComponent linkComponent,
459		StringBuffer hrefBuf,
460		boolean firstParameter,
461		String charEncoding)
462		throws IOException
463		{
464	0	boolean strictXhtmlLinks
465		= MyfacesConfig.getCurrentInstance(facesContext.getExternalContext()).isStrictXhtmlLinks();
466	0	for (Iterator it = getChildren(linkComponent).iterator(); it.hasNext(); )
467		{
468	0	UIComponent child = (UIComponent)it.next();
469	0	if (child instanceof UIParameter)
470		{
471	0	String name = ((UIParameter)child).getName();
472	0	Object value = ((UIParameter)child).getValue();
473	0	addParameterToHref(name, value, hrefBuf, firstParameter, charEncoding, strictXhtmlLinks);
474	0	firstParameter = false;
475		}
476	0	}
477	0	}
478
479		protected void renderOutputLinkStart(FacesContext facesContext, UIOutput output)
480		throws IOException
481		{
482	0	ResponseWriter writer = facesContext.getResponseWriter();
483
484	0	if (HtmlRendererUtils.isDisabled(output))
485		{
486	0	writer.startElement(HTML.SPAN_ELEM, output);
487	0	HtmlRendererUtils.writeIdIfNecessary(writer, output, facesContext);
488	0	HtmlRendererUtils.renderHTMLAttributes(writer, output, HTML.ANCHOR_PASSTHROUGH_ATTRIBUTES);
489		}
490		else
491		{
492		//calculate href
493	0	String href = org.apache.myfaces.shared_impl.renderkit.RendererUtils.getStringValue(facesContext, output);
494		//check if there is an anchor # in it
495	0	int index = href.indexOf('#');
496	0	String anchorString = null;
497	0	if (index > -1)
498		{
499		// remove anchor element and add it again after the parameter are encoded
500	0	anchorString = href.substring(index,href.length());
501	0	href = href.substring(0,index);
502		}
503	0	if (getChildCount(output) > 0)
504		{
505	0	StringBuffer hrefBuf = new StringBuffer(href);
506	0	addChildParametersToHref(facesContext, output, hrefBuf,
507		(href.indexOf('?') == -1), //first url parameter?
508		writer.getCharacterEncoding());
509	0	href = hrefBuf.toString();
510		}
511	0	if (index > -1)
512		{
513	0	href += anchorString;
514		}
515	0	href = facesContext.getExternalContext().encodeResourceURL(href); //TODO: or encodeActionURL ?
516
517		//write anchor
518	0	writer.startElement(HTML.ANCHOR_ELEM, output);
519	0	HtmlRendererUtils.writeIdAndNameIfNecessary(writer, output, facesContext);
520	0	writer.writeURIAttribute(HTML.HREF_ATTR, href, null);
521	0	HtmlRendererUtils.renderHTMLAttributes(writer, output, org.apache.myfaces.shared_impl.renderkit.html.HTML.ANCHOR_PASSTHROUGH_ATTRIBUTES);
522	0	writer.flush();
523		}
524	0	}
525
526		private void renderLinkParameter(String name,
527		Object value,
528		StringBuffer onClick,
529		String jsForm,
530		UIComponent nestingForm)
531		{
532	0	if (name == null)
533		{
534	0	throw new IllegalArgumentException("Unnamed parameter value not allowed within command link.");
535		}
536	0	onClick.append(jsForm);
537	0	onClick.append(".elements['").append(name).append("']");
538		//UIParameter is no ValueHolder, so no conversion possible
539	0	String strParamValue = value != null ? org.apache.myfaces.shared_impl.renderkit.html.util.HTMLEncoder.encode(value.toString(), false, false) : "";
540	0	onClick.append(".value='").append(strParamValue).append("';");
541
542	0	addHiddenCommandParameter(FacesContext.getCurrentInstance(), nestingForm, name);
543	0	}
544
545		private static void addParameterToHref(String name,
546		Object value,
547		StringBuffer hrefBuf,
548		boolean firstParameter,
549		String charEncoding,
550		boolean strictXhtmlLinks) throws UnsupportedEncodingException {
551	0	if (name == null) {
552	0	throw new IllegalArgumentException("Unnamed parameter value not allowed within command link.");
553		}
554
555	0	if (firstParameter) {
556	0	hrefBuf.append('?');
557		} else {
558	0	if (strictXhtmlLinks) {
559	0	hrefBuf.append("&");
560		} else {
561	0	hrefBuf.append('&');
562		}
563		}
564
565	0	hrefBuf.append(URLEncoder.encode(name, charEncoding));
566	0	hrefBuf.append('=');
567	0	if (value != null)
568		{
569		//UIParameter is no ConvertibleValueHolder, so no conversion possible
570	0	hrefBuf.append(URLEncoder.encode(value.toString(), charEncoding));
571		}
572	0	}
573
574
575		protected void renderOutputLinkEnd(FacesContext facesContext, UIComponent component)
576		throws IOException
577		{
578	0	ResponseWriter writer = facesContext.getResponseWriter();
579
580	0	if (HtmlRendererUtils.isDisabled(component))
581		{
582	0	writer.endElement(HTML.SPAN_ELEM);
583		}
584		else
585		{
586		// force separate end tag
587	0	writer.writeText("", null);
588	0	writer.endElement(HTML.ANCHOR_ELEM);
589		}
590	0	}
591
592		protected void renderCommandLinkEnd(FacesContext facesContext, UIComponent component)
593		throws IOException
594		{
595	0	ResponseWriter writer = facesContext.getResponseWriter();
596	0	if (HtmlRendererUtils.isDisabled(component))
597		{
598
599	0	writer.endElement(HTML.SPAN_ELEM);
600		}
601		else
602		{
603	0	writer.writeText("", null);
604	0	writer.endElement(HTML.ANCHOR_ELEM);
605		}
606	0	}
607
608		}