plugins/osx-timemachine: `shellcheck` && `shfmt`

Use bash functionality rather than external binaries. Alsö, if $SUDO_ASKPASS is set then pass -A to sudo.

clean_files.txt

@@ -103,6 +103,7 @@ plugins/available/jump.plugin.bash
 plugins/available/less-pretty-cat.plugin.bash
 plugins/available/node.plugin.bash
 plugins/available/nodenv.plugin.bash
+plugins/available/osx-timemachine.plugin.bash
 plugins/available/osx.plugin.bash
 plugins/available/percol.plugin.bash
 plugins/available/plenv.plugin.bash

plugins/available/osx-timemachine.plugin.bash

@@ -1,84 +1,94 @@
-cite about-plugin
+# shellcheck shell=bash
 about-plugin 'OS X Time Machine functions'
 
-function time-machine-destination() {
+if [[ "${OSTYPE}" != 'darwin'* ]]; then
-  group "osx-timemachine"
+	_log_warning "This plugin only works with Mac OS X"
-  about "Shows the OS X Time Machine destination/mount point"
+	return 1
+fi
 
-  echo $(tmutil destinationinfo | grep "Mount Point" | sed -e 's/Mount Point   : \(.*\)/\1/g')
+function time-machine-destination() {
+	group "osx-timemachine"
+	about "Shows the OS X Time Machine destination/mount point"
+
+	tmutil destinationinfo | grep "Mount Point" | sed -e 's/Mount Point   : \(.*\)/\1/g'
 }
 
 function time-machine-list-machines() {
-  group "osx-timemachine"
+	group "osx-timemachine"
-  about "Lists the OS X Time Machine machines on the backup volume"
+	about "Lists the OS X Time Machine machines on the backup volume"
 
-  local tmdest="$(time-machine-destination)/Backups.backupdb"
+	local tmdest
+	tmdest="$(time-machine-destination)/Backups.backupdb"
 
-  find "$tmdest" -maxdepth 1 -mindepth 1 -type d | grep -v "/\." | while read line ; do
+	find "$tmdest" -maxdepth 1 -mindepth 1 -type d | grep -v "/\." | while read -r line; do
-    echo "${line##*/}"
+		echo "${line##*/}"
-  done
+	done
 }
 
 function time-machine-list-all-backups() {
-  group "osx-timemachine"
+	group "osx-timemachine"
-  about "Shows all of the backups for the specified machine"
+	about "Shows all of the backups for the specified machine"
-  param "1: Machine name (optional)"
+	param "1: Machine name (optional)"
-  example "time-machine-list-all-backups my-laptop"
+	example "time-machine-list-all-backups my-laptop"
 
-  # Use the local hostname if none provided
+	# Use the local hostname if none provided
-  local COMPUTERNAME=${1:-$(scutil --get ComputerName)}
+	local COMPUTERNAME BACKUP_LOCATION
-  local BACKUP_LOCATION="$(time-machine-destination)/Backups.backupdb/$COMPUTERNAME"
+	COMPUTERNAME=${1:-$(scutil --get ComputerName)}
+	BACKUP_LOCATION="$(time-machine-destination)/Backups.backupdb/$COMPUTERNAME"
 
-  find "$BACKUP_LOCATION" -maxdepth 1 -mindepth 1 -type d | while read line ; do
+	find "$BACKUP_LOCATION" -maxdepth 1 -mindepth 1 -type d | while read -r line; do
-    echo "$line"
+		echo "$line"
-  done
+	done
 }
 
 function time-machine-list-old-backups() {
-  group "osx-timemachine"
+	group "osx-timemachine"
-  about "Shows all of the backups for the specified machine, except for the most recent backup"
+	about "Shows all of the backups for the specified machine, except for the most recent backup"
-  param "1: Machine name (optional)"
+	param "1: Machine name (optional)"
-  example "time-machine-list-old-backups my-laptop"
+	example "time-machine-list-old-backups my-laptop"
 
-  # Use the local hostname if none provided
+	# Use the local hostname if none provided
-  local COMPUTERNAME=${1:-$(scutil --get ComputerName)}
+	local COMPUTERNAME BACKUP_LOCATION
-  local BACKUP_LOCATION="$(time-machine-destination)/Backups.backupdb/$COMPUTERNAME"
+	COMPUTERNAME=${1:-$(scutil --get ComputerName)}
+	BACKUP_LOCATION="$(time-machine-destination)/Backups.backupdb/$COMPUTERNAME"
 
-  # List all but the most recent one
+	# List all but the most recent one
-  find "$BACKUP_LOCATION" -maxdepth 1 -mindepth 1 -type d -name 2\* | sed \$d | while read line ; do
+	find "$BACKUP_LOCATION" -maxdepth 1 -mindepth 1 -type d -name 2\* | sed \$d | while read -r line; do
-    echo "$line"
+		echo "$line"
-  done
+	done
 }
 
 # Taken from here: http://stackoverflow.com/a/30547074/1228454
 function _tm_startsudo() {
-    sudo -v
+	sudo -v # validate without running a command.
-    ( while true; do sudo -v; sleep 50; done; ) &
+	(while sudo "-${SUDO_ASKPASS:+A}v"; do
-    SUDO_PID="$!"
+		sleep 50
-    trap _tm_stopsudo SIGINT SIGTERM
+	done) &
+	SUDO_PID="$!"
+	trap _tm_stopsudo SIGINT SIGTERM
 }
 function _tm_stopsudo() {
-    kill "$SUDO_PID"
+	kill "$SUDO_PID"
-    trap - SIGINT SIGTERM
+	trap - SIGINT SIGTERM
-    sudo -k
+	sudo -k
 }
 
 function time-machine-delete-old-backups() {
-  group "osx-timemachine"
+	group "osx-timemachine"
-  about "Deletes all of the backups for the specified machine, with the exception of the most recent one"
+	about "Deletes all of the backups for the specified machine, with the exception of the most recent one"
-  param "1: Machine name (optional)"
+	param "1: Machine name (optional)"
-  example "time-machine-delete-old-backups my-laptop"
+	example "time-machine-delete-old-backups my-laptop"
 
-  # Use the local hostname if none provided
+	# Use the local hostname if none provided
-  local COMPUTERNAME=${1:-$(scutil --get ComputerName)}
+	local COMPUTERNAME=${1:-$(scutil --get ComputerName)} _old_backup
 
-  # Ask for sudo credentials only once
+	# Ask for sudo credentials only once
-  _tm_startsudo
+	_tm_startsudo
 
-  echo "$(time-machine-list-old-backups "$COMPUTERNAME")" | while read i ; do
+	while read -r _old_backup; do
-    # Delete the backup
+		# Delete the backup
-    sudo tmutil delete "$i"
+		sudo tmutil delete "$_old_backup"
-  done
+	done <<< "$(time-machine-list-old-backups "$COMPUTERNAME")"
 
-  _tm_stopsudo
+	_tm_stopsudo
 }