JAL-3949 Complete new abstracted logging framework in jalview.log. Updated log calls...
[jalview.git] / src / jalview / util / BrowserLauncher.java
index 6f89f68..dbd9177 100755 (executable)
@@ -1,24 +1,33 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview 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 3 of the License, or (at your option) any later version.
- * 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
  * Jalview 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 Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.util;
 
-import java.io.*;
-import java.lang.reflect.*;
+import jalview.bin.Cache;
+
+import java.io.File;
+import java.io.IOException;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.Field;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
 
 /**
  * BrowserLauncher is a class that provides one static method, openURL, which
@@ -62,14 +71,14 @@ import java.lang.reflect.*;
  * functionality or any adverse or unexpected effects of using this software.
  * <p>
  * Credits: <br>
- * Steven Spencer, JavaWorld magazine (<a
- * href="http://www.javaworld.com/javaworld/javatips/jw-javatip66.html">Java Tip
- * 66</a>) <br>
+ * Steven Spencer, JavaWorld magazine
+ * (<a href="http://www.javaworld.com/javaworld/javatips/jw-javatip66.html">Java
+ * Tip 66</a>) <br>
  * Thanks also to Ron B. Yeh, Eric Shapiro, Ben Engber, Paul Teitlebaum, Andrea
  * Cantatore, Larry Barowski, Trevor Bedzek, Frank Miedrich, and Ron Rabakukk
  * 
- * @author Eric Albert (<a
- *         href="mailto:ejalbert@cs.stanford.edu">ejalbert@cs.stanford.edu</a>)
+ * @author Eric Albert (<a href=
+ *         "mailto:ejalbert@cs.stanford.edu">ejalbert@cs.stanford.edu</a>)
  * @version 1.4b1 (Released June 20, 2001)
  */
 public class BrowserLauncher
@@ -226,8 +235,17 @@ public class BrowserLauncher
    */
   static
   {
+
     loadedWithoutErrors = true;
 
+    if (!Platform.isJS())
+    /**
+     * Java only
+     * 
+     * @j2sIgnore
+     * 
+     */
+    {
     String osName = System.getProperty("os.name");
 
     if (osName.startsWith("Mac OS"))
@@ -300,6 +318,7 @@ public class BrowserLauncher
     { // if we haven't hit any errors yet
       loadedWithoutErrors = loadClasses();
     }
+    }
   }
 
   /**
@@ -318,6 +337,15 @@ public class BrowserLauncher
    */
   private static boolean loadClasses()
   {
+
+    if (!Platform.isJS())
+    /**
+     * Java only
+     * 
+     * @j2sIgnore
+     * 
+     */
+    {
     switch (jvm)
     {
     case MRJ_2_0:
@@ -335,9 +363,11 @@ public class BrowserLauncher
                 { int.class });
         appleEventConstructor = appleEventClass
                 .getDeclaredConstructor(new Class[]
-                { int.class, int.class, aeTargetClass, int.class, int.class });
-        aeDescConstructor = aeDescClass.getDeclaredConstructor(new Class[]
-        { String.class });
+                { int.class, int.class, aeTargetClass, int.class,
+                    int.class });
+        aeDescConstructor = aeDescClass
+                .getDeclaredConstructor(new Class[]
+                { String.class });
 
         makeOSType = osUtilsClass.getDeclaredMethod("makeOSType",
                 new Class[]
@@ -346,8 +376,7 @@ public class BrowserLauncher
                 new Class[]
                 { int.class, aeDescClass });
         sendNoReply = appleEventClass.getDeclaredMethod("sendNoReply",
-                new Class[]
-                {});
+                new Class[] {});
 
         Field keyDirectObjectField = aeClass
                 .getDeclaredField("keyDirectObject");
@@ -398,8 +427,8 @@ public class BrowserLauncher
         findFolder = mrjFileUtilsClass.getDeclaredMethod("findFolder",
                 new Class[]
                 { mrjOSTypeClass });
-        getFileCreator = mrjFileUtilsClass.getDeclaredMethod(
-                "getFileCreator", new Class[]
+        getFileCreator = mrjFileUtilsClass
+                .getDeclaredMethod("getFileCreator", new Class[]
                 { File.class });
         getFileType = mrjFileUtilsClass.getDeclaredMethod("getFileType",
                 new Class[]
@@ -438,10 +467,12 @@ public class BrowserLauncher
       try
       {
         Class linker = Class.forName("com.apple.mrj.jdirect.Linker");
-        Constructor constructor = linker.getConstructor(new Class[]
-        { Class.class });
-        linkage = constructor.newInstance(new Object[]
-        { BrowserLauncher.class });
+        Constructor constructor = linker
+                .getConstructor(new Class[]
+                { Class.class });
+        linkage = constructor
+                .newInstance(new Object[]
+                { BrowserLauncher.class });
       } catch (ClassNotFoundException cnfe)
       {
         errorMessage = cnfe.getMessage();
@@ -497,6 +528,7 @@ public class BrowserLauncher
       break;
     }
 
+    }
     return true;
   }
 
@@ -513,6 +545,14 @@ public class BrowserLauncher
    */
   private static Object locateBrowser()
   {
+    if (!Platform.isJS())
+    /**
+     * Java only
+     * 
+     * @j2sIgnore
+     * 
+     */
+    {
     if (browser != null)
     {
       return browser;
@@ -527,13 +567,16 @@ public class BrowserLauncher
         Integer finderCreatorCode = (Integer) makeOSType.invoke(null,
                 new Object[]
                 { FINDER_CREATOR });
-        Object aeTarget = aeTargetConstructor.newInstance(new Object[]
-        { finderCreatorCode });
-        Integer gurlType = (Integer) makeOSType.invoke(null, new Object[]
-        { GURL_EVENT });
-        Object appleEvent = appleEventConstructor.newInstance(new Object[]
-        { gurlType, gurlType, aeTarget, kAutoGenerateReturnID,
-            kAnyTransactionID });
+        Object aeTarget = aeTargetConstructor
+                .newInstance(new Object[]
+                { finderCreatorCode });
+        Integer gurlType = (Integer) makeOSType.invoke(null,
+                new Object[]
+                { GURL_EVENT });
+        Object appleEvent = appleEventConstructor
+                .newInstance(new Object[]
+                { gurlType, gurlType, aeTarget, kAutoGenerateReturnID,
+                    kAnyTransactionID });
 
         // Don't set browser = appleEvent because then the next time we call
         // locateBrowser(), we'll get the same AppleEvent, to which we'll
@@ -570,8 +613,9 @@ public class BrowserLauncher
 
       try
       {
-        systemFolder = (File) findFolder.invoke(null, new Object[]
-        { kSystemFolderType });
+        systemFolder = (File) findFolder.invoke(null,
+                new Object[]
+                { kSystemFolderType });
       } catch (IllegalArgumentException iare)
       {
         browser = null;
@@ -612,13 +656,13 @@ public class BrowserLauncher
           // applications being picked up on certain Mac OS 9 systems,
           // especially German ones, and sending a GURL event to those
           // applications results in a logout under Multiple Users.
-          Object fileType = getFileType.invoke(null, new Object[]
-          { file });
+          Object fileType = getFileType.invoke(null, new Object[] { file });
 
           if (FINDER_TYPE.equals(fileType.toString()))
           {
-            Object fileCreator = getFileCreator.invoke(null, new Object[]
-            { file });
+            Object fileCreator = getFileCreator.invoke(null,
+                    new Object[]
+                    { file });
 
             if (FINDER_CREATOR.equals(fileCreator.toString()))
             {
@@ -670,12 +714,15 @@ public class BrowserLauncher
 
     case OTHER:
     default:
-      browser = jalview.bin.Cache.getDefault("DEFAULT_BROWSER", "firefox");
+      browser = Cache.getDefault("DEFAULT_BROWSER", "firefox");
 
       break;
     }
 
+    }
+
     return browser;
+
   }
 
   /**
@@ -697,16 +744,34 @@ public class BrowserLauncher
    */
   public static void openURL(String url) throws IOException
   {
+
+    if (Platform.isJS())
+    {
+      Platform.openURL(url);
+      return;
+    }
+    else
+    /**
+     * Java only
+     * 
+     * @j2sIgnore
+     */
+    {
+
     if (!loadedWithoutErrors)
     {
-      throw new IOException("Exception in finding browser: " + errorMessage);
+      throw new IOException(MessageManager
+              .formatMessage("exception.browser_not_found", new String[]
+              { errorMessage }));
     }
 
     Object browser = locateBrowser();
 
     if (browser == null)
     {
-      throw new IOException("Unable to locate browser: " + errorMessage);
+      throw new IOException(MessageManager.formatMessage(
+              "exception.browser_unable_to_locate", new String[]
+              { errorMessage }));
     }
 
     switch (jvm)
@@ -717,27 +782,27 @@ public class BrowserLauncher
 
       try
       {
-        aeDesc = aeDescConstructor.newInstance(new Object[]
-        { url });
-        putParameter.invoke(browser, new Object[]
-        { keyDirectObject, aeDesc });
-        sendNoReply.invoke(browser, new Object[]
-        {});
+        aeDesc = aeDescConstructor.newInstance(new Object[] { url });
+        putParameter.invoke(browser,
+                new Object[]
+                { keyDirectObject, aeDesc });
+        sendNoReply.invoke(browser, new Object[] {});
       } catch (InvocationTargetException ite)
       {
-        throw new IOException(
-                "InvocationTargetException while creating AEDesc: "
-                        + ite.getMessage());
+        throw new IOException(MessageManager.formatMessage(
+                "exception.invocation_target_exception_creating_aedesc",
+                new String[]
+                { ite.getMessage() }));
       } catch (IllegalAccessException iae)
       {
-        throw new IOException(
-                "IllegalAccessException while building AppleEvent: "
-                        + iae.getMessage());
+        throw new IOException(MessageManager.formatMessage(
+                "exception.illegal_access_building_apple_evt", new String[]
+                { iae.getMessage() }));
       } catch (InstantiationException ie)
       {
-        throw new IOException(
-                "InstantiationException while creating AEDesc: "
-                        + ie.getMessage());
+        throw new IOException(MessageManager.formatMessage(
+                "exception.illegal_access_building_apple_evt", new String[]
+                { ie.getMessage() }));
       } finally
       {
         aeDesc = null; // Encourage it to get disposed if it was created
@@ -747,8 +812,7 @@ public class BrowserLauncher
       break;
 
     case MRJ_2_1:
-      Runtime.getRuntime().exec(new String[]
-      { (String) browser, url });
+      Runtime.getRuntime().exec(new String[] { (String) browser, url });
 
       break;
 
@@ -759,13 +823,11 @@ public class BrowserLauncher
 
       if (result == 0)
       {
-        int[] selectionStart = new int[]
-        { 0 };
+        int[] selectionStart = new int[] { 0 };
         byte[] urlBytes = url.getBytes();
-        int[] selectionEnd = new int[]
-        { urlBytes.length };
-        result = ICLaunchURL(instance[0], new byte[]
-        { 0 }, urlBytes, urlBytes.length, selectionStart, selectionEnd);
+        int[] selectionEnd = new int[] { urlBytes.length };
+        result = ICLaunchURL(instance[0], new byte[] { 0 }, urlBytes,
+                urlBytes.length, selectionStart, selectionEnd);
 
         if (result == 0)
         {
@@ -775,13 +837,16 @@ public class BrowserLauncher
         }
         else
         {
-          throw new IOException("Unable to launch URL: " + result);
+          throw new IOException(MessageManager.formatMessage(
+                  "exception.unable_to_launch_url", new String[]
+                  { Integer.valueOf(result).toString() }));
         }
       }
       else
       {
-        throw new IOException(
-                "Unable to create an Internet Config instance: " + result);
+        throw new IOException(MessageManager.formatMessage(
+                "exception.unable_to_create_internet_config", new String[]
+                { Integer.valueOf(result).toString() }));
       }
 
       break;
@@ -790,18 +855,17 @@ public class BrowserLauncher
 
       try
       {
-        openURL.invoke(null, new Object[]
-        { url });
+        openURL.invoke(null, new Object[] { url });
       } catch (InvocationTargetException ite)
       {
-        throw new IOException(
-                "InvocationTargetException while calling openURL: "
-                        + ite.getMessage());
+        throw new IOException(MessageManager.formatMessage(
+                "exception.invocation_target_calling_url", new String[]
+                { ite.getMessage() }));
       } catch (IllegalAccessException iae)
       {
-        throw new IOException(
-                "IllegalAccessException while calling openURL: "
-                        + iae.getMessage());
+        throw new IOException(MessageManager.formatMessage(
+                "exception.illegal_access_calling_url", new String[]
+                { iae.getMessage() }));
       }
 
       break;
@@ -811,8 +875,8 @@ public class BrowserLauncher
 
       // Add quotes around the URL to allow ampersands and other special
       // characters to work.
-      Process process = Runtime.getRuntime().exec(
-              new String[]
+      Process process = Runtime.getRuntime()
+              .exec(new String[]
               { (String) browser, FIRST_WINDOWS_PARAMETER,
                   SECOND_WINDOWS_PARAMETER, THIRD_WINDOWS_PARAMETER,
                   '"' + url + '"' });
@@ -826,9 +890,9 @@ public class BrowserLauncher
         process.exitValue();
       } catch (InterruptedException ie)
       {
-        throw new IOException(
-                "InterruptedException while launching browser: "
-                        + ie.getMessage());
+        throw new IOException(MessageManager.formatMessage(
+                "exception.interrupted_launching_browser", new String[]
+                { ie.getMessage() }));
       }
 
       break;
@@ -846,11 +910,9 @@ public class BrowserLauncher
        * NETSCAPE_REMOTE_PARAMETER+" "+ NETSCAPE_OPEN_PARAMETER_START + url +
        * NETSCAPE_OPEN_NEW_WINDOW + NETSCAPE_OPEN_PARAMETER_END);
        */
-      process = Runtime.getRuntime().exec(
-              new String[]
-              {
-                  (String) browser,
-                  NETSCAPE_REMOTE_PARAMETER,
+      process = Runtime.getRuntime()
+              .exec(new String[]
+              { (String) browser, NETSCAPE_REMOTE_PARAMETER,
 
                   NETSCAPE_OPEN_PARAMETER_START + url
                           + NETSCAPE_OPEN_NEW_WINDOW
@@ -862,14 +924,13 @@ public class BrowserLauncher
 
         if (exitCode != 0)
         { // if Netscape was not open
-          Runtime.getRuntime().exec(new String[]
-          { (String) browser, url });
+          Runtime.getRuntime().exec(new String[] { (String) browser, url });
         }
       } catch (InterruptedException ie)
       {
-        throw new IOException(
-                "InterruptedException while launching browser: "
-                        + ie.getMessage());
+        throw new IOException(MessageManager.formatMessage(
+                "exception.interrupted_launching_browser", new String[]
+                { ie.getMessage() }));
       }
 
       break;
@@ -878,13 +939,14 @@ public class BrowserLauncher
 
       // This should never occur, but if it does, we'll try the simplest thing
       // possible
-      Runtime.getRuntime().exec(new String[]
-      { (String) browser, url });
+      Runtime.getRuntime().exec(new String[] { (String) browser, url });
 
       break;
     }
+    }
   }
 
+
   /**
    * Methods required for Mac OS X. The presence of native methods does not
    * cause any problems on other platforms.