Add a new LaunchHandler to show error messages when starting applications

This LaunchHandler is only used when not running in headless mode. This
launchHandler is also responsible for showing the splash screen.

2011-03-30  Omair Majid  <[email protected]>

    * netx/net/sourceforge/jnlp/LaunchHandler.java
    (launchInitialized, launchStarting): New methods.
    * netx/net/sourceforge/jnlp/DefaultLaunchHandler.java
    (launchInitialized, launchStarting): New methods. No-op
    implementation.
    (printMessage): Make it static.
    * netx/net/sourceforge/jnlp/GuiLaunchHandler.java: New file.
    (launchCompleted, launchError, launchStarting, launchInitialized),
    (launchWarning, validationError): New methods.
    * netx/net/sourceforge/jnlp/Launcher.java (launchApplication):
    Invoke handler.launchInitialized and handler.launchStarting instead
    of showing a splash screen directly.
    * netx/net/sourceforge/jnlp/resources/Messages.properties: Add
    ButShowDetails, ButHideDetails and Error.
    * netx/net/sourceforge/jnlp/runtime/Boot.java (run): Do not exit on
    error.
    * netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java
    (initialize): Set handler to GuiLaunchHandler if not running in
    headless mode.
    * netx/net/sourceforge/jnlp/util/BasicExceptionDialog.java: New
    file.
    (exceptionToString, show): New methods.

8 files changed, 301 insertions, 24 deletions

diff --git a/netx/net/sourceforge/jnlp/DefaultLaunchHandler.java b/netx/net/sourceforge/jnlp/DefaultLaunchHandler.java
index 29faba4..d52681f 100644
--- a/netx/net/sourceforge/jnlp/DefaultLaunchHandler.java
+++ b/netx/net/sourceforge/jnlp/DefaultLaunchHandler.java
@@ -76,7 +76,7 @@ public class DefaultLaunchHandler implements LaunchHandler {
     /**
      * Print a message to stdout.
      */
-    protected void printMessage(LaunchException ex) {
+    protected static void printMessage(LaunchException ex) {
         StringBuffer result = new StringBuffer();
         result.append("netx: ");
         result.append(ex.getCategory());
@@ -103,4 +103,20 @@ public class DefaultLaunchHandler implements LaunchHandler {
         }
     }
 
+    /**
+     * Do nothing on when initializing
+     */
+    @Override
+    public void launchInitialized(JNLPFile file) {
+        // do nothing
+    }
+
+    /**
+     * Do nothing when starting
+     */
+    @Override
+    public void launchStarting(ApplicationInstance application) {
+        // do nothing
+    }
+
 }
diff --git a/netx/net/sourceforge/jnlp/GuiLaunchHandler.java b/netx/net/sourceforge/jnlp/GuiLaunchHandler.java
new file mode 100644
index 0000000..28a2013
--- /dev/null
+++ b/netx/net/sourceforge/jnlp/GuiLaunchHandler.java
@@ -0,0 +1,123 @@
+/* GuiLaunchHandler.java
+   Copyright (C) 2011 Red Hat, Inc.
+
+This file is part of IcedTea.
+
+IcedTea is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+IcedTea is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with IcedTea; see the file COPYING.  If not, write to the
+Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library.  Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module.  An independent module is a module which is not derived from
+or based on this library.  If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so.  If you do not wish to do so, delete this
+exception statement from your version. */
+
+package net.sourceforge.jnlp;
+
+import java.net.URL;
+
+import javax.swing.SwingUtilities;
+
+import net.sourceforge.jnlp.cache.ResourceTracker;
+import net.sourceforge.jnlp.cache.UpdatePolicy;
+import net.sourceforge.jnlp.runtime.ApplicationInstance;
+import net.sourceforge.jnlp.util.BasicExceptionDialog;
+
+/**
+ * A {@link LaunchHandler} that gives feedback to the user using GUI elements
+ * including splash screens and exception dialogs.
+ */
+public class GuiLaunchHandler implements LaunchHandler {
+
+    private JNLPSplashScreen splashScreen = null;
+    private UpdatePolicy policy = UpdatePolicy.ALWAYS;
+
+    @Override
+    public void launchCompleted(ApplicationInstance application) {
+        // do nothing
+    }
+
+    @Override
+    public void launchError(final LaunchException exception) {
+        SwingUtilities.invokeLater(new Runnable() {
+            @Override
+            public void run() {
+                BasicExceptionDialog.show(exception);
+            }
+        });
+    }
+
+    @Override
+    public void launchStarting(ApplicationInstance application) {
+        SwingUtilities.invokeLater(new Runnable() {
+            @Override
+            public void run() {
+                if (splashScreen != null) {
+                    if (splashScreen.isSplashScreenValid()) {
+                        splashScreen.setVisible(false);
+                    }
+                    splashScreen.dispose();
+                }
+            }
+        });
+    }
+
+    @Override
+    public void launchInitialized(final JNLPFile file) {
+        SwingUtilities.invokeLater(new Runnable() {
+            @Override
+            public void run() {
+                final int preferredWidth = 500;
+                final int preferredHeight = 400;
+
+                URL splashImageURL = file.getInformation().getIconLocation(
+                        IconDesc.SPLASH, preferredWidth, preferredHeight);
+                if (splashImageURL != null) {
+                    ResourceTracker resourceTracker = new ResourceTracker(true);
+                    resourceTracker.addResource(splashImageURL, file.getFileVersion(), null, policy);
+                    splashScreen = new JNLPSplashScreen(resourceTracker, null, null);
+                    splashScreen.setSplashImageURL(splashImageURL);
+                    if (splashScreen.isSplashScreenValid()) {
+                        splashScreen.setVisible(true);
+                    }
+                }
+            }
+        });
+    }
+
+    @Override
+    public boolean launchWarning(LaunchException warning) {
+        DefaultLaunchHandler.printMessage(warning);
+        return true;
+    }
+
+    @Override
+    public boolean validationError(LaunchException security) {
+        DefaultLaunchHandler.printMessage(security);
+        return true;
+    }
+
+}
diff --git a/netx/net/sourceforge/jnlp/LaunchHandler.java b/netx/net/sourceforge/jnlp/LaunchHandler.java
index a0b106b..f12dcf6 100644
--- a/netx/net/sourceforge/jnlp/LaunchHandler.java
+++ b/netx/net/sourceforge/jnlp/LaunchHandler.java
@@ -56,6 +56,24 @@ public interface LaunchHandler {
     // controller is in place.
 
     /**
+     * Called when an application, applet or installer has been determined.
+     * We have some very basic information about the application at this point,
+     * but do not have everything required. This is a nice point to show the
+     * splash screen.
+     *
+     * @param application the application instance that is starting
+     */
+    public void launchInitialized(JNLPFile file);
+
+    /**
+     * Called when an application, applet or installer is ready to start.
+     * Good point to hide the splash screen.
+     *
+     * @param application the application instance that is ready
+     */
+    public void launchStarting(ApplicationInstance application);
+
+    /**
      * Called when an application, applet, or installer has been
      * launched successfully (the main method or applet start method
      * returned normally).
diff --git a/netx/net/sourceforge/jnlp/Launcher.java b/netx/net/sourceforge/jnlp/Launcher.java
index 531e282..ea0afc4 100644
--- a/netx/net/sourceforge/jnlp/Launcher.java
+++ b/netx/net/sourceforge/jnlp/Launcher.java
@@ -396,20 +396,7 @@ public class Launcher {
                 return null;
             }
 
-            final int preferredWidth = 500;
-            final int preferredHeight = 400;
-            JNLPSplashScreen splashScreen = null;
-            URL splashImageURL = file.getInformation().getIconLocation(
-                    IconDesc.SPLASH, preferredWidth, preferredHeight);
-            if (splashImageURL != null) {
-                ResourceTracker resourceTracker = new ResourceTracker(true);
-                resourceTracker.addResource(splashImageURL, file.getFileVersion(), null, updatePolicy);
-                splashScreen = new JNLPSplashScreen(resourceTracker, null, null);
-                splashScreen.setSplashImageURL(splashImageURL);
-                if (splashScreen.isSplashScreenValid()) {
-                    splashScreen.setVisible(true);
-                }
-            }
+            handler.launchInitialized(file);
 
             ApplicationInstance app = createApplication(file);
             app.initialize();
@@ -446,12 +433,7 @@ public class Launcher {
 
             setContextClassLoaderForAllThreads(app.getThreadGroup(), app.getClassLoader());
 
-            if (splashScreen != null) {
-                if (splashScreen.isSplashScreenValid()) {
-                    splashScreen.setVisible(false);
-                }
-                splashScreen.dispose();
-            }
+            handler.launchStarting(app);
 
             main.setAccessible(true);
             main.invoke(null, new Object[] { args });
diff --git a/netx/net/sourceforge/jnlp/resources/Messages.properties b/netx/net/sourceforge/jnlp/resources/Messages.properties
index 1f95723..64325fb 100644
--- a/netx/net/sourceforge/jnlp/resources/Messages.properties
+++ b/netx/net/sourceforge/jnlp/resources/Messages.properties
@@ -14,9 +14,13 @@ ButProceed=Proceed
 ButRun=Run

 ButApply=Apply

 ButDone=Done

+ButShowDetails=Show Details

+ButHideDetails=Hide Details

+

 AFileOnTheMachine=a file on the machine

 AlwaysAllowAction=Always allow this action

 Usage=Usage:

+Error=Error

 

 Continue=Do you want to continue?

 Field=Field

diff --git a/netx/net/sourceforge/jnlp/runtime/Boot.java b/netx/net/sourceforge/jnlp/runtime/Boot.java
index 1db5296..e86644c 100644
--- a/netx/net/sourceforge/jnlp/runtime/Boot.java
+++ b/netx/net/sourceforge/jnlp/runtime/Boot.java
@@ -190,7 +190,7 @@ public final class Boot implements PrivilegedAction<Void> {
         }
 
         try {
-            new Launcher().launch(getFile());
+            new Launcher(false).launch(getFile());
         } catch (LaunchException ex) {
             // default handler prints this
         } catch (Exception ex) {
diff --git a/netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java b/netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java
index f48d3ad..75b9ec5 100644
--- a/netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java
+++ b/netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java
@@ -187,8 +187,13 @@ public class JNLPRuntime {
         if (!headless && indicator == null)
             indicator = new DefaultDownloadIndicator();
 
-        if (handler == null)
-            handler = new DefaultLaunchHandler();
+        if (handler == null) {
+            if (headless) {
+                handler = new DefaultLaunchHandler();
+            } else {
+                handler = new GuiLaunchHandler();
+            }
+        }
 
         ServiceManager.setServiceManagerStub(new XServiceManagerStub()); // ignored if we're running under Web Start
 
diff --git a/netx/net/sourceforge/jnlp/util/BasicExceptionDialog.java b/netx/net/sourceforge/jnlp/util/BasicExceptionDialog.java
new file mode 100644
index 0000000..bf3d250
--- /dev/null
+++ b/netx/net/sourceforge/jnlp/util/BasicExceptionDialog.java
@@ -0,0 +1,129 @@
+/* BasicExceptionDialog.java
+   Copyright (C) 2011 Red Hat, Inc.
+
+This file is part of IcedTea.
+
+IcedTea is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+IcedTea is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with IcedTea; see the file COPYING.  If not, write to the
+Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library.  Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module.  An independent module is a module which is not derived from
+or based on this library.  If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so.  If you do not wish to do so, delete this
+exception statement from your version. */
+
+package net.sourceforge.jnlp.util;
+
+import static net.sourceforge.jnlp.runtime.Translator.R;
+
+import java.awt.BorderLayout;
+import java.awt.Dimension;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.io.PrintWriter;
+import java.io.StringWriter;
+
+import javax.swing.BorderFactory;
+import javax.swing.BoxLayout;
+import javax.swing.JButton;
+import javax.swing.JComponent;
+import javax.swing.JDialog;
+import javax.swing.JLabel;
+import javax.swing.JOptionPane;
+import javax.swing.JPanel;
+import javax.swing.JScrollPane;
+import javax.swing.JTextArea;
+
+/**
+ * A dialog that displays some basic information about an exception
+ */
+public class BasicExceptionDialog {
+
+    private static String exceptionToString(Exception exception) {
+        StringWriter stringWriter = new StringWriter();
+        PrintWriter printWriter = new PrintWriter(stringWriter);
+        exception.printStackTrace(printWriter);
+        return stringWriter.toString();
+    }
+
+    /**
+     * Must be invoked from the Swing EDT.
+     *
+     * @param exception the exception to indicate
+     */
+    public static void show(Exception exception) {
+        String detailsText = exceptionToString(exception);
+
+        final JPanel mainPanel = new JPanel(new BorderLayout());
+        mainPanel.setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
+
+        JOptionPane optionPane = new JOptionPane(mainPanel, JOptionPane.ERROR_MESSAGE);
+        final JDialog errorDialog = optionPane.createDialog(R("Error"));
+
+        final JPanel quickInfoPanel = new JPanel();
+        BoxLayout layout = new BoxLayout(quickInfoPanel, BoxLayout.Y_AXIS);
+        quickInfoPanel.setLayout(layout);
+        mainPanel.add(quickInfoPanel, BorderLayout.PAGE_START);
+
+        JLabel errorLabel = new JLabel(exception.getMessage());
+        errorLabel.setAlignmentY(JComponent.LEFT_ALIGNMENT);
+        quickInfoPanel.add(errorLabel);
+
+        final JButton viewDetails = new JButton(R("ButShowDetails"));
+        viewDetails.setAlignmentY(JComponent.LEFT_ALIGNMENT);
+        viewDetails.setActionCommand("show");
+        quickInfoPanel.add(viewDetails);
+
+        JTextArea textArea = new JTextArea();
+        textArea.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
+        textArea.setEditable(false);
+        textArea.setText(detailsText);
+        final JScrollPane scrollPane = new JScrollPane(textArea);
+        scrollPane.setPreferredSize(new Dimension(100, 200));
+
+        viewDetails.addActionListener(new ActionListener() {
+            @Override
+            public void actionPerformed(ActionEvent e) {
+                if (viewDetails.getActionCommand().equals("show")) {
+                    mainPanel.add(scrollPane, BorderLayout.CENTER);
+                    viewDetails.setActionCommand("hide");
+                    viewDetails.setText(R("ButHideDetails"));
+                    errorDialog.pack();
+                } else {
+                    mainPanel.remove(scrollPane);
+                    viewDetails.setActionCommand("show");
+                    viewDetails.setText(R("ButShowDetails"));
+                    errorDialog.pack();
+                }
+            }
+        });
+
+        errorDialog.pack();
+        errorDialog.setResizable(true);
+        errorDialog.setVisible(true);
+        errorDialog.dispose();
+    }
+}