Java tutorial
/** * Copyright (C) 2000 - 2013 Silverpeas * * This program is free software: you can redistribute it and/or modify it under the terms of the * GNU Affero General Public License as published by the Free Software Foundation, either version 3 * of the License, or (at your option) any later version. * * As a special exception to the terms and conditions of version 3.0 of the GPL, you may * redistribute this Program in connection with Free/Libre Open Source Software ("FLOSS") * applications as described in Silverpeas's FLOSS exception. You should have received a copy of the * text describing the FLOSS exception, and it is also available here: * "http://www.silverpeas.org/docs/core/legal/floss_exception.html" * * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License along with this program. * If not, see <http://www.gnu.org/licenses/>. */ package com.silverpeas.util; import com.stratelia.silverpeas.silvertrace.SilverTrace; import javax.xml.bind.DatatypeConverter; import org.apache.commons.lang3.StringEscapeUtils; import org.silverpeas.util.Charsets; /** * Util class to encode special string or characters * * @author lloiseau * @version 1.0 */ public class EncodeHelper { /** * Convert a java string to a javascript string Replace \,\n,\r and " * * @param javastring Java string to encode * @return javascript string encoded */ public static String javaStringToJsString(String javastring) { if (!isDefined(javastring)) { return ""; } return StringEscapeUtils.escapeEcmaScript(javastring); } /** * Convert a java string to a html string for textArea Replace ", <, >, & and \n * * @param javastring Java string to encode * @return html string encoded */ public static String javaStringToHtmlString(String javastring) { if (!isDefined(javastring)) { return ""; } return StringEscapeUtils.escapeHtml4(javastring).replace("", "œ"); } public static String javaStringToXmlString(String javastring) { return escapeXml(javastring); } public static String escapeXml(String javastring) { if (isDefined(javastring)) { return StringEscapeUtils.escapeXml(javastring); } else { return ""; } } /** * Convert a java string to a html string for textfield... Replace ", <, >, & and \n * * @param javastring Java string to encode * @return html string encoded */ public static String convertWhiteSpacesForHTMLDisplay(String javastring) { if (!isDefined(javastring)) { return ""; } StringBuilder resSB = new StringBuilder(javastring.length() + 10); for (int i = 0; i < javastring.length(); i++) { switch (javastring.charAt(i)) { case '\n': resSB.append("<br/>"); break; case '\r': break; case '\t': resSB.append(" "); break; default: resSB.append(javastring.charAt(i)); } } return resSB.toString(); } /** * Convert a java string to a html string for textfield... Replace ", <, >, & and \n * * @param javastring Java string to encode * @return html string encoded */ public static String javaStringToHtmlParagraphe(String javastring) { String escapedString = javaStringToHtmlString(javastring); return convertWhiteSpacesForHTMLDisplay(escapedString); } /** * Convert a html string to a java string Replace " * * @param htmlstring HTML string to encode * @return html string JAVA encoded */ public static String htmlStringToJavaString(String htmlstring) { if (!isDefined(htmlstring)) { return ""; } return StringEscapeUtils.unescapeHtml4(htmlstring); } /** * This method transforms a text with caracter specificly encoded for HTML by a text encoded in * according to the Java code. * * @param text (String) a single text which contains a lot of forbidden caracters. This text must * not be null * @return Returns the transformed text without specific codes. */ public static String transformHtmlCode(String text) { SilverTrace.info("util", "Encode.transformHtmlCode()", "root.MSG_GEN_PARAM_VALUE", " text recu " + text); return StringEscapeUtils.unescapeHtml4(text); } /** * Convert a java string to a html string for textArea Replace euro symbol * * @param javastring Java string to encode * @return html string encoded * @deprecated */ public static String encodeSpecialChar(String javastring) { if (!isDefined(javastring)) { return ""; } return javastring; } /** * This method transforms a string to replace the 'special' caracters to store them correctly in * the database * * @param sText a single text which may contains 'special' caracters * @return Returns the transformed text without specific codes. */ public static String transformStringForBD(String sText) { if (!isDefined(sText)) { return ""; } SilverTrace.info("util", "Encode.transformStringForBD()", "root.MSG_GEN_ENTER_METHOD", " text = " + sText); int nStringLength = sText.length(); StringBuilder resSB = new StringBuilder(nStringLength + 10); for (int i = 0; i < nStringLength; i++) { switch (sText.charAt(i)) { case '': resSB.append('\u20ac'); // Euro Symbol break; // case '': case '\u2019': resSB.append('\''); // quote word break; default: resSB.append(sText.charAt(i)); } } SilverTrace.info("util", "Encode.transformStringForBD()", "root.MSG_GEN_EXIT_METHOD", " new text = " + resSB.toString()); return resSB.toString(); } public static String convertHTMLEntities(String text) { SilverTrace.debug("util", "Encode.convertHTMLEntities()", "root.MSG_GEN_PARAM_VALUE", " text recu " + text); String result = StringEscapeUtils.escapeHtml4(text); SilverTrace.debug("util", "Encode.convertHTMLEntities()", "root.MSG_GEN_PARAM_VALUE", "text sortant = " + result); return result; } /** * Encode an UTF-8 filename in Base64 for the content-disposition header according to RFC2047. * * @see http://www.ietf.org/rfc/rfc2047.txt * @param filename the UTF-8 filename to be encoded. * @return the filename to be inserted in the content-disposition header. */ public static String encodeFilename(String filename) { StringBuilder buffer = new StringBuilder(256); buffer.append("=?UTF-8?B?"); buffer.append(DatatypeConverter.printBase64Binary(filename.getBytes(Charsets.UTF_8))); buffer.append("?="); return buffer.toString(); } private EncodeHelper() { } private static boolean isDefined(String text) { return text != null && !text.isEmpty(); } }