DMDirc-Client/launcher/unix/DMDirc.sh

#!/bin/sh
#
# This script launches dmdirc and attempts to update the jar file if needed.
#
# DMDirc - Open Source IRC Client
# Copyright (c) 2006-2010 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.

LAUNCHERVERSION="17"
LAUNCHERINFO="unix-${LAUNCHERVERSION}"

params=""

# Check the which command exists, and if so make sure it behaves how we want
# it to...
WHICH=`which which 2>/dev/null`
if [ "" = "${WHICH}" ]; then
	echo "which command not found. Aborting.";
	exit 0;
else
	# Solaris sucks
	BADWHICH=`which /`
	if [ "${BADWHICH}" != "" ]; then
		echo "Replacing bad which command.";
		# "Which" on solaris gives non-empty results for commands that don't exist
		which() {
			OUT=`${WHICH} ${1}`
			if [ $? -eq 0 ]; then
				echo ${OUT}
			else
				echo ""
			fi;
		}
	fi;
fi

# Find out where we are
BASEDIR=${0%/*}
if [ "${BASEDIR}" = "${0}" ]; then
	BASEDIR=`which $0`
	BASEDIR=${BASEDIR%/*}
fi
CHECKBASEDIR=`echo "${BASEDIR}" | sed 's#^/##'`
if [ "${CHECKBASEDIR}" = "${BASEDIR}" ]; then
	BASEDIR=${PWD}/${BASEDIR}
fi;

# Store params so that we can pass them back to the client
for param in "$@"; do
	if [ "${param}" = "--noprofile" -o "${param}" = "--updateonly" ]; then 
		continue;
	fi;
	PSN=`echo "${param}" | grep "^-psn_"`
	if [ "" = "${PSN}" ]; then
		SPACE=`echo "${param}" | grep " "`
		if [ "${SPACE}" != "" ]; then
			niceParam=`echo "${param}" | sed 's/"/\\\\"/g'`
			params=${params}" \"${niceParam}\""
		else
			params=${params}" ${param}"
		fi;
	fi;
done;

if [ -e "${BASEDIR}/functions.sh" ]; then
	. ${BASEDIR}/functions.sh
else
	echo "Unable to find functions.sh, using built in functions"
	###FUNCTIONS_FILE###
fi;

# Check to see if we can bspatch things
BSPATCH="./bspatch"
if [ ! -e "${BSPATCH}" ]; then
	BSPATCH=`which bspatch`
fi;

# This launcher supports zip files.
LAUNCHERINFO=${LAUNCHERINFO}",zip"

if [ "${BSPATCH}" != "" ]; then
	# TODO: Website should (if available) send bsdiff patches
	# to clients with bsdiff compatible launchers
	LAUNCHERINFO=${LAUNCHERINFO}",bsdiff";
fi;

# Check for some CLI params
if [ "${ISOSX}" = "1" ]; then
	profiledir="${HOME}/Library/Preferences/DMDirc/"
else
	profiledir="${HOME}/.DMDirc/"
	if [ ! -d "${profiledir}" ]; then
		profiledir="${XDG_CONFIG_HOME}"
		if [ "${profiledir}" = "" ]; then
			profiledir="${HOME}/.config"
		fi;
		profiledir="${profiledir}/DMDirc/"
	fi;
fi;

USEPROFILE=1;
UPDATEONLY=0;
while test -n "$1"; do
	case "$1" in
		--directory|-d)
			shift
			profiledir=${1}
			;;
		--noprofile)
			USEPROFILE=0;
			;;
		--updateonly)
			UPDATEONLY=1;
			;;
		-p|--portable)
			profiledir=${PWD};
			;;
	esac
	shift
done

getConfigOption() {
	FILE="${profiledir}/dmdirc.config"
	WANTED_DOMAIN="${1}"
	WANTED_KEY="${2}"
	CURRENT_SECTION=""
	if [ "${WANTED_KEY}" != "" -a "${WANTED_DOMAIN}" = "" ]; then
		if [ -e "${FILE}" ]; then
			cat ${FILE} | sed 's/\\/\\\\/g' | while IFS='' read -r LINE; do
				IS_SECTION=`echo ${LINE} | egrep "^.*:$"`
				IS_KEYVALUE=`echo ${LINE} | egrep "^[[:space:]]+.*=.*$"`
				if [ "" != "${IS_SECTION}" ]; then
					CURRENT_SECTION=${LINE%%:*}
				elif [ "" != "${IS_KEYVALUE}" ]; then
					KEY=`echo ${LINE%%=*} | sed 's/^\s*//g'`
					VALUE=${LINE##*=}
					if [ "${WANTED_DOMAIN}" = "${CURRENT_SECTION}" -a "${WANTED_KEY}" = "${KEY}" ]; then
						echo ${VALUE};
					fi;
				fi;
			done;
		fi;
	fi;
}

if [ "${ISOSX}" = "1" ]; then
	jarDir=${BASEDIR}/../Resources/Java/
	jar=${jarDir}DMDirc.jar
else
	jar=${BASEDIR}/DMDirc.jar
fi
launcherUpdater=${profiledir}/updateLauncher.sh
BSDJava1="/usr/local/jdk1.6.0/jre/bin/java"
BSDJava2="/usr/local/diablo-jdk1.6.0/jre/bin/java"
echo "---------------------"
echo "DMDirc - Open Source IRC Client"
echo "Launcher Version: ${LAUNCHERVERSION}"
echo "Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes"
echo "---------------------"
if [ "${ISOSX}" = "1" ]; then
	echo "Running on OS X."
elif [ "${KERNEL}" = "Linux" ]; then
	echo "Running on Linux."
elif [ "`echo ${KERNEL} | grep -i BSD`" != "" ]; then
	echo "Running on BSD."
elif [ "`echo ${KERNEL} | grep -i SunOS`" != "" ]; then
	echo "Running on Solaris."
else
	echo "Running on unknown unix variation: ${KERNEL}."
fi;

if [ -e "${profiledir}/.launcher.zip" ]; then
	# Unzip!
	unzip ${profiledir}/.launcher.zip -d ${profiledir}/
fi;

echo -n "Checking for launcher updates in ${profiledir} - ";
if [ -e "${profiledir}/.launcher.sh.ignore" ]; then
	rm -Rf "${profiledir}/.launcher.sh.ignore"
	echo "Ignoring!";
elif [ -e "${profiledir}/.launcher.sh" ]; then
	echo "Found!";
	echo "Attempting to update..";

	# The code below intentionally doesn't use the FUNCTIONS_FILE include as it
	# wouldn't correctly escape \${0} and \${2} where needed and thus stuff would
	# break!
	cat <<EOF> ${launcherUpdater}
		cd ${BASEDIR}
		if [ -e "${BASEDIR}/functions.sh" ]; then
			. ${BASEDIR}/functions.sh
		else
			echo "Unable to find functions.sh, using old functions"
			errordialog() {
				# Send message to console.
				echo ""
				echo "-----------------------------------------------------------------------"
				echo "Error: \${1}"
				echo "-----------------------------------------------------------------------"
				echo "\${2}"
				echo "-----------------------------------------------------------------------"
	
				if [ "${ISOSX}" = "1" -a "" != "${OSASCRIPT}" ]; then
					echo "Displaying dialog.."
					${OSASCRIPT} -e 'tell application "System Events"' -e "activate" -e "display dialog \"${1}\n${2}\" buttons {\"Ok\"} with icon stop" -e 'end tell'
				else
					if [ "" != "${ISKDE}" -a "" != "${KDIALOG}" -a "" != "${DISPLAY}" ]; then
						echo "Dialog on Display: ${DISPLAY}"
						${KDIALOG} --title "DMDirc: \${1}" --error "\${1}\n\n\${2}"
					elif [ "" != "${ISGNOME}" -a "" != "${ZENITY}" -a "" != "${DISPLAY}" ]; then
						echo "Dialog on Display: ${DISPLAY}"
						${ZENITY} --error --title "DMDirc: \${1}" --text "\${1}\n\n\${2}"
					fi
				fi
			}
	
			messagedialog() {
				# Send message to console.
				echo ""
				echo "-----------------------------------------------------------------------"
				echo "Info: \${1}"
				echo "-----------------------------------------------------------------------"
				echo "\${2}"
				echo "-----------------------------------------------------------------------"
	
				if [ "${ISOSX}" = "1" -a "" != "${OSASCRIPT}" ]; then
					echo "Displaying dialog.."
					${OSASCRIPT} -e 'tell application "System Events"' -e "activate" -e "display dialog \"${1}\n${2}\" buttons {\"Ok\"} giving up after 120 with icon note" -e 'end tell'
				else
					if [ "" != "${ISKDE}" -a "" != "${KDIALOG}" -a "" != "${DISPLAY}" ]; then
						echo "Dialog on Display: ${DISPLAY}"
						${KDIALOG} --title "DMDirc: \${1}" --msgbox "\${1}\n\n\${2}"
					elif [ "" != "${ISGNOME}" -a "" != "${ZENITY}" -a "" != "${DISPLAY}" ]; then
						echo "Dialog on Display: ${DISPLAY}"
						${ZENITY} --info --title "DMDirc: \${1}" --text "\${1}\n\n\${2}"
					fi
				fi;
			}
		fi;

		mv -fv ${profiledir}/.launcher.sh ${0}
		if [ ! -e "${profiledir}/.launcher.sh" ]; then
			echo "Launcher Update successful."
			messagedialog "Launcher Update" "Launcher Update successful"
		else
			if [ "${UID}" = "" ]; then
				UID=`id -u`;
			fi
			if [ "0" != "${UID}" ]; then
				if [ "${ISOSX}" = "1" ]; then
					messagedialog "DMDirc" "The DMDirc Client Updater was unable to modify the client installation, trying again with administrator access"
					if [ $? -eq 0 ]; then
						echo "Password dialog on display"
						osascript -e do shell script "mv -fv \"${profiledir}/.launcher.sh\" \"${0}\"" with administrator privileges
					fi;
				else
					if [ "" != "${ISKDE}" -a "" != "${KSUDO}" -a "" != "${DISPLAY}" ]; then
						echo "Password dialog on ${DISPLAY}"
						${KSUDO} --comment "DMDirc Client Updater requires root access to modify the global installation" -- mv -fv "${profiledir}/.launcher.sh" "${0}"
					elif [ "" != "${ISGNOME}" -a "" != "${GSUDO}" -a "" != "${DISPLAY}" ]; then
						echo "Password dialog on ${DISPLAY}"
						${GSUDO} -k --message "DMDirc Client Updater requires root access to modify the global installation" -- mv -fv "${profiledir}/.launcher.sh" "${0}"
					elif [ "" != "${ZENITY}" -a "" != "${DISPLAY}" ]; then	
						sudo -k
						${ZENITY} --entry --title="DMDirc" --text="DMDirc Client Updater requires root access to modify the global installation, please enter your password to continue." --entry-text="" --hide-text | sudo -S -- mv -fv "${profiledir}/.launcher.sh" "${0}"
					else
						echo "DMDirc Client Updater requires root access to modify the global installation"
						sudo mv -fv "${profiledir}/.launcher.sh" "${0}"
					fi;
				fi;
			fi
			if [ ! -e "${profiledir}/.launcher.sh" ]; then
				echo "Update successful."
				messagedialog "Launcher Update" "Launcher Update successful"
			else
				echo "Launcher failed."
				errordialog "Launcher Update" "Launcher Update failed, using old version"
				touch ${profiledir}/.launcher.sh.ignore
			fi;
		fi;
		sh ${0} ${params}
EOF
	chmod a+x ${launcherUpdater}
	${launcherUpdater}
	exit 0;
else
	echo "Not found.";
fi;

if [ -e "${launcherUpdater}" ]; then
	rm -Rf "${launcherUpdater}"
fi;

echo -n "Checking for client updates in ${profiledir} - ";

UPDATESOURCE="${profiledir}/.DMDirc.jar"
BSDIFF="0"
if [ -e "${profiledir}/.DMDirc.jar.bsdiff" -a "${BSPATCH}" != "" ]; then
	UPDATESOURCE="${profiledir}/.DMDirc.jar.bsdiff"
	BSDIFF="1"
fi;

if [ -e "${UPDATESOURCE}" ]; then
	UPDATEOK="0"
	TRYROOT="1"
	echo "Found!";
	echo "Attempting to update..";
	if [ "${BSDIFF}" = "1" ]; then
		cp ${jar} ${jar}.bak
		${BSPATCH} ${jar}.bak ${jar} ${UPDATESOURCE}
		if [ "${?}" = "0" ]; then
			FILEINFO=`which ${jar} | egrep "data$"`
			if [ "${FILEINFO}" = "" ]; then
				UPDATEOK="1"
			else
				# Let the user know the update failed.
				echo "1" >> "${profiledir}/.updatefailed";
				chmod 777 "${profiledir}/.updatefailed";
				# Replace the attempted update with the old jar
				cp ${jar}.bak ${jar}
				# Don't bother trying as root.
				TRYROOT="0"
			fi;
		fi;
	else
		mv -fv ${UPDATESOURCE} ${jar}
		if [ ! -e "${profiledir}/.DMDirc.jar" ]; then
			UPDATEOK="1"
		fi;
	fi;
	
	if [ "${UPDATEOK}" = "1" ]; then
		echo "Update successful."
		messagedialog "Client Update" "Client Update successful"
		if [ "${UPDATEONLY}" = "1" ]; then
			exit 0;
		fi;
	else
		if [ "${UID}" = "" ]; then
			UID=`id -u`;
		fi
		if [ "0" != "${UID}" -a "1" = "${TRYROOT}" ]; then
			if [ "${ISOSX}" = "1" ]; then
				messagedialog "DMDirc" "The DMDirc Client Updater was unable to modify the client installation, trying again with administrator access"
				if [ $? -eq 0 ]; then
					echo "Password dialog on display"
					# osascript -e "do shell script \"mv -fv \\\"${profiledir}/.DMDirc.jar\\\" \\\"${jar}\\\"\" with administrator privileges"
					osascript -e "do shell script \"sh ${0} ${params} -d "${profiledir}" --updateonly\" with administrator privileges"
				fi;
			else
				if [ "" != "${ISKDE}" -a "" != "${KSUDO}" -a "" != "${DISPLAY}" ]; then
					echo "Password dialog on ${DISPLAY}"
					# ${KSUDO} --comment "DMDirc Client Updater requires root access to modify the global installation" -- mv -fv "${profiledir}/.DMDirc.jar" "${jar}"
					${KSUDO} --comment "DMDirc Client Updater requires root access to modify the global installation" -- sh ${0} ${params} -d "${profiledir}" --updateonly
				elif [ "" != "${ISGNOME}" -a "" != "${GSUDO}" -a "" != "${DISPLAY}" ]; then
					echo "Password dialog on ${DISPLAY}"
					# ${GSUDO} -k --message "DMDirc Client Updater requires root access to modify the global installation" -- mv -fv "${profiledir}/.DMDirc.jar" "${jar}"
					${GSUDO} -k --message "DMDirc Client Updater requires root access to modify the global installation" -- sh ${0} ${params} -d "${profiledir}" --updateonly
				elif [ "" != "${ZENITY}" -a "" != "${DISPLAY}" ]; then	
					sudo -k
					${ZENITY} --entry --title="DMDirc" --text="DMDirc Client Updater requires root access to modify the global installation, please enter your password to continue." --entry-text="" --hide-text | sudo -S -- sh ${0} ${params} -d "${profiledir}" --updateonly
				else
					echo "DMDirc Client Updater requires root access to modify the global installation"
					# sudo mv -fv "${profiledir}/.DMDirc.jar" "${jar}"
					sudo sh ${0} ${params} -d "${profiledir}" --updateonly
				fi;
			fi;
		elif [ "${UPDATEONLY}" = "1" ]; then
			# Update failed as root, so give up.
			echo "1" >> "${profiledir}/.updatefailed";
			chmod 777 "${profiledir}/.updatefailed";
			exit 1;
		fi;
		
		if [ ! -e "${profiledir}/.updatefailed" ]; then
			echo "Update successful."
			messagedialog "Client Update" "Client Update successful"
		else
			rm -Rf ${profiledir}/.updatefailed;
			echo "Update failed."
			errordialog "Client Update" "Client Update failed, using old version"
			if [ "${BSDIFF}" = "1" ]; then
				# Run the client without bspatch support
				LAUNCHERINFO=`echo ${LAUNCHERINFO} | sed 's/|bsdiff//'`
			fi;
		fi;
	fi
else
	echo "Not found.";
fi;

if [ "${UPDATEONLY}" = "1" ]; then
	exit 0;
fi;

relaunch() {
	trap - INT TERM EXIT
	echo ""
	echo "============================================================="
	echo "ERROR"
	echo "============================================================="
	echo "${HOME}/.profile has errors in it (or an 'exit' command)."
	echo "Setup will now restart with the --noprofile option."
	echo "============================================================="
	sh ${0} ${params} --noprofile
}

echo -n "Looking for java - ";
if [ "${ISOSX}" = "1" ]; then
	JAVA=`which java`
	if [ -e "/System/Library/Frameworks/JavaVM.framework/Versions/1.6.0/Commands/java" ]; then
		JAVA="/System/Library/Frameworks/JavaVM.framework/Versions/1.6.0/Commands/java"
	elif [ -e "/System/Library/Frameworks/JavaVM.framework/Versions/1.6/Commands/java" ]; then
		JAVA="/System/Library/Frameworks/JavaVM.framework/Versions/1.6/Commands/java"
	fi;
else
	if [ -e "${HOME}/.profile" -a "${USEPROFILE}" = "1" ]; then
		# Source the profile incase java can't be found otherwise
		trap relaunch INT TERM EXIT
		. ${HOME}/.profile
		trap - INT TERM EXIT
	fi;
	JAVA=`which java`
	if [ ! -e "${JAVA}" ]; then
		# Location where ports on FreeBSD/PCBSD installs java6
		# check it first, because it isn't added to the path automatically
		JAVA=${BSDJava1}
		if [ ! -e "${JAVA}" ]; then
			# Try alternative BSD Location
			JAVA=${BSDJava2}
		fi;
	fi;
fi;

if [ "" != "${JAVA}" ]; then
	echo "Success! (${JAVA})"
else
	echo "Failed!"
	ERROR="Sorry, java does not appear to be installed on this machine.";
	ERROR=${ERROR}"\n"
	if [ "${ISOSX}" = "1" ]; then
		ERROR=${ERROR}"\nDMDirc requires a 1.6.0 compatible JVM.";
	else
		ERROR=${ERROR}"\nDMDirc requires a 1.6.0 compatible JVM, you can get one from: http://www.java.com";
		ERROR=${ERROR}"\nor reinstall DMDirc and let the installer install one for you.";
	fi;
	errordialog "Unable to launch dmdirc!" "${ERROR}";
	exit 1;
fi

echo -n "Running DMDirc - "
if [ -e "${jar}" ]; then
	# Check that DMDirc will run, if java is not 1.6 this will fail.
	# We do it this way otherwise segfaults etc would cause an unable to launch
	# error message to be printed.
	${JAVA} -jar ${jar} --help >/dev/null 2>&1
	if [ $? -ne 0 ]; then
		FAILED=1
		# If we are on BSD, check to see if there is alternative versions of java
		# than the one in the path.
		if [ "`echo ${KERNEL} | grep -i BSD`" != "" ]; then
			if [ "${JAVA}" != "${BSDJava1}" -a "${JAVA}" != "${BSDJava2}" ]; then
				JAVA=${BSDJava1}
				if [ ! -e "${JAVA}" ]; then
					JAVA=${BSDJava2}
				fi;
				# Now check to see if DMDirc runs again.
				${JAVA} -jar ${jar} --help >/dev/null 2>&1
				if [ $? -eq 0 ]; then
					# It runs!
					FAILED=0
				fi;
			fi;
		fi;
		if [ ${FAILED} -eq 1 ]; then
			echo "Failed."
			ERROR="Sorry, the currently installed version of java is not compatible with DMDirc.";
			ERROR=${ERROR}"\n";
			if [ "${ISOSX}" = "1" ]; then
				ERROR=${ERROR}"\nDMDirc requires a 1.6.0 compatible JVM.";
			else
				ERROR=${ERROR}"\nDMDirc requires a 1.6.0 compatible JVM, you can get one from: http://www.java.com";
				ERROR=${ERROR}"\nor reinstall DMDirc and let the installer install one for you.";
			fi;
			errordialog "Unable to launch dmdirc!" "${ERROR}";
			exit 1;
		fi;
	fi

	# Now we can run the client for real, this allows stderr/stdout output
	# to be seen, and the shell script exits with the correct exit code.
	APPLEOPTS=""
	if [ "${ISOSX}" = "1" ]; then
		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"
		#APPLEOPTS="${APPLEOPTS} -Dapple.awt.showGrowBox=true"
		#APPLEOPTS="${APPLEOPTS} -Dapple.laf.useScreenMenuBar=true"
	fi;
	${JAVA}${APPLEOPTS} -ea -jar ${jar} -l ${LAUNCHERINFO} ${params}
	EXITCODE=${?}
	if [ ${EXITCODE} -eq 42 ]; then
		# The client says we need to up update, rerun ourself before exiting.
		${0} ${params}
	fi;
	exit ${EXITCODE};
else
	echo "Failed.";
	errordialog "Unable to launch dmdirc!" "No jar file found";
fi