Controller script, pihole.sh added

Syntax changes for user output to be consistent

advanced/Scripts/blacklist.sh

@@ -11,15 +11,15 @@
 # (at your option) any later version.
 
 if [[ $# = 0 ]]; then
-    echo "Immediately blacklists one or more domains in the hosts file"
+    echo "::: Immediately blacklists one or more domains in the hosts file"
-    echo " "
+    echo ":::"
-    echo "Usage: blacklist.sh domain1 [domain2 ...]"
+    echo "::: Usage: pihole.sh -b domain1 [domain2 ...]"
-    echo "  "
+    echo ":::"
-    echo "Options:"
+    echo "::: Options:"
-    echo "  -d, --delmode		Remove domains from the blacklist"
+    echo ":::  -d, --delmode		Remove domains from the blacklist"
-    echo "  -nr, --noreload	Update blacklist without refreshing dnsmasq"
+    echo ":::  -nr, --noreload		Update blacklist without refreshing dnsmasq"
-    echo "  -f, --force		Force updating of the hosts files, even if there are no changes"
+    echo ":::  -f, --force			Force updating of the hosts files, even if there are no changes"
-    echo "  -q, --quiet		output is less verbose"
+    echo ":::  -q, --quiet			output is less verbose"
     exit 1
 fi
 
@@ -53,7 +53,7 @@ function HandleOther(){
   #check validity of domain
 	validDomain=$(echo "$1" | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/')
 	if [ -z "$validDomain" ]; then
-		echo "$1" is not a valid argument or domain name
+		echo "::: $1 is not a valid argument or domain name"
 	else	  
 	  domList=("${domList[@]}" $validDomain)
 	fi

advanced/Scripts/chronometer.sh

@@ -118,14 +118,14 @@ function normalChrono(){
 }
 
 function displayHelp(){
- echo "Displays stats about your piHole!"
+ 	echo "::: Displays stats about your piHole!"
-    echo " "
+    echo ":::"
-    echo "Usage: chronometer.sh [optional:-j]"
+    echo "::: Usage: pihole.sh -c [optional:-j]"
-    echo "Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds"
+    echo "::: Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds"
-    echo "  "
+    echo ":::"
-    echo "Options:"
+    echo "::: Options:"
-    echo "  -j, --json		output stats as JSON formatted string"
+    echo ":::  -j, --json		output stats as JSON formatted string"
-    echo "  -h, --help	display this help text"
+    echo ":::  -h, --help		display this help text"
 
     exit 1
 }

advanced/Scripts/whitelist.sh

@@ -11,15 +11,15 @@
 # (at your option) any later version.
 
 if [[ $# = 0 ]]; then
-    echo "Immediately whitelists one or more domains in the hosts file"
+    echo "::: Immediately whitelists one or more domains in the hosts file"
-    echo " "
+    echo ":::"
-    echo "Usage: whitelist.sh domain1 [domain2 ...]"
+    echo "::: Usage: pihole -w domain1 [domain2 ...]"
-    echo "  "
+    echo ":::"
-    echo "Options:"
+    echo "::: Options:"
-    echo "  -d, --delmode		Remove domains from the whitelist"
+    echo ":::  -d, --delmode		Remove domains from the whitelist"
-    echo "  -nr, --noreload	Update Whitelist without refreshing dnsmasq"
+    echo ":::  -nr, --noreload		Update Whitelist without refreshing dnsmasq"
-    echo "  -f, --force		Force updating of the hosts files, even if there are no changes"
+    echo ":::  -f, --force			Force updating of the hosts files, even if there are no changes"
-    echo "  -q, --quiet		output is less verbose"
+    echo ":::  -q, --quiet			output is less verbose"
     exit 1
 fi
 

pihole.sh

@@ -0,0 +1,98 @@
+#!/bin/bash
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2015, 2016 by Jacob Salmela
+# Network-wide ad blocking via your Raspberry Pi
+# http://pi-hole.net
+# Controller for all pihole scripts and functions.
+#
+# Pi-hole is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+
+# Must be root to use this tool
+if [[ $EUID -eq 0 ]];then
+	echo "::: You are root."
+else
+	echo "::: Sudo will be used for this tool."
+  # Check if it is actually installed
+  # If it isn't, exit because the unnstall cannot complete
+  if [[ $(dpkg-query -s sudo) ]];then
+		export SUDO="sudo"
+  else
+    echo "::: Please install sudo or run this as root."
+    exit 1
+  fi
+fi
+
+function whitelistFunc {
+	shift
+	$SUDO /opt/pihole/whitelist.sh "$@"
+	exit 1
+}
+
+function blacklistFunc {
+	shift
+	$SUDO /opt/pihole/blacklist.sh "$@"
+	exit 1
+}
+
+function debugFunc {
+	$SUDO /opt/pihole/piholeDebug.sh
+	exit 1
+}
+
+function flushFunc {
+	$SUDO /opt/pihole/piholeLogFlush.sh
+	exit 1
+}
+
+function updateDashboardFunc {
+	$SUDO /opt/pihole/updateDashboard.sh
+	exit 1
+}
+
+function setupLCDFunction {
+	$SUDO /opt/pihole/setupLCD.sh
+	exit 1
+}
+
+function chronometerFunc {
+	$SUDO /opt/pihole/chronometer.sh
+	exit 1
+}
+
+function helpFunc {
+    echo "::: Control all PiHole specific functions!"
+    echo ":::"
+    echo "::: Usage: pihole.sh [options]"
+    printf ":::\tAdd -h after -w, -b, or -c  for more information on usage\n"
+    echo ":::"
+    echo "::: Options:"
+    printf ":::  -w, --whitelist\t\tWhitelist domains\n"
+    printf ":::  -b, --blacklist\t\tBlacklist domains\n"
+    printf ":::  -d, --debug\t\tStart a debugging session if having trouble\n"
+    printf ":::  -f, --flush\t\tFlush the pihole.log file\n"
+    printf ":::  -u, --updateDashboard\t\tUpdate the web dashboard manually\n"
+   	printf ":::  -s, --setupLCD\t\tAutomatically configures the Pi to use the 2.8 LCD screen to display stats on it\n"
+	printf ":::  -c, --chronometer\t\tCalculates stats and displays to an LCD\n"
+	printf ":::  -h, --help\t\tShow this help dialog\n"
+    exit 1
+}
+
+if [[ $# = 0 ]]; then
+	helpFunc
+fi
+
+# Handle redirecting to specific functions based on arguments
+case "$1" in
+"-w" | "--whitelist"		) whitelistFunc "$@";;
+"-b" | "--blacklist"		) blacklistFunc "$@";;
+"-d" | "--debug"			) debugFunc;;
+"-f" | "--flush"			) flushFunc;;
+"-u" | "--updateDashboard"	) updateDashboardFunc;;
+"-s" | "--setupLCD"			) setupLCDFunction;;
+"-c" | "--chronometer"		) chronometerFunc;;
+"-h" | "--help"				) helpFunc;;
+*                    		) helpFunc;;
+esac