+ * corrects older JFC log files which sometimes do not contain correct source specification for
+ * events. It parses the file and adds component specifications to the source, that do not have
+ * them. The parent components are reused from the last GUI element the user worked with. The
+ * leaf component is parsed from the toString parameter that is provided with the
+ * source specifications. The resulting leaf nodes are not fully correct. They may pretend to
+ * be equal although they are not. But more correctness is not achievable based on the
+ * toString parameter.
+ *
+ * the file to write the result into + *
+ */ + private PrintStream outFile; + + /** + *+ * the currently parsed event + *
+ */ + private Event currentEvent; + + /** + *+ * the currently parsed source of the currently parsed event + *
+ */ + private Source currentSource; + + /** + *+ * the source of the last parsed event + *
+ */ + private Source lastSource; + + /** + *+ * the currently parsed component of the currently parsed source of the currently parsed event + *
+ */ + private Component currentComponent; + + /** + *+ * the currently parsed session + *
+ */ + private Session currentSession; + + /** + *+ * corrects the given file and returns the name of the file into which the result was written + *
+ * + * @param filename the name of the file to be corrected + * + * @return the name of the file with the corrected logfile + * + * @throws IllegalArgumentException if the filename is null + */ + public String correctFile(String filename) throws IllegalArgumentException { + if (filename == null) { + throw new IllegalArgumentException("filename must not be null"); + } + + return correctFile(new File(filename)).getAbsolutePath(); + } + + /** + *+ * corrects the given file, stores the result in the second provided file and returns the + * name of the file into which the result was written + *
+ * + * @param filename the name of the file to be corrected + * @param resultFile the name of the file into which the corrected log shall be written + * + * @return the name of the file with the corrected logfile + * + * @throws IllegalArgumentException if the filename or resultFile is null + */ + public String correctFile(String filename, String resultFile) throws IllegalArgumentException { + if ((filename == null) | (resultFile == null)) { + throw new IllegalArgumentException("filename and resultFile must not be null"); + } + + return correctFile(new File(filename), new File(resultFile)).getAbsolutePath(); + } + + /** + *+ * corrects the given file and returns the file into which the result was written. The name + * of the resulting file is contains the suffix "_corrected" before the dot. + *
+ * + * @param file the file to be corrected + * + * @return the file containing the corrected logfile + * + * @throws IllegalArgumentException if the file is null + */ + public File correctFile(File file) throws IllegalArgumentException { + if (file == null) { + throw new IllegalArgumentException("file must not be null"); + } + + int index = file.getName().lastIndexOf('.'); + String fileName = + file.getName().substring(0, index) + "_corrected" + file.getName().substring(index); + + File resultFile = new File(file.getParentFile(), fileName); + + return correctFile(file, resultFile); + } + + /** + *+ * corrects the given file, stores the result in the second provided file and returns the + * file into which the result was written + *
+ * + * @param file the file to be corrected + * @param resultFile the file into which the corrected log shall be written + * + * @return the file with the corrected logfile + * + * @throws IllegalArgumentException if the file or resultFile is null or if they are equal + */ + public File correctFile(File file, File resultFile) throws IllegalArgumentException { + if ((file == null) || (resultFile == null)) { + throw new IllegalArgumentException("file and result file must not be null"); + } + + if (file.getAbsolutePath().equals(resultFile.getAbsolutePath())) { + throw new IllegalArgumentException("file and result file must not be equal"); + } + + try { + outFile = new PrintStream(new FileOutputStream(resultFile)); + outFile.println(""); + } + catch (FileNotFoundException e1) { + throw new IllegalArgumentException("could not create a corrected file name " + + resultFile + " next to " + file); + } + + + SAXParserFactory spf = SAXParserFactory.newInstance(); + spf.setValidating(true); + + SAXParser saxParser = null; + InputSource inputSource = null; + try { + saxParser = spf.newSAXParser(); + inputSource = + new InputSource(new InputStreamReader(new FileInputStream(file), "UTF-8")); + } + catch (UnsupportedEncodingException e) { + Console.printerr("Error parsing file + " + file.getName()); + Console.logException(e); + return null; + } + catch (ParserConfigurationException e) { + Console.printerr("Error parsing file + " + file.getName()); + Console.logException(e); + return null; + } + catch (SAXException e) { + Console.printerr("Error parsing file + " + file.getName()); + Console.logException(e); + return null; + } + catch (FileNotFoundException e) { + Console.printerr("Error parsing file + " + file.getName()); + Console.logException(e); + return null; + } + if (inputSource != null) { + inputSource.setSystemId("file://" + file.getAbsolutePath()); + try { + if (saxParser == null) { + throw new RuntimeException("SAXParser creation failed"); + } + saxParser.parse(inputSource, this); + } + catch (SAXParseException e) { + Console.printerrln("Failure parsing file in line " + e.getLineNumber() + + ", column " + e.getColumnNumber() + "."); + Console.logException(e); + return null; + } + catch (SAXException e) { + Console.printerr("Error parsing file + " + file.getName()); + Console.logException(e); + return null; + } + catch (IOException e) { + Console.printerr("Error parsing file + " + file.getName()); + Console.logException(e); + return null; + } + } + + if (outFile != null) { + outFile.close(); + } + + return resultFile; + } + + /* + * (non-Javadoc) + * + * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String, + * java.lang.String, org.xml.sax.Attributes) + */ + public void startElement(String uri, String localName, String qName, Attributes atts) + throws SAXException + { + if (qName.equals("sessions")) { + currentSession = new Session(); + currentSession.type = "sessions"; + } + else if (qName.equals("newsession")) { + if (currentSession != null) { + currentSession.dump(outFile); + } + + currentSession = new Session(); + currentSession.type = "newsession"; + } + else if (qName.equals("event")) { + currentEvent = new Event(); + currentEvent.id = atts.getValue("id"); + } + else if (qName.equals("source")) { + currentSource = new Source(); + } + else if (qName.equals("component")) { + currentComponent = new Component(); + } + else if (qName.equals("param")) { + if (currentComponent != null) { + currentComponent.params.add + (new String[] {atts.getValue("name"), atts.getValue("value") }); + } + else if (currentSource != null) { + currentSource.params.add + (new String[] {atts.getValue("name"), atts.getValue("value") }); + } + else if (currentEvent != null) { + currentEvent.params.add + (new String[] {atts.getValue("name"), atts.getValue("value") }); + } + else { + throw new SAXException("parameter occurred at an unexpected place"); + } + } + else { + throw new SAXException("unexpected tag " + qName); + } + } + + /* + * (non-Javadoc) + * + * @see org.xml.sax.helpers.DefaultHandler#endElement(java.lang.String, java.lang.String, + * java.lang.String) + */ + @Override + public void endElement(String uri, String localName, String qName) throws SAXException { + if (qName.equals("sessions")) { + //harmonizeToStringComponents(); + + currentSession.dump(outFile); + currentSession = null; + } + else if (qName.equals("newsession")) { + //harmonizeToStringComponents(); + + currentSession.dump(outFile); + currentSession = null; + } + else if (qName.equals("event")) { + currentSession.events.add(currentEvent); + currentEvent = null; + } + else if (qName.equals("source")) { + if (currentSource.components.size() == 0) { + correctEventSource(currentSource); + } + + lastSource = currentSource; + currentEvent.source = currentSource; + currentSource = null; + } + else if (qName.equals("component")) { + currentSource.components.add(currentComponent); + currentComponent = null; + } + else if (!qName.equals("param")) { + throw new SAXException("unexpected closing tag " + qName); + } + + } + + /** + * + */ + /*private void harmonizeToStringComponents() { + List
+ * corrects the source of an event. It copies all parameters of the source of the previous
+ * event if they are not included in the source already. Furthermore, it adds all components
+ * of the source of the previous event. At last, it adds a further component based on the
+ * information found in the toString parameter of the source.
+ *
+ * determines a component based on the toString parameter of the provided source.
+ * For this, it parses the parameter value and tries to determine several infos such as the
+ * type and the name of it. The resulting components are not always distinguishable. This is,
+ * because the toString parameter does not contain sufficient information for
+ * correct identification.
+ *
toString parameter from
+ *
+ * @return the component parsed from the toString parameter
+ */
+ private Component getComponentFromToString(Source source) {
+ String toStringValue = null;
+
+ for (String[] parameter : source.params) {
+ if ("toString".equals(parameter[0])) {
+ toStringValue = parameter[1];
+ break;
+ }
+ }
+
+ ComponentFromToString component = new ComponentFromToString();
+
+ // search for the beginning of the parameters section. Up to this position we find the class
+ int start = toStringValue.indexOf('[');
+ String clazz = toStringValue.substring(0, start);
+
+ // the first parameters are x and y coordinate as well as the size. The size is one
+ // parameter, where with and height are separated with an 'x'
+ start = toStringValue.indexOf(',', start) + 1;
+ int end = toStringValue.indexOf(',', start);
+
+ component.x = Integer.parseInt(toStringValue.substring(start, end));
+
+ start = end + 1;
+ end = toStringValue.indexOf(',', start);
+
+ component.y = Integer.parseInt(toStringValue.substring(start, end));
+
+ start = end + 1;
+ end = toStringValue.indexOf('x', start);
+
+ component.width = Integer.parseInt(toStringValue.substring(start, end));
+
+ start = end + 1;
+ end = toStringValue.indexOf(',', start);
+
+ component.height = Integer.parseInt(toStringValue.substring(start, end));
+
+ // no start parsing the rest of the parameters and extract those having a key and a
+ // value and whose key is text, defaultIcon, or an alignment
+ int intermediate;
+ start = end + 1;
+
+ String title = null;
+ String icon = null;
+ String alignment = null;
+
+ do {
+ end = toStringValue.indexOf(',', start);
+ intermediate = toStringValue.indexOf('[', start);
+
+ if ((intermediate >= 0) && (intermediate < end)) {
+ // the value of the parameter itself contains brackets. So try to determine the
+ // real end of the parameter
+ end = toStringValue.indexOf(']', intermediate);
+ end = toStringValue.indexOf(',', end);
+ }
+
+ if (end < 0) {
+ //we reached the end of the stream. So the the end to the "end"
+ end = toStringValue.lastIndexOf(']');
+ }
+
+ intermediate = toStringValue.indexOf('=', start);
+
+ if ((intermediate >= 0) && (intermediate < end)) {
+ // this is a key value pair, so store the the parameter
+ String key = toStringValue.substring(start, intermediate);
+ String value = toStringValue.substring(intermediate + 1, end);
+
+ if ("text".equals(key)) {
+ title = value;
+ }
+ else if ("defaultIcon".equals(key)) {
+ icon = value;
+ }
+ else if ("alignmentX".equals(key) || "alignmentY".equals(key)) {
+ if (alignment == null) {
+ alignment = value;
+ }
+ else {
+ alignment += "/" + value;
+ }
+ }
+ }
+ /*else {
+ // this is a simple value, for now simply ignore it
+ String key = toStringValue.substring(start, end);
+ if (!"invalid".equals(key)) {
+ componentHash += key.hashCode();
+ component.params.add(new String[] { key, "true" });
+ }
+ }*/
+
+ start = end + 1;
+ }
+ while (start < toStringValue.lastIndexOf(']'));
+
+ // finish the component specification by setting the parameters
+ if (title == null) {
+ if (icon == null) {
+ title = clazz.substring(clazz.lastIndexOf('.') + 1) + "(";
+
+ // to be able to distinguish some elements, that usually have no name and icon, try
+ // to include some of their specific identifying information in their name.
+ if ("org.tigris.gef.presentation.FigTextEditor".equals(clazz) ||
+ "org.argouml.core.propertypanels.ui.UMLTextField".equals(clazz))
+ {
+ title += "height " + component.height + ", ";
+ }
+ else if ("org.argouml.core.propertypanels.ui.UMLLinkedList".equals(clazz) ||
+ "org.argouml.core.propertypanels.ui.LabelledComponent".equals(clazz))
+ {
+ title += "position " + component.x + "/" + component.y + ", ";
+ }
+
+ title += "alignment " + alignment + ")";
+ }
+ else {
+ title = icon;
+ }
+ }
+
+ component.params.add(new String[] { "title", title } );
+ component.params.add(new String[] { "class", clazz } );
+ component.params.add(new String[] { "icon", icon } );
+ component.params.add(new String[] { "index", "-1" });
+
+ int hashCode = clazz.hashCode() + title.hashCode();
+
+ if (hashCode < 0) {
+ hashCode = -hashCode;
+ }
+
+ component.params.add(new String[] { "hash", Integer.toString(hashCode, 16) });
+
+ return component;
+ }
+
+ /**
+ * + * used to dump a list of parameters to the provided print stream + *
+ */ + private void dumpParams(PrintStream out, List+ * used to carry all events of a session and to dump it to the output file + *
+ */ + private class Session { + private String type; + private List+ * used to carry all information about an event and to dump it to the output file + *
+ */ + private class Event { + private String id; + private List+ * used to carry all information about a source of an event and to dump it to the output file + *
+ */ + private class Source { + private List+ * used to carry all information about a component of a source and to dump it to the output file + *
+ */ + private class Component { + protected List+ * represents a specific component, which was read from the toString parameter of a source + *
+ */ + private class ComponentFromToString extends Component { + private int x; + private int y; + private int width; + private int height; + + @Override + protected void dump(PrintStream out) { + out.println("+ * Command that tries to correct all files in a folder as if they were log files generated by the + * older version of the JFCMonitor which sometimes do not include correct event sources. The result + * is another specified directory, which contains the corrected files. + *
+ * + * @author Patrick Harms + * @version 1.0 + */ +public class CMDcorrectDirOldJFC implements Command { + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.util.console.Command#run(java.util.List) + */ + @Override + public void run(List