[1242] | 1 | // Copyright 2012 Georg-August-Universität Göttingen, Germany |
---|
| 2 | // |
---|
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
---|
| 4 | // you may not use this file except in compliance with the License. |
---|
| 5 | // You may obtain a copy of the License at |
---|
| 6 | // |
---|
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
---|
| 8 | // |
---|
| 9 | // Unless required by applicable law or agreed to in writing, software |
---|
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
---|
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
---|
| 12 | // See the License for the specific language governing permissions and |
---|
| 13 | // limitations under the License. |
---|
| 14 | |
---|
| 15 | package de.ugoe.cs.autoquest.plugin.html; |
---|
| 16 | |
---|
| 17 | import java.io.File; |
---|
| 18 | import java.io.FileNotFoundException; |
---|
| 19 | import java.io.FileOutputStream; |
---|
| 20 | import java.io.OutputStreamWriter; |
---|
| 21 | import java.io.PrintWriter; |
---|
| 22 | import java.io.UnsupportedEncodingException; |
---|
| 23 | import java.security.MessageDigest; |
---|
| 24 | import java.security.NoSuchAlgorithmException; |
---|
| 25 | import java.util.HashSet; |
---|
| 26 | import java.util.LinkedList; |
---|
| 27 | import java.util.List; |
---|
| 28 | import java.util.Map; |
---|
| 29 | import java.util.Set; |
---|
| 30 | |
---|
| 31 | import org.apache.commons.codec.binary.Base64; |
---|
| 32 | import org.xml.sax.SAXException; |
---|
| 33 | |
---|
| 34 | import de.ugoe.cs.util.StringTools; |
---|
| 35 | import de.ugoe.cs.util.console.Console; |
---|
| 36 | |
---|
| 37 | /** |
---|
| 38 | * <p> |
---|
[1277] | 39 | * pseudomizes the text entered in text input events by replacing it with an MD5 hash. For this, it |
---|
| 40 | * parses a given file and dumps a replacement, in which all text input events have an MD5 hash |
---|
[1353] | 41 | * as entered text. If the events already have an MD5 hash, it stays unchanged. Providing the |
---|
| 42 | * parameters to the constructor, it can be decided to pseudomize text entries into file and search |
---|
| 43 | * input fields, as well. |
---|
[1242] | 44 | * </p> |
---|
| 45 | * |
---|
| 46 | * @author Patrick Harms |
---|
| 47 | * @version 1.0 |
---|
| 48 | * |
---|
| 49 | */ |
---|
| 50 | public class HTMLLogTextInputPseudomizer extends AbstractDefaultLogParser { |
---|
| 51 | |
---|
| 52 | /** |
---|
| 53 | * <p> |
---|
[1353] | 54 | * Indicator if search input fields must be pseudomized, as well. |
---|
| 55 | * </p> |
---|
| 56 | */ |
---|
| 57 | private boolean pseudomizeSearchInputs = false; |
---|
| 58 | |
---|
| 59 | /** |
---|
| 60 | * <p> |
---|
| 61 | * Indicator if file input fields must be pseudomized, as well. |
---|
| 62 | * </p> |
---|
| 63 | */ |
---|
| 64 | private boolean pseudomizeFileInputs = false; |
---|
| 65 | |
---|
| 66 | /** |
---|
| 67 | * <p> |
---|
[1242] | 68 | * The output writer into which the pseudomized variant of the log file is written |
---|
| 69 | * </p> |
---|
| 70 | */ |
---|
| 71 | private PrintWriter outputWriter; |
---|
| 72 | |
---|
| 73 | /** |
---|
| 74 | * <p> |
---|
| 75 | * The set of text input fields found in the GUI model |
---|
| 76 | * </p> |
---|
| 77 | */ |
---|
| 78 | private Set<String> textInputFieldIds = new HashSet<String>(); |
---|
| 79 | |
---|
| 80 | /** |
---|
| 81 | * <p> |
---|
| 82 | * the events that were read |
---|
| 83 | * </p> |
---|
| 84 | */ |
---|
| 85 | private List<EventEntry> sortedEvents = new LinkedList<EventEntry>(); |
---|
| 86 | |
---|
| 87 | /** |
---|
| 88 | * <p> |
---|
[1353] | 89 | * creates the input pseudomizer with the switches, if text inputs into file and search fields |
---|
| 90 | * shall be pseudomized, as well. |
---|
| 91 | * </p> |
---|
| 92 | * |
---|
| 93 | * @param pseudomizeSearchInputs true, if inputs into search fields shall be pseudomized, as |
---|
| 94 | * well; false else |
---|
| 95 | * @param pseudomizeFileInputs true, if inputs into file fields shall be pseudomized, as well; |
---|
| 96 | * false else |
---|
| 97 | */ |
---|
| 98 | public HTMLLogTextInputPseudomizer(boolean pseudomizeSearchInputs, |
---|
| 99 | boolean pseudomizeFileInputs) |
---|
| 100 | { |
---|
| 101 | this.pseudomizeSearchInputs = pseudomizeSearchInputs; |
---|
| 102 | this.pseudomizeFileInputs = pseudomizeFileInputs; |
---|
| 103 | } |
---|
| 104 | |
---|
| 105 | /** |
---|
| 106 | * <p> |
---|
[1242] | 107 | * called to pseudomize all text inputs in the given log file. The method reuses |
---|
| 108 | * {@link #pseudomizeFile(File)}. |
---|
| 109 | * </p> |
---|
| 110 | * |
---|
| 111 | * @param file the log file in which the text inputs must be pseudomized |
---|
| 112 | */ |
---|
| 113 | public void pseudomizeFile(String file) { |
---|
| 114 | if (file == null) { |
---|
| 115 | throw new IllegalArgumentException("file must not be null"); |
---|
| 116 | } |
---|
| 117 | |
---|
| 118 | pseudomizeFile(new File(file)); |
---|
| 119 | } |
---|
| 120 | |
---|
| 121 | /** |
---|
| 122 | * <p> |
---|
| 123 | * called to pseudomize all text inputs in the given log file. The given file is read |
---|
| 124 | * completely. All GUI elements are written to an output file as they are. All events are |
---|
[1277] | 125 | * written to an output file as they are, as well, as long as they do not represent text inputs. |
---|
[1242] | 126 | * If they are text input events, the entered text is replaced by its hash value for |
---|
| 127 | * pseudomizing the text input. Finally, the original log file is deleted and replaced by |
---|
| 128 | * the pseudomized variant. Log files, which are already pseudomized, stay untouched. |
---|
| 129 | * </p> |
---|
| 130 | * |
---|
| 131 | * @param file the log file in which the text inputs must be pseudomized |
---|
| 132 | */ |
---|
| 133 | public void pseudomizeFile(File file) { |
---|
| 134 | if (file == null) { |
---|
| 135 | throw new IllegalArgumentException("file must not be null"); |
---|
| 136 | } |
---|
| 137 | |
---|
| 138 | if (!file.exists()) { |
---|
| 139 | throw new IllegalArgumentException("file must denote an existing file"); |
---|
| 140 | } |
---|
| 141 | |
---|
| 142 | if (!file.isFile()) { |
---|
| 143 | throw new IllegalArgumentException("file must denote a file"); |
---|
| 144 | } |
---|
| 145 | |
---|
| 146 | File outFile = new File(file.getParentFile(), file.getName() + "_tmp"); |
---|
| 147 | boolean parsingFailed = false; |
---|
| 148 | |
---|
| 149 | try { |
---|
| 150 | FileOutputStream fis = new FileOutputStream(outFile); |
---|
| 151 | outputWriter = new PrintWriter(new OutputStreamWriter(fis, "UTF-8")); |
---|
| 152 | outputWriter.println("<?xml version=\"1.0\" encoding=\"UTF-8\"?>"); |
---|
| 153 | outputWriter.println("<session>"); |
---|
| 154 | |
---|
| 155 | textInputFieldIds.clear(); |
---|
| 156 | sortedEvents.clear(); |
---|
| 157 | |
---|
| 158 | try { |
---|
| 159 | super.parseFile(file); |
---|
| 160 | } |
---|
| 161 | catch (SAXException e) { |
---|
| 162 | parsingFailed = true; |
---|
| 163 | } |
---|
| 164 | |
---|
| 165 | for (EventEntry event : sortedEvents) { |
---|
| 166 | event.dump(); |
---|
| 167 | } |
---|
| 168 | |
---|
| 169 | outputWriter.println("</session>"); |
---|
| 170 | outputWriter.flush(); |
---|
| 171 | } |
---|
| 172 | catch (FileNotFoundException e) { |
---|
| 173 | Console.printerrln("could not create pseudomized file " + outFile); |
---|
| 174 | } |
---|
| 175 | catch (UnsupportedEncodingException e) { |
---|
| 176 | // this should never happen |
---|
| 177 | e.printStackTrace(); |
---|
| 178 | } |
---|
| 179 | finally { |
---|
| 180 | if (outputWriter != null) { |
---|
| 181 | outputWriter.close(); |
---|
| 182 | outputWriter = null; |
---|
| 183 | } |
---|
| 184 | } |
---|
| 185 | |
---|
| 186 | if (!parsingFailed && outFile.exists()) { |
---|
| 187 | if (!file.delete()) { |
---|
| 188 | Console.printerrln("could not delete pseudomized file " + file); |
---|
| 189 | } |
---|
| 190 | else if (!outFile.renameTo(file)) { |
---|
| 191 | Console.printerrln |
---|
| 192 | ("could not rename pseudomized file to original file name " + file); |
---|
| 193 | } |
---|
| 194 | else { |
---|
| 195 | Console.println("pseudomized file " + file); |
---|
| 196 | } |
---|
| 197 | } |
---|
| 198 | else { |
---|
| 199 | if (!outFile.delete()) { |
---|
| 200 | Console.printerrln("could not delete temporary file " + outFile); |
---|
| 201 | } |
---|
| 202 | } |
---|
| 203 | } |
---|
| 204 | |
---|
| 205 | /* (non-Javadoc) |
---|
| 206 | * @see de.ugoe.cs.autoquest.plugin.html.AbstractDefaultLogParser#parseFile(java.lang.String) |
---|
| 207 | */ |
---|
| 208 | @Override |
---|
| 209 | public void parseFile(String filename) { |
---|
| 210 | throw new IllegalStateException("this method must not be called externally"); |
---|
| 211 | } |
---|
| 212 | |
---|
| 213 | /* (non-Javadoc) |
---|
| 214 | * @see de.ugoe.cs.autoquest.plugin.html.AbstractDefaultLogParser#parseFile(java.io.File) |
---|
| 215 | */ |
---|
| 216 | @Override |
---|
| 217 | public void parseFile(File file) { |
---|
| 218 | throw new IllegalStateException("this method must not be called externally"); |
---|
| 219 | } |
---|
| 220 | |
---|
| 221 | /* (non-Javadoc) |
---|
| 222 | * @see de.ugoe.cs.autoquest.plugin.html.AbstractDefaultLogParser#handleGUIElement(String, Map) |
---|
| 223 | */ |
---|
| 224 | @Override |
---|
| 225 | protected boolean handleGUIElement(String id, Map<String, String> parameters) |
---|
| 226 | throws SAXException |
---|
| 227 | { |
---|
| 228 | outputWriter.print("<component id=\""); |
---|
| 229 | outputWriter.print(id); |
---|
| 230 | outputWriter.println("\">"); |
---|
| 231 | |
---|
| 232 | for (Map.Entry<String, String> param : parameters.entrySet()) { |
---|
| 233 | dumpParam(param.getKey(), param.getValue()); |
---|
| 234 | |
---|
[1353] | 235 | if ("tagname".equals(param.getKey())) { |
---|
| 236 | if ("input_text".equals(param.getValue()) || |
---|
| 237 | (pseudomizeSearchInputs && "input_search".equals(param.getValue())) || |
---|
| 238 | (pseudomizeFileInputs && "input_file".equals(param.getValue()))) |
---|
| 239 | { |
---|
| 240 | textInputFieldIds.add(id); |
---|
| 241 | } |
---|
[1242] | 242 | } |
---|
| 243 | } |
---|
| 244 | |
---|
| 245 | outputWriter.println("</component>"); |
---|
| 246 | |
---|
| 247 | return true; |
---|
| 248 | } |
---|
| 249 | |
---|
| 250 | /* (non-Javadoc) |
---|
| 251 | * @see de.ugoe.cs.autoquest.plugin.html.AbstractDefaultLogParser#handleEvent(String,Map) |
---|
| 252 | */ |
---|
| 253 | @Override |
---|
| 254 | protected boolean handleEvent(String type, Map<String, String> parameters) throws SAXException { |
---|
| 255 | String timestampStr = parameters.get("timestamp"); |
---|
| 256 | |
---|
| 257 | long timestamp = Long.MAX_VALUE; |
---|
| 258 | |
---|
| 259 | if (timestampStr != null) { |
---|
| 260 | timestamp = Long.parseLong(timestampStr); |
---|
| 261 | } |
---|
| 262 | |
---|
| 263 | EventEntry newEvent = new EventEntry(type, parameters, timestamp); |
---|
| 264 | |
---|
[1265] | 265 | int start = 0; |
---|
| 266 | int end = sortedEvents.size(); |
---|
| 267 | int center = 0; |
---|
| 268 | long centerTimestamp; |
---|
| 269 | |
---|
| 270 | while (start != end) { |
---|
| 271 | center = start + ((end - start) / 2); |
---|
| 272 | |
---|
| 273 | if ((center != start) || (center != end)) { |
---|
| 274 | centerTimestamp = sortedEvents.get(center).timestamp; |
---|
| 275 | |
---|
| 276 | if (centerTimestamp < newEvent.timestamp) { |
---|
| 277 | start = Math.max(center, start + 1); |
---|
| 278 | } |
---|
| 279 | else if (centerTimestamp > newEvent.timestamp) { |
---|
| 280 | end = Math.min(center, end - 1); |
---|
| 281 | } |
---|
| 282 | else { |
---|
| 283 | // add the event directly where the center is, as the timestamps of the center |
---|
| 284 | // and the new event are equal |
---|
[1272] | 285 | end = center; |
---|
| 286 | start = end; |
---|
[1265] | 287 | break; |
---|
| 288 | } |
---|
| 289 | } |
---|
| 290 | else { |
---|
| 291 | // add the event to the position denoted by the add index |
---|
[1242] | 292 | break; |
---|
| 293 | } |
---|
| 294 | } |
---|
| 295 | |
---|
[1265] | 296 | sortedEvents.add(start, newEvent); |
---|
[1242] | 297 | |
---|
| 298 | if ("onchange".equals(type)) { |
---|
| 299 | String targetId = parameters.get("target"); |
---|
| 300 | |
---|
| 301 | if ((targetId != null) && textInputFieldIds.contains(targetId)) { |
---|
| 302 | String value = parameters.get("selectedValue"); |
---|
| 303 | |
---|
[1246] | 304 | if ((value != null) && !value.endsWith("==")) { |
---|
[1242] | 305 | try { |
---|
| 306 | MessageDigest md = MessageDigest.getInstance("SHA-512"); |
---|
| 307 | md.update(value.getBytes("UTF-8")); |
---|
| 308 | value = Base64.encodeBase64String(md.digest()); |
---|
| 309 | } |
---|
| 310 | catch (UnsupportedEncodingException e) { |
---|
| 311 | throw new IllegalStateException("Java VM does not support this code"); |
---|
| 312 | } |
---|
| 313 | catch (NoSuchAlgorithmException e) { |
---|
| 314 | throw new IllegalStateException("Java VM does not support this code"); |
---|
| 315 | } |
---|
[1246] | 316 | |
---|
| 317 | parameters.put("selectedValue", value); |
---|
[1242] | 318 | } |
---|
| 319 | } |
---|
| 320 | } |
---|
| 321 | |
---|
| 322 | return true; |
---|
| 323 | } |
---|
| 324 | |
---|
| 325 | /** |
---|
| 326 | * <p> |
---|
| 327 | * dumps a parameter with the given name and value to the log file. The result is a |
---|
| 328 | * tag named param with a name attribute and a value attribute. The value is transformed |
---|
| 329 | * to a String if it is no String already. Furthermore, an XML entity replacement is performed |
---|
| 330 | * if required. |
---|
| 331 | * </p> |
---|
| 332 | * |
---|
| 333 | * @param name the name of the parameter to be dumped |
---|
| 334 | * @param value the value of the parameter to be dumped |
---|
| 335 | */ |
---|
| 336 | private void dumpParam(String name, Object value) { |
---|
| 337 | if (value == null) { |
---|
| 338 | return; |
---|
| 339 | } |
---|
| 340 | |
---|
| 341 | String val; |
---|
| 342 | |
---|
| 343 | if (value instanceof String) { |
---|
| 344 | val = (String) value; |
---|
| 345 | } |
---|
| 346 | else { |
---|
| 347 | val = String.valueOf(value); |
---|
| 348 | } |
---|
| 349 | |
---|
| 350 | outputWriter.print(" <param name=\""); |
---|
| 351 | outputWriter.print(name); |
---|
| 352 | outputWriter.print("\" value=\""); |
---|
| 353 | outputWriter.print(StringTools.xmlEntityReplacement(val)); |
---|
| 354 | outputWriter.println("\"/>"); |
---|
| 355 | } |
---|
| 356 | |
---|
| 357 | |
---|
| 358 | /** |
---|
| 359 | * <p> |
---|
| 360 | * this class is used internally for storing events in a sorted list together with the |
---|
| 361 | * timestamps, being the sort criteria. |
---|
| 362 | * </p> |
---|
| 363 | */ |
---|
| 364 | private class EventEntry { |
---|
| 365 | |
---|
| 366 | /** |
---|
| 367 | * <p> |
---|
| 368 | * the type of the event |
---|
| 369 | * </p> |
---|
| 370 | */ |
---|
| 371 | private String type; |
---|
| 372 | |
---|
| 373 | /** |
---|
| 374 | * <p> |
---|
| 375 | * the parameters of the event |
---|
| 376 | * </p> |
---|
| 377 | */ |
---|
| 378 | private Map<String, String> parameters; |
---|
| 379 | |
---|
| 380 | /** |
---|
| 381 | * <p> |
---|
| 382 | * the timestamp of the event |
---|
| 383 | * </p> |
---|
| 384 | */ |
---|
| 385 | private long timestamp; |
---|
| 386 | |
---|
| 387 | /** |
---|
| 388 | * <p> |
---|
| 389 | * creates a new event entry with event type, parameters and the timestamp |
---|
| 390 | * </p> |
---|
| 391 | */ |
---|
| 392 | private EventEntry(String type, Map<String, String> parameters, long timestamp) { |
---|
| 393 | this.type = type; |
---|
| 394 | this.parameters = parameters; |
---|
| 395 | this.timestamp = timestamp; |
---|
| 396 | } |
---|
| 397 | |
---|
| 398 | /** |
---|
| 399 | * <p> |
---|
| 400 | * convenience method for dumping the event into the compressed log file |
---|
| 401 | * </p> |
---|
| 402 | */ |
---|
| 403 | private void dump() { |
---|
| 404 | outputWriter.print("<event type=\""); |
---|
| 405 | outputWriter.print(type); |
---|
| 406 | outputWriter.println("\">"); |
---|
| 407 | |
---|
| 408 | for (Map.Entry<String, String> param : parameters.entrySet()) { |
---|
| 409 | dumpParam(param.getKey(), param.getValue()); |
---|
| 410 | } |
---|
| 411 | |
---|
| 412 | outputWriter.println("</event>"); |
---|
| 413 | } |
---|
| 414 | } |
---|
| 415 | } |
---|