/**
* Copyright (C) 2012 JBoss Inc
*
* 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.jboss.dashboard.ui.taglib;
import org.jboss.dashboard.ui.components.UIComponentHandlerFactoryElement;
import org.jboss.dashboard.ui.taglib.factory.UseComponentTag;
import org.jboss.dashboard.workspace.Parameters;
import org.jboss.dashboard.workspace.Panel;
import org.apache.commons.lang.StringEscapeUtils;
import org.apache.commons.lang.StringUtils;
import javax.servlet.jsp.JspTagException;
import javax.servlet.jsp.tagext.TagSupport;
/**
* This tag must encodes the given string value to the namespace of the current panel.
* <p/>
* This tag should be used for named elements in the panel output (such as Javascript
* functions and variables). The encoding ensures that the given name is uniquely
* associated with this panel and avoids name conflicts with other elements on
* the workspace page or with other panels on the page.
* <p/>
* The encode tag must not contain any body content.
* <p/>
* The following required attribute is defined for this tag:
* <li>
* name (Type: String, required) � the name of the String that should be encoded
* into the namespace of the panel. <br>
* </li>
* <p/>
* An example of a JSP using the encode tag could be:
* <p/>
* <CODE>
* <A HREF=�javascript:<panel:encode name=�doFoo()�/>�/>Foo</A>
* </CODE>
* <p/>
* The example references a JavaScript function with the name �doFoo�, which is encoded
* to ensure uniqueness on the workspace page.
*/
public class EncodeTag extends TagSupport {
/**
* Logger
*/
private static org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(EncodeTag.class.getName());
/**
* Text to encode
*/
private String name = null;
/**
* @see javax.servlet.jsp.tagext.TagSupport
*/
public int doEndTag() throws JspTagException {
Panel panel = (Panel) pageContext.getRequest().getAttribute(Parameters.RENDER_PANEL);
UIComponentHandlerFactoryElement factoryComponent = (UIComponentHandlerFactoryElement) pageContext.getRequest().getAttribute(UseComponentTag.COMPONENT_ATTR_NAME);
String encodedName = encode(panel, factoryComponent, name);
try {
pageContext.getOut().print(encodedName);
} catch (Exception ex) {
log.error("Error encoding panel name [" + name + "] for panel " + panel.getId(), ex);
}
return SKIP_BODY;
}
/**
* Encode a name for a given panel context, appending it to a String depending on the panel.
*
* @param panel Panel being rendered
* @param factoryComponent factoryComponent
* @param name symbolic name to encode @return an encoded version for that name, so that different panels have different names.
* @return a encoded name
*/
public static String encode(Panel panel, UIComponentHandlerFactoryElement factoryComponent, String name) {
StringBuffer sb = new StringBuffer();
if (panel != null) {
sb.append("panel_").append(panel.getPanelId().longValue() < 0 ?
("NEG" + Math.abs(panel.getPanelId().longValue())) : panel.getPanelId().toString());
}
if (factoryComponent != null) {
String alias = factoryComponent.getComponentAlias();
if (!StringUtils.isEmpty(alias) && isJavaIdentifier(alias)) {
sb.append("_component_").append(alias);
} else {
sb.append("_component_").append(Math.abs(factoryComponent.getName().hashCode()));
}
}
sb.append("_").append(StringEscapeUtils.escapeHtml(name));
return sb.toString();
}
/**
* Returns true if s is a legal Java identifier.
* @param s String to check
*/
public static boolean isJavaIdentifier(String s) {
if (s.length() == 0 || !Character.isJavaIdentifierStart(s.charAt(0))) {
return false;
}
for (int i = 1; i < s.length(); i++) {
if (!Character.isJavaIdentifierPart(s.charAt(i))) {
return false;
}
}
return true;
}
/**
* Encode a name for a given panel context, appending it to a String depending on the panel.
*
* @param panel Panel being rendered
* @param name symbolic name to encode
* @return an encoded version for that name, so that different panels have different names.
*/
public static String encode(Panel panel, String name) {
return encode(panel, null, name);
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}