eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/model/MessagingUtils.java

   1 package eu.etaxonomy.taxeditor.model;
   2
   3 import java.io.PrintWriter;
   4 import java.io.StringWriter;
   5 import java.util.ArrayList;
   6 import java.util.List;
   7
   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;
  16
  17 import eu.etaxonomy.cdm.persistence.hibernate.permission.SecurityExceptionUtils;
  18 import eu.etaxonomy.taxeditor.store.CdmStore;
  19 import eu.etaxonomy.taxeditor.store.internal.TaxeditorStorePlugin;
  20
  21 /**
  22  * Utility class which handles all the messaging information generated by the
  23  * Editor.
  24  *
  25  * This includes logging as well as dialogs.
  26  *
  27  * @author cmathew
  28  *
  29  */
  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";
  34
  35     /**
  36      * Gets the Log4J logger for a given class
  37      *
  38      * @param clazz
  39      *            a {@link java.lang.Class} object.
  40      * @return a {@link org.apache.log4j.Logger} object.
  41      */
  42     public static Logger getLog4JLogger(Class clazz) {
  43         return Logger.getLogger(clazz);
  44     }
  45
  46     /**
  47      * Logs details from a given Status object
  48      *
  49      * @param status
  50      *                          a {@link org.eclipse.core.runtime.IStatus} object.
  51      */
  52     private static void log(IStatus status) {
  53         TaxeditorStorePlugin.getDefault().getLog().log(status);
  54     }
  55
  56     /**
  57      * Logs a status object as information.
  58      *
  59      * @param status
  60      *            a {@link org.eclipse.core.runtime.IStatus} object.
  61      */
  62     public static void info(IStatus status) {
  63         log(status);
  64     }
  65
  66     /**
  67      * Logs a string as information.
  68      *
  69      * @param message
  70      *            a {@link java.lang.String} object.
  71      */
  72     public static void info(String message) {
  73         IStatus status = new Status(IStatus.INFO, AbstractUtility.getPluginId(), message);
  74         info(status);
  75     }
  76
  77     /**
  78      * Logs an exception from a given source as a warning.
  79      *
  80      * @param source
  81      * @param t
  82      */
  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);
  86         log(status);
  87     }
  88
  89     /**
  90      * Logs a status object from a given source as a warning.
  91      *
  92      * @param source
  93      * @param status
  94      */
  95     public static void warn(Class source, IStatus status) {
  96         MessagingUtils.getLog4JLogger(source).warn(status.getMessage(), status.getException());
  97         log(status);
  98     }
  99
 100     /**
 101      * Logs a string from a given source as a warning.
 102      *
 103      *
 104      * @param source
 105      *            a {@link java.lang.Class} object.
 106      * @param message
 107      *            a {@link java.lang.String} object.
 108      */
 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);
 112         log(status);
 113     }
 114
 115     /**
 116      * Logs a status object from a given source as an error.
 117      *
 118      *
 119      * @param source
 120      *            a {@link java.lang.Class} object.
 121      * @param status
 122      *            a {@link org.eclipse.core.runtime.IStatus} object.
 123      */
 124     public static void error(Class source, IStatus status) {
 125         getLog4JLogger(source)
 126         .error(status.getMessage(), status.getException());
 127         log(status);
 128     }
 129
 130     /**
 131      * Logs a string and exception from a given source as an error.
 132      *
 133      *
 134      * @param source
 135      *            a {@link java.lang.Class} object.
 136      * @param message
 137      *            a {@link java.lang.String} object.
 138      * @param t
 139      *            a {@link java.lang.Throwable} object.
 140      */
 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);
 144     }
 145
 146
 147
 148     /**
 149      * Logs an exception from a given source as an error.
 150      *
 151      *
 152      * @param source
 153      *            a {@link java.lang.Class} object.
 154      * @param t
 155      *            a {@link java.lang.Throwable} object.
 156      */
 157     public static void error(Class source, Throwable t) {
 158         error(source.getClass(), t.getMessage(), t);
 159     }
 160
 161
 162
 163     /**
 164      * Returns a list of strings, providing info on,
 165      *  - login
 166      *  - editor version
 167      *  - server (address + source name)
 168      *  - db schema version
 169      *
 170      * @return
 171      */
 172     public static List<String> getContextInfo() {
 173         List<String> contextInfo = new ArrayList<String>();
 174         String name = "";
 175         String schemaVersion = "";
 176         String server = "";
 177         String version = "";
 178         String login = "";
 179         try {
 180             version = Platform.getBundle("eu.etaxonomy.taxeditor.application").getHeaders().get(org.osgi.framework.Constants.BUNDLE_VERSION);
 181
 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();
 187             }
 188
 189         } catch (Exception e) {
 190             // Nothing to do
 191         }
 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"));
 198
 199         return contextInfo;
 200     }
 201
 202     public static String getStackTraceAndContextInfo(Throwable t, List<String> contextInfo)  {
 203         StringBuffer stackTraceAndContextInfo = new StringBuffer();
 204         Throwable throwable = t;
 205
 206         for(String infoItem : contextInfo) {
 207             stackTraceAndContextInfo.append(infoItem + System.getProperty("line.separator"));
 208         }
 209
 210         StringWriter sw = new StringWriter();
 211
 212         if(throwable == null) {
 213             throwable = getDefaultThrowable();
 214         }
 215         throwable.printStackTrace(new PrintWriter(sw));
 216
 217         stackTraceAndContextInfo.append(sw.toString());
 218
 219         return stackTraceAndContextInfo.toString();
 220     }
 221
 222     private static Throwable getDefaultThrowable() {
 223         return new Throwable("Error thrown but no associated exception");
 224     }
 225
 226
 227
 228     /**
 229      * Displays a {@link eu.etaxonomy.taxeditor.model.CdmErrorDialog}.
 230      *
 231      * @param title
 232      * @param source
 233      * @param t
 234      * @param contextInfo
 235      * @param message
 236      * @param status
 237      */
 238     private static void errorDialog(final String title,
 239             final Object source,
 240             final Throwable t,
 241             final List<String> contextInfo,
 242             final String message,
 243             final MultiStatus status) {
 244
 245         Display.getDefault().asyncExec(new Runnable() {
 246
 247             @Override
 248             public void run() {
 249                 String stackTraceWithContext = getStackTraceAndContextInfo(t, contextInfo);
 250                 CdmErrorDialog ced = new CdmErrorDialog(AbstractUtility.getShell(), title, message, status, stackTraceWithContext);
 251                 ced.open();
 252                 Class<? extends Object> clazz = source != null ? source.getClass() : this.getClass();
 253
 254
 255                 IStatus singleStatus = new Status(IStatus.ERROR,
 256                         status.getPlugin(),
 257                         message,
 258                         new Exception(stackTraceWithContext));
 259
 260                 error(clazz, singleStatus);
 261             }
 262         });
 263     }
 264
 265     /**
 266      * Displays a {@link eu.etaxonomy.taxeditor.model.CdmErrorDialog}.
 267      *
 268      * @param title
 269      * @param source
 270      * @param message
 271      * @param pluginId
 272      * @param t
 273      */
 274     public static void errorDialog(final String title,
 275             final Object source,
 276             final String message,
 277             final String pluginId,
 278             final Throwable t,
 279             boolean addContactMesg) {
 280
 281         Throwable throwable = t;
 282         StringBuffer sbStackTrace = new StringBuffer();
 283
 284         // We need to build a MultiStatus object since the simple
 285         // idea of writing out the stack trace as a single string
 286         // leads to a single line on windows
 287         List<Status> childStatuses = new ArrayList<Status>();
 288
 289         // add context info
 290         List<String> contextInfo = getContextInfo();
 291         for(String infoItem : contextInfo) {
 292             childStatuses.add(new Status(IStatus.ERROR, pluginId, infoItem));
 293         }
 294
 295         if(throwable == null) {
 296             throwable = getDefaultThrowable();
 297         }
 298
 299         int thCount = 0;
 300         int maxTraces = 4;
 301
 302         for(Throwable th : ExceptionUtils.getThrowables(throwable)) {
 303             // add main exception
 304             if(thCount == 0) {
 305                 for (StackTraceElement ste : th.getStackTrace()) {
 306                     childStatuses.add(new Status(IStatus.ERROR, pluginId, "  at " + ste.toString()));
 307                 }
 308             } else {
 309                 // add recursive causes
 310                 if(th != null) {
 311                     childStatuses.add(new Status(IStatus.ERROR, pluginId, ""));
 312                     String msg = th.toString();
 313                     childStatuses.add(new Status(IStatus.ERROR, pluginId, "Caused by : " + msg));
 314                     int traceCount = 0;
 315                     for (StackTraceElement ste : th.getStackTrace()) {
 316                         // add only pre-defined number of trace elements
 317                         if(traceCount > maxTraces) {
 318                             childStatuses.add(new Status(IStatus.ERROR, pluginId, "  ...."));
 319                             break;
 320                         }
 321                         // build & add status
 322                         childStatuses.add(new Status(IStatus.ERROR, pluginId, "  at " + ste.toString()));
 323                         traceCount++;
 324                     }
 325                 }
 326             }
 327             thCount++;
 328         }
 329         String finalMessage = message;
 330
 331         if(finalMessage == null || finalMessage.isEmpty()) {
 332             finalMessage = DEFAULT_MESSAGE;
 333         }
 334
 335         if(addContactMesg) {
 336             // add edit support contact info to message
 337             finalMessage += MessagingUtils.CONTACT_MESSAGE;
 338         }
 339
 340         MultiStatus ms = new MultiStatus(pluginId,
 341                 IStatus.ERROR,
 342                 childStatuses.toArray(new Status[] {}),
 343                 throwable.toString(),
 344                 throwable);
 345
 346         errorDialog(title, source, throwable, contextInfo, finalMessage, ms);
 347     }
 348
 349     /**
 350      * Displays a dialog for an exception occurring in an operation.
 351      *
 352      * This will be either a {@link eu.etaxonomy.taxeditor.model.CdmErrorDialog} in case of a
 353      * security runtime exception or a warning {@link org.eclipse.jface.dialogs.MessageDialog} in
 354      * case of any other exception.
 355      *
 356      * @param title
 357      *            a {@link java.lang.String} object.
 358      * @param source
 359      *            a {@link java.lang.Object} object.
 360      * @param status
 361      *            a {@link org.eclipse.core.runtime.IStatus} object.
 362      */
 363     public static void operationDialog(final Object source,
 364             final Exception ex,
 365             final String pluginId,
 366             final String operationlabel,
 367             final String hint) {
 368
 369         Display.getDefault().asyncExec(new Runnable() {
 370
 371             @Override
 372             public void run() {
 373                 MultiStatus info = null;
 374                 String title = null;
 375
 376                 // FIXME cannot access TaxonomicEditorPlugin.PLUGIN_ID from here
 377                 // String PID = TaxonomicEditorPlugin.PLUGIN_ID;
 378                 String PID = "eu.etaxonomy.taxeditor.application";
 379
 380                 // checking security exceptions for every operation
 381                 RuntimeException securityRuntimeException = SecurityExceptionUtils.findSecurityRuntimeException(ex);
 382
 383                 // in case of a security exception it is a warning, else it is an error
 384                 if(securityRuntimeException != null){
 385                     title = "Your changes could not be saved!";
 386                     warningDialog(title, source, String.format("You are missing sufficient permissions for the operation \"%s\". %s", operationlabel, hint));
 387                 } else {
 388                     title = "Error executing operation";
 389                     errorDialog(title, source, String.format("An error occured while executing %s. %s", operationlabel, hint), pluginId, ex, true);
 390
 391                 }
 392
 393
 394             }
 395         });
 396     }
 397
 398
 399
 400
 401     /**
 402      * Displays a question {@link org.eclipse.jface.dialogs.MessageDialog}.
 403      *
 404      * @param title
 405      *            a {@link java.lang.String} object.
 406      * @param message
 407      *            a {@link java.lang.String} object.
 408      * @return a boolean.
 409      */
 410     public static boolean confirmDialog(String title, String message) {
 411         return MessageDialog.openQuestion(AbstractUtility.getShell(), title, message);
 412     }
 413
 414     /**
 415      * Displays a message {@link org.eclipse.jface.dialogs.MessageDialog}.
 416      *
 417      * @param title
 418      * @param source
 419      * @param message
 420      */
 421     public static void messageDialog(final String title, final Object source, final String message) {
 422         MessagingUtils.messageDialog(title, source, message, null, true);
 423     }
 424
 425
 426
 427     /**
 428      * Displays an error {@link org.eclipse.jface.dialogs.MessageDialog}.
 429      *
 430      * @param title
 431      *            The dialogs title
 432      * @param source
 433      *            The object where the warning was generated (used by log4j)
 434      * @param message
 435      *            An informative String to be presented to the user
 436      * @param title
 437      *            The dialogs title
 438      * @param t
 439      *            a Throwable if one exists or null
 440      */
 441     public static void messageDialog(final String title,
 442             final Object source,
 443             final String message,
 444             final Throwable t) {
 445         MessagingUtils.messageDialog(title, source, message, t, true);
 446     }
 447
 448     /**
 449      * Displays an error {@link org.eclipse.jface.dialogs.MessageDialog}.
 450      *
 451      * @param title
 452      *            The dialogs title
 453      * @param source
 454      *            The object where the warning was generated (used by log4j)
 455      * @param message
 456      *            An informative String to be presented to the user
 457      * @param title
 458      *            The dialogs title
 459      * @param t
 460      *            a Throwable if one exists or null
 461      */
 462     public static void messageDialog(final String title,
 463             final Object source,
 464             final String message,
 465             final Throwable t,
 466             boolean async) {
 467         if(async) {
 468             Display.getDefault().asyncExec(new Runnable() {
 469
 470                 @Override
 471                 public void run() {
 472                     MessageDialog.openError(AbstractUtility.getShell(), title, message + getCauseRecursively(t));
 473                     Class<? extends Object> clazz = source != null ? source
 474                             .getClass() : this.getClass();
 475                             error(clazz, message, t);
 476                 }
 477
 478
 479             });
 480         } else {
 481             MessageDialog.openError(AbstractUtility.getShell(), title, message + getCauseRecursively(t));
 482             Class<? extends Object> clazz = source != null ? source.getClass() : TaxeditorStorePlugin.class;
 483             error(clazz, message, t);
 484         }
 485     }
 486
 487     public static String getCauseRecursively(Throwable t) {
 488         if(t == null){
 489             return "";
 490         }
 491
 492         if(t.getCause() != null){
 493             return getCauseRecursively(t.getCause());
 494         }else{
 495             return String.format("\n\nException: %s\nMessage: %s", t.getClass().getSimpleName(), t.getMessage());
 496         }
 497
 498     }
 499     /**
 500      * Displays a warning {@link org.eclipse.jface.dialogs.MessageDialog}.
 501      *
 502      * @param title
 503      * @param termBase
 504      * @param status
 505      */
 506     public static void warningDialog(String title, Object source,
 507             IStatus status) {
 508         MessagingUtils.warningDialog(title, source, status.getMessage());
 509     }
 510
 511     /**
 512      * Standard warning dialog for the case when the application is not yet connected to the datasource
 513      *
 514      * @param source
 515      */
 516     public static void noDataSourceWarningDialog(Object source) {
 517         MessagingUtils
 518         .warningDialog(
 519                 "Application is not connected to a datastore",
 520                 source,
 521                 "The requested operation is only available when "
 522                 + "connected to a datasource. You may choose a datasource to connect to or create a new one in the datasource view.");
 523     }
 524
 525     /**
 526      * Displays a warning {@link org.eclipse.jface.dialogs.MessageDialog}.
 527      *
 528      * @param title
 529      *            The dialogs title
 530      * @param source
 531      *            The object where the warning was generated (used by log4j)
 532      * @param message
 533      *            An informative String to be presented to the user
 534      */
 535     public static void warningDialog(final String title, final Object source, final String message) {
 536         Display.getDefault().asyncExec(new Runnable() {
 537
 538             @Override
 539             public void run() {
 540                 MessageDialog.openWarning(AbstractUtility.getShell(), title, message);
 541                 Class<? extends Object> clazz = source != null ? source
 542                         .getClass() : AbstractUtility.class;
 543                         warn(clazz, message);
 544             }
 545         });
 546     }
 547
 548     /**
 549      * Displays an information {@link org.eclipse.jface.dialogs.MessageDialog}.
 550      *
 551      * @param title
 552      * @param status
 553      */
 554     public static void informationDialog(final String title, final IStatus status) {
 555         MessagingUtils.informationDialog(title, status.getMessage());
 556     }
 557
 558     /**
 559      * Displays an information {@link org.eclipse.jface.dialogs.MessageDialog}.
 560      *
 561      * @param title
 562      *            a {@link java.lang.String} object.
 563      * @param message
 564      *            a {@link java.lang.String} object.
 565      */
 566     public static void informationDialog(final String title,
 567             final String message) {
 568         Display.getDefault().asyncExec(new Runnable() {
 569
 570             @Override
 571             public void run() {
 572                 MessageDialog.openInformation(AbstractUtility.getShell(), title, message);
 573             }
 574         });
 575     }
 576
 577     /**
 578      * Open a message box that informs the user about unimplemented
 579      * functionality. This method is for developer convenience.
 580      *
 581      * @param source
 582      *            a {@link java.lang.Object} object.
 583      */
 584     public static void notImplementedMessage(Object source) {
 585         warningDialog("Not yet implemented", source,
 586                 "This functionality is not yet implemented.");
 587     }
 588
 589 }