Changes between Version 24 and Version 25 of APP_BUG_REPORT_FORM_R0

Timestamp:

05/28/09 18:53:16 (16 years ago)

Author:

mitex

Comment:

--

APP_BUG_REPORT_FORM_R0

@@ -74 +74 @@
  * Create a menu item "Send an &Error Report..." in {{{org.sophie2.main.func.help.menuitems}}} and attach it to the Help menu.
 
- * Create a class {{{org.sophie2.main.func.help.bugreport.BugReportDialogInput}}} that extends {{{DialogInput<Void>}}} and represents the bug report data:
-  * {{{Throwable throwable}}} - can be null
-  * {{{String log}}} - the contents of the Sophie log file
-  * {{{Properties systemProperties}}} - java system properties ([http://java.sun.com/j2se/1.4.2/docs/api/java/lang/System.html#getProperties()])
-  * {{{String email}}}
-  * {{{String explanation}}} - can be empty
-  * {{{File attachment}}} - can be null
+ * Create a class {{{org.sophie2.main.func.help.bugreport.BugReport}}} that represents the bug report data and has the following properties:
+  * String property {{{stackTrace}}} - can be empty
+  * String property {{{log}}} - the contents of Sophie log files
+  * String property {{{systemProperties}}} - java system properties, serialized ([http://java.sun.com/j2se/1.4.2/docs/api/java/lang/System.html#getProperties()])
+  * String property {{{email}}}
+  * String property {{{userExplanation}}} - can be empty
+  * File property {{{attachment}}} - can be null
+  * String property {{{technicalInformation}}} - auto property which contains all technical data in this report, serialized to String. Includes everything that is automatically collected - stack trace, log files, system properties.
+  * String method {{{getContent()}}} - gets all data in this report, serialized to String.
+
+ * Create a class {{{org.sophie2.main.func.help.bugreport.BugReportDialogInput}}} that extends {{{DialogInput<Void>}}}:
+  * {{{private final BugReport bugReport;}}}
+  * {{{private final String windowTitle;}}}
 
  * Create a class {{{org.sophie2.main.func.help.bugreport.BugReportDialog}}} that extends {{{org.sophie2.base.dialogs.Dialog<BugReportDialogInput, Void>}}}.
   * Use {{{BoundTextField}}}s.
    * The e-mail text field should perform validation using regular expression.
-  * String property {{{reportData}}} - serialized report data, without the user explanation and e-mail address.
-  * String property {{{userExplanation}}}
-  * String property {{{userEmail}}}
+  * BugReport property
+  * String property {{{title}}}
+  * JDialog property {{{swingComponent}}}.
+  * enum EventIds: CLOSE, SAVE_TO_FILE, ATTACH_FILE, EMAIL_CHANGED
   * Register the dialog in the help module.
 
@@ -94 +101 @@
   * Use {{{FileEntryManager}}}'s methods {{{getReadableFileEntry}}} and {{{getWritableFileEntry}}}.
 
+ * Move Sophie log files to distrib directory:
+  * Edit {{{log4j.properties}}} for author and reader, set log path to be in distrib/log.
+  * Now log files can be read using FileEntryManager.
+
  * Create a controller {{{enum org.sophie2.main.func.help.bugreport.BugReportLogic}}}
-  * method {{{BugReportDialogInput collectReportData(Throwable t)}}} that collects all required report data:
-   * the exception is taken as a parameter
+  * SHOW_BUG_REPORT_FORM: this should be called when the menu item is selected. Calls BugReportLogic.showBugReportForm(null); (null, because no exception is thrown)
+  * SAVE_REPORT_TO_FILE: opens a file dialog, saves the result of BugReport.getContent() and closes the form.
+   * Use UTF-8 encoding.
+  * ATTACH_FILE: opens a file dialog, sets the attachment field in the bugReport property of the event source (BugReportDialog).
+  * CLOSE: closes the form.
+  * SAVE_EMAIL: invoked when the user enters a valid e-mail in the form. Saves the address as described earlier.
+  * {{{static void showBugReportForm(Throwable throwable)}}}: calls {{{collectReportData(throwable)}}} and opens the form using DialogManager.
+  * {{{static BugReport collectReportData(Throwable t)}}}: collects all required report data:
+   * serializes the throwable's stack trace to string.
    * gets current date and time.
-   * reads the log file
+   * reads all log files (using {{{listFileEntries}}} in {{{FileEntryManager}}}).
    * gets all system properties
    * reads the e-mail address from a file
    * the explanation is an empty string
    * the attached file is null
-  * SHOW_BUG_REPORT_FORM: invokes the dialog using {{{DialogManager.get().showDialog}}} with argument - report generated by {{{generateReport}}}.
-  * method {{{String generateReport(BugReportDialogInput)}}} that serializes all the data to string.
-   * The exception is serialized using printStackTrace.
-   * Use ISO format for the date.
-   * Use UTF-8 encoding.
-  * SAVE_TO_FILE: opens a file dialog, saves the result of {{{generateReport}}} (without the attached file) and closes the form.
-  * LOAD_FROM_FILE: opens a file dialog, replaces the generated report.
-  * ATTACH_FILE: opens a file dialog, sets the attachment field in BugReportDialogInput.
-  * CLOSE: closes the form.
 
  * Create a class {{{org.sophie2.main.func.help.bugreport.SophieExceptionHandler}}} that implements {{{Thread.UncaughtExceptionHandler}}}.
-  * In {{{uncaughtException(Thread t, Throwable e)}}} fire the same R3 event as the menuitem, but with parameter {{{e}}}.
+  * In {{{uncaughtException(Thread t, Throwable e)}}} call {{{BugReportLogic.showBugReportForm(e);}}}
  * Register that handler by invoking {{{Thread.setDefaultUncaughtExceptionHandler(new SophieExceptionHandler());}}} in {{{HelpModule.doStart}}}.