Fix URL Handling in OSX.

Fixes issue 954.


git-svn-id: http://svn.dmdirc.com/trunk@4054 00569f92-eb28-0410-84fd-f71c24880f

installer/osx/DMDirc-Apple.c

@@ -0,0 +1,121 @@
+/*
+ * Copyright (c) 2006-2008 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * JNI library for OS X url handling.
+ * Compile with:
+ *     gcc -dynamiclib -framework JavaVM -framework Carbon -o libDMDirc-Apple.jnilib DMDirc-Apple.c -arch x86_64
+ */
+
+#include <Carbon/Carbon.h>
+#include <JavaVM/jni.h>
+
+/** The method to callback */
+static jmethodID callbackMethod;
+
+/** The JVM our callback is in */
+static JavaVM *jvm;
+
+/** The global reference to the Apple object that wants the callback */
+static jobject apple;
+
+/** Callback from OS X with URL. */
+static OSErr openURLCallback(const AppleEvent *theAppleEvent, AppleEvent* reply, long handlerRefcon);
+
+/**
+ * JNI Method to register interest in callback.
+ * Obtained from:
+ *     javah -classpath DMDirc.jar com.dmdirc.ui.swing.Apple
+ * Reference:
+ *     http://developer.apple.com/documentation/Carbon/Reference/Apple_Event_Manager/Reference/reference.html#//apple_ref/c/func/AEInstallEventHandler
+ *
+ * @param env The JNIEnvironment for this callback.
+ * @param this The object that is registering the callback
+ */
+JNIEXPORT jint JNICALL Java_com_dmdirc_ui_swing_Apple_registerOpenURLCallback (JNIEnv *env, jobject object) {
+	// Find the callback in the object
+	callbackMethod = (*env)->GetMethodID(env, (*env)->GetObjectClass(env, object), "handleOpenURL", "(Ljava/lang/String;)V");
+	
+	// Check if the callback exists.
+	if (callbackMethod != 0) {
+		// Store the JVM for this callback, and a global reference to the Apple object
+		(*env)->GetJavaVM(env, &jvm);
+		apple = (*env)->NewGlobalRef(env, object);
+	
+		// Now register the callback to ourself.
+		return (jint)AEInstallEventHandler(kInternetEventClass, kAEGetURL, NewAEEventHandlerUPP((AEEventHandlerProcPtr)openURLCallback), 0, false);
+	} else {
+		return 1;
+	}
+}
+
+
+/**
+ * Callback from OS X with URL.
+ * Reference:
+ *     http://developer.apple.com/documentation/Carbon/Reference/Apple_Event_Manager/Reference/reference.html#//apple_ref/c/func/NewAEEventHandlerUPP
+ *     http://developer.apple.com/documentation/Carbon/Reference/Apple_Event_Manager/Reference/reference.html#//apple_ref/c/tdef/AEEventHandlerUPP
+ *     http://developer.apple.com/documentation/Carbon/Reference/Apple_Event_Manager/Reference/reference.html#//apple_ref/c/tdef/AEEventHandlerProcPtr
+ *
+ * @param theAppleEvent Pointer to apple event handle
+ * @param reply Pointer to default reply event
+ * @param handlerRefcon Reference constant for this callback. (Ignored)
+ */
+static OSErr openURLCallback(const AppleEvent *theAppleEvent, AppleEvent* reply, long handlerRefcon) {
+	OSErr result = noErr;
+	Size givenLength = 0;
+	DescType type = typeChar;
+	
+	// Get the size of the string the callback wants to give us, and then
+	// check that it is > 0 in length.
+	result = AESizeOfParam(theAppleEvent, keyDirectObject, &type, &givenLength);
+	if (result == noErr && givenLength != 0) {
+		// Allocate a buffer for the result
+		// givenLength +1 for the \0
+		Size length = givenLength + 1;
+		char *dataPtr = (char*)malloc(length);
+		
+		if (dataPtr != 0) {
+			// Empty the buffer
+			memset(dataPtr, 0, length);
+			
+			// Get the url
+			result = AEGetParamPtr(theAppleEvent, keyDirectObject, typeChar, 0, dataPtr, givenLength, &givenLength);
+			// Did we get it?
+			if (result == noErr) {
+				// Get the java environment for the jvm we want to callback to
+				JNIEnv *env;
+				(*jvm)->AttachCurrentThread(jvm, (void **)&env, NULL);
+				
+				// Convert the url into a java string
+				jstring theURL = (*env)->NewStringUTF(env, dataPtr);
+				
+				// Call the method!
+				(*env)->CallVoidMethod(env, apple, callbackMethod, theURL);
+			}
+			
+			// Free the buffer
+			free(dataPtr);
+		}
+	}
+	
+	// And return!
+	return result;
+}

installer/osx/makeInstallerOSX.sh

@@ -44,6 +44,22 @@ MKHFS=`which mkfs.hfs`
 MKHFSPLUS=`which mkfs.hfsplus`
 HDIUTIL=`which hdiutil`
 
+JNIName="libDMDirc-Apple.jnilib"
+
+if [ ! -e "${JNIName}" ]; then
+	if [ -e "/System/Library/Frameworks/JavaVM.framework/Headers" ]; then
+		GCC=`which gcc`
+		${GCC} -dynamiclib -framework JavaVM -framework Carbon -o ${JNIName} DMDirc-Apple.c -arch x86_64
+		if [ ! -e "${JNIName}" ]; then
+			echo "JNI Lib not found and failed to compile. Aborting."
+			exit 1;
+		fi;
+	else
+		echo "JNI Lib not found, unable to compile on this system. Aborting."
+		exit 1;
+	fi;
+fi;
+
 if [ "" = "${HDIUTIL}" ]; then
 	if [ "" = "${MKHFS}" -a "" = "${MKHFSPLUS}" ]; then
 		echo "This machine is unable to produce dmg images. Aborting."
@@ -280,6 +296,7 @@ EOF
 #	</dict>
 
 cp DMDirc.jar ${RESDIR}/Java/DMDirc.jar
+cp ${JNIName} ${RESDIR}/Java/${JNIName}
 
 #if [ -e "../common/installer.jar" ]; then
 #	ln -sf ../common/installer.jar ./installer.jar

launcher/osx/DMDirc.sh

@@ -84,7 +84,8 @@ messagedialog() {
 	fi;
 }
 
-jar=`dirname $0`/../Resources/Java/DMDirc.jar
+jarDir=`dirname $0`/../Resources/Java/
+jar=${jarDir}DMDirc.jar
 launcherUpdater=${profiledir}/updateLauncher.sh
 echo "---------------------"
 echo "DMDirc - Open Source IRC Client"
@@ -215,8 +216,8 @@ else
 	echo "Failed!"
 	ERROR="Sorry, java is not installed on this machine.";
 	ERROR=${ERROR}"\n"
-	ERROR=${ERROR}"\nDMDirc requires a 1.6.0 compatible JVM, this is currently:";
-	ERROR=${ERROR}"\nonly availble as a Developer Preview from the Apple Developer site.";
+	ERROR=${ERROR}"\nDMDirc requires a 1.6.0 compatible JVM, this is currently";
+	ERROR=${ERROR}"only availble as a Developer Preview from the Apple Developer site.";
 	errordialog "Unable to launch dmdirc!" "${ERROR}";
 	exit 1;
 fi
@@ -232,8 +233,8 @@ if [ -e "${jar}" ]; then
 		ERROR="Sorry, the currently installed version of java is not compatible with";
 		ERROR=${ERROR}"\nDMDirc.";
 		ERROR=${ERROR}"\n";
-		ERROR=${ERROR}"\nDMDirc requires a 1.6.0 compatible JVM, this is currently:";
-		ERROR=${ERROR}"\nonly availble as a Developer Preview from the Apple Developer site.";
+		ERROR=${ERROR}"\nDMDirc requires a 1.6.0 compatible JVM, this is currently";
+		ERROR=${ERROR}"only availble as a Developer Preview from the Apple Developer site.";
 		errordialog "Unable to launch dmdirc!" "${ERROR}";
 		exit 1;
 	fi
@@ -242,6 +243,7 @@ if [ -e "${jar}" ]; then
 	# to be seen, and the shell script exits with the correct exit code.
 	
 	APPLEOPTS=""
+	APPLEOPTS="${APPLEOPTS} -Djava.library.path=${jarDir}"
 #	APPLEOPTS="${APPLEOPTS} -Dcom.apple.mrj.application.growbox.intrudes=false"
 #	APPLEOPTS="${APPLEOPTS} -Dcom.apple.mrj.application.live-resize=true"
 #	APPLEOPTS="${APPLEOPTS} -Dcom.apple.mrj.application.apple.menu.about.name=DMDirc"

src/com/dmdirc/ui/swing/Apple.java

@@ -23,19 +23,31 @@
 package com.dmdirc.ui.swing;
 
 import com.dmdirc.Main;
+import com.dmdirc.actions.ActionManager;
+import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.actions.interfaces.ActionType;
 import com.dmdirc.config.IdentityManager;
+import com.dmdirc.interfaces.ActionListener;
+import com.dmdirc.util.IrcAddress;
+import com.dmdirc.util.InvalidAddressException;
+
+import com.dmdirc.logger.ErrorLevel;
+import com.dmdirc.logger.Logger;
 
 import java.awt.event.ActionEvent;
+
 import java.lang.reflect.InvocationHandler;
 import java.lang.reflect.Method;
 import java.lang.reflect.Field;
 import java.lang.reflect.Proxy;
 import java.lang.reflect.InvocationTargetException;
 
+import java.util.ArrayList;
+
 /**
  * Integrate DMDirc with OS X better.
  */
-public final class Apple implements InvocationHandler {
+public final class Apple implements InvocationHandler, ActionListener {
 	/** ApplicationEvent */
 	private interface ApplicationEvent {
 		String getFilename();
@@ -60,6 +72,12 @@ public final class Apple implements InvocationHandler {
 	/** The MenuBar for the application */
 	private MenuBar menuBar = null;
 
+	/** Has the CLIENT_OPENED action been called? */
+	private volatile boolean clientOpened = false;
+	
+	/** Store any addresses that are opened before CLIENT_OPENED. */
+	private volatile ArrayList<IrcAddress> addresses = new ArrayList<IrcAddress>();
+
 	/**
 	 * Get the "Apple" instance.
 	 *
@@ -71,6 +89,25 @@ public final class Apple implements InvocationHandler {
 		}
 		return me;
 	}
+	
+	/**
+	 * Create the Apple class.
+	 * This attempts to:
+	 *   - load the JNI library
+	 *   - register the callback
+	 *   - register a CLIENT_OPENED listener
+	 */
+	private Apple() {
+		if (isApple()) {
+			try {
+				System.loadLibrary("DMDirc-Apple");
+				registerOpenURLCallback();
+				ActionManager.addListener(this, CoreActionType.CLIENT_OPENED);
+			} catch (UnsatisfiedLinkError ule) {
+				Logger.appError(ErrorLevel.MEDIUM, "Unable to load JNI library.", ule);
+			}
+		}
+	}
 
 	/**
 	 * Get the "Application" object
@@ -124,7 +161,6 @@ public final class Apple implements InvocationHandler {
 	 * @return true if we are running on OS X
 	 */
 	public static boolean isApple() {
-//		return (Main.getUI() instanceof SwingController && System.getProperty("os.name").startsWith("Mac OS"));
 		return (System.getProperty("mrj.version") != null);
 	}
 
@@ -147,7 +183,6 @@ public final class Apple implements InvocationHandler {
 		System.setProperty("apple.laf.useScreenMenuBar", "true");
 		System.setProperty("com.apple.mrj.application.growbox.intrudes", "false");
 		System.setProperty("com.apple.mrj.application.live-resize", "true");
-//		System.setProperty("com.apple.mrj.application.apple.menu.about.name", "DMDirc: " + Main.VERSION);
 		System.setProperty("com.apple.mrj.application.apple.menu.about.name", "DMDirc");
 	}
 	
@@ -209,6 +244,7 @@ public final class Apple implements InvocationHandler {
 	}
 	
 	/** {@inheritDoc} */
+	@Override
 	public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable {
 		if (!isApple()) { return null; }
 		
@@ -305,4 +341,55 @@ public final class Apple implements InvocationHandler {
 	 * @param event an ApplicationEvent object
 	 */
 	public void handleReopenApplication(final ApplicationEvent event) { }
+	
+	/** {@inheritDoc} */
+	@Override
+	public void processEvent(final ActionType type, final StringBuffer format, final Object... arguments) {
+		if (type == CoreActionType.CLIENT_OPENED) {
+			synchronized (addresses) {
+				clientOpened = true;
+				for (IrcAddress addr : addresses) {
+					addr.connect();
+				}
+				addresses.clear();
+			}
+		}
+	}
+
+	/**
+	 * Callback from JNI library.
+	 * If called before the client has finished opening, the URL will be added to
+	 * a list that will be connected to once the CLIENT_OPENED action is called.
+	 * Otherwise we connect right away.
+	 *
+	 * @param url The irc url to connect to.
+	 */
+	@SuppressWarnings("unused")
+	public void handleOpenURL(final String url) {
+		if (isApple()) {
+			try {
+				synchronized (addresses) {
+					final IrcAddress addr = new IrcAddress(url);
+					if (!clientOpened) {
+						addresses.add(addr);
+					} else {
+						// When the JNI callback is called there is no ContextClassLoader set.
+						// This causes an NPE in IconManager if no servers have been connected to yet
+						// This solves it.
+						if (Thread.currentThread().getContextClassLoader() == null) {
+							Thread.currentThread().setContextClassLoader(ClassLoader.getSystemClassLoader());
+						}
+						addr.connect();
+					}
+				}
+			} catch (InvalidAddressException iae) { }
+		}
+	}
+
+	/**
+	 * Register the getURL Callback.
+	 *
+	 * @return 0 on success, 1 on failure.
+	 */
+	private synchronized final native int registerOpenURLCallback();
 }