aboutsummaryrefslogtreecommitdiff
path: root/java/src/main/java/org/pablotron/luigi/Filter.java
blob: 134e406aa2926a5749fc3436b3d66c367b698b9a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
package org.pablotron.luigi;

import java.util.Map;
import java.util.HashMap;
import java.nio.charset.Charset;

import org.pablotron.luigi.errors.FilterError;

/**
 * Default filter set and filter handler callback.
 */
public final class Filter {
  /**
   * Hide constructor to prevent instantiation.
   */
  private Filter() {}

  /**
   * Filter handler callback interface.
   */
  public static interface Handler {
    /**
     * Called during template expansion to apply the given filter.
     *
     * @param val String value.
     * @param args Array of filter arguments specified in template string.
     * @param row Complete map of arguments passed during template run.
     *
     * @return Filtered value as a string.
     *
     * @throws FilterError If an error occurs during filtering.
     */
    public String filter(
      String val,
      String args[],
      Map<String, String> row
    ) throws FilterError;
  };

  /**
   * Convert given string value to byte array.
   *
   * If the length of the argument array is greater than zero, then the
   * first argument is used as the name of a character set for the input
   * string.
   *
   * @param val String value.
   * @param args Array of filter arguments.  May be empty.
   *
   * @return Byte array.
   */
  private static byte[] getBytes(final String val, final String args[]) {
    final Charset charset = (args.length > 0) ? Charset.forName(args[0]) :  Charset.defaultCharset();
    return val.getBytes(charset);
  }

  /**
   * Convert signed byte to unsigned integer.
   *
   * @param b Signed byte value.
   *
   * @return Unsigned integer.
   */
  private static int toUInt(final byte b) {
    return (b < 0) ? (256 + b) : b;
  }

  /**
   * Default filter set.
   *
   * The default filters are as follows:
   *
   * <ul>
   *   <li><code>uc</code>: Convert string to upper-case.</li>
   *   <li><code>lc</code>: Convert string to lower-case.</li>
   *   <li><code>h</code>: HTML-escape string.</li>
   *   <li><code>u</code>: URL-escape string.</li>
   *   <li><code>trim</code>: Strip leading and trailing whitespace from string.</li>
   *   <!-- li><code>base64</code>: Base64-encode value.</li -->
   * </ul>
   */
  public static Map<String, Handler> FILTERS = new HashMap<String, Handler>() {{
    put("null", new Handler() {
      public String filter(String val, String args[], Map<String, String> row) {
        return "";
      }
    });

    put("s", new Handler() {
      public String filter(String val, String args[], Map<String, String> row) {
        int v = Integer.parseInt(val);
        return (v == 1) ? "" : "s";
      }
    });

    put("uc", new Handler() {
      public String filter(String val, String args[], Map<String, String> row) {
        return val.toUpperCase();
      }
    });

    put("lc", new Handler() {
      public String filter(String val, String args[], Map<String, String> row) {
        return val.toLowerCase();
      }
    });

    put("length", new Handler() {
      public String filter(String val, String args[], Map<String, String> row) {
        return Integer.toString(val.length());
      }
    });

    put("trim", new Handler() {
      public String filter(String val, String args[], Map<String, String> row) {
        return val.trim();
      }
    });

    put("h", new Handler() {
      public String filter(String val, String args[], Map<String, String> row) {
        StringBuilder r = new StringBuilder();
        final byte bytes[] = getBytes(val, args);

        for (int i = 0, l = bytes.length; i < l; i++) {
          final byte b = bytes[i];

          switch (b) {
          case '&':
            r.append("&amp;");
            break;
          case '<':
            r.append("&lt;");
            break;
          case '>':
            r.append("&gt;");
            break;
          case '\'':
            r.append("&apos;");
            break;
          case '"':
            r.append("&quot;");
            break;
          default:
            if (b < 32 || b > 126) {
              r.append(String.format("&#%d;", toUInt(b)));
            } else {
              r.append((char) b);
            }
          }
        }

        return r.toString();
      }
    });

    put("u", new Handler() {
      public String filter(String val, String args[], Map<String, String> row) {
        final StringBuilder r = new StringBuilder();
        final byte bytes[] = getBytes(val, args);

        for (int i = 0, l = bytes.length; i < l; i++) {
          final byte b = bytes[i];

          switch (b) {
          case 'A':
          case 'B':
          case 'C':
          case 'D':
          case 'E':
          case 'F':
          case 'G':
          case 'H':
          case 'I':
          case 'J':
          case 'K':
          case 'L':
          case 'M':
          case 'N':
          case 'O':
          case 'P':
          case 'Q':
          case 'R':
          case 'S':
          case 'T':
          case 'U':
          case 'V':
          case 'W':
          case 'X':
          case 'Y':
          case 'Z':
          case 'a':
          case 'b':
          case 'c':
          case 'd':
          case 'e':
          case 'f':
          case 'g':
          case 'h':
          case 'i':
          case 'j':
          case 'k':
          case 'l':
          case 'm':
          case 'n':
          case 'o':
          case 'p':
          case 'q':
          case 'r':
          case 's':
          case 't':
          case 'u':
          case 'v':
          case 'w':
          case 'x':
          case 'y':
          case 'z':
          case '0':
          case '1':
          case '2':
          case '3':
          case '4':
          case '5':
          case '6':
          case '7':
          case '8':
          case '9':
          case '-':
          case '_':
          case '.':
          case '~':
            // unreserved character
            r.append((char) b);
            break;
          case ' ':
            r.append("+");
            break;
          default:
            r.append(String.format("%%%02X", toUInt(b)));
          }
        }

        return r.toString();
      }
    });

    put("trim", new Handler() {
      public String filter(String val, String args[], Map<String, String> row) {
        return val.replaceAll("\\A\\s+|\\s+\\Z", "");
      }
    });
  }};
};