source/mir/util/HTMLRoutines.java

   1 /*
   2  * Copyright (C) 2001, 2002  The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with the com.oreilly.servlet library, any library
  22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
  23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
  24  * the above that use the same license as the above), and distribute linked
  25  * combinations including the two.  You must obey the GNU General Public
  26  * License in all respects for all of the code used other than the above
  27  * mentioned libraries.  If you modify this file, you may extend this exception
  28  * to your version of the file, but you are not obligated to do so.  If you do
  29  * not wish to do so, delete this exception statement from your version.
  30  */
  31
  32 package mir.util;
  33
  34 import java.net.URLEncoder;
  35
  36 public class HTMLRoutines {
  37
  38   public static String encodeURL(String aString) {
  39     return URLEncoder.encode(aString);
  40   }
  41
  42   /**
  43    *
  44    *
  45    * @param aString
  46    * @param anEncoding the encoding to use (Note: JDK 1.3 does not seem to support custom
  47    *             encodings, so this parameter is ignored for now)
  48    * @return
  49    */
  50
  51   public static String encodeURL(String aString, String anEncoding) {
  52     try {
  53       return URLEncoder.encode(aString);
  54     }
  55     catch (Throwable t) {
  56       throw new RuntimeException(t.getMessage());
  57     }
  58   }
  59
  60   public static String encodeHTML(String aText) {
  61     final char[] CHARACTERS_TO_ESCAPE = { '&', '<', '>', '"' };
  62     final String[] ESCAPE_CODES = { "&amp;", "&lt;", "&gt;", "&quot;" };
  63
  64     return StringRoutines.replaceStringCharacters(aText, CHARACTERS_TO_ESCAPE, ESCAPE_CODES);
  65   }
  66
  67   public static String encodeXML(String aText) {
  68     final char[] CHARACTERS_TO_ESCAPE = { '&', '<', '>', '"', '\'' };
  69     final String[] ESCAPE_CODES = { "&amp;", "&lt;", "&gt;", "&quot;", "&apos;" };
  70
  71     return StringRoutines.replaceStringCharacters(aText, CHARACTERS_TO_ESCAPE, ESCAPE_CODES);
  72   }
  73 }