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  any library licensed under the Apache Software License,
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30
  31 package mir.util;
  32
  33 import java.net.URLEncoder;
  34
  35 public class HTMLRoutines {
  36
  37   public static String encodeURL(String aString) {
  38     return URLEncoder.encode(aString);
  39   }
  40
  41   /**
  42    *
  43    *
  44    * @param aString
  45    * @param anEncoding the encoding to use (Note: JDK 1.3 does not seem to support custom
  46    *             encodings, so this parameter is ignored for now)
  47    * @return
  48    */
  49
  50   public static String encodeURL(String aString, String anEncoding) {
  51     try {
  52       return URLEncoder.encode(aString);
  53     }
  54     catch (Throwable t) {
  55       throw new RuntimeException(t.getMessage());
  56     }
  57   }
  58
  59   public static String encodeHTML(String aText) throws UtilExc {
  60     final char[] CHARACTERS_TO_ESCAPE = { '&', '<', '>', '"' };
  61     final String[] ESCAPE_CODES = { "&amp;", "&lt;", "&gt;", "&quot;" };
  62
  63     return StringRoutines.replaceStringCharacters(aText, CHARACTERS_TO_ESCAPE, ESCAPE_CODES);
  64   }
  65
  66   public static String prettyEncodeHTML(String aText) throws UtilExc {
  67     return
  68         StringRoutines.performRegularExpressionReplacement(encodeHTML(aText), "\\n", "<br>\n");
  69   }
  70
  71   public static String encodeXML(String aText) {
  72     //#x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]
  73     final char[] CHARACTERS_TO_ESCAPE = { '&', '<', '>', '"', '\'',
  74         '\u0000', '\u0001', '\u0003', '\u0004', '\u0005', '\u0006', '\u0007', '\u0008', '\u0000', '\u000B',
  75         '\u000C', '\u000E', '\u000F', '\u0010', '\u0011', '\u0012', '\u0013', '\u0014', '\u0015', '\u0016',
  76         '\u0017', '\u0018', '\u0019', '\u001A', '\u001B', '\u001C', '\u001D', '\u001E'  };
  77     final String[] ESCAPE_CODES = { "&amp;", "&lt;", "&gt;", "&quot;", "&apos;",
  78         "", "", "", "", "", "", "", "", "", "",
  79         "", "", "", "", "", "", "", "", "", "",
  80         "", "", "", "", "", "", "", ""};
  81
  82
  83     return StringRoutines.replaceStringCharacters(aText, CHARACTERS_TO_ESCAPE, ESCAPE_CODES);
  84   }
  85 }