src/main/java/net/pterodactylus/sone/template/JavascriptFilter.java

   1 /*
   2  * Sone - JavascriptFilter.java - Copyright © 2011 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.template;
  19
  20 import java.util.Map;
  21
  22 import net.pterodactylus.util.number.Hex;
  23 import net.pterodactylus.util.template.Filter;
  24 import net.pterodactylus.util.template.TemplateContext;
  25
  26 /**
  27  * Escapes double quotes, backslashes, carriage returns and line feeds, and
  28  * additionally encloses a given string with double quotes to make it possible
  29  * to use a string in Javascript.
  30  *
  31  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  32  */
  33 public class JavascriptFilter implements Filter {
  34
  35         /**
  36          * {@inheritDoc}
  37          */
  38         @Override
  39         public Object format(TemplateContext templateContext, Object data, Map<String, String> parameters) {
  40                 StringBuilder javascriptString = new StringBuilder();
  41                 javascriptString.append('"');
  42                 for (char c : String.valueOf(data).toCharArray()) {
  43                         if (c == '\r') {
  44                                 javascriptString.append("\\r");
  45                                 continue;
  46                         }
  47                         if (c == '\n') {
  48                                 javascriptString.append("\\n");
  49                                 continue;
  50                         }
  51                         if (c == '\t') {
  52                                 javascriptString.append("\\t");
  53                                 continue;
  54                         }
  55                         if ((c == '"') || (c == '\\')) {
  56                                 javascriptString.append('\\');
  57                                 javascriptString.append(c);
  58                         } else if (c < 32) {
  59                                 javascriptString.append("\\x").append(Hex.toHex((byte) c));
  60                         } else {
  61                                 javascriptString.append(c);
  62                         }
  63                 }
  64                 javascriptString.append('"');
  65                 return javascriptString.toString();
  66         }
  67
  68 }