packageManager.sh

#!/bin/bash
#
# packageManager.sh, a.k.a pm - A universal package manager script
#
# Changes:
# v1.2.11
# - Took away sudo, added it to pmCF.sh
# - Now warns user when trying to run as sudo. Can be overridden with -o
# - Side note: I love the fact the last real update to this was almost a year ago lol
# - Script now returns incremental value based on number of errors, coincides with changes to pmCF.sh
#
# v1.2.10
# - Removed some changelog to comply with new rules
#
# v1.2.9
# - Added $shortName and $longName for logging purposes
#
# v1.2.8
# - Fixed an issue preventing program installation from folders from working
#
# v1.2.7
# - After some extensive testing and StackOverflow research, installing from files/directories FINALLY works as planned!
#
# v1.2.6
# - Fixed installation from folder issues incurred from last update
# - Editing text files now edits and deletes a tmp file so main files are not disrupted
# - Added msfupdate to updateOthers()
# - Select commands will now trigger updateOthers(), making it semi-usable!
#
# v1.2.5
# - Switched from a while loop to a for loop, solved the folder installation issues
#
# v1.2.4
# - Fixed adding options (hopefully)
# - no-confirm actually does something now, and should work as well
# - Added a couple of common shorcuts I have become used to using this script the past few weeks (fu, fuc)
# - Added support for updating Raspberry Pi firmware, npm and pip support coming soon
#
# v1.2.3
# - Adding options is broken, attempted a fix, but didn't have time to diagnose it more
#
# v1.2.2
# - Changed the way the script looks for privilege so query and pkginfo trigger the privilege check
#
# v1.2.1
# - Spaces break things. Removed offending spaces.
# - Script will now quit early if not root on most systems
#
# v1.2.0
# - Added option for -n|--no-confirm to reflect new default in pmCF.sh of non-interactive management
# - Gives warnings for dangerous -n cases
#
# v1.1.0
# - Install mode now works with files and folders of files, like programInstaller.sh
#
# v1.0.1
# - Some functions didn't work, fixed it with shift statements
#
# v1.0.0
# - Release version ready
# - Everything is in the processArgs() function
#
# TODO:
# - Code in distUpgrade() stuff
#
# v1.2.11, 10 Feb. 2018, 13:17 PST

### Variables

pmOptions="" # Options to be added when running package manager
#runMode="NULL"
program="NULL" # Uninitialized variables are unhappy variables
programMode="name"
confirm=0 # 0 Indicates no change, anything else indicates running noConfirm()
rtnValue=0 # Used to indicate any problems while installing
override=0 # Whether or not to suppress sudo/root error message

# Used for logging
longName="packageManager"
shortName="pm"

### Functions

if [[ -f commonFunctions.sh ]]; then
	source commonFunctions.sh
elif [[ -f /usr/share/commonFunctions.sh ]]; then
	source /usr/share/commonFunctions.sh
else
	echo "commonFunctions.sh could not be located!"
	
	# Comment/uncomment below depending on if script actually uses common functions
	echo "Script will now exit, please put file in same directory as script, or link to /usr/share!"
	exit 1
fi

function displayHelp() {
read -d '' helpVar <<"endHelp"

Usage: pm [options] <mode> [package(s)]
Note: For mode, you can use full names listed below, or single letter in brackets.

Run Modes:
   Re[f]resh                                 : Update the list of available packages and updates from package maintainer
   [U]pgrade                                 : Refresh the package list, and then install all available upgrades
   [I]nstall <package_1> [package_2] ...     : Attempt to install all given packages. Works with text files and directories as well!
   [R]emove <package_1> [package_2] ...      : Remove given installed packages
   [Q]uery <package_1> [package_2] ...       : Search package databases for matching package names (does not install)
   [P]kginfo <package_1> [package_2] ...     : Display detailed info (dependencies, version, etc) about packages
   [C]lean                                   : Clean the system of stale and unnecessary packages

Options:
   -h | --help                      : Display this help message
   -v | --verbose                   : Display detailed debugging info (note: MUST be first argument!)
   -o | --option <pm_option>        : Any options added here will be added when running the package manager
                                    : Use as many times as needed!
   -r | --override					: Suppresses error message and allows script to be run as sudo/root
   -n | --no-confirm                : Runs specified actions without prompting user to continue. Not supported by all PMs!
   
endHelp
echo "$helpVar"
}

function noConfirm() {
	[[ -z $program || "$program" == "NULL" ]] && determinePM
	
	case $program in
		apt)
		[[ -z $pmOptions ]] && pmOptions="--assume-yes" || pmOptions="$pmOptions ""--assume-yes"
		;;
		pacman)
		[[ -z $pmOptions ]] && pmOptions="--no-confirm" || pmOptions="$pmOptions ""--no-confirm"
		;;
		dnf|yum)
		[[ -z $pmOptions ]] && pmOptions="-y" || pmOptions="$pmOptions ""-y"
		;;
		zypper)
		[[ -z $pmOptions ]] && pmOptions="--non-interactive" || pmOptions="$pmOptions ""--non-interactive"
		;;
		*)
		# Emerge, slackpkg, rpm do not support assume-yes like commands
		debug "l2" "User specified to run in no-confirm mode, but $program doesn't support it!"
		;;
	esac
}

function processArgs() {
	# Make sure arguments is not empty
	if [[ -z $1 ]]; then
		debug "l2" "ERROR: $0 requires at least one argument to run!"
		displayHelp
		exit 1
	fi
	
	for var in "$@"
	do
		case "$var" in
			-h|--help)
			displayHelp
			exit 0
			;;
			-o|--option)
			if [[ -z $pmOptions ]]; then
				pmOptions="$2"
			else
				pmOptions="$pmOptions ""$2"
			fi
			shift
			;;
			-r|--override)
			debug "WARN: Enabling override for sudo/root users!"
			override=1
			;;
			-n|--no-confirm)
			confirm=1
			noConfirm
			;;
			fu|FU)
			#[[ "$program" != "pacman" ]] && checkPrivilege "exit"
			updatePM
			((rtnValue+=$?))
			upgradePM
			((rtnValue+=$?))
			updateOthers
			;;
			fuc|FUC)
			#[[ "$program" != "pacman" ]] && checkPrivilege "exit"
			updatePM
			((rtnValue+=$?))
			upgradePM
			((rtnValue+=$?))
			updateOthers
			if [[ $confirm -ne 0 ]]; then
				debug "Warning user against cleaning the package manager non-interactively..."
				announce "WARNING: It can be dangerous to clean package managers without confirmation!" "Script will continue shortly, but it is recommended to CTRL+C now!"
				sleep 5
			fi
			cleanPM
			((rtnValue+=$?))
			;;
			f|F|refresh|Refresh|update|Update) # Such alias.
			[[ "$program" != "pacman" ]] && checkPrivilege "exit" 
			updatePM
			((rtnValue+=$?))
			;;
			u|U|upgrade|Upgrade)
			[[ "$program" != "pacman" ]] && checkPrivilege "exit" 
			upgradePM
			((rtnValue+=$?))
			updateOthers
			;;
			c|C|clean|Clean)
			# Give a warning if running in non-interactive mode
			if [[ $confirm -ne 0 ]]; then
				debug "WARN: Warning user against cleaning the package manager non-interactively..."
				announce "WARNING: It can be dangerous to clean package managers without confirmation!" "Script will continue shortly, but it is recommended to CTRL+C now!"
				sleep 5
			fi
			
			#[[ "$program" != "pacman" ]] && checkPrivilege "exit" 
			cleanPM
			((rtnValue+=$?))
			;;
			i|I|install|Install)
			#[[ "$program" != "pacman" ]] && checkPrivilege "exit" 
			shift
			for prog in "$@"
			do
				programInstaller "$1"
				shift
			done
			;;
			r|R|remove|Remove)
			#[[ "$program" != "pacman" ]] && checkPrivilege "exit" 
			shift
			
			# Give a warning if running in non-interactive mode
			if [[ $confirm -ne 0 ]]; then
				debug "WARN: Warning user against removing programs non-interactively..."
				announce "WARNING: It is dangerous to remove programs without confirmation!" "Script will continue shortly, but it is highly recommended to CTRL+C now!"
				sleep 5
			fi
			
			for prog in "$@"
			do
				removePM "$1"
				((rtnValue+=$?))
				shift
			done
			;;
			q|Q|query|Query)
			shift
			for prog in "$@"
			do
				queryPM "$1"
				((rtnValue+=$?))
				shift
			done
			;;
			p|P|pkg*|Pkg*) # Hopefully this works the way I want, wild cards can be tricky
			shift
			for prog in "$@"
			do
				pkgInfo "$1"
				((rtnValue+=$?))
				shift
			done
			;;
		esac
		shift
	done
}

function programInstaller() {
	# Decide on mode
	if [[ -f $1 ]]; then
		debug "INFO: $1 is a file, running in file mode!"
		export file=$1
		export programMode="file"
	elif [[ -d $1 ]]; then
		debug "INFO: $1 is a folder, running in directory mode!"
		export file=$1
		export programMode="directory"
	else
		debug "INFO: Argument is not a file or folder, assuming $1 is a program!"
	fi
	
	# Now, install based on mode. Taken from the old programInstaller.sh
	case $programMode in
		file)
		announce "Now installing programs listed in $file!" "This may take a while depending on number of updates and internet speed" "Check $logFile for details"
		getUserAnswer "Would you like to edit $file before installing?"
		case $? in
			0)
			fileTMP="$file".tmp # Temp file, so main files are not edited
			cp "$file" "$fileTMP"
			editTextFile "$fileTMP"
			;;
			1)
			fileTMP="$file".tmp # Temp file, so main files are not edited
			cp "$file" "$fileTMP"
			debug "INFO: User chose not to edit $file"
			;;
			*)
			debug "ERROR: Unknown option: $?"
			announce "Error occurred! Please consult log!"
			((rtnValue++))
			exit 1
			;;
		esac
		#while read -r -u4 line; do
		#	[[ $line = \#* ]] && continue # Skips comment lines
		#	universalInstaller "$line"
		#done <$file
		
		OIFS=$IFS
		IFS=$'\n' # Change to IFS is necessary
		set -f # Disables globbing
		for line in $(cat $fileTMP); # Not sure why the community dislikes cat, but it works
		do
			[[ $line = \#* ]] && continue # Skips comment lines
			universalInstaller "$line"
			((rtnValue+=$?))
		done
		IFS=$OIFS # Reset IFS and globbing so the rest of the script doesn't break
		set +f
		
		rm "$fileTMP"
		;;
		directory)
		announce "Installing programs from files in directory $file!" "This WILL take a long time!" "Don't go anywhere, you will be asked if each section should be installed!"
		cd "$file"
		for list in *.txt;
		do
			debug "INFO: Asking user if they would like to install $list"
			getUserAnswer "Would you like to install the programs listed in $list?"
			if [[ $? -eq 1 ]]; then
				debug "WARN: Skipping $list at user's choice..."
			else
				# Ask if user wants to edit file before installing
				getUserAnswer "Would you like to edit $list before installing?"
				case $? in
				0)
				listTMP="$list".tmp # Temp file, so main files are not edited
				cp "$list" "$listTMP"
				editTextFile "$listTMP"
				;;
				1)
				listTMP="$list".tmp
				cp "$list" "$listTMP"
				debug "INFO: User chose not to edit $list"
				;;
				*)
				debug "ERROR: Unknown option: $?"
				announce "Error occurred! Please consult log!"
				exit 1
				;;
				esac

				#while read -r line; do
				#	[[ $line = \#* ]] && continue # Skips comment lines
				#	universalInstaller "$line"
				#done <"$list"
				
				OIFS=$IFS
				IFS=$'\n'
				set -f
				for line in $(cat "$listTMP");
				do
					[[ $line == \#* ]] && continue # Skips comment lines
					debug "INFO: Attempting to install $line"
					universalInstaller "$line"
					((rtnValue+=$?))
				done
				IFS=$OIFS
				set +f
				
				rm "$listTMP" # Leave no trace. Besides what the user wants, that is
			fi
		done
		[[ ! -z $OLDPWD ]] && cd "$OLDPWD" || cd .. # Return to previous location so other scripts don't break
		;;
		name)
		universalInstaller "$1"
		((rtnValue+=$?))
		;;
		*)
		debug "Everything is broken. Why. At least you have unique debug messages for an easy CTRL+F."
		exit 72
		;;
	esac
}

function updateOthers() {
	# Check to see if there are other installers/updaters, and offer to update them
	
	# rpi-update - Firmware updater for Raspberry Pi distros
	if [[ ! -z $(which rpi-update 2>/dev/null) ]]; then
		getUserAnswer "y" "Raspberry Pi detected, would you like to update firmware with rpi-update?"
		case $? in
			0)
			sudo rpi-update
			((rtnValue+=$?))
			;;
			1)
			false
			;;
			*)
			debug "l3" "ERROR: Unknown value from getUserAnswer()!"
			;;
		esac
	fi
	
	# Update Metasploit framework using msfupdate
	if [[ ! -z $(which msfupdate 2>/dev/null) ]]; then
		getUserAnswer "n" "Metasploit detected, would you like to update as well?"
		case $? in
			0)
			sudo msfupdate
			((rtnValue+=$?))
			;;
			1)
			false
			;;
			*)
			debug "l3" "ERROR: Unknown value from getUserAnswer()!"
			;;
		esac
	fi
}

### Main Script

# Warn users against running as root
if [[ "$EUID" -eq 0 && "$override" -eq 0 ]]; then
	debug "l2" "ERROR: Script was run as root without override, warning user"
	announce "ERROR: Please do not run $longName as sudo/root!" "Script will use sudo when necessary automatically" "You can override this with the -r|--override option. Exiting for now."
	exit 20 # That way [ -gt $x ] and [ -ne 0 ] work
fi

determinePM

processArgs "$@" # Didn't plan it this way, but awesome that everything work with this script

announce "Done with script!"
exit "$rtnValue"

#EOF