BrowserLauncher.java

package ij.plugin;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.net.URL;
import java.net.URLClassLoader;
import java.applet.Applet;

public class BrowserLauncher implements PlugIn {

    public void run(String theURL) {
        if (theURL==null || theURL.equals(""))
            theURL = "http://rsb.info.nih.gov/ij/";
        else if (theURL.equals("online"))
            theURL = "http://rsb.info.nih.gov/ij/docs";
        Applet applet = ij.IJ.getApplet();
        if (applet!=null) {
            try {
                applet.getAppletContext().showDocument(new URL(theURL), "_blank" );
            } catch (Exception e) {}
            return;
        }
        try {openURL(theURL);}
        catch (IOException e) {}
    }

    private static int jvm;

    private static Object browser;

    private static boolean loadedWithoutErrors;

    private static Class mrjFileUtilsClass;

    private static Class mrjOSTypeClass;

    private static Class aeDescClass;
    
    private static Constructor aeTargetConstructor;
    
    private static Constructor appleEventConstructor;
    
    private static Constructor aeDescConstructor;
    
    private static Method findFolder;

    private static Method getFileCreator;
    
    private static Method getFileType;
    
    private static Method openURL;
    
    private static Method makeOSType;
    
    private static Method putParameter;
    
    private static Method sendNoReply;
    
    private static Object kSystemFolderType;

    private static Integer keyDirectObject;

    private static Integer kAutoGenerateReturnID;
    
    private static Integer kAnyTransactionID;

    private static Object linkage;
    
    private static final String JDirect_MacOSX = "/System/Library/Frameworks/Carbon.framework/Frameworks/HIToolbox.framework/HIToolbox";

    private static final int MRJ_2_0 = 0;
    
    private static final int MRJ_2_1 = 1;

    private static final int MRJ_3_0 = 3;
    
    private static final int MRJ_3_1 = 4;

    private static final int WINDOWS = 5;
    
    private static final int MACOSX = 6;

    private static final int OTHER = -1;

    private static final String FINDER_TYPE = "FNDR";

    private static final String FINDER_CREATOR = "MACS";

    private static final String GURL_EVENT = "GURL";

    private static final String NETSCAPE_REMOTE_PARAMETER = "-remote";
    private static final String NETSCAPE_OPEN_PARAMETER_START = "'openURL(";
    private static final String NETSCAPE_OPEN_PARAMETER_END = ")'";
    
    private static String errorMessage;

    static {
        loadedWithoutErrors = true;
        String osName = System.getProperty("os.name");
        if (osName.startsWith("Mac OS X") )
            jvm  = MACOSX;
        else if (osName.startsWith("Mac OS")) {
            String mrjVersion = System.getProperty("mrj.version");
            String majorMRJVersion = mrjVersion.substring(0, 3);
            try {
                double version = Double.valueOf(majorMRJVersion).doubleValue();
                if (version == 2) {
                    jvm = MRJ_2_0;
                } else if (version >= 2.1 && version < 3) {
                    // Assume that all 2.x versions of MRJ work the same.  MRJ 2.1 actually
                    // works via Runtime.exec() and 2.2 supports that but has an openURL() method
                    // as well that we currently ignore.
                    jvm = MRJ_2_1;
                } else if (version == 3.0) {
                    jvm = MRJ_3_0;
                } else if (version >= 3.1) {
                    // Assume that all 3.1 and later versions of MRJ work the same.
                    jvm = MRJ_3_1;
                } else {
                    loadedWithoutErrors = false;
                    errorMessage = "Unsupported MRJ version: " + version;
                }
            } catch (NumberFormatException nfe) {
                loadedWithoutErrors = false;
                errorMessage = "Invalid MRJ version: " + mrjVersion;
            }
        } else if (osName.startsWith("Windows"))
                jvm = WINDOWS;
        else
            jvm = OTHER;
        
        if (loadedWithoutErrors) {  // if we haven't hit any errors yet
            loadedWithoutErrors = loadClasses();
        }
    }

    public BrowserLauncher() { }
    
    private static boolean loadClasses() {
        switch (jvm) {
            case MRJ_2_1:
                try {
                    mrjFileUtilsClass = Class.forName("com.apple.mrj.MRJFileUtils");
                    mrjOSTypeClass = Class.forName("com.apple.mrj.MRJOSType");
                    Field systemFolderField = mrjFileUtilsClass.getDeclaredField("kSystemFolderType");
                    kSystemFolderType = systemFolderField.get(null);
                    findFolder = mrjFileUtilsClass.getDeclaredMethod("findFolder", new Class[] { mrjOSTypeClass });
                    getFileCreator = mrjFileUtilsClass.getDeclaredMethod("getFileCreator", new Class[] { File.class });
                    getFileType = mrjFileUtilsClass.getDeclaredMethod("getFileType", new Class[] { File.class });
                } catch (ClassNotFoundException cnfe) {
                    errorMessage = cnfe.getMessage();
                    return false;
                } catch (NoSuchFieldException nsfe) {
                    errorMessage = nsfe.getMessage();
                    return false;
                } catch (NoSuchMethodException nsme) {
                    errorMessage = nsme.getMessage();
                    return false;
                } catch (SecurityException se) {
                    errorMessage = se.getMessage();
                    return false;
                } catch (IllegalAccessException iae) {
                    errorMessage = iae.getMessage();
                    return false;
                }
                break;
            case MACOSX:
                try {
                    if (new File("/System/Library/Java/com/apple/cocoa/application/NSWorkspace.class").exists()){
                         ClassLoader classLoader = new URLClassLoader(new URL[]{new File("/System/Library/Java").toURL()});
                         mrjFileUtilsClass = Class.forName("com.apple.cocoa.application.NSWorkspace", true, classLoader);
                    } else {
                         mrjFileUtilsClass = Class.forName("com.apple.cocoa.application.NSWorkspace");
                    }
                    openURL = mrjFileUtilsClass.getDeclaredMethod("openURL", new Class[] { java.net.URL.class });
                } catch (Exception e) {
                    ij.IJ.log("MaxOSX: "+e);
                    errorMessage = e.getMessage();
                    return false;
                }
            default:
                break;
        }
        return true;
    }

    private static Object locateBrowser() {
        if (browser != null) {
            return browser;
        }
        switch (jvm) {
            case MRJ_2_0:
                return null;
            case MRJ_2_1:
                File systemFolder;
                try {
                    systemFolder = (File) findFolder.invoke(null, new Object[] { kSystemFolderType });
                } catch (IllegalArgumentException iare) {
                    browser = null;
                    errorMessage = iare.getMessage();
                    return browser;
                } catch (IllegalAccessException iae) {
                    browser = null;
                    errorMessage = iae.getMessage();
                    return browser;
                } catch (InvocationTargetException ite) {
                    browser = null;
                    errorMessage = ite.getTargetException().getClass() + ": " + ite.getTargetException().getMessage();
                    return browser;
                }
                String[] systemFolderFiles = systemFolder.list();
                // Avoid a FilenameFilter because that can't be stopped mid-list
                for(int i = 0; i < systemFolderFiles.length; i++) {
                    try {
                        File file = new File(systemFolder, systemFolderFiles[i]);
                        if (!file.isFile()) {
                            continue;
                        }
                        // We're looking for a file with a creator code of 'MACS' and
                        // a type of 'FNDR'.  Only requiring the type results in non-Finder
                        // 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 });
                        if (FINDER_TYPE.equals(fileType.toString())) {
                            Object fileCreator = getFileCreator.invoke(null, new Object[] { file });
                            if (FINDER_CREATOR.equals(fileCreator.toString())) {
                                browser = file.toString();  // Actually the Finder, but that's OK
                                return browser;
                            }
                        }
                    } catch (IllegalArgumentException iare) {
                        browser = browser;
                        errorMessage = iare.getMessage();
                        return null;
                    } catch (IllegalAccessException iae) {
                        browser = null;
                        errorMessage = iae.getMessage();
                        return browser;
                    } catch (InvocationTargetException ite) {
                        browser = null;
                        errorMessage = ite.getTargetException().getClass() + ": " + ite.getTargetException().getMessage();
                        return browser;
                    }
                }
                browser = null;
                break;
            case MRJ_3_0:
            case MRJ_3_1:
            case WINDOWS:
                browser = "";   // not used; return something non-null
                break;
            case OTHER:
            default:
                browser = "netscape";
                break;
        }
        return browser;
    }

    public static void openURL(String url) throws IOException {
        if (!loadedWithoutErrors) {
            throw new IOException("Exception in finding browser: " + errorMessage);
        }
        Object browser = locateBrowser();
        if (browser == null) {
            throw new IOException("Unable to locate browser: " + errorMessage);
        }
        
        switch (jvm) {
            case MRJ_2_1:
                Runtime.getRuntime().exec(new String[] { (String) browser, url } );
                break;
            case MACOSX:
                try {
                    Method aMethod = mrjFileUtilsClass.getDeclaredMethod("sharedWorkspace", new Class[] {});
                    Object aTarget = aMethod.invoke( mrjFileUtilsClass, new Object[] {});
                    openURL.invoke(aTarget, new Object[] { new java.net.URL( url )}); 
                } catch (Exception e) {
                    errorMessage = ""+e;
                }
                break;
            case WINDOWS:
                String cmd = "rundll32 url.dll,FileProtocolHandler " + url;
                if (ij.IJ.debugMode) {ij.IJ.log("Exec: "+cmd);}
                Process process = Runtime.getRuntime().exec(cmd);
                // This avoids a memory leak on some versions of Java on Windows.
                // That's hinted at in <http://developer.java.sun.com/developer/qow/archive/68/>.
                try {
                    process.waitFor();
                    process.exitValue();
                } catch (InterruptedException ie) {
                    throw new IOException("InterruptedException while launching browser: " + ie.getMessage());
                }
                break;
            case OTHER:
                // Assume that we're on Unix and that Netscape is installed
                
                // First, attempt to open the URL in a currently running session of Netscape
                process = Runtime.getRuntime().exec(new String[] { (String) browser,
                                                    NETSCAPE_REMOTE_PARAMETER,
                                                    NETSCAPE_OPEN_PARAMETER_START +
                                                    url +
                                                    NETSCAPE_OPEN_PARAMETER_END });
                try {
                    int exitCode = process.waitFor();
                    if (exitCode != 0) {    // if Netscape was not open
                        Runtime.getRuntime().exec(new String[] { (String) browser, url });
                    }
                } catch (InterruptedException ie) {
                    throw new IOException("InterruptedException while launching browser: " + ie.getMessage());
                }
                break;
            default:
                // This should never occur, but if it does, we'll try the simplest thing possible
                Runtime.getRuntime().exec(new String[] { (String) browser, url });
                break;
        }
    }

    private native static int ICStart(int[] instance, int signature);
    private native static int ICStop(int[] instance);
    private native static int ICLaunchURL(int instance, byte[] hint, byte[] data, int len,
                                            int[] selectionStart, int[] selectionEnd);
}