Merge branch 'develop' into features/JAL-1793VCF
[jalview.git] / src / jalview / util / BrowserLauncher.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.util;
22
23 import java.io.File;
24 import java.io.IOException;
25 import java.lang.reflect.Constructor;
26 import java.lang.reflect.Field;
27 import java.lang.reflect.InvocationTargetException;
28 import java.lang.reflect.Method;
29
30 /**
31  * BrowserLauncher is a class that provides one static method, openURL, which
32  * opens the default web browser for the current user of the system to the given
33  * URL. It may support other protocols depending on the system -- mailto, ftp,
34  * etc. -- but that has not been rigorously tested and is not guaranteed to
35  * work.
36  * <p>
37  * Yes, this is platform-specific code, and yes, it may rely on classes on
38  * certain platforms that are not part of the standard JDK. What we're trying to
39  * do, though, is to take something that's frequently desirable but inherently
40  * platform-specific -- opening a default browser -- and allow programmers (you,
41  * for example) to do so without worrying about dropping into native code or
42  * doing anything else similarly evil.
43  * <p>
44  * Anyway, this code is completely in Java and will run on all JDK 1.1-compliant
45  * systems without modification or a need for additional libraries. All classes
46  * that are required on certain platforms to allow this to run are dynamically
47  * loaded at runtime via reflection and, if not found, will not cause this to do
48  * anything other than returning an error when opening the browser.
49  * <p>
50  * There are certain system requirements for this class, as it's running through
51  * Runtime.exec(), which is Java's way of making a native system call.
52  * Currently, this requires that a Macintosh have a Finder which supports the
53  * GURL event, which is true for Mac OS 8.0 and 8.1 systems that have the
54  * Internet Scripting AppleScript dictionary installed in the Scripting
55  * Additions folder in the Extensions folder (which is installed by default as
56  * far as I know under Mac OS 8.0 and 8.1), and for all Mac OS 8.5 and later
57  * systems. On Windows, it only runs under Win32 systems (Windows 95, 98, and NT
58  * 4.0, as well as later versions of all). On other systems, this drops back
59  * from the inherently platform-sensitive concept of a default browser and
60  * simply attempts to launch Netscape via a shell command.
61  * <p>
62  * This code is Copyright 1999-2001 by Eric Albert (ejalbert\@cs.stanford.edu)
63  * and may be redistributed or modified in any form without restrictions as long
64  * as the portion of this comment from this paragraph through the end of the
65  * comment is not removed. The author requests that he be notified of any
66  * application, applet, or other binary that makes use of this code, but that's
67  * more out of curiosity than anything and is not required. This software
68  * includes no warranty. The author is not repsonsible for any loss of data or
69  * functionality or any adverse or unexpected effects of using this software.
70  * <p>
71  * Credits: <br>
72  * Steven Spencer, JavaWorld magazine
73  * (<a href="http://www.javaworld.com/javaworld/javatips/jw-javatip66.html">Java
74  * Tip 66</a>) <br>
75  * Thanks also to Ron B. Yeh, Eric Shapiro, Ben Engber, Paul Teitlebaum, Andrea
76  * Cantatore, Larry Barowski, Trevor Bedzek, Frank Miedrich, and Ron Rabakukk
77  * 
78  * @author Eric Albert (<a href=
79  *         "mailto:ejalbert@cs.stanford.edu">ejalbert@cs.stanford.edu</a>)
80  * @version 1.4b1 (Released June 20, 2001)
81  */
82 public class BrowserLauncher
83 {
84   /**
85    * The Java virtual machine that we are running on. Actually, in most cases we
86    * only care about the operating system, but some operating systems require us
87    * to switch on the VM.
88    */
89   private static int jvm;
90
91   /** The browser for the system */
92   private static Object browser;
93
94   /**
95    * Caches whether any classes, methods, and fields that are not part of the
96    * JDK and need to be dynamically loaded at runtime loaded successfully.
97    * <p>
98    * Note that if this is <code>false</code>, <code>openURL()</code> will always
99    * return an IOException.
100    */
101   private static boolean loadedWithoutErrors;
102
103   /** The com.apple.mrj.MRJFileUtils class */
104   private static Class mrjFileUtilsClass;
105
106   /** The com.apple.mrj.MRJOSType class */
107   private static Class mrjOSTypeClass;
108
109   /** The com.apple.MacOS.AEDesc class */
110   private static Class aeDescClass;
111
112   /** The &lt;init&gt;(int) method of com.apple.MacOS.AETarget */
113   private static Constructor aeTargetConstructor;
114
115   /** The &lt;init&gt;(int, int, int) method of com.apple.MacOS.AppleEvent */
116   private static Constructor appleEventConstructor;
117
118   /** The &lt;init&gt;(String) method of com.apple.MacOS.AEDesc */
119   private static Constructor aeDescConstructor;
120
121   /** The findFolder method of com.apple.mrj.MRJFileUtils */
122   private static Method findFolder;
123
124   /** The getFileCreator method of com.apple.mrj.MRJFileUtils */
125   private static Method getFileCreator;
126
127   /** The getFileType method of com.apple.mrj.MRJFileUtils */
128   private static Method getFileType;
129
130   /** The openURL method of com.apple.mrj.MRJFileUtils */
131   private static Method openURL;
132
133   /** The makeOSType method of com.apple.MacOS.OSUtils */
134   private static Method makeOSType;
135
136   /** The putParameter method of com.apple.MacOS.AppleEvent */
137   private static Method putParameter;
138
139   /** The sendNoReply method of com.apple.MacOS.AppleEvent */
140   private static Method sendNoReply;
141
142   /** Actually an MRJOSType pointing to the System Folder on a Macintosh */
143   private static Object kSystemFolderType;
144
145   /** The keyDirectObject AppleEvent parameter type */
146   private static Integer keyDirectObject;
147
148   /** The kAutoGenerateReturnID AppleEvent code */
149   private static Integer kAutoGenerateReturnID;
150
151   /** The kAnyTransactionID AppleEvent code */
152   private static Integer kAnyTransactionID;
153
154   /** The linkage object required for JDirect 3 on Mac OS X. */
155   private static Object linkage;
156
157   /** The framework to reference on Mac OS X */
158   private static final String JDirect_MacOSX = "/System/Library/Frameworks/Carbon.framework/Frameworks/HIToolbox.framework/HIToolbox";
159
160   /** JVM constant for MRJ 2.0 */
161   private static final int MRJ_2_0 = 0;
162
163   /** JVM constant for MRJ 2.1 or later */
164   private static final int MRJ_2_1 = 1;
165
166   /** JVM constant for Java on Mac OS X 10.0 (MRJ 3.0) */
167   private static final int MRJ_3_0 = 3;
168
169   /** JVM constant for MRJ 3.1 */
170   private static final int MRJ_3_1 = 4;
171
172   /** JVM constant for any Windows NT JVM */
173   private static final int WINDOWS_NT = 5;
174
175   /** JVM constant for any Windows 9x JVM */
176   private static final int WINDOWS_9x = 6;
177
178   /** JVM constant for any other platform */
179   private static final int OTHER = -1;
180
181   /**
182    * The file type of the Finder on a Macintosh. Hardcoding "Finder" would keep
183    * non-U.S. English systems from working properly.
184    */
185   private static final String FINDER_TYPE = "FNDR";
186
187   /**
188    * The creator code of the Finder on a Macintosh, which is needed to send
189    * AppleEvents to the application.
190    */
191   private static final String FINDER_CREATOR = "MACS";
192
193   /** The name for the AppleEvent type corresponding to a GetURL event. */
194   private static final String GURL_EVENT = "GURL";
195
196   /**
197    * The first parameter that needs to be passed into Runtime.exec() to open the
198    * default web browser on Windows.
199    */
200   private static final String FIRST_WINDOWS_PARAMETER = "/c";
201
202   /** The second parameter for Runtime.exec() on Windows. */
203   private static final String SECOND_WINDOWS_PARAMETER = "start";
204
205   /**
206    * The third parameter for Runtime.exec() on Windows. This is a "title"
207    * parameter that the command line expects. Setting this parameter allows URLs
208    * containing spaces to work.
209    */
210   private static final String THIRD_WINDOWS_PARAMETER = "\"\"";
211
212   /**
213    * The shell parameters for Netscape that opens a given URL in an already-open
214    * copy of Netscape on many command-line systems.
215    */
216   private static final String NETSCAPE_REMOTE_PARAMETER = "-remote";
217
218   private static final String NETSCAPE_OPEN_PARAMETER_START = "openURL(";
219
220   private static final String NETSCAPE_OPEN_NEW_WINDOW = ", new-window";
221
222   private static final String NETSCAPE_OPEN_PARAMETER_END = ")";
223
224   /**
225    * The message from any exception thrown throughout the initialization
226    * process.
227    */
228   private static String errorMessage;
229
230   /**
231    * An initialization block that determines the operating system and loads the
232    * necessary runtime data.
233    */
234   static
235   {
236     loadedWithoutErrors = true;
237
238     String osName = System.getProperty("os.name");
239
240     if (osName.startsWith("Mac OS"))
241     {
242       String mrjVersion = System.getProperty("mrj.version");
243       String majorMRJVersion;
244       if (mrjVersion == null)
245       {
246         // must be on some later build with mrj support
247         majorMRJVersion = "3.1";
248       }
249       else
250       {
251         majorMRJVersion = mrjVersion.substring(0, 3);
252       }
253
254       try
255       {
256         double version = Double.valueOf(majorMRJVersion).doubleValue();
257
258         if (version == 2)
259         {
260           jvm = MRJ_2_0;
261         }
262         else if ((version >= 2.1) && (version < 3))
263         {
264           // Assume that all 2.x versions of MRJ work the same. MRJ 2.1 actually
265           // works via Runtime.exec() and 2.2 supports that but has an openURL()
266           // method
267           // as well that we currently ignore.
268           jvm = MRJ_2_1;
269         }
270         else if (version == 3.0)
271         {
272           jvm = MRJ_3_0;
273         }
274         else if (version >= 3.1)
275         {
276           // Assume that all 3.1 and later versions of MRJ work the same.
277           jvm = MRJ_3_1;
278         }
279         else
280         {
281           loadedWithoutErrors = false;
282           errorMessage = "Unsupported MRJ version: " + version;
283         }
284       } catch (NumberFormatException nfe)
285       {
286         loadedWithoutErrors = false;
287         errorMessage = "Invalid MRJ version: " + mrjVersion;
288       }
289     }
290     else if (osName.startsWith("Windows"))
291     {
292       if (osName.indexOf("9") != -1)
293       {
294         jvm = WINDOWS_9x;
295       }
296       else
297       {
298         jvm = WINDOWS_NT;
299       }
300     }
301     else
302     {
303       jvm = OTHER;
304     }
305
306     if (loadedWithoutErrors)
307     { // if we haven't hit any errors yet
308       loadedWithoutErrors = loadClasses();
309     }
310   }
311
312   /**
313    * This class should be never be instantiated; this just ensures so.
314    */
315   private BrowserLauncher()
316   {
317   }
318
319   /**
320    * Called by a static initializer to load any classes, fields, and methods
321    * required at runtime to locate the user's web browser.
322    * 
323    * @return <code>true</code> if all intialization succeeded <code>false</code>
324    *         if any portion of the initialization failed
325    */
326   private static boolean loadClasses()
327   {
328     switch (jvm)
329     {
330     case MRJ_2_0:
331
332       try
333       {
334         Class aeTargetClass = Class.forName("com.apple.MacOS.AETarget");
335         Class osUtilsClass = Class.forName("com.apple.MacOS.OSUtils");
336         Class appleEventClass = Class.forName("com.apple.MacOS.AppleEvent");
337         Class aeClass = Class.forName("com.apple.MacOS.ae");
338         aeDescClass = Class.forName("com.apple.MacOS.AEDesc");
339
340         aeTargetConstructor = aeTargetClass
341                 .getDeclaredConstructor(new Class[]
342                 { int.class });
343         appleEventConstructor = appleEventClass
344                 .getDeclaredConstructor(new Class[]
345                 { int.class, int.class, aeTargetClass, int.class,
346                     int.class });
347         aeDescConstructor = aeDescClass
348                 .getDeclaredConstructor(new Class[]
349                 { String.class });
350
351         makeOSType = osUtilsClass.getDeclaredMethod("makeOSType",
352                 new Class[]
353                 { String.class });
354         putParameter = appleEventClass.getDeclaredMethod("putParameter",
355                 new Class[]
356                 { int.class, aeDescClass });
357         sendNoReply = appleEventClass.getDeclaredMethod("sendNoReply",
358                 new Class[] {});
359
360         Field keyDirectObjectField = aeClass
361                 .getDeclaredField("keyDirectObject");
362         keyDirectObject = (Integer) keyDirectObjectField.get(null);
363
364         Field autoGenerateReturnIDField = appleEventClass
365                 .getDeclaredField("kAutoGenerateReturnID");
366         kAutoGenerateReturnID = (Integer) autoGenerateReturnIDField
367                 .get(null);
368
369         Field anyTransactionIDField = appleEventClass
370                 .getDeclaredField("kAnyTransactionID");
371         kAnyTransactionID = (Integer) anyTransactionIDField.get(null);
372       } catch (ClassNotFoundException cnfe)
373       {
374         errorMessage = cnfe.getMessage();
375
376         return false;
377       } catch (NoSuchMethodException nsme)
378       {
379         errorMessage = nsme.getMessage();
380
381         return false;
382       } catch (NoSuchFieldException nsfe)
383       {
384         errorMessage = nsfe.getMessage();
385
386         return false;
387       } catch (IllegalAccessException iae)
388       {
389         errorMessage = iae.getMessage();
390
391         return false;
392       }
393
394       break;
395
396     case MRJ_2_1:
397
398       try
399       {
400         mrjFileUtilsClass = Class.forName("com.apple.mrj.MRJFileUtils");
401         mrjOSTypeClass = Class.forName("com.apple.mrj.MRJOSType");
402
403         Field systemFolderField = mrjFileUtilsClass
404                 .getDeclaredField("kSystemFolderType");
405         kSystemFolderType = systemFolderField.get(null);
406         findFolder = mrjFileUtilsClass.getDeclaredMethod("findFolder",
407                 new Class[]
408                 { mrjOSTypeClass });
409         getFileCreator = mrjFileUtilsClass
410                 .getDeclaredMethod("getFileCreator", new Class[]
411                 { File.class });
412         getFileType = mrjFileUtilsClass.getDeclaredMethod("getFileType",
413                 new Class[]
414                 { File.class });
415       } catch (ClassNotFoundException cnfe)
416       {
417         errorMessage = cnfe.getMessage();
418
419         return false;
420       } catch (NoSuchFieldException nsfe)
421       {
422         errorMessage = nsfe.getMessage();
423
424         return false;
425       } catch (NoSuchMethodException nsme)
426       {
427         errorMessage = nsme.getMessage();
428
429         return false;
430       } catch (SecurityException se)
431       {
432         errorMessage = se.getMessage();
433
434         return false;
435       } catch (IllegalAccessException iae)
436       {
437         errorMessage = iae.getMessage();
438
439         return false;
440       }
441
442       break;
443
444     case MRJ_3_0:
445
446       try
447       {
448         Class linker = Class.forName("com.apple.mrj.jdirect.Linker");
449         Constructor constructor = linker
450                 .getConstructor(new Class[]
451                 { Class.class });
452         linkage = constructor
453                 .newInstance(new Object[]
454                 { BrowserLauncher.class });
455       } catch (ClassNotFoundException cnfe)
456       {
457         errorMessage = cnfe.getMessage();
458
459         return false;
460       } catch (NoSuchMethodException nsme)
461       {
462         errorMessage = nsme.getMessage();
463
464         return false;
465       } catch (InvocationTargetException ite)
466       {
467         errorMessage = ite.getMessage();
468
469         return false;
470       } catch (InstantiationException ie)
471       {
472         errorMessage = ie.getMessage();
473
474         return false;
475       } catch (IllegalAccessException iae)
476       {
477         errorMessage = iae.getMessage();
478
479         return false;
480       }
481
482       break;
483
484     case MRJ_3_1:
485
486       try
487       {
488         mrjFileUtilsClass = Class.forName("com.apple.mrj.MRJFileUtils");
489         openURL = mrjFileUtilsClass.getDeclaredMethod("openURL",
490                 new Class[]
491                 { String.class });
492       } catch (ClassNotFoundException cnfe)
493       {
494         errorMessage = cnfe.getMessage();
495
496         return false;
497       } catch (NoSuchMethodException nsme)
498       {
499         errorMessage = nsme.getMessage();
500
501         return false;
502       }
503
504       break;
505
506     default:
507       break;
508     }
509
510     return true;
511   }
512
513   /**
514    * Attempts to locate the default web browser on the local system. s results
515    * so it only locates the browser once for each use of this class per JVM
516    * instance.
517    * 
518    * @return The browser for the system. Note that this may not be what you
519    *         would consider to be a standard web browser; instead, it's the
520    *         application that gets called to open the default web browser. In
521    *         some cases, this will be a non-String object that provides the
522    *         means of calling the default browser.
523    */
524   private static Object locateBrowser()
525   {
526     if (browser != null)
527     {
528       return browser;
529     }
530
531     switch (jvm)
532     {
533     case MRJ_2_0:
534
535       try
536       {
537         Integer finderCreatorCode = (Integer) makeOSType.invoke(null,
538                 new Object[]
539                 { FINDER_CREATOR });
540         Object aeTarget = aeTargetConstructor
541                 .newInstance(new Object[]
542                 { finderCreatorCode });
543         Integer gurlType = (Integer) makeOSType.invoke(null,
544                 new Object[]
545                 { GURL_EVENT });
546         Object appleEvent = appleEventConstructor
547                 .newInstance(new Object[]
548                 { gurlType, gurlType, aeTarget, kAutoGenerateReturnID,
549                     kAnyTransactionID });
550
551         // Don't set browser = appleEvent because then the next time we call
552         // locateBrowser(), we'll get the same AppleEvent, to which we'll
553         // already have
554         // added the relevant parameter. Instead, regenerate the AppleEvent
555         // every time.
556         // There's probably a way to do this better; if any has any ideas,
557         // please let
558         // me know.
559         return appleEvent;
560       } catch (IllegalAccessException iae)
561       {
562         browser = null;
563         errorMessage = iae.getMessage();
564
565         return browser;
566       } catch (InstantiationException ie)
567       {
568         browser = null;
569         errorMessage = ie.getMessage();
570
571         return browser;
572       } catch (InvocationTargetException ite)
573       {
574         browser = null;
575         errorMessage = ite.getMessage();
576
577         return browser;
578       }
579
580     case MRJ_2_1:
581
582       File systemFolder;
583
584       try
585       {
586         systemFolder = (File) findFolder.invoke(null,
587                 new Object[]
588                 { kSystemFolderType });
589       } catch (IllegalArgumentException iare)
590       {
591         browser = null;
592         errorMessage = iare.getMessage();
593
594         return browser;
595       } catch (IllegalAccessException iae)
596       {
597         browser = null;
598         errorMessage = iae.getMessage();
599
600         return browser;
601       } catch (InvocationTargetException ite)
602       {
603         browser = null;
604         errorMessage = ite.getTargetException().getClass() + ": "
605                 + ite.getTargetException().getMessage();
606
607         return browser;
608       }
609
610       String[] systemFolderFiles = systemFolder.list();
611
612       // Avoid a FilenameFilter because that can't be stopped mid-list
613       for (int i = 0; i < systemFolderFiles.length; i++)
614       {
615         try
616         {
617           File file = new File(systemFolder, systemFolderFiles[i]);
618
619           if (!file.isFile())
620           {
621             continue;
622           }
623
624           // We're looking for a file with a creator code of 'MACS' and
625           // a type of 'FNDR'. Only requiring the type results in non-Finder
626           // applications being picked up on certain Mac OS 9 systems,
627           // especially German ones, and sending a GURL event to those
628           // applications results in a logout under Multiple Users.
629           Object fileType = getFileType.invoke(null, new Object[] { file });
630
631           if (FINDER_TYPE.equals(fileType.toString()))
632           {
633             Object fileCreator = getFileCreator.invoke(null,
634                     new Object[]
635                     { file });
636
637             if (FINDER_CREATOR.equals(fileCreator.toString()))
638             {
639               browser = file.toString(); // Actually the Finder, but that's OK
640
641               return browser;
642             }
643           }
644         } catch (IllegalArgumentException iare)
645         {
646           errorMessage = iare.getMessage();
647
648           return null;
649         } catch (IllegalAccessException iae)
650         {
651           browser = null;
652           errorMessage = iae.getMessage();
653
654           return browser;
655         } catch (InvocationTargetException ite)
656         {
657           browser = null;
658           errorMessage = ite.getTargetException().getClass() + ": "
659                   + ite.getTargetException().getMessage();
660
661           return browser;
662         }
663       }
664
665       browser = null;
666
667       break;
668
669     case MRJ_3_0:
670     case MRJ_3_1:
671       browser = ""; // Return something non-null
672
673       break;
674
675     case WINDOWS_NT:
676       browser = "cmd.exe";
677
678       break;
679
680     case WINDOWS_9x:
681       browser = "command.com";
682
683       break;
684
685     case OTHER:
686     default:
687       browser = jalview.bin.Cache.getDefault("DEFAULT_BROWSER", "firefox");
688
689       break;
690     }
691
692     return browser;
693   }
694
695   /**
696    * used to ensure that browser is up-to-date after a configuration change
697    * (Unix DEFAULT_BROWSER property change).
698    */
699   public static void resetBrowser()
700   {
701     browser = null;
702   }
703
704   /**
705    * Attempts to open the default web browser to the given URL.
706    * 
707    * @param url
708    *          The URL to open
709    * @throws IOException
710    *           If the web browser could not be located or does not run
711    */
712   public static void openURL(String url) throws IOException
713   {
714     if (!loadedWithoutErrors)
715     {
716       throw new IOException(MessageManager
717               .formatMessage("exception.browser_not_found", new String[]
718               { errorMessage }));
719     }
720
721     Object browser = locateBrowser();
722
723     if (browser == null)
724     {
725       throw new IOException(MessageManager.formatMessage(
726               "exception.browser_unable_to_locate", new String[]
727               { errorMessage }));
728     }
729
730     switch (jvm)
731     {
732     case MRJ_2_0:
733
734       Object aeDesc = null;
735
736       try
737       {
738         aeDesc = aeDescConstructor.newInstance(new Object[] { url });
739         putParameter.invoke(browser,
740                 new Object[]
741                 { keyDirectObject, aeDesc });
742         sendNoReply.invoke(browser, new Object[] {});
743       } catch (InvocationTargetException ite)
744       {
745         throw new IOException(MessageManager.formatMessage(
746                 "exception.invocation_target_exception_creating_aedesc",
747                 new String[]
748                 { ite.getMessage() }));
749       } catch (IllegalAccessException iae)
750       {
751         throw new IOException(MessageManager.formatMessage(
752                 "exception.illegal_access_building_apple_evt", new String[]
753                 { iae.getMessage() }));
754       } catch (InstantiationException ie)
755       {
756         throw new IOException(MessageManager.formatMessage(
757                 "exception.illegal_access_building_apple_evt", new String[]
758                 { ie.getMessage() }));
759       } finally
760       {
761         aeDesc = null; // Encourage it to get disposed if it was created
762         browser = null; // Ditto
763       }
764
765       break;
766
767     case MRJ_2_1:
768       Runtime.getRuntime().exec(new String[] { (String) browser, url });
769
770       break;
771
772     case MRJ_3_0:
773
774       int[] instance = new int[1];
775       int result = ICStart(instance, 0);
776
777       if (result == 0)
778       {
779         int[] selectionStart = new int[] { 0 };
780         byte[] urlBytes = url.getBytes();
781         int[] selectionEnd = new int[] { urlBytes.length };
782         result = ICLaunchURL(instance[0], new byte[] { 0 }, urlBytes,
783                 urlBytes.length, selectionStart, selectionEnd);
784
785         if (result == 0)
786         {
787           // Ignore the return value; the URL was launched successfully
788           // regardless of what happens here.
789           ICStop(instance);
790         }
791         else
792         {
793           throw new IOException(MessageManager.formatMessage(
794                   "exception.unable_to_launch_url", new String[]
795                   { Integer.valueOf(result).toString() }));
796         }
797       }
798       else
799       {
800         throw new IOException(MessageManager.formatMessage(
801                 "exception.unable_to_create_internet_config", new String[]
802                 { Integer.valueOf(result).toString() }));
803       }
804
805       break;
806
807     case MRJ_3_1:
808
809       try
810       {
811         openURL.invoke(null, new Object[] { url });
812       } catch (InvocationTargetException ite)
813       {
814         throw new IOException(MessageManager.formatMessage(
815                 "exception.invocation_target_calling_url", new String[]
816                 { ite.getMessage() }));
817       } catch (IllegalAccessException iae)
818       {
819         throw new IOException(MessageManager.formatMessage(
820                 "exception.illegal_access_calling_url", new String[]
821                 { iae.getMessage() }));
822       }
823
824       break;
825
826     case WINDOWS_NT:
827     case WINDOWS_9x:
828
829       // Add quotes around the URL to allow ampersands and other special
830       // characters to work.
831       Process process = Runtime.getRuntime()
832               .exec(new String[]
833               { (String) browser, FIRST_WINDOWS_PARAMETER,
834                   SECOND_WINDOWS_PARAMETER, THIRD_WINDOWS_PARAMETER,
835                   '"' + url + '"' });
836
837       // This avoids a memory leak on some versions of Java on Windows.
838       // That's hinted at in
839       // <http://developer.java.sun.com/developer/qow/archive/68/>.
840       try
841       {
842         process.waitFor();
843         process.exitValue();
844       } catch (InterruptedException ie)
845       {
846         throw new IOException(MessageManager.formatMessage(
847                 "exception.interrupted_launching_browser", new String[]
848                 { ie.getMessage() }));
849       }
850
851       break;
852
853     case OTHER:
854
855       // Assume that we're on Unix and that Netscape (actually Firefox) is
856       // installed
857       // First, attempt to open the URL in a currently running session of
858       // Netscape
859       // JBPNote log debug
860
861       /*
862        * System.out.println("Executing : "+browser+" "+
863        * NETSCAPE_REMOTE_PARAMETER+" "+ NETSCAPE_OPEN_PARAMETER_START + url +
864        * NETSCAPE_OPEN_NEW_WINDOW + NETSCAPE_OPEN_PARAMETER_END);
865        */
866       process = Runtime.getRuntime()
867               .exec(new String[]
868               { (String) browser, NETSCAPE_REMOTE_PARAMETER,
869
870                   NETSCAPE_OPEN_PARAMETER_START + url
871                           + NETSCAPE_OPEN_NEW_WINDOW
872                           + NETSCAPE_OPEN_PARAMETER_END });
873
874       try
875       {
876         int exitCode = process.waitFor();
877
878         if (exitCode != 0)
879         { // if Netscape was not open
880           Runtime.getRuntime().exec(new String[] { (String) browser, url });
881         }
882       } catch (InterruptedException ie)
883       {
884         throw new IOException(MessageManager.formatMessage(
885                 "exception.interrupted_launching_browser", new String[]
886                 { ie.getMessage() }));
887       }
888
889       break;
890
891     default:
892
893       // This should never occur, but if it does, we'll try the simplest thing
894       // possible
895       Runtime.getRuntime().exec(new String[] { (String) browser, url });
896
897       break;
898     }
899   }
900
901   /**
902    * Methods required for Mac OS X. The presence of native methods does not
903    * cause any problems on other platforms.
904    */
905   private native static int ICStart(int[] instance, int signature);
906
907   private native static int ICStop(int[] instance);
908
909   private native static int ICLaunchURL(int instance, byte[] hint,
910           byte[] data, int len, int[] selectionStart, int[] selectionEnd);
911 }