[434] | 1 | package de.ugoe.cs.quest.plugin.mfc;
|
---|
[1] | 2 |
|
---|
| 3 | import java.io.File;
|
---|
[45] | 4 | import java.io.FileInputStream;
|
---|
[1] | 5 | import java.io.FileNotFoundException;
|
---|
| 6 | import java.io.IOException;
|
---|
[45] | 7 | import java.io.InputStreamReader;
|
---|
[1] | 8 | import java.security.InvalidParameterException;
|
---|
[203] | 9 | import java.util.Collection;
|
---|
[619] | 10 | import java.util.HashMap;
|
---|
[1] | 11 | import java.util.LinkedList;
|
---|
| 12 | import java.util.List;
|
---|
[619] | 13 | import java.util.Map;
|
---|
[1] | 14 | import java.util.SortedMap;
|
---|
| 15 | import java.util.TreeMap;
|
---|
[639] | 16 | import java.util.logging.Level;
|
---|
[1] | 17 |
|
---|
| 18 | import javax.xml.parsers.ParserConfigurationException;
|
---|
| 19 | import javax.xml.parsers.SAXParser;
|
---|
| 20 | import javax.xml.parsers.SAXParserFactory;
|
---|
| 21 |
|
---|
| 22 | import org.xml.sax.Attributes;
|
---|
| 23 | import org.xml.sax.InputSource;
|
---|
| 24 | import org.xml.sax.SAXException;
|
---|
| 25 | import org.xml.sax.SAXParseException;
|
---|
| 26 | import org.xml.sax.helpers.DefaultHandler;
|
---|
| 27 |
|
---|
[566] | 28 | import de.ugoe.cs.quest.eventcore.Event;
|
---|
[619] | 29 | import de.ugoe.cs.quest.eventcore.guimodel.GUIModel;
|
---|
[434] | 30 | import de.ugoe.cs.quest.plugin.mfc.eventcore.WindowsMessage;
|
---|
[619] | 31 | import de.ugoe.cs.quest.plugin.mfc.eventcore.WindowsMessageType;
|
---|
| 32 | import de.ugoe.cs.quest.plugin.mfc.guimodel.MFCGUIElement;
|
---|
| 33 | import de.ugoe.cs.quest.plugin.mfc.guimodel.WindowTree;
|
---|
[1] | 34 | import de.ugoe.cs.util.StringTools;
|
---|
| 35 | import de.ugoe.cs.util.console.Console;
|
---|
| 36 |
|
---|
[171] | 37 | /**
|
---|
| 38 | * <p>
|
---|
[619] | 39 | * This class provides functionality to parse XML log files generated by the MFCUsageMonitor of
|
---|
| 40 | * EventBench. The result of parsing a file is a collection of event sequences. It uses the
|
---|
| 41 | * {@link SequenceSplitter} and the {@link EventGenerator} as well as custom defined
|
---|
| 42 | * {@link MessageHandler} for the parsing.
|
---|
[171] | 43 | * </p>
|
---|
| 44 | *
|
---|
| 45 | * @author Steffen Herbold
|
---|
| 46 | * @version 1.0
|
---|
| 47 | */
|
---|
[297] | 48 | public class MFCLogParser extends DefaultHandler {
|
---|
[171] | 49 |
|
---|
[619] | 50 | /**
|
---|
| 51 | * <p>
|
---|
| 52 | * If a custom message handler is used, this field contains its handle. Otherwise this field is
|
---|
| 53 | * {@code null}.
|
---|
| 54 | * </p>
|
---|
| 55 | */
|
---|
| 56 | private MessageHandler currentHandler;
|
---|
[171] | 57 |
|
---|
[619] | 58 | /**
|
---|
| 59 | * <p>
|
---|
| 60 | * internal handle to the current window tree
|
---|
| 61 | * </p>
|
---|
| 62 | */
|
---|
| 63 | private WindowTree currentWindowTree;
|
---|
[171] | 64 |
|
---|
[619] | 65 | /**
|
---|
| 66 | * <p>
|
---|
| 67 | * the type of the currently parsed message
|
---|
| 68 | * </p>
|
---|
| 69 | */
|
---|
| 70 | private WindowsMessageType currentMessageType;
|
---|
| 71 |
|
---|
| 72 | /**
|
---|
| 73 | * <p>
|
---|
| 74 | * the parameters of the currently parsed message
|
---|
| 75 | * </p>
|
---|
| 76 | */
|
---|
| 77 | private Map<String, Object> currentMessageParameters = new HashMap<String, Object>();
|
---|
| 78 |
|
---|
| 79 | /**
|
---|
| 80 | * <p>
|
---|
| 81 | * {@link SequenceSplitter} instance used by the {@link MFCLogParser}.
|
---|
| 82 | * </p>
|
---|
| 83 | */
|
---|
| 84 | private SequenceSplitter sequenceSplitter;
|
---|
[171] | 85 |
|
---|
[619] | 86 | /**
|
---|
| 87 | * <p>
|
---|
| 88 | * Collection of message sequences that is contained in the log file, which is parsed.
|
---|
| 89 | * </p>
|
---|
| 90 | */
|
---|
| 91 | private Collection<List<Event>> sequences;
|
---|
[171] | 92 |
|
---|
[619] | 93 | /**
|
---|
| 94 | * <p>
|
---|
| 95 | * Debugging variable that allows the analysis which message type occurs how often in the log
|
---|
| 96 | * file. Can be used to enhance the message filter.
|
---|
| 97 | * </p>
|
---|
| 98 | */
|
---|
| 99 | private SortedMap<WindowsMessageType, Integer> typeCounter;
|
---|
[171] | 100 |
|
---|
[619] | 101 | /**
|
---|
| 102 | * <p>
|
---|
| 103 | * Debugging variable that enables the counting of the occurrences of each message. Used in
|
---|
| 104 | * combination with {@link #typeCounter}.
|
---|
| 105 | * </p>
|
---|
| 106 | */
|
---|
| 107 | private boolean countMessageOccurences;
|
---|
[171] | 108 |
|
---|
[619] | 109 | /**
|
---|
| 110 | * <p>
|
---|
| 111 | * Constructor. Creates a new LogParser that does not count message occurrences.
|
---|
| 112 | * </p>
|
---|
| 113 | */
|
---|
| 114 | public MFCLogParser() {
|
---|
| 115 | this(false);
|
---|
| 116 | }
|
---|
[171] | 117 |
|
---|
[619] | 118 | /**
|
---|
| 119 | * <p>
|
---|
| 120 | * Constructor. Creates a new LogParser.
|
---|
| 121 | * </p>
|
---|
| 122 | *
|
---|
| 123 | * @param countMessageOccurences
|
---|
| 124 | * if true, the occurrences of each message type in the log is counted.
|
---|
| 125 | */
|
---|
| 126 | public MFCLogParser(boolean countMessageOccurences) {
|
---|
| 127 | sequences = new LinkedList<List<Event>>();
|
---|
| 128 | currentHandler = null;
|
---|
| 129 | this.countMessageOccurences = countMessageOccurences;
|
---|
| 130 | if (countMessageOccurences) {
|
---|
| 131 | typeCounter = new TreeMap<WindowsMessageType, Integer>();
|
---|
| 132 | }
|
---|
| 133 | }
|
---|
[171] | 134 |
|
---|
[619] | 135 | /**
|
---|
| 136 | * <p>
|
---|
| 137 | * Parses a log file written by the MFCMonitor and creates a collection of event sequences.
|
---|
| 138 | * </p>
|
---|
| 139 | *
|
---|
| 140 | * @param filename
|
---|
| 141 | * name and path of the log file
|
---|
| 142 | */
|
---|
| 143 | public void parseFile(String filename) {
|
---|
| 144 | if (filename == null) {
|
---|
| 145 | throw new InvalidParameterException("filename must not be null");
|
---|
| 146 | }
|
---|
[171] | 147 |
|
---|
[619] | 148 | parseFile(new File(filename));
|
---|
| 149 | }
|
---|
[171] | 150 |
|
---|
[619] | 151 | /**
|
---|
| 152 | * <p>
|
---|
| 153 | * Parses a log file written by the MFCMonitor and creates a collection of event sequences.
|
---|
| 154 | * </p>
|
---|
| 155 | *
|
---|
| 156 | * @param file
|
---|
| 157 | * name and path of the log file
|
---|
| 158 | */
|
---|
| 159 | public void parseFile(File file) {
|
---|
| 160 | if (file == null) {
|
---|
| 161 | throw new InvalidParameterException("file must not be null");
|
---|
| 162 | }
|
---|
[171] | 163 |
|
---|
[619] | 164 | SAXParserFactory spf = SAXParserFactory.newInstance();
|
---|
| 165 | spf.setValidating(true);
|
---|
[171] | 166 |
|
---|
[619] | 167 | SAXParser saxParser = null;
|
---|
| 168 | InputSource inputSource = null;
|
---|
| 169 | try {
|
---|
| 170 | saxParser = spf.newSAXParser();
|
---|
| 171 | inputSource = new InputSource(new InputStreamReader(new FileInputStream(file)));// ,
|
---|
| 172 | // "UTF-8"));
|
---|
| 173 | // } catch (UnsupportedEncodingException e) {
|
---|
| 174 | // e.printStackTrace();
|
---|
| 175 | }
|
---|
| 176 | catch (ParserConfigurationException e) {
|
---|
| 177 | // TODO handle Exception
|
---|
| 178 | e.printStackTrace();
|
---|
| 179 | }
|
---|
| 180 | catch (SAXException e) {
|
---|
| 181 | // TODO handle Exception
|
---|
| 182 | e.printStackTrace();
|
---|
| 183 | }
|
---|
| 184 | catch (FileNotFoundException e) {
|
---|
| 185 | // TODO handle Exception
|
---|
| 186 | e.printStackTrace();
|
---|
| 187 | }
|
---|
| 188 |
|
---|
| 189 | if (inputSource != null) {
|
---|
| 190 | inputSource.setSystemId("file://" + file.getAbsolutePath());
|
---|
| 191 | try {
|
---|
| 192 | if (saxParser == null) {
|
---|
| 193 | throw new RuntimeException("SAXParser creation failed");
|
---|
| 194 | }
|
---|
| 195 | saxParser.parse(inputSource, this);
|
---|
| 196 | }
|
---|
| 197 | catch (SAXParseException e) {
|
---|
| 198 | Console.printerrln("Failure parsing file in line " + e.getLineNumber() +
|
---|
| 199 | ", column " + e.getColumnNumber() + ".");
|
---|
| 200 | e.printStackTrace();
|
---|
| 201 | }
|
---|
| 202 | catch (SAXException e) {
|
---|
| 203 | // TODO handle Exception
|
---|
| 204 | e.printStackTrace();
|
---|
| 205 | }
|
---|
| 206 | catch (IOException e) {
|
---|
| 207 | // TODO handle Exception
|
---|
| 208 | e.printStackTrace();
|
---|
| 209 | }
|
---|
| 210 | }
|
---|
| 211 |
|
---|
| 212 | if (countMessageOccurences) {
|
---|
| 213 | Console.println("Message statistics:");
|
---|
| 214 | Console.println
|
---|
| 215 | (typeCounter.toString().replace(" ", StringTools.ENDLINE).replaceAll("[\\{\\}]", ""));
|
---|
| 216 | }
|
---|
| 217 | }
|
---|
| 218 |
|
---|
| 219 | /**
|
---|
| 220 | * <p>
|
---|
| 221 | * Returns the collection of event sequences that is obtained from parsing log files.
|
---|
| 222 | * </p>
|
---|
| 223 | *
|
---|
| 224 | * @return collection of event sequences
|
---|
| 225 | */
|
---|
| 226 | public Collection<List<Event>> getSequences() {
|
---|
| 227 | return sequences;
|
---|
| 228 | }
|
---|
[171] | 229 |
|
---|
[619] | 230 | /**
|
---|
| 231 | * <p>
|
---|
| 232 | * Returns the gui model that is obtained from parsing log files.
|
---|
| 233 | * </p>
|
---|
| 234 | *
|
---|
| 235 | * @return collection of event sequences
|
---|
| 236 | */
|
---|
| 237 | public GUIModel getGuiModel() {
|
---|
| 238 | return currentWindowTree.getGUIModel();
|
---|
| 239 | }
|
---|
[171] | 240 |
|
---|
[619] | 241 | /*
|
---|
| 242 | * (non-Javadoc)
|
---|
| 243 | *
|
---|
| 244 | * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String,
|
---|
| 245 | * java.lang.String, org.xml.sax.Attributes)
|
---|
| 246 | */
|
---|
| 247 | @Override
|
---|
| 248 | public void startElement(String uri, String localName, String qName, Attributes atts)
|
---|
| 249 | throws SAXException
|
---|
| 250 | {
|
---|
| 251 | if (qName.equals("session")) {
|
---|
[639] | 252 | Console.traceln(Level.FINE, "start of session");
|
---|
[619] | 253 | // in some logs, the session end may be marked in between the log. This is because
|
---|
| 254 | // of thread problems. So instead of creating a new GUI model, preserve it.
|
---|
| 255 | if (currentWindowTree == null) {
|
---|
| 256 | currentWindowTree = new WindowTree();
|
---|
| 257 | }
|
---|
| 258 | sequenceSplitter = new SequenceSplitter(currentWindowTree);
|
---|
| 259 | }
|
---|
| 260 | else if (qName.equals("msg")) {
|
---|
| 261 | currentMessageType = WindowsMessageType.parseMessageType(atts.getValue("type"));
|
---|
[171] | 262 |
|
---|
[619] | 263 | if (countMessageOccurences) {
|
---|
| 264 | Integer currentCount = typeCounter.get(currentMessageType);
|
---|
| 265 | if (currentCount == null) {
|
---|
| 266 | typeCounter.put(currentMessageType, 1);
|
---|
| 267 | }
|
---|
| 268 | else {
|
---|
| 269 | typeCounter.put(currentMessageType, currentCount + 1);
|
---|
| 270 | }
|
---|
| 271 | }
|
---|
[171] | 272 |
|
---|
[619] | 273 | if (currentMessageType == WindowsMessageType.WM_CREATE) {
|
---|
| 274 | currentHandler = new HandlerCreate(currentWindowTree);
|
---|
| 275 | currentHandler.onStartElement();
|
---|
| 276 | }
|
---|
| 277 | else if (currentMessageType == WindowsMessageType.WM_DESTROY) {
|
---|
| 278 | currentHandler = new HandlerDestroy(currentWindowTree);
|
---|
| 279 | currentHandler.onStartElement();
|
---|
| 280 | }
|
---|
| 281 | else if (currentMessageType == WindowsMessageType.WM_SETTEXT) {
|
---|
| 282 | currentHandler = new HandlerSetText(currentWindowTree);
|
---|
| 283 | currentHandler.onStartElement();
|
---|
| 284 | }
|
---|
| 285 | }
|
---|
| 286 | else if (qName.equals("param")) {
|
---|
| 287 | if (currentHandler != null) {
|
---|
| 288 | currentHandler.onParameter(atts.getValue("name"), atts.getValue("value"));
|
---|
| 289 | }
|
---|
| 290 | else {
|
---|
| 291 | // provide the parameters directly in the correct type
|
---|
| 292 | String paramName = atts.getValue("name");
|
---|
| 293 | if (("window.hwnd".equals(paramName)) ||
|
---|
| 294 | ("source".equals(paramName)) ||
|
---|
| 295 | ("LPARAM".equals(paramName)) ||
|
---|
| 296 | ("WPARAM".equals(paramName)) ||
|
---|
| 297 | ("scrollPos".equals(paramName)) ||
|
---|
| 298 | ("scrollBarHandle".equals(paramName)))
|
---|
| 299 | {
|
---|
| 300 | Long paramValue = Long.parseLong(atts.getValue("value"));
|
---|
| 301 | currentMessageParameters.put(paramName, paramValue);
|
---|
| 302 | }
|
---|
| 303 | else {
|
---|
| 304 | currentMessageParameters.put(paramName, atts.getValue("value"));
|
---|
| 305 | }
|
---|
| 306 | }
|
---|
| 307 | }
|
---|
| 308 | }
|
---|
| 309 |
|
---|
| 310 | /*
|
---|
| 311 | * (non-Javadoc)
|
---|
| 312 | *
|
---|
| 313 | * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String, java.lang.String,
|
---|
| 314 | * java.lang.String)
|
---|
| 315 | */
|
---|
| 316 | @Override
|
---|
| 317 | public void endElement(String uri, String localName, String qName) throws SAXException {
|
---|
| 318 | if (qName.equals("msg")) {
|
---|
| 319 | if (currentHandler != null) {
|
---|
| 320 | currentHandler.onEndElement();
|
---|
| 321 | currentHandler = null;
|
---|
| 322 | }
|
---|
| 323 | else {
|
---|
| 324 | try {
|
---|
| 325 | long hwnd = (Long) currentMessageParameters.get("window.hwnd");
|
---|
| 326 | MFCGUIElement target = currentWindowTree.find(hwnd);
|
---|
| 327 |
|
---|
| 328 | WindowsMessage message = new WindowsMessage
|
---|
| 329 | (currentMessageType, target, currentMessageParameters);
|
---|
| 330 |
|
---|
| 331 | sequenceSplitter.addMessage(message);
|
---|
| 332 | }
|
---|
| 333 | catch (InvalidParameterException e) {
|
---|
[639] | 334 | Console.traceln(Level.WARNING, e.getMessage() + " WindowsMessage " + currentMessageType +
|
---|
[619] | 335 | " ignored.");
|
---|
| 336 | }
|
---|
| 337 | }
|
---|
| 338 | }
|
---|
| 339 | else if (qName.equals("session")) {
|
---|
| 340 | sequenceSplitter.endSession();
|
---|
| 341 | List<Event> seq = sequenceSplitter.getSequence();
|
---|
| 342 | if (seq != null && !seq.isEmpty()) {
|
---|
| 343 | sequences.add(seq);
|
---|
| 344 | }
|
---|
[639] | 345 | Console.traceln(Level.FINE, "end of session");
|
---|
[619] | 346 | }
|
---|
| 347 | }
|
---|
| 348 |
|
---|
[1] | 349 | }
|
---|