Remove Office 2011

#!/bin/sh
#set -x

TOOL_NAME="Microsoft Office 2011 for Mac Removal Tool"
TOOL_VERSION="1.4"

## Copyright (c) 2017 Microsoft Corp. All rights reserved.
## Scripts are not supported under any Microsoft standard support program or service. The scripts are provided AS IS without warranty of any kind.
## Microsoft disclaims all implied warranties including, without limitation, any implied warranties of merchantability or of fitness for a 
## particular purpose. The entire risk arising out of the use or performance of the scripts and documentation remains with you. In no event shall
## Microsoft, its authors, or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever 
## (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary 
## loss) arising out of the use of or inability to use the sample scripts or documentation, even if Microsoft has been advised of the possibility
## of such damages.

## Set up logging
# All stdout and sterr will go to the log file. Console alone can be accessed through >&3. For console and log use | tee /dev/fd/3
SCRIPT_NAME=$(basename "$0")
WORKING_FOLDER=$(dirname "$0")
LOG_FILE="$TMPDIR""$SCRIPT_NAME.log"
touch "$LOG_FILE"
exec 3>&1 1>>${LOG_FILE} 2>&1

## Formatting support
TEXT_RED='\033[0;31m'
TEXT_YELLOW='\033[0;33m'
TEXT_GREEN='\033[0;32m'
TEXT_BLUE='\033[0;34m'
TEXT_NORMAL='\033[0m'

## Initialize global variables
FORCE_PERM=false
PRESERVE_DATA=true
APP_RUNNING=false
KEEP_LYNC=false
SAVE_LICENSE=false

## Path constants
PATH_OFFICE2011="/Applications/Microsoft Office 2011"
PATH_WORD2011="/Applications/Microsoft Office 2011/Microsoft Word.app"
PATH_EXCEL2011="/Applications/Microsoft Office 2011/Microsoft Excel.app"
PATH_PPT2011="/Applications/Microsoft Office 2011/Microsoft PowerPoint.app"
PATH_OUTLOOK2011="/Applications/Microsoft Office 2011/Microsoft Outlook.app"
PATH_LYNC2011="/Applications/Microsoft Lync.app"
PATH_MAU="/Library/Application Support/Microsoft/MAU2.0/Microsoft AutoUpdate.app"

## Functions
function LogMessage {
	echo $(date) "$*"
}

function ConsoleMessage {
	echo "$*" >&3
}

function FormattedConsoleMessage {
	FUNCDENT="$1"
	FUNCTEXT="$2"
	printf "$FUNCDENT" "$FUNCTEXT" >&3
}

function AllMessage {
	echo $(date) "$*"
	echo "$*" >&3
}

function LogDevice {
	LogMessage "In function 'LogDevice'"
	system_profiler SPSoftwareDataType -detailLevel mini
	system_profiler SPHardwareDataType -detailLevel mini
}

function ShowUsage {
	LogMessage "In function 'ShowUsage'"
	ConsoleMessage "Usage: $SCRIPT_NAME [--Force] [--Help] [--KeepLync] [--SaveLicense]"
	ConsoleMessage "Use --Force to bypass warnings and forcibly remove Office 2011 applications and data"
	ConsoleMessage ""
}

function GetDestructivePerm {
	LogMessage "In function 'GetDestructivePerm'"
	if [ $FORCE_PERM = false ]; then
		LogMessage "Script is not running with force - asking user for permission to continue"
		ConsoleMessage "${TEXT_RED}WARNING: This procedure will remove application and data files.${TEXT_NORMAL}"
		ConsoleMessage "${TEXT_RED}Be sure to have a backup before continuing.${TEXT_NORMAL}"
		ConsoleMessage "Do you wish to continue? (y/n)"
		read -p "" "GOAHEAD"
		if [ "$GOAHEAD" == "y" ] || [ "$GOAHEAD" == "Y" ]; then
			LogMessage "Destructive permissions granted by user"
			return
		else
			LogMessage "Destructive permissions DENIED by user"
			ConsoleMessage ""
			exit 0
		fi
	fi
}

function GetDestructiveDataPerm {
	LogMessage "In function 'GetDestructiveDataPerm'"
	if [ $FORCE_PERM = false ]; then
		LogMessage "Script is not running with force - asking user for permission to remove data files"
		ConsoleMessage "${TEXT_RED}This tool can either preserve or remove Outlook data files.${TEXT_NORMAL}"
		ConsoleMessage "Do you wish to preserve Outlook data? (y/n)"
		read -p "" "GOAHEAD"
		if [ "$GOAHEAD" == "y" ] || [ "$GOAHEAD" == "Y" ]; then
			LogMessage "User chose to preserve Outlook data"
			PRESERVE_DATA=true
		else
			LogMessage "User chose to remove Outlook data"
			PRESERVE_DATA=false
		fi
	fi
}

function GetDestructiveLicensePerm {
	LogMessage "In function 'GetDestructiveLicensePerm'"
	if [ $FORCE_PERM = false ]; then
		LogMessage "Script is not running with force - asking user for permission to remove license file"
		if [ $SAVE_LICENSE = false ]; then
			LogMessage "SAVE_LICENSE is false - asking user if they want to remove it"
			ConsoleMessage "${TEXT_RED}This tool can either preserve or remove your product activation license.${TEXT_NORMAL}"
			ConsoleMessage "Do you wish to preserve the license? (y/n)"
			read -p "" "GOAHEAD"
			if [ "$GOAHEAD" == "y" ] || [ "$GOAHEAD" == "Y" ]; then
				LogMessage "User chose to preserve the license"
				SAVE_LICENSE=true
			else
				LogMessage "User chose to remove the license"
				SAVE_LICENSE=false
			fi
		fi
	fi
}
function GetSudo {
	LogMessage "In function 'GetSudo'"
	if [ "$EUID" != "0" ]; then
		LogMessage "Script is not running as root - asking user for admin password"
		sudo -p "Enter administrator password: " echo
		if [ $? -eq 0 ] ; then
			LogMessage "Admin password entered successfully"
			ConsoleMessage ""
			return
		else
			LogMessage "Admin password is INCORRECT"
			exit 1
		fi
	fi
}

function CheckRunning {
	FUNCPROC="$1"
	LogMessage "In function 'CheckRunning' with argument $FUNCPROC"
	local RUNNING_RESULT=$(ps ax | grep -v grep | grep "$FUNCPROC")
	if [ "${#RUNNING_RESULT}" -gt 0 ]; then
		LogMessage "$FUNCPROC is currently running"
		APP_RUNNING=true
	fi
}

function CheckRunning2011 {
	LogMessage "In function 'CheckRunning2011'"
	CheckRunning "$PATH_WORD2011" "Word 2011"
	CheckRunning "$PATH_EXCEL2011" "Excel 2011"
	CheckRunning "$PATH_PPT2011" "PowerPoint 2011"
	CheckRunning "$PATH_OUTLOOK2011" "Outlook 2011"
	if [ $KEEP_LYNC = false ]; then 
		CheckRunning "$PATH_LYNC2011" "Lync 2011"
	fi
}

function Close2011 {
	LogMessage "In function 'Close2011'"
	if [ $FORCE_PERM = false ]; then
		LogMessage "Script is not running with force - asking user for permission to continue"
		GetForcePerms
	fi
	ForceQuit2011
}

function GetForcePerms {
	LogMessage "In function 'GetForcePerms'"
	ConsoleMessage "${TEXT_YELLOW}WARNING: Office applications are currently open and need to be closed.${TEXT_NORMAL}"
	ConsoleMessage "Do you want this program to forcibly close open applications? (y/n)"
	read -p "" "GOAHEAD"
	if [ "$GOAHEAD" == "y" ] || [ "$GOAHEAD" == "Y" ]; then
		LogMessage "User gave permission for the script to close running apps"
		FORCE_PERM=true
		ConsoleMessage ""
	else
		LogMessage "User DENIED permissions for the script to close running apps"
		ConsoleMessage ""
		exit 0
	fi
}

function ForceTerminate {
	FUNCPROC="$1"
	LogMessage "In function 'ForceTerminate' with argument $FUNCPROC"
	$(ps ax | grep -v grep | grep "$FUNCPROC" | cut -d' ' -f1 | xargs kill -9 2> /dev/null)
}

function ForceQuit2011 {
	LogMessage "In function 'ForceQuit2011'"
	FormattedConsoleMessage "%-55s" "Shutting down all Office 2011 applications"
	ForceTerminate "$PATH_WORD2011" "Word 2011"
	ForceTerminate "$PATH_EXCEL2011" "Excel 2011"
	ForceTerminate "$PATH_PPT2011" "PowerPoint 2011"
	ForceTerminate "$PATH_OUTLOOK2011" "Outlook 2011"
	if [ $KEEP_LYNC = false ]; then 
		ForceTerminate "$PATH_LYNC2011" "Lync 2011"
	fi
	ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
}

function RemoveComponent {
	FUNCPATH="$1"
	FUNCTEXT="$2"
	LogMessage "In function 'RemoveComponent with arguments $FUNCPATH and $FUNCTEXT'"
	FormattedConsoleMessage "%-55s" "Removing $FUNCTEXT"
	if [ -d "$FUNCPATH" ] || [ -e "$FUNCPATH" ] ; then
		LogMessage "Removing path $FUNCPATH"
		$(sudo rm -r -f "$FUNCPATH")
	else
		LogMessage "$FUNCPATH was not detected"
		ConsoleMessage "${TEXT_YELLOW}Not detected${TEXT_NORMAL}"
		return
	fi
	if [ -d "$FUNCPATH" ] || [ -e "$FUNCPATH" ] ; then
		LogMessage "Path $FUNCPATH still exists after deletion"
		ConsoleMessage "${TEXT_RED}Failed${TEXT_NORMAL}"
	else
		LogMessage "Path $FUNCPATH was successfully removed"
		ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
	fi
}

function PreserveComponent {
	FUNCPATH="$1"
	FUNCTEXT="$2"
	LogMessage "In function 'remove_PreserveComponent with arguments $FUNCPATH and $FUNCTEXT'"
	FormattedConsoleMessage "%-55s" "Preserving $FUNCTEXT"
	if [ -d "$FUNCPATH" ] || [ -e "$FUNCPATH" ] ; then
		LogMessage "Renaming path $FUNCPATH"
		$(sudo mv -fv "$FUNCPATH" "$FUNCPATH-Preserved")
	else
		LogMessage "$FUNCPATH was not detected"
		ConsoleMessage "${TEXT_YELLOW}Not detected${TEXT_NORMAL}"
		return
	fi
	if [ -d "$FUNCPATH" ] || [ -e "$FUNCPATH" ] ; then
		LogMessage "Path $FUNCPATH still exists after rename"
		ConsoleMessage "${TEXT_RED}Failed${TEXT_NORMAL}"
	else
		LogMessage "Path $FUNCPATH was successfully renamed"
		ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
	fi
}

function Remove2011Receipts {
	LogMessage "In function 'Remove2011Receipts'"
	FormattedConsoleMessage "%-55s" "Removing Package Receipts"
	RECEIPTCOUNT=0
	RemoveReceipt "com.microsoft.office.all.*"
	RemoveReceipt "com.microsoft.office.en.*"
	RemoveReceipt "com.microsoft.merp.*"
	RemoveReceipt "com.microsoft.mau.*"
	if (( $RECEIPTCOUNT > 0 )) ; then
		ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
	else
		ConsoleMessage "${TEXT_YELLOW}Not detected${TEXT_NORMAL}"
	fi
}

function RemoveReceipt {
	FUNCPATH="$1"
	LogMessage "In function 'RemoveReceipt' with argument $FUNCPATH"
	PKGARRAY=($(pkgutil --pkgs=$FUNCPATH))
	for p in "${PKGARRAY[@]}"
	do
		LogMessage "Forgetting package $p"
		sudo pkgutil --forget $p
		if [ $? -eq 0 ] ; then
			((RECEIPTCOUNT++))
		fi
	done
}

function Remove2011Preferences {
	LogMessage "In function 'Remove2011Preferences'"
	FormattedConsoleMessage "%-55s" "Removing Preferences"
	PREFCOUNT=0
	RemovePref "/Library/Preferences/com.microsoft.Word.plist"
	RemovePref "/Library/Preferences/com.microsoft.Excel.plist"
	RemovePref "/Library/Preferences/com.microsoft.Powerpoint.plist"
	RemovePref "/Library/Preferences/com.microsoft.Outlook.plist"
	RemovePref "/Library/Preferences/com.microsoft.outlook.databasedaemon.plist"
	RemovePref "/Library/Preferences/com.microsoft.DocumentConnection.plist"
	RemovePref "/Library/Preferences/com.microsoft.office.setupassistant.plist"
	RemovePref "/Users/*/Library/Preferences/com.microsoft.Word.plist"
	RemovePref "/Users/*/Library/Preferences/com.microsoft.Excel.plist"
	RemovePref "/Users/*/Library/Preferences/com.microsoft.Powerpoint.plist"
	if [ $KEEP_LYNC = false ]; then 
		RemovePref "/Users/*/Library/Preferences/com.microsoft.Lync.plist"
	fi
	RemovePref "/Users/*/Library/Preferences/com.microsoft.Outlook.plist"
	RemovePref "/Users/*/Library/Preferences/com.microsoft.outlook.databasedaemon.plist"
	RemovePref "/Users/*/Library/Preferences/com.microsoft.outlook.office_reminders.plist"
	RemovePref "/Users/*/Library/Preferences/com.microsoft.DocumentConnection.plist"
	RemovePref "/Users/*/Library/Preferences/com.microsoft.office.setupassistant.plist"
	RemovePref "/Users/*/Library/Preferences/com.microsoft.office.plist"
	RemovePref "/Users/*/Library/Preferences/com.microsoft.error_reporting.plist"
	RemovePref "/Users/*/Library/Preferences/ByHost/com.microsoft.Word.*.plist"
	RemovePref "/Users/*/Library/Preferences/ByHost/com.microsoft.Excel.*.plist"
	RemovePref "/Users/*/Library/Preferences/ByHost/com.microsoft.Powerpoint.*.plist"
	RemovePref "/Users/*/Library/Preferences/ByHost/com.microsoft.Outlook.*.plist"
	RemovePref "/Users/*/Library/Preferences/ByHost/com.microsoft.outlook.databasedaemon.*.plist"
	RemovePref "/Users/*/Library/Preferences/ByHost/com.microsoft.DocumentConnection.*.plist"
	RemovePref "/Users/*/Library/Preferences/ByHost/com.microsoft.office.setupassistant.*.plist"
	RemovePref "/Users/*/Library/Preferences/ByHost/com.microsoft.registrationDB.*.plist"
	RemovePref "/Users/*/Library/Preferences/ByHost/com.microsoft.e0Q*.*.plist"
	RemovePref "/Users/*/Library/Preferences/ByHost/com.microsoft.Office365.*.plist"
	if [ $KEEP_LYNC = false ]; then 
		RemovePref "/Users/*/Library/Preferences/ByHost/MicrosoftLyncRegistrationDB.*.plist"
	fi
	if (( $PREFCOUNT > 0 )); then
		ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
	else
		ConsoleMessage "${TEXT_YELLOW}Not detected${TEXT_NORMAL}"
	fi
}

function RemovePref {
	FUNCPATH="$1"
	LogMessage "In function 'RemovePref' with argument $FUNCPATH"
	ls $FUNCPATH
	if [ $? -eq 0 ] ; then
		LogMessage "Found preference $FUNCPATH"
		$(sudo rm -f $FUNCPATH)
		if [ $? -eq 0 ] ; then
			LogMessage "Preference $FUNCPATH removed"
			((PREFCOUNT++))
		else
			LogMessage "Preference $FUNCPATH could NOT be removed"
		fi
	fi
}

function CleanDock {
	LogMessage "In function 'CleanDock'"
	FormattedConsoleMessage "%-55s" "Cleaning icons in dock"
	if [ -e "$WORKING_FOLDER/dockutil" ]; then
		LogMessage "Found DockUtil tool"
		sudo "$WORKING_FOLDER"/dockutil --remove "file:///Applications/Microsoft%20Office%202011/Microsoft%20Document%20Connection.app/" --no-restart
		sudo "$WORKING_FOLDER"/dockutil --remove "file:///Applications/Microsoft%20Office%202011/Microsoft%20Word.app/" --no-restart
		sudo "$WORKING_FOLDER"/dockutil --remove "file:///Applications/Microsoft%20Office%202011/Microsoft%20Excel.app/" --no-restart
		sudo "$WORKING_FOLDER"/dockutil --remove "file:///Applications/Microsoft%20Office%202011/Microsoft%20PowerPoint.app/" --no-restart
		if [ $KEEP_LYNC = false ]; then 
			sudo "$WORKING_FOLDER"/dockutil --remove "file:///Applications/Microsoft%20Office%202011/Microsoft%20Lync.app/" --no-restart
		fi
		sudo "$WORKING_FOLDER"/dockutil --remove "file:///Applications/Microsoft%20Office%202011/Microsoft%20Outlook.app/"
		LogMessage "Completed dock clean-up"
		ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
	else
		ConsoleMessage "${TEXT_YELLOW}Not detected${TEXT_NORMAL}"
	fi
}

function RelaunchCFPrefs {
	LogMessage "In function 'RelaunchCFPrefs'"
	FormattedConsoleMessage "%-55s" "Restarting Preferences Daemon"
	sudo ps ax | grep -v grep | grep "cfprefsd" | cut -d' ' -f1 | xargs sudo kill -9
	if [ $? -eq 0 ] ; then
		LogMessage "Successfully terminated all preferences daemons"
		ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
	else
		LogMessage "FAILED to terminate all preferences daemons"
		ConsoleMessage "${TEXT_RED}Failed${TEXT_NORMAL}"
	fi
}

function MainLoop {
	LogMessage "In function 'MainLoop'"
	# Show warning about destructive behavior of the script and ask for permission to continue
	GetDestructivePerm
	GetDestructiveDataPerm
	GetDestructiveLicensePerm
	# If appropriate, elevate permissions so the script can perform all actions
	GetSudo
	# Check to see if any of the 2011 apps are currently open
	CheckRunning2011
	if [ $APP_RUNNING = true ]; then
		LogMessage "One of more 2011 apps are running"
		Close2011
	fi
	# Remove Office 2011 apps
	RemoveComponent "$PATH_OFFICE2011" "Office 2011 Applications"
	if [ $KEEP_LYNC = false ]; then 
		RemoveComponent "$PATH_LYNC2011" "Lync"
	fi
	
	# Remove Office 2011 helpers
	RemoveComponent "/Library/LaunchDaemons/com.microsoft.office.licensing.helper.plist" "Launch Daemon: Licensing Helper"
	RemoveComponent "/Library/PrivilegedHelperTools/com.microsoft.office.licensing.helper" "Helper Tools: Licensing Helper"
	# Remove Office 2011 fonts
	RemoveComponent "/Library/Fonts/Microsoft" "Office Fonts"
	# Remove Office 2011 license
	if [ $SAVE_LICENSE = false ]; then
		LogMessage "SAVE_LICENSE is false - removing license file"
		RemoveComponent "/Library/Preferences/com.microsoft.office.licensing.plist" "Product License"
	fi
	# Remove Office 2011 application support
	RemoveComponent "/Library/Application Support/Microsoft/MERP2.0" "Error Reporting"
	RemoveComponent "/Users/*/Library/Application Support/Microsoft/Office" "Application Support"
	# Remove Office 2011 caches
	RemoveComponent "/Users/*/Library/Caches/com.microsoft.browserfont.cache" "Browser Font Cache"
	RemoveComponent "/Users/*/Library/Caches/com.microsoft.office.setupassistant" "Setup Assistant Cache"
	RemoveComponent "/Users/*/Library/Caches/Microsoft/Office" "Office Cache"
	RemoveComponent "/Users/*/Library/Caches/Outlook" "Outlook Identity Cache"
	RemoveComponent "/Users/*/Library/Caches/com.microsoft.Outlook" "Outlook Cache"
	# Remove Office 2011 preferences
	Remove2011Preferences
	# Remove or rename Outlook 2011 identities and databases
	if [ $PRESERVE_DATA = false ]; then
		RemoveComponent "/Users/*/Documents/Microsoft User Data/Office 2011 Identities" "Outlook Identities and Databases"
		RemoveComponent "/Users/*/Documents/Microsoft User Data/Saved Attachments" "Outlook Saved Attachments"
		RemoveComponent "/Users/*/Documents/Microsoft User Data/Outlook Sound Sets" "Outlook Sound Sets"
	else
		PreserveComponent "/Users/*/Documents/Microsoft User Data/Office 2011 Identities" "Outlook Identities and Databases"
		PreserveComponent "/Users/*/Documents/Microsoft User Data/Saved Attachments" "Outlook Saved Attachments"
		PreserveComponent "/Users/*/Documents/Microsoft User Data/Outlook Sound Sets" "Outlook Sound Sets"
	fi
	# Remove Office 2011 package receipts
	Remove2011Receipts
	# Clean up icons on the dock not available without the dockutil command-line utility installed.
	# CleanDock
	# Restart cfprefs
	RelaunchCFPrefs
}

## Main
LogMessage "Starting $SCRIPT_NAME"
AllMessage "${TEXT_BLUE}=== $TOOL_NAME $TOOL_VERSION ===${TEXT_NORMAL}"
LogDevice

# Evaluate command-line arguments
if [[ $# = 0 ]]; then
	LogMessage "No command-line arguments passed, going into interactive mode"
	MainLoop
else
	LogMessage "Command-line arguments passed, attempting to parse"
	while [[ $# > 0 ]]
	do
	key="$1"
	LogMessage "Argument: $key"
	case "$key" in
    	--Help|-h|--help)
    	ShowUsage
    	exit 0
	shift # past argument
    	;;
    	--Force|-f|--force)
    	LogMessage "Force mode set to TRUE"
    	FORCE_PERM=true
    	shift # past argument
    	;;
    	--KeepLync|-k|--keeplync)
    	LogMessage "Keep Lync set to TRUE"
    	KEEP_LYNC=true
    	shift # past argument
    	;;
    	--SaveLicense|-s|--savelicense)
    	LogMessage "SaveLicense set to TRUE"
    	SAVE_LICENSE=true
    	shift # past argument
    	;;
    	*)
    	ShowUsage
    	echo "Ignoring unrecognized argument: $key"
    	;;
	esac
	shift # past argument or value
	done
	MainLoop
fi

ConsoleMessage ""
ConsoleMessage "All events and errors were logged to $LOG_FILE"
ConsoleMessage ""
LogMessage "Exiting script"
exit 0