325 lines
12 KiB
Java
325 lines
12 KiB
Java
/*
|
|
* 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.
|
|
*
|
|
* $Header:$
|
|
*/
|
|
package org.apache.beehive.netui.tags;
|
|
|
|
import java.io.UnsupportedEncodingException;
|
|
import java.util.Iterator;
|
|
import java.util.Map;
|
|
import javax.servlet.jsp.JspException;
|
|
|
|
import org.apache.beehive.netui.core.URLCodec;
|
|
import org.apache.beehive.netui.tags.rendering.AbstractRenderAppender;
|
|
import org.apache.beehive.netui.util.internal.InternalStringBuilder;
|
|
|
|
/**
|
|
* This class provides a set of static methods that provide HTML utility code.
|
|
*/
|
|
public class HtmlUtils
|
|
{
|
|
/**
|
|
* Detect simple HTML contained inside of the given <code>value</code> string.
|
|
* @param value the value
|
|
* @return <code>true</code> if the string contains HTML; <code>false</code> otherwise.
|
|
*/
|
|
public static boolean containsHtml(String value)
|
|
{
|
|
int numChars = value.length();
|
|
char c;
|
|
|
|
for (int i = 0; i < numChars; i++) {
|
|
c = value.charAt(i);
|
|
switch (c) {
|
|
case '<':
|
|
return true;
|
|
case '&':
|
|
return true;
|
|
case '"':
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Filter the specified value for characters that are sensitive to
|
|
* HTML interpreters. It will return a string with these characters replaced
|
|
* with HTML entities. This method calls the overloaded method with <code>markupHTMLSpaceReturn</code>
|
|
* set to <code>false</code>.
|
|
* @param value The <code>String</code> value to be filtered and returned.
|
|
* @param result the {@link AbstractRenderAppender} to which the results should be rendered
|
|
*/
|
|
public static void filter(String value, AbstractRenderAppender result)
|
|
{
|
|
filter(value, result, false);
|
|
}
|
|
|
|
/**
|
|
* Filter the specified string for characters that are sensitive to
|
|
* HTML interpreters, returning the string with these characters replaced
|
|
* by the corresponding character entities.
|
|
* @param value The <code>String</code> value to be filtered and returned.
|
|
* @param markupHTMLSpaceReturn convert space characters and return characters
|
|
* to &nbsp; and <br /> marketup for html.
|
|
* @param result the {@link AbstractRenderAppender} to which the results should be rendered
|
|
*/
|
|
public static void filter(String value, AbstractRenderAppender result, boolean markupHTMLSpaceReturn)
|
|
{
|
|
// if the value is null, return
|
|
if (value == null)
|
|
return;
|
|
|
|
// convert the string
|
|
int numChars = value.length();
|
|
char c;
|
|
char prev = 0;
|
|
|
|
for (int i = 0; i < numChars; i++) {
|
|
c = value.charAt(i);
|
|
switch (c) {
|
|
case '<':
|
|
result.append("<");
|
|
break;
|
|
case '>':
|
|
result.append(">");
|
|
break;
|
|
case '&':
|
|
result.append("&");
|
|
break;
|
|
case '"':
|
|
result.append(""");
|
|
break;
|
|
case '\'':
|
|
result.append("'");
|
|
break;
|
|
case ' ':
|
|
if (markupHTMLSpaceReturn) {
|
|
if (prev == ' ') {
|
|
result.append(" ");
|
|
}
|
|
else
|
|
result.append(c);
|
|
}
|
|
else
|
|
result.append(c);
|
|
break;
|
|
case '\n':
|
|
if (markupHTMLSpaceReturn) {
|
|
result.append("<br />");
|
|
}
|
|
else
|
|
result.append(c);
|
|
break;
|
|
default:
|
|
result.append(c);
|
|
}
|
|
prev = c;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Escape the escapes (") and (\\) with escapes. These characters will be replaced with
|
|
* (") and (\\\\) respectively.
|
|
* @param value the string to escape
|
|
* @return the escaped string
|
|
*/
|
|
public static String escapeEscapes(String value)
|
|
{
|
|
assert(value != null);
|
|
InternalStringBuilder sb = new InternalStringBuilder(value.length());
|
|
for (int i = 0; i < value.length(); i++) {
|
|
char c = value.charAt(i);
|
|
if (c == '"') {
|
|
sb.append(""");
|
|
continue;
|
|
}
|
|
if (c == '\\') {
|
|
sb.append("\\\\");
|
|
continue;
|
|
}
|
|
sb.append(c);
|
|
}
|
|
return sb.toString();
|
|
}
|
|
|
|
/**
|
|
* Deprecated method using an old algorithm to escape escapes.
|
|
* @param value the value
|
|
* @return the escaped value
|
|
* @deprecated use {@link #escapeEscapes(String)} instead
|
|
*/
|
|
public static String legacyEscapeEscapes(String value)
|
|
{
|
|
assert(value != null);
|
|
InternalStringBuilder sb = new InternalStringBuilder(value.length());
|
|
for (int i = 0; i < value.length(); i++) {
|
|
char c = value.charAt(i);
|
|
if (c == '"') {
|
|
sb.append("\\\"");
|
|
continue;
|
|
}
|
|
if (c == '\\') {
|
|
sb.append("\\\\");
|
|
continue;
|
|
}
|
|
sb.append(c);
|
|
}
|
|
return sb.toString();
|
|
}
|
|
|
|
/**
|
|
* Add parameters contained in the givem {@link Map} to the URL. This method can handle values of type
|
|
* {@link String}, String array, null, and {@link Object} contained in the {@link Map}. If the type
|
|
* is an array, each of the items in the array will be added in-order onto the URL. {@link Object}s in the
|
|
* array will be added to the URL after calling {@link Object#toString()}.
|
|
*
|
|
* @param url the base URL
|
|
* @param params the parameters to add to the URL
|
|
* @param encoding the encoding to use when encoding parameters onto the URL
|
|
* @return the URL created by adding the parameters onto the base URL string
|
|
* @throws JspException
|
|
*/
|
|
public static String addParams(String url, Map params, String encoding)
|
|
throws JspException
|
|
{
|
|
InternalStringBuilder urlBuffer = new InternalStringBuilder(url);
|
|
|
|
try {
|
|
// Add dynamic parameters if requested
|
|
if ((params != null) && (params.size() > 0)) {
|
|
|
|
// Add the required request parameters
|
|
boolean question = url.indexOf('?') >= 0;
|
|
Iterator keys = params.keySet().iterator();
|
|
while (keys.hasNext()) {
|
|
String key = (String) keys.next();
|
|
Object value = params.get(key);
|
|
if (value == null) {
|
|
if (!question) {
|
|
urlBuffer.append('?');
|
|
question = true;
|
|
}
|
|
else {
|
|
urlBuffer.append("&");
|
|
}
|
|
urlBuffer.append(URLCodec.encode(key, encoding));
|
|
urlBuffer.append('='); // Interpret null as "no value"
|
|
}
|
|
else if (value instanceof String) {
|
|
if (!question) {
|
|
urlBuffer.append('?');
|
|
question = true;
|
|
}
|
|
else {
|
|
urlBuffer.append("&");
|
|
}
|
|
urlBuffer.append(URLCodec.encode(key, encoding));
|
|
urlBuffer.append('=');
|
|
urlBuffer.append(URLCodec.encode((String) value, encoding));
|
|
}
|
|
else if (value instanceof String[]) {
|
|
String values[] = (String[]) value;
|
|
for (int i = 0; i < values.length; i++) {
|
|
if (!question) {
|
|
urlBuffer.append('?');
|
|
question = true;
|
|
}
|
|
else {
|
|
urlBuffer.append("&");
|
|
}
|
|
urlBuffer.append(URLCodec.encode(key, encoding));
|
|
urlBuffer.append('=');
|
|
urlBuffer.append(URLCodec.encode(values[i], encoding));
|
|
}
|
|
}
|
|
/* convert all other objects to String */
|
|
else {
|
|
if (!question) {
|
|
urlBuffer.append('?');
|
|
question = true;
|
|
}
|
|
else {
|
|
urlBuffer.append("&");
|
|
}
|
|
urlBuffer.append(URLCodec.encode(key, encoding));
|
|
urlBuffer.append('=');
|
|
urlBuffer.append(URLCodec.encode(value.toString(), encoding));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
catch (UnsupportedEncodingException uee) {
|
|
JspException jspException = new JspException("Unsupported Encoding" + encoding, uee);
|
|
|
|
// todo: future cleanup
|
|
// The 2.5 Servlet api will set the initCause in the Throwable superclass during construction,
|
|
// this will cause an IllegalStateException on the following call.
|
|
if (jspException.getCause() == null) {
|
|
jspException.initCause(uee);
|
|
}
|
|
throw jspException;
|
|
}
|
|
|
|
return urlBuffer.toString();
|
|
}
|
|
|
|
/**
|
|
* Determine if the given <code>value</code> contains an HTML entity.
|
|
* @param value the value to check for an entity
|
|
* @return <code>true</code> if the value contains an entity; <code>false</code> otherwise.
|
|
*/
|
|
public static boolean containsEntity(String value)
|
|
{
|
|
assert (value != null) : "Parameter 'value' must not be null";
|
|
|
|
int pos = value.indexOf('&');
|
|
if (pos == -1)
|
|
return false;
|
|
|
|
int end = value.indexOf(';');
|
|
if (end != -1 && pos < end) {
|
|
// extract the entity and then verify it is
|
|
// a valid unicode identifier.
|
|
String entity = value.substring(pos + 1, end);
|
|
if (entity.length() == 0)
|
|
return false;
|
|
char[] chars = entity.toCharArray();
|
|
|
|
// verify the start is an indentifier start
|
|
// and the rest is a part.
|
|
if (!Character.isUnicodeIdentifierStart(chars[0])) {
|
|
if (chars[0] == '#' && chars.length > 1) {
|
|
for (int i = 1; i < chars.length; i++) {
|
|
if (!Character.isDigit(chars[i]))
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
for (int i = 1; i < chars.length; i++) {
|
|
if (!Character.isUnicodeIdentifierPart(chars[i]))
|
|
return false;
|
|
}
|
|
// good indentifier
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
}
|