1 package eu
.etaxonomy
.taxeditor
.model
;
3 import java
.io
.PrintWriter
;
4 import java
.io
.StringWriter
;
5 import java
.util
.ArrayList
;
8 import org
.apache
.commons
.lang
.exception
.ExceptionUtils
;
9 import org
.apache
.log4j
.Logger
;
10 import org
.eclipse
.core
.runtime
.IStatus
;
11 import org
.eclipse
.core
.runtime
.MultiStatus
;
12 import org
.eclipse
.core
.runtime
.Platform
;
13 import org
.eclipse
.core
.runtime
.Status
;
14 import org
.eclipse
.jface
.dialogs
.MessageDialog
;
15 import org
.eclipse
.swt
.widgets
.Display
;
17 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.permission
.SecurityExceptionUtils
;
18 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
19 import eu
.etaxonomy
.taxeditor
.store
.internal
.TaxeditorStorePlugin
;
22 * Utility class which handles all the messaging information generated by the
25 * This includes logging as well as dialogs.
30 public class MessagingUtils
{
31 public final static String UNEXPECTED_ERROR_MESSAGE
= "This is an unexpected error.";
32 public final static String CONTACT_MESSAGE
= System
.getProperty("line.separator") + "Please contact EDIT Support (EditSupport@bgbm.org) with the error trace below (click on the 'Details' button).";
33 public final static String DEFAULT_MESSAGE
= "Error thrown but no associated message";
36 * Gets the Log4J logger for a given class
39 * a {@link java.lang.Class} object.
40 * @return a {@link org.apache.log4j.Logger} object.
42 public static Logger
getLog4JLogger(Class clazz
) {
43 return Logger
.getLogger(clazz
);
47 * Logs details from a given Status object
50 * a {@link org.eclipse.core.runtime.IStatus} object.
52 private static void log(IStatus status
) {
53 TaxeditorStorePlugin
.getDefault().getLog().log(status
);
57 * Logs a status object as information.
60 * a {@link org.eclipse.core.runtime.IStatus} object.
62 public static void info(IStatus status
) {
67 * Logs a string as information.
70 * a {@link java.lang.String} object.
72 public static void info(String message
) {
73 IStatus status
= new Status(IStatus
.INFO
, AbstractUtility
.getPluginId(), message
);
78 * Logs an exception from a given source as a warning.
83 public static void warn(Class source
, Throwable t
) {
84 IStatus status
= new Status(IStatus
.WARNING
, AbstractUtility
.getPluginId(), t
.getMessage(), t
);
85 MessagingUtils
.getLog4JLogger(source
).warn(t
);
90 * Logs a status object from a given source as a warning.
95 public static void warn(Class source
, IStatus status
) {
96 MessagingUtils
.getLog4JLogger(source
).warn(status
.getMessage(), status
.getException());
101 * Logs a string from a given source as a warning.
105 * a {@link java.lang.Class} object.
107 * a {@link java.lang.String} object.
109 public static void warn(Class source
, String message
) {
110 IStatus status
= new Status(IStatus
.WARNING
, AbstractUtility
.getPluginId(), message
);
111 MessagingUtils
.getLog4JLogger(source
).warn(message
);
116 * Logs a status object from a given source as an error.
120 * a {@link java.lang.Class} object.
122 * a {@link org.eclipse.core.runtime.IStatus} object.
124 public static void error(Class source
, IStatus status
) {
125 getLog4JLogger(source
)
126 .error(status
.getMessage(), status
.getException());
131 * Logs a string and exception from a given source as an error.
135 * a {@link java.lang.Class} object.
137 * a {@link java.lang.String} object.
139 * a {@link java.lang.Throwable} object.
141 public static void error(Class source
, String message
, Throwable t
) {
142 IStatus status
= new Status(IStatus
.ERROR
, AbstractUtility
.getPluginId(), message
, t
);
143 error(source
, status
);
149 * Logs an exception from a given source as an error.
153 * a {@link java.lang.Class} object.
155 * a {@link java.lang.Throwable} object.
157 public static void error(Class source
, Throwable t
) {
158 error(source
.getClass(), t
.getMessage(), t
);
164 * Returns a list of strings, providing info on,
167 * - server (address + source name)
168 * - db schema version
172 public static List
<String
> getContextInfo() {
173 List
<String
> contextInfo
= new ArrayList
<String
>();
175 String schemaVersion
= "";
180 version
= Platform
.getBundle("eu.etaxonomy.taxeditor.application").getHeaders().get(org
.osgi
.framework
.Constants
.BUNDLE_VERSION
);
182 if(CdmStore
.getActiveCdmSource() != null ) {
183 login
= CdmStore
.getLoginManager().getAuthenticatedUser().getUsername();
184 name
= CdmStore
.getActiveCdmSource().getName();
185 schemaVersion
= CdmStore
.getActiveCdmSource().getDbSchemaVersion();
186 server
= CdmStore
.getActiveCdmSource().getServer();
189 } catch (Exception e
) {
192 contextInfo
.add("login : " + login
);
193 contextInfo
.add("editor version : " + version
);
194 contextInfo
.add("server : " + server
+ " / " + name
);
195 contextInfo
.add("schema version : " + schemaVersion
);
196 contextInfo
.add("os : " + System
.getProperty("os.name")+" "+System
.getProperty("os.version")+" "+System
.getProperty("os.arch"));
197 contextInfo
.add("java : "+System
.getProperty("java.version"));
202 public static String
getStackTraceAndContextInfo(Throwable t
, List
<String
> contextInfo
) {
203 StringBuffer stackTraceAndContextInfo
= new StringBuffer();
204 Throwable throwable
= t
;
206 for(String infoItem
: contextInfo
) {
207 stackTraceAndContextInfo
.append(infoItem
+ System
.getProperty("line.separator"));
210 StringWriter sw
= new StringWriter();
212 if(throwable
== null) {
213 throwable
= getDefaultThrowable();
215 throwable
.printStackTrace(new PrintWriter(sw
));
217 stackTraceAndContextInfo
.append(sw
.toString());
219 return stackTraceAndContextInfo
.toString();
222 public static String
getContextInfo(List
<String
> contextInfo
) {
223 StringBuffer scontextInfoStringBuffer
= new StringBuffer();
226 for(String infoItem
: contextInfo
) {
227 scontextInfoStringBuffer
.append(infoItem
+ System
.getProperty("line.separator"));
232 return scontextInfoStringBuffer
.toString();
235 private static Throwable
getDefaultThrowable() {
236 return new Throwable("Error thrown but no associated exception");
242 * Displays a {@link eu.etaxonomy.taxeditor.model.CdmErrorDialog}.
251 private static void errorDialog(final String title
,
254 final List
<String
> contextInfo
,
255 final String message
,
256 final MultiStatus status
) {
258 Display
.getDefault().asyncExec(new Runnable() {
262 String stackTraceWithContext
= getStackTraceAndContextInfo(t
, contextInfo
);
263 CdmErrorDialog ced
= new CdmErrorDialog(AbstractUtility
.getShell(), title
, message
, status
, stackTraceWithContext
);
265 Class
<?
extends Object
> clazz
= source
!= null ? source
.getClass() : this.getClass();
268 IStatus singleStatus
= new Status(IStatus
.ERROR
,
271 new Exception(stackTraceWithContext
));
273 error(clazz
, singleStatus
);
279 * Displays a {@link eu.etaxonomy.taxeditor.model.CdmErrorDialog}.
287 public static void errorDialog(final String title
,
289 final String message
,
290 final String pluginId
,
292 boolean addContactMesg
) {
294 Throwable throwable
= t
;
295 StringBuffer sbStackTrace
= new StringBuffer();
297 // We need to build a MultiStatus object since the simple
298 // idea of writing out the stack trace as a single string
299 // leads to a single line on windows
300 List
<Status
> childStatuses
= new ArrayList
<Status
>();
303 List
<String
> contextInfo
= getContextInfo();
304 for(String infoItem
: contextInfo
) {
305 childStatuses
.add(new Status(IStatus
.ERROR
, pluginId
, infoItem
));
308 if(throwable
== null) {
309 throwable
= getDefaultThrowable();
315 for(Throwable th
: ExceptionUtils
.getThrowables(throwable
)) {
316 // add main exception
318 for (StackTraceElement ste
: th
.getStackTrace()) {
319 childStatuses
.add(new Status(IStatus
.ERROR
, pluginId
, " at " + ste
.toString()));
322 // add recursive causes
324 childStatuses
.add(new Status(IStatus
.ERROR
, pluginId
, ""));
325 String msg
= th
.toString();
326 childStatuses
.add(new Status(IStatus
.ERROR
, pluginId
, "Caused by : " + msg
));
328 for (StackTraceElement ste
: th
.getStackTrace()) {
329 // add only pre-defined number of trace elements
330 if(traceCount
> maxTraces
) {
331 childStatuses
.add(new Status(IStatus
.ERROR
, pluginId
, " ...."));
334 // build & add status
335 childStatuses
.add(new Status(IStatus
.ERROR
, pluginId
, " at " + ste
.toString()));
342 String finalMessage
= message
;
344 if(finalMessage
== null || finalMessage
.isEmpty()) {
345 finalMessage
= DEFAULT_MESSAGE
;
349 // add edit support contact info to message
350 finalMessage
+= MessagingUtils
.CONTACT_MESSAGE
;
353 MultiStatus ms
= new MultiStatus(pluginId
,
355 childStatuses
.toArray(new Status
[] {}),
356 throwable
.toString(),
359 errorDialog(title
, source
, throwable
, contextInfo
, finalMessage
, ms
);
363 * Displays a dialog for an exception occurring in an operation.
365 * This will be either a {@link eu.etaxonomy.taxeditor.model.CdmErrorDialog} in case of a
366 * security runtime exception or a warning {@link org.eclipse.jface.dialogs.MessageDialog} in
367 * case of any other exception.
370 * a {@link java.lang.String} object.
372 * a {@link java.lang.Object} object.
374 * a {@link org.eclipse.core.runtime.IStatus} object.
376 public static void operationDialog(final Object source
,
378 final String pluginId
,
379 final String operationlabel
,
382 Display
.getDefault().asyncExec(new Runnable() {
386 MultiStatus info
= null;
389 // FIXME cannot access TaxonomicEditorPlugin.PLUGIN_ID from here
390 // String PID = TaxonomicEditorPlugin.PLUGIN_ID;
391 String PID
= "eu.etaxonomy.taxeditor.application";
393 // checking security exceptions for every operation
394 RuntimeException securityRuntimeException
= SecurityExceptionUtils
.findSecurityRuntimeException(ex
);
396 // in case of a security exception it is a warning, else it is an error
397 if(securityRuntimeException
!= null){
398 title
= "Your changes could not be saved!";
399 warningDialog(title
, source
, String
.format("You are missing sufficient permissions for the operation \"%s\". %s", operationlabel
, hint
));
401 title
= "Error executing operation";
402 errorDialog(title
, source
, String
.format("An error occured while executing %s. %s", operationlabel
, hint
), pluginId
, ex
, true);
415 * Displays a question {@link org.eclipse.jface.dialogs.MessageDialog}.
418 * a {@link java.lang.String} object.
420 * a {@link java.lang.String} object.
423 public static boolean confirmDialog(String title
, String message
) {
424 return MessageDialog
.openQuestion(AbstractUtility
.getShell(), title
, message
);
428 * Displays a message {@link org.eclipse.jface.dialogs.MessageDialog}.
434 public static void messageDialog(final String title
, final Object source
, final String message
) {
435 MessagingUtils
.messageDialog(title
, source
, message
, null, true);
441 * Displays an error {@link org.eclipse.jface.dialogs.MessageDialog}.
446 * The object where the warning was generated (used by log4j)
448 * An informative String to be presented to the user
452 * a Throwable if one exists or null
454 public static void messageDialog(final String title
,
456 final String message
,
458 MessagingUtils
.messageDialog(title
, source
, message
, t
, true);
462 * Displays an error {@link org.eclipse.jface.dialogs.MessageDialog}.
467 * The object where the warning was generated (used by log4j)
469 * An informative String to be presented to the user
473 * a Throwable if one exists or null
475 public static void messageDialog(final String title
,
477 final String message
,
481 Display
.getDefault().asyncExec(new Runnable() {
485 MessageDialog
.openError(AbstractUtility
.getShell(), title
, message
+ getCauseRecursively(t
));
486 Class
<?
extends Object
> clazz
= source
!= null ? source
487 .getClass() : this.getClass();
488 error(clazz
, message
, t
);
494 MessageDialog
.openError(AbstractUtility
.getShell(), title
, message
+ getCauseRecursively(t
));
495 Class
<?
extends Object
> clazz
= source
!= null ? source
.getClass() : TaxeditorStorePlugin
.class;
496 error(clazz
, message
, t
);
500 public static String
getCauseRecursively(Throwable t
) {
505 if(t
.getCause() != null){
506 return getCauseRecursively(t
.getCause());
508 return String
.format("\n\nException: %s\nMessage: %s", t
.getClass().getSimpleName(), t
.getMessage());
513 * Displays a warning {@link org.eclipse.jface.dialogs.MessageDialog}.
519 public static void warningDialog(String title
, Object source
,
521 MessagingUtils
.warningDialog(title
, source
, status
.getMessage());
525 * Standard warning dialog for the case when the application is not yet connected to the datasource
529 public static void noDataSourceWarningDialog(Object source
) {
532 "Application is not connected to a datastore",
534 "The requested operation is only available when "
535 + "connected to a datasource. You may choose a datasource to connect to or create a new one in the datasource view.");
539 * Displays a warning {@link org.eclipse.jface.dialogs.MessageDialog}.
544 * The object where the warning was generated (used by log4j)
546 * An informative String to be presented to the user
548 public static void warningDialog(final String title
, final Object source
, final String message
) {
549 Display
.getDefault().asyncExec(new Runnable() {
553 MessageDialog
.openWarning(AbstractUtility
.getShell(), title
, message
);
554 Class
<?
extends Object
> clazz
= source
!= null ? source
555 .getClass() : AbstractUtility
.class;
556 warn(clazz
, message
);
562 * Displays an information {@link org.eclipse.jface.dialogs.MessageDialog}.
567 public static void informationDialog(final String title
, final IStatus status
) {
568 MessagingUtils
.informationDialog(title
, status
.getMessage());
572 * Displays an information {@link org.eclipse.jface.dialogs.MessageDialog}.
575 * a {@link java.lang.String} object.
577 * a {@link java.lang.String} object.
579 public static void informationDialog(final String title
,
580 final String message
) {
581 Display
.getDefault().asyncExec(new Runnable() {
585 MessageDialog
.openInformation(AbstractUtility
.getShell(), title
, message
);
591 * Open a message box that informs the user about unimplemented
592 * functionality. This method is for developer convenience.
595 * a {@link java.lang.Object} object.
597 public static void notImplementedMessage(Object source
) {
598 warningDialog("Not yet implemented", source
,
599 "This functionality is not yet implemented.");