From 5ea08a2120bbe2e771085e9a6f49aba66e25c7c9 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 17:07:08 +0100 Subject: [PATCH 01/17] add -r to reconfigure pihole (basically runs basic-install.sh from /etc/.pihole) --- pihole | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/pihole b/pihole index e0d1715a..b96df225 100755 --- a/pihole +++ b/pihole @@ -116,6 +116,11 @@ function updatePiholeFunc { exit 1 } +function reconfigurePiholeFunc { + ${SUDO} /etc/.pihole/automated\ install/basic-install.sh + exit 1; +} + function updateGravityFunc { ${SUDO} /opt/pihole/gravity.sh "$@" exit 1 @@ -190,6 +195,7 @@ case "$1" in "-d" | "debug" ) debugFunc;; "-f" | "flush" ) flushFunc;; "-up" | "updatePihole" ) updatePiholeFunc;; +"-r" | "reconfigure" ) reconfigurePiholeFunc;; "-g" | "updateGravity" ) updateGravityFunc "$@";; "-s" | "setupLCD" ) setupLCDFunction;; "-c" | "chronometer" ) chronometerFunc "$@";; @@ -198,4 +204,4 @@ case "$1" in "-q" | "query" ) queryFunc "$@";; "uninstall" ) uninstallFunc;; * ) helpFunc;; -esac +esac \ No newline at end of file From 5e883239f98eb5ff2f017c6370c9bd37dc686255 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 17:15:59 +0100 Subject: [PATCH 02/17] remove calls for ${SUDO} as per basic-install.sh. --- pihole | 45 +++++++++++++++++++++------------------------ 1 file changed, 21 insertions(+), 24 deletions(-) diff --git a/pihole b/pihole index b96df225..e1e18898 100755 --- a/pihole +++ b/pihole @@ -12,38 +12,35 @@ # 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 pihole cannot be invoked without privileges. - if [ -x "$(command -v sudo)" ];then - export SUDO="sudo" - else - echo "::: Please install sudo or run this as root." - exit 1 - fi + if [ -x "$(command -v sudo)" ];then + echo "::: Elevating to root with sudo" + exec sudo bash "$0" "$@" + exit $? + else + echo "::: sudo is needed to run pihole commands. Please run this script as root or install sudo." + exit 1 + fi fi function whitelistFunc { shift - ${SUDO} /opt/pihole/whitelist.sh "$@" + /opt/pihole/whitelist.sh "$@" exit 1 } function blacklistFunc { shift - ${SUDO} /opt/pihole/blacklist.sh "$@" + /opt/pihole/blacklist.sh "$@" exit 1 } function debugFunc { - ${SUDO} /opt/pihole/piholeDebug.sh + /opt/pihole/piholeDebug.sh exit 1 } function flushFunc { - ${SUDO} /opt/pihole/piholeLogFlush.sh + /opt/pihole/piholeLogFlush.sh exit 1 } @@ -86,7 +83,7 @@ function updatePiholeFunc { echo ":::" echo "::: Fetching latest changes from GitHub..." cd /var/www/html/admin - ${SUDO} git pull origin master + git pull origin master echo ":::" echo "::: Pi-hole Web Admin has been updated to ${webVersion}" echo "::: See https://changes.pi-hole.net for details" @@ -101,8 +98,8 @@ function updatePiholeFunc { echo "::: Fetching latest changes from GitHub..." cd /etc/.pihole - ${SUDO} git pull origin master - ${SUDO} /etc/.pihole/automated\ install/basic-install.sh pihole + git pull origin master + /etc/.pihole/automated\ install/basic-install.sh pihole echo ":::" echo "::: Pi-hole has been updated to version ${piholeVersionLatest}" @@ -117,17 +114,17 @@ function updatePiholeFunc { } function reconfigurePiholeFunc { - ${SUDO} /etc/.pihole/automated\ install/basic-install.sh + /etc/.pihole/automated\ install/basic-install.sh exit 1; } function updateGravityFunc { - ${SUDO} /opt/pihole/gravity.sh "$@" + /opt/pihole/gravity.sh "$@" exit 1 } function setupLCDFunction { - ${SUDO} /opt/pihole/setupLCD.sh + /opt/pihole/setupLCD.sh exit 1 } @@ -147,18 +144,18 @@ function queryFunc { function chronometerFunc { shift - ${SUDO} /opt/pihole/chronometer.sh "$@" + /opt/pihole/chronometer.sh "$@" exit 1 } function uninstallFunc { - ${SUDO} /opt/pihole/uninstall.sh + /opt/pihole/uninstall.sh exit 1 } function versionFunc { - ${SUDO} /opt/pihole/version.sh + /opt/pihole/version.sh exit 1 } From 9352ba6e4a76a721cd6ad9d82bca54fc93f26913 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 17:16:44 +0100 Subject: [PATCH 03/17] about time we exit 0'd --- pihole | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/pihole b/pihole index e1e18898..0406d19c 100755 --- a/pihole +++ b/pihole @@ -25,23 +25,23 @@ fi function whitelistFunc { shift /opt/pihole/whitelist.sh "$@" - exit 1 + exit 0 } function blacklistFunc { shift /opt/pihole/blacklist.sh "$@" - exit 1 + exit 0 } function debugFunc { /opt/pihole/piholeDebug.sh - exit 1 + exit 0 } function flushFunc { /opt/pihole/piholeLogFlush.sh - exit 1 + exit 0 } @@ -110,22 +110,22 @@ function updatePiholeFunc { echo "::: See https://changes.pi-hole.net for details" fi - exit 1 + exit 0 } function reconfigurePiholeFunc { /etc/.pihole/automated\ install/basic-install.sh - exit 1; + exit 0; } function updateGravityFunc { /opt/pihole/gravity.sh "$@" - exit 1 + exit 0 } function setupLCDFunction { /opt/pihole/setupLCD.sh - exit 1 + exit 0 } function queryFunc { @@ -139,24 +139,24 @@ function queryFunc { fi echo "" done - exit 1 + exit 0 } function chronometerFunc { shift /opt/pihole/chronometer.sh "$@" - exit 1 + exit 0 } function uninstallFunc { /opt/pihole/uninstall.sh - exit 1 + exit 0 } function versionFunc { /opt/pihole/version.sh - exit 1 + exit 0 } function helpFunc { @@ -178,7 +178,7 @@ function helpFunc { echo "::: -v, version Show current versions" echo "::: -q, query Query the adlists for a specific domain" echo "::: uninstall Uninstall Pi-Hole from your system :(!" - exit 1 + exit 0 } if [[ $# = 0 ]]; then From 461de48625739d36c1113df978b21a4533760cf2 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 17:25:17 +0100 Subject: [PATCH 04/17] function declarations as per basic-install.sh --- pihole | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/pihole b/pihole index 0406d19c..dd50481a 100755 --- a/pihole +++ b/pihole @@ -22,30 +22,30 @@ if [[ ! $EUID -eq 0 ]];then fi fi -function whitelistFunc { +whitelistFunc() { shift /opt/pihole/whitelist.sh "$@" exit 0 } -function blacklistFunc { +blacklistFunc() { shift /opt/pihole/blacklist.sh "$@" exit 0 } -function debugFunc { +debugFunc() { /opt/pihole/piholeDebug.sh exit 0 } -function flushFunc { +flushFunc() { /opt/pihole/piholeLogFlush.sh exit 0 } -function updatePiholeFunc { +updatePiholeFunc() { if [ ! -d "/etc/.pihole" ]; then #This is unlikely echo "::: Critical Error: Pi-Hole repo missing from system!" @@ -113,22 +113,22 @@ function updatePiholeFunc { exit 0 } -function reconfigurePiholeFunc { +reconfigurePiholeFunc() { /etc/.pihole/automated\ install/basic-install.sh exit 0; } -function updateGravityFunc { +updateGravityFunc() { /opt/pihole/gravity.sh "$@" exit 0 } -function setupLCDFunction { +setupLCDFunction() { /opt/pihole/setupLCD.sh exit 0 } -function queryFunc { +queryFunc() { domain=$2 for list in /etc/pihole/list.* do @@ -142,24 +142,24 @@ function queryFunc { exit 0 } -function chronometerFunc { +chronometerFunc() { shift /opt/pihole/chronometer.sh "$@" exit 0 } -function uninstallFunc { +uninstallFunc() { /opt/pihole/uninstall.sh exit 0 } -function versionFunc { +versionFunc() { /opt/pihole/version.sh exit 0 } -function helpFunc { +helpFunc() { echo "::: Control all PiHole specific functions!" echo ":::" echo "::: Usage: pihole [options]" @@ -201,4 +201,4 @@ case "$1" in "-q" | "query" ) queryFunc "$@";; "uninstall" ) uninstallFunc;; * ) helpFunc;; -esac \ No newline at end of file +esac From 090fbd04afea455c0fcdfffc20e85d698cb099d4 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 17:54:04 +0100 Subject: [PATCH 05/17] Remove ${SUDO} usages and root checks from scripts called by `pihole` command as they should not be called directly. --- advanced/Scripts/blacklist.sh | 35 ++++++++------------------- advanced/Scripts/chronometer.sh | 16 ++++++------ advanced/Scripts/setupLCD.sh | 43 +++++++++++---------------------- advanced/Scripts/whitelist.sh | 36 +++++++++------------------ pihole | 16 ++++++------ 5 files changed, 51 insertions(+), 95 deletions(-) diff --git a/advanced/Scripts/blacklist.sh b/advanced/Scripts/blacklist.sh index a289a9a5..feeca9da 100755 --- a/advanced/Scripts/blacklist.sh +++ b/advanced/Scripts/blacklist.sh @@ -10,22 +10,7 @@ # the Free Software Foundation, either version 2 of the License, or # (at your option) any later version. -#rootcheck -if [[ $EUID -eq 0 ]];then - echo "::: You are root." -else - echo "::: sudo will be used." - # Check if it is actually installed - # If it isn't, exit because the install cannot complete - if [ -x "$(command -v sudo)" ];then - export SUDO="sudo" - else - echo "::: Please install sudo or run this script as root." - exit 1 - fi -fi - -function helpFunc() +helpFunc() { echo "::: Immediately blacklists one or more domains in the hosts file" echo ":::" @@ -86,7 +71,7 @@ if [[ -f ${piholeIPv6file} ]];then piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }') fi -function HandleOther(){ +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 @@ -96,7 +81,7 @@ function HandleOther(){ fi } -function PopBlacklistFile(){ +PopBlacklistFile(){ #check blacklist file exists, and if not, create it if [[ ! -f ${blacklist} ]];then touch ${blacklist} @@ -110,7 +95,7 @@ function PopBlacklistFile(){ done } -function AddDomain(){ +AddDomain(){ #| sed 's/\./\\./g' bool=false grep -Ex -q "$1" ${blacklist} || bool=true @@ -129,7 +114,7 @@ function AddDomain(){ fi } -function RemoveDomain(){ +RemoveDomain(){ bool=false grep -Ex -q "$1" ${blacklist} || bool=true @@ -148,7 +133,7 @@ function RemoveDomain(){ fi } -function ModifyHostFile(){ +ModifyHostFile(){ if ${addmode}; then #add domains to the hosts file if [[ -r ${blacklist} ]];then @@ -178,7 +163,7 @@ function ModifyHostFile(){ fi } -function Reload() { +Reload() { # Reload hosts file echo ":::" echo -n "::: Refresh lists in dnsmasq..." @@ -187,15 +172,15 @@ function Reload() { if [[ ${dnsmasqPid} ]]; then # service already running - reload config - ${SUDO} killall -s HUP dnsmasq + killall -s HUP dnsmasq else # service not running, start it up - ${SUDO} service dnsmasq start + service dnsmasq start fi echo " done!" } -function DisplayBlist() { +DisplayBlist() { verbose=false echo -e " Displaying Gravity Affected Domains \n" count=1 diff --git a/advanced/Scripts/chronometer.sh b/advanced/Scripts/chronometer.sh index eae7cf1c..c03b4649 100755 --- a/advanced/Scripts/chronometer.sh +++ b/advanced/Scripts/chronometer.sh @@ -17,7 +17,7 @@ gravity="/etc/pihole/gravity.list" today=$(date "+%b %e") -function CalcBlockedDomains(){ +CalcBlockedDomains(){ CheckIPv6 if [ -e "$gravity" ]; then #Are we IPV6 or IPV4? @@ -33,7 +33,7 @@ function CalcBlockedDomains(){ fi } -function CalcQueriesToday(){ +CalcQueriesToday(){ if [ -e "$piLog" ];then queriesToday=$(cat "$piLog" | grep "$today" | awk '/query/ {print $6}' | wc -l) else @@ -41,7 +41,7 @@ function CalcQueriesToday(){ fi } -function CalcblockedToday(){ +CalcblockedToday(){ if [ -e "$piLog" ] && [ -e "$gravity" ];then blockedToday=$(cat ${piLog} | awk '/\/etc\/pihole\/gravity.list/ && !/address/ {print $6}' | wc -l) else @@ -49,7 +49,7 @@ function CalcblockedToday(){ fi } -function CalcPercentBlockedToday(){ +CalcPercentBlockedToday(){ if [ "$queriesToday" != "Err." ] && [ "$blockedToday" != "Err." ]; then if [ "$queriesToday" != 0 ]; then #Fixes divide by zero error :) #scale 2 rounds the number down, so we'll do scale 4 and then trim the last 2 zeros @@ -61,7 +61,7 @@ function CalcPercentBlockedToday(){ fi } -function CheckIPv6(){ +CheckIPv6(){ piholeIPv6file="/etc/pihole/.useIPv6" if [[ -f ${piholeIPv6file} ]];then # If the file exists, then the user previously chose to use IPv6 in the automated installer @@ -69,7 +69,7 @@ function CheckIPv6(){ fi } -function outputJSON(){ +outputJSON(){ CalcQueriesToday CalcblockedToday CalcPercentBlockedToday @@ -79,7 +79,7 @@ function outputJSON(){ printf '{"domains_being_blocked":"%s","dns_queries_today":"%s","ads_blocked_today":"%s","ads_percentage_today":"%s"}\n' "$blockedDomainsTotal" "$queriesToday" "$blockedToday" "$percentBlockedToday" } -function normalChrono(){ +normalChrono(){ for (( ; ; )) do clear @@ -121,7 +121,7 @@ function normalChrono(){ done } -function displayHelp(){ +displayHelp(){ echo "::: Displays stats about your piHole!" echo ":::" echo "::: Usage: sudo pihole -c [optional:-j]" diff --git a/advanced/Scripts/setupLCD.sh b/advanced/Scripts/setupLCD.sh index c77f1f4a..5ef324fe 100755 --- a/advanced/Scripts/setupLCD.sh +++ b/advanced/Scripts/setupLCD.sh @@ -11,21 +11,6 @@ # (at your option) any later version. ############ FUNCTIONS ########### -# Run this script as root or under sudo -echo ":::" -if [[ $EUID -eq 0 ]];then - echo "::: You are root." -else - echo "::: sudo will be used." - # Check if it is actually installed - # If it isn't, exit because the install cannot complete - if [ -x "$(command -v sudo)" ];then - export SUDO="sudo" - else - echo "::: Please install sudo or run this script as root." - exit 1 - fi -fi # Borrowed from adafruit-pitft-helper < borrowed from raspi-config # https://github.com/adafruit/Adafruit-PiTFT-Helper/blob/master/adafruit-pitft-helper#L324-L334 @@ -45,11 +30,11 @@ getInitSys() { autoLoginPiToConsole() { if [ -e /etc/init.d/lightdm ]; then if [ ${SYSTEMD} -eq 1 ]; then - ${SUDO} systemctl set-default multi-user.target - ${SUDO} ln -fs /etc/systemd/system/autologin@.service /etc/systemd/system/getty.target.wants/getty@tty1.service + systemctl set-default multi-user.target + ln -fs /etc/systemd/system/autologin@.service /etc/systemd/system/getty.target.wants/getty@tty1.service else - ${SUDO} update-rc.d lightdm disable 2 - ${SUDO} sed /etc/inittab -i -e "s/1:2345:respawn:\/sbin\/getty --noclear 38400 tty1/1:2345:respawn:\/bin\/login -f pi tty1 <\/dev\/tty1 >\/dev\/tty1 2>&1/" + update-rc.d lightdm disable 2 + sed /etc/inittab -i -e "s/1:2345:respawn:\/sbin\/getty --noclear 38400 tty1/1:2345:respawn:\/bin\/login -f pi tty1 <\/dev\/tty1 >\/dev\/tty1 2>&1/" fi fi } @@ -66,23 +51,23 @@ echo /usr/local/bin/chronometer.sh >> /home/pi/.bashrc # Set up the LCD screen based on Adafruits instuctions: # https://learn.adafruit.com/adafruit-pitft-28-inch-resistive-touchscreen-display-raspberry-pi/easy-install -curl -SLs https://apt.adafruit.com/add-pin | ${SUDO} bash -${SUDO} apt-get -y install raspberrypi-bootloader -${SUDO} apt-get -y install adafruit-pitft-helper -${SUDO} adafruit-pitft-helper -t 28r +curl -SLs https://apt.adafruit.com/add-pin | bash +apt-get -y install raspberrypi-bootloader +apt-get -y install adafruit-pitft-helper +adafruit-pitft-helper -t 28r # Download the cmdline.txt file that prevents the screen from going blank after a period of time -${SUDO} mv /boot/cmdline.txt /boot/cmdline.orig -${SUDO} curl -o /boot/cmdline.txt https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/cmdline.txt +mv /boot/cmdline.txt /boot/cmdline.orig +curl -o /boot/cmdline.txt https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/cmdline.txt # Back up the original file and download the new one -${SUDO} mv /etc/default/console-setup /etc/default/console-setup.orig -${SUDO} curl -o /etc/default/console-setup https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/console-setup +mv /etc/default/console-setup /etc/default/console-setup.orig +curl -o /etc/default/console-setup https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/console-setup # Instantly apply the font change to the LCD screen -${SUDO} setupcon +setupcon -${SUDO} reboot +reboot # Start showing the stats on the screen by running the command on another tty: # http://unix.stackexchange.com/questions/170063/start-a-process-on-a-different-tty diff --git a/advanced/Scripts/whitelist.sh b/advanced/Scripts/whitelist.sh index 75d62173..d6a09b35 100755 --- a/advanced/Scripts/whitelist.sh +++ b/advanced/Scripts/whitelist.sh @@ -10,22 +10,8 @@ # the Free Software Foundation, either version 2 of the License, or # (at your option) any later version. -#rootcheck -if [[ $EUID -eq 0 ]];then - echo "::: You are root." -else - echo "::: sudo will be used." - # Check if it is actually installed - # If it isn't, exit because the install cannot complete - if [ -x "$(command -v sudo)" ];then - export SUDO="sudo" - else - echo "::: Please install sudo or run this script as root." - exit 1 - fi -fi -function helpFunc() +helpFunc() { echo "::: Immediately whitelists one or more domains in the hosts file" echo ":::" @@ -85,7 +71,7 @@ if [[ -f ${piholeIPv6file} ]];then piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }') fi -function HandleOther(){ +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 @@ -95,7 +81,7 @@ function HandleOther(){ fi } -function PopWhitelistFile(){ +PopWhitelistFile(){ #check whitelist file exists, and if not, create it if [[ ! -f ${whitelist} ]];then touch ${whitelist} @@ -110,7 +96,7 @@ function PopWhitelistFile(){ done } -function AddDomain(){ +AddDomain(){ #| sed 's/\./\\./g' bool=false @@ -132,7 +118,7 @@ function AddDomain(){ fi } -function RemoveDomain(){ +RemoveDomain(){ bool=false grep -Ex -q "$1" ${whitelist} || bool=true @@ -151,7 +137,7 @@ function RemoveDomain(){ fi } -function ModifyHostFile(){ +ModifyHostFile(){ if ${addmode}; then #remove domains in from hosts file if [[ -r ${whitelist} ]];then @@ -195,7 +181,7 @@ function ModifyHostFile(){ fi } -function Reload() { +Reload() { # Reload hosts file echo ":::" echo -n "::: Refresh lists in dnsmasq..." @@ -203,15 +189,15 @@ function Reload() { if [[ ${dnsmasqPid} ]]; then # service already running - reload config - ${SUDO} killall -s HUP dnsmasq + killall -s HUP dnsmasq else # service not running, start it up - ${SUDO} service dnsmasq start + service dnsmasq start fi echo " done!" } -function DisplayWlist() { +DisplayWlist() { verbose=false echo -e " Displaying Gravity Resistant Domains \n" count=1 @@ -251,4 +237,4 @@ fi if ${reload}; then Reload -fi +fi \ No newline at end of file diff --git a/pihole b/pihole index dd50481a..30b13403 100755 --- a/pihole +++ b/pihole @@ -12,14 +12,14 @@ # Must be root to use this tool if [[ ! $EUID -eq 0 ]];then - if [ -x "$(command -v sudo)" ];then - echo "::: Elevating to root with sudo" - exec sudo bash "$0" "$@" - exit $? - else - echo "::: sudo is needed to run pihole commands. Please run this script as root or install sudo." - exit 1 - fi + if [ -x "$(command -v sudo)" ];then + echo "::: Elevating to root with sudo" + exec sudo bash "$0" "$@" + exit $? + else + echo "::: sudo is needed to run pihole commands. Please run this script as root or install sudo." + exit 1 + fi fi whitelistFunc() { From 4c42f00a8636acc8d30b65aff05c826f8a68def4 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 18:42:53 +0100 Subject: [PATCH 06/17] remove uses of ${SUDO} and root check from gravity. As this is handled by `pihole` command. --- gravity.sh | 32 +++++++++----------------------- 1 file changed, 9 insertions(+), 23 deletions(-) diff --git a/gravity.sh b/gravity.sh index bcfcc9ee..94360b70 100755 --- a/gravity.sh +++ b/gravity.sh @@ -13,20 +13,6 @@ # Run this script as root or under sudo echo ":::" -if [[ $EUID -eq 0 ]];then - echo "::: You are root." -else - echo "::: sudo will be used." - # Check if it is actually installed - # If it isn't, exit because the install cannot complete - if [ -x "$(command -v sudo)" ];then - export SUDO="sudo" - else - echo "::: Please install sudo or run this script as root." - exit 1 - fi -fi - function helpFunc() { echo "::: Pull in domains from adlists" @@ -105,13 +91,13 @@ function gravity_collapse() { # Temporary hack to allow non-root access to pihole directory # Will update later, needed for existing installs, new installs should # create this directory as non-root - ${SUDO} chmod 777 ${piholeDir} + chmod 777 ${piholeDir} echo ":::" echo "::: Existing pihole directory found" else echo "::: Creating pihole directory..." mkdir ${piholeDir} - ${SUDO} chmod 777 ${piholeDir} + chmod 777 ${piholeDir} fi } @@ -305,7 +291,7 @@ function gravity_reload() { #Clear no longer needed files... echo ":::" echo -n "::: Cleaning up un-needed files..." - ${SUDO} rm ${piholeDir}/pihole.*.txt + rm ${piholeDir}/pihole.*.txt echo " done!" # Reload hosts file @@ -316,17 +302,17 @@ function gravity_reload() { #First escape forward slashes in the path: adList=${adList//\//\\\/} #Now replace the line in dnsmasq file - ${SUDO} sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf + sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf dnsmasqPid=$(pidof dnsmasq) - find "$piholeDir" -type f -exec ${SUDO} chmod 666 {} \; + find "$piholeDir" -type f -exec chmod 666 {} \; if [[ ${dnsmasqPid} ]]; then # service already running - reload config - ${SUDO} killall -s HUP dnsmasq + killall -s HUP dnsmasq else # service not running, start it up - ${SUDO} service dnsmasq start + service dnsmasq start fi echo " done!" } @@ -342,12 +328,12 @@ done if [[ ${forceGrav} == true ]]; then echo -n "::: Deleting exising list cache..." - ${SUDO} rm /etc/pihole/list.* + rm /etc/pihole/list.* echo " done!" fi #Overwrite adlists.default from /etc/.pihole in case any changes have been made. Changes should be saved in /etc/adlists.list -${SUDO} cp /etc/.pihole/adlists.default /etc/pihole/adlists.default +cp /etc/.pihole/adlists.default /etc/pihole/adlists.default gravity_collapse gravity_spinup gravity_Schwarzchild From fc4fe5409989d059f9c11096f07bc5a7191c266a Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 20:02:57 +0100 Subject: [PATCH 07/17] standardise function naming --- gravity.sh | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/gravity.sh b/gravity.sh index 94360b70..0aaf2b88 100755 --- a/gravity.sh +++ b/gravity.sh @@ -13,7 +13,7 @@ # Run this script as root or under sudo echo ":::" -function helpFunc() +helpFunc() { echo "::: Pull in domains from adlists" echo ":::" @@ -54,7 +54,7 @@ fi ########################### # collapse - begin formation of pihole -function gravity_collapse() { +gravity_collapse() { echo "::: Neutrino emissions detected..." echo ":::" #Decide if we're using a custom ad block list, or defaults. @@ -102,7 +102,7 @@ function gravity_collapse() { } # patternCheck - check to see if curl downloaded any new files. -function gravity_patternCheck() { +gravity_patternCheck() { patternBuffer=$1 # check if the patternbuffer is a non-zero length file if [[ -s "$patternBuffer" ]];then @@ -118,7 +118,7 @@ function gravity_patternCheck() { } # transport - curl the specified url with any needed command extentions -function gravity_transport() { +gravity_transport() { url=$1 cmd_ext=$2 agent=$3 @@ -140,7 +140,7 @@ function gravity_transport() { } # spinup - main gravity function -function gravity_spinup() { +gravity_spinup() { echo ":::" # Loop through domain list. Download each one and remove commented lines (lines beginning with '# 'or '/') and # blank lines for ((i = 0; i < "${#sources[@]}"; i++)) @@ -177,7 +177,7 @@ function gravity_spinup() { } # Schwarzchild - aggregate domains to one list and add blacklisted domains -function gravity_Schwarzchild() { +gravity_Schwarzchild() { echo "::: " # Find all active domains and compile them into one file and remove CRs echo -n "::: Aggregating list of domains..." @@ -189,7 +189,7 @@ function gravity_Schwarzchild() { echo " done!" } -function gravity_Blacklist(){ +gravity_Blacklist(){ # Append blacklist entries if they exist echo -n "::: Running blacklist script to update HOSTS file...." ${blacklistScript} -f -nr -q > /dev/null @@ -199,7 +199,7 @@ function gravity_Blacklist(){ echo " $numBlacklisted domain${plural} blacklisted!" } -function gravity_Whitelist() { +gravity_Whitelist() { echo ":::" # Prevent our sources from being pulled into the hole plural=; [[ "${sources[@]}" != "1" ]] && plural=s @@ -220,7 +220,7 @@ function gravity_Whitelist() { echo " $numWhitelisted domain${plural} whitelisted!" } -function gravity_unique() { +gravity_unique() { # Sort and remove duplicates echo -n "::: Removing duplicate domains...." sort -u ${piholeDir}/${supernova} > ${piholeDir}/${eventHorizon} @@ -229,7 +229,7 @@ function gravity_unique() { echo "::: $numberOf unique domains trapped in the event horizon." } -function gravity_hostFormat() { +gravity_hostFormat() { # Format domain list as "192.168.x.x domain.com" echo "::: Formatting domains into a HOSTS file..." if [[ -f /etc/hostname ]]; then @@ -256,7 +256,7 @@ function gravity_hostFormat() { } # blackbody - remove any remnant files from script processes -function gravity_blackbody() { +gravity_blackbody() { # Loop through list files for file in ${piholeDir}/*.${justDomainsExtension} do @@ -269,7 +269,7 @@ function gravity_blackbody() { done } -function gravity_advanced() { +gravity_advanced() { # Remove comments and print only the domain name # Most of the lists downloaded are already in hosts file format but the spacing/formating is not contigious # This helps with that and makes it easier to read @@ -287,7 +287,7 @@ function gravity_advanced() { gravity_unique } -function gravity_reload() { +gravity_reload() { #Clear no longer needed files... echo ":::" echo -n "::: Cleaning up un-needed files..." From 51c4c51d9e1ca21c8454fb999d3691c0eea598a0 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 20:03:33 +0100 Subject: [PATCH 08/17] Add trap to check existence of setupVars --- gravity.sh | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/gravity.sh b/gravity.sh index 0aaf2b88..4ef440a5 100755 --- a/gravity.sh +++ b/gravity.sh @@ -32,7 +32,15 @@ whitelistScript=/opt/pihole/whitelist.sh blacklistScript=/opt/pihole/blacklist.sh #Source the setupVars from install script for the IP -. /etc/pihole/setupVars.conf +setupVars=/etc/pihole/setupVars.conf +if [[ -f ${setupVars} ]];then + . /etc/pihole/setupVars.conf +else + echo "::: WARNING: /etc/pihole/setupVars.conf missing. Possible installation failure." + echo "::: Please run 'pihole -r', and choose the 'install' option to reconfigure." + exit 1 +fi + #Remove the /* from the end of the IPv4addr. IPv4addr=${IPv4_address%/*} From 7ee1110351fe5bffc6cc9de7c29fd24b440c7213 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 20:09:38 +0100 Subject: [PATCH 09/17] ugh. pihole.conf. --- gravity.sh | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/gravity.sh b/gravity.sh index 4ef440a5..5f0606b4 100755 --- a/gravity.sh +++ b/gravity.sh @@ -54,10 +54,9 @@ supernova=${basename}.1.supernova.txt eventHorizon=${basename}.2.eventHorizon.txt accretionDisc=${basename}.3.accretionDisc.txt -# After setting defaults, check if there's local overrides +# Warn users still using pihole.conf that it no longer has any effect (I imagine about 2 people use it) if [[ -r ${piholeDir}/pihole.conf ]];then - echo "::: Local calibration requested..." - . ${piholeDir}/pihole.conf + echo "::: pihole.conf file no longer supported. Over-rides in this file are ignored." fi ########################### From 7e10dcdcf05034416920a8f0c5a3a16557951d34 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 20:12:16 +0100 Subject: [PATCH 10/17] update pihole bash-completion --- advanced/bash-completion/pihole | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/advanced/bash-completion/pihole b/advanced/bash-completion/pihole index 2d6aafae..1fae988d 100644 --- a/advanced/bash-completion/pihole +++ b/advanced/bash-completion/pihole @@ -4,7 +4,7 @@ _pihole() COMPREPLY=() cur="${COMP_WORDS[COMP_CWORD]}" prev="${COMP_WORDS[COMP_CWORD-1]}" - opts="blacklist chronometer debug flush help query setupLCD uninstall updateDashboard updateGravity updatePihole version whitelist" + opts="blacklist chronometer debug flush help query reconfigure setupLCD uninstall updateGravity updatePihole version whitelist" COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) ) return 0 From a43577fa26c4c2c9852f4ec9a330101463073025 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 20:43:03 +0100 Subject: [PATCH 11/17] add reconfigure flag to -r command --- automated install/basic-install.sh | 19 +++++++++++++++++-- pihole | 4 ++-- 2 files changed, 19 insertions(+), 4 deletions(-) diff --git a/automated install/basic-install.sh b/automated install/basic-install.sh index 945fa1e1..ccb84667 100755 --- a/automated install/basic-install.sh +++ b/automated install/basic-install.sh @@ -40,6 +40,11 @@ columns=$(tput cols) r=$(( rows / 2 )) c=$(( columns / 2 )) +######## Flags. Shhh ######## +skipSpaceCheck=false +skipRepoUpdate=false +runUnattended=false + ######## FIRST CHECK ######## # Must be root to install echo ":::" @@ -884,8 +889,18 @@ update_dialogs(){ } main() { + +for var in "$@" +do + case "$var" in + "--reconfigure" ) skipRepoUpdate=true;; + "--i_do_not_follow_recommendations" ) skipSpaceCheck=false;; + "--unattended" ) runUnattended=true;; + esac +done + if [[ -f ${setupVars} ]];then - if [ "$1" == "pihole" ]; then + if [ "$runUnattended" = true ]; then useUpdateVars=true else update_dialogs @@ -894,7 +909,7 @@ fi # Start the installer # Verify there is enough disk space for the install -if [[ $1 = "--i_do_not_follow_recommendations" ]]; then +if [[ "$skipSpaceCheck" = true ]]; then echo "::: --i_do_not_follow_recommendations passed to script" echo "::: skipping free disk space verification!" else diff --git a/pihole b/pihole index 30b13403..4ed446be 100755 --- a/pihole +++ b/pihole @@ -99,7 +99,7 @@ updatePiholeFunc() { echo "::: Fetching latest changes from GitHub..." cd /etc/.pihole git pull origin master - /etc/.pihole/automated\ install/basic-install.sh pihole + /etc/.pihole/automated\ install/basic-install.sh --unattended echo ":::" echo "::: Pi-hole has been updated to version ${piholeVersionLatest}" @@ -114,7 +114,7 @@ updatePiholeFunc() { } reconfigurePiholeFunc() { - /etc/.pihole/automated\ install/basic-install.sh + /etc/.pihole/automated\ install/basic-install.sh --reconfigure exit 0; } From e612003293a5b4e217ad61beec386ffeaa6f7510 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 20:52:20 +0100 Subject: [PATCH 12/17] handle arguments better, convert to flags, echo when they're set to true. --- automated install/basic-install.sh | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/automated install/basic-install.sh b/automated install/basic-install.sh index ccb84667..9e9a7367 100755 --- a/automated install/basic-install.sh +++ b/automated install/basic-install.sh @@ -40,7 +40,7 @@ columns=$(tput cols) r=$(( rows / 2 )) c=$(( columns / 2 )) -######## Flags. Shhh ######## +######## Undocumented Flags. Shhh ######## skipSpaceCheck=false skipRepoUpdate=false runUnattended=false @@ -890,6 +890,7 @@ update_dialogs(){ main() { +# Check arguments for the undocumented flags for var in "$@" do case "$var" in @@ -901,6 +902,7 @@ done if [[ -f ${setupVars} ]];then if [ "$runUnattended" = true ]; then + echo "::: --unattended passed to install script, no whiptail dialogs will be displayed" useUpdateVars=true else update_dialogs @@ -910,8 +912,7 @@ fi # Start the installer # Verify there is enough disk space for the install if [[ "$skipSpaceCheck" = true ]]; then - echo "::: --i_do_not_follow_recommendations passed to script" - echo "::: skipping free disk space verification!" + echo "::: --i_do_not_follow_recommendations passed to script, skipping free disk space verification!" else verifyFreeDiskSpace fi @@ -928,6 +929,14 @@ install_dependent_packages INSTALLER_DEPS[@] # Install packages used by the Pi-hole install_dependent_packages PIHOLE_DEPS[@] +if [[ "$skipRepoUpdate" = true ]]; then + echo "::: --reconfigure passed to install script. Not downloading/updating local repos" +else + # Get Git files for Core and Admin + getGitFiles ${piholeFilesDir} ${piholeGitUrl} + getGitFiles ${webInterfaceDir} ${webInterfaceGitUrl} +fi + if [[ ${useUpdateVars} == false ]]; then # Display welcome dialogs welcomeDialogs @@ -935,9 +944,6 @@ if [[ ${useUpdateVars} == false ]]; then mkdir -p /etc/pihole/ # Remove legacy scripts from previous storage location remove_legacy_scripts - # Get Git files for Core and Admin - getGitFiles ${piholeFilesDir} ${piholeGitUrl} - getGitFiles ${webInterfaceDir} ${webInterfaceGitUrl} # Stop resolver and webserver while installing proceses stop_service dnsmasq stop_service lighttpd From 3a9b39b842086799b2fb3b3a6ff959f33a5088fd Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 21:12:13 +0100 Subject: [PATCH 13/17] adjust text in update_dialogs() whiptail --- automated install/basic-install.sh | 39 +++++++++++++++++++----------- 1 file changed, 25 insertions(+), 14 deletions(-) diff --git a/automated install/basic-install.sh b/automated install/basic-install.sh index 9e9a7367..a5de9863 100755 --- a/automated install/basic-install.sh +++ b/automated install/basic-install.sh @@ -42,7 +42,7 @@ c=$(( columns / 2 )) ######## Undocumented Flags. Shhh ######## skipSpaceCheck=false -skipRepoUpdate=false +reconfigure=false runUnattended=false ######## FIRST CHECK ######## @@ -864,13 +864,25 @@ View the web interface at http://pi.hole/admin or http://${IPv4_address%/*}/admi } update_dialogs(){ + # reconfigure + if [ "$reconfigure" = true ]; then + opt1a="Refresh" + opt1b="Refresh will retain existing settings" + strAdd="You will remain on the same version" + else + opt1a="Update" + opt1b="Update will retain existing settings." + strAdd="You will be updated to the latest version." + fi + opt2a="Reconfigure" + opt2b="Reconfigure will allow you to enter new settings" - UpdateCmd=$(whiptail --title "Existing Install Detected!" --menu "\n\nWe have detected an existing install.\n\nPlease choose from the following options:" ${r} ${c} 2 \ - "Update" "Update install will retain existing settings." \ - "Install" "Install will allow you to enter new settings." 3>&2 2>&1 1>&3) + UpdateCmd=$(whiptail --title "Existing Install Detected!" --menu "\n\nWe have detected an existing install.\n\nPlease choose from the following options: \n($strAdd)" ${r} ${c} 2 \ + "$opt1a" "$opt1b" \ + "$opt2a" "$opt2b" 3>&2 2>&1 1>&3) - if [[ $? = 0 ]];then - case ${UpdateCmd} in + if [[ $? = 0 ]];then + case ${UpdateCmd} in Update) echo "::: Updating existing install" . ${setupVars} @@ -880,21 +892,20 @@ update_dialogs(){ echo "::: Running complete install script" useUpdateVars=false ;; - esac - else - echo "::: Cancel selected. Exiting..." - exit 1 - fi + esac + else + echo "::: Cancel selected. Exiting..." + exit 1 + fi } main() { - # Check arguments for the undocumented flags for var in "$@" do case "$var" in - "--reconfigure" ) skipRepoUpdate=true;; + "--reconfigure" ) reconfigure=true;; "--i_do_not_follow_recommendations" ) skipSpaceCheck=false;; "--unattended" ) runUnattended=true;; esac @@ -929,7 +940,7 @@ install_dependent_packages INSTALLER_DEPS[@] # Install packages used by the Pi-hole install_dependent_packages PIHOLE_DEPS[@] -if [[ "$skipRepoUpdate" = true ]]; then +if [[ "$reconfigure" = true ]]; then echo "::: --reconfigure passed to install script. Not downloading/updating local repos" else # Get Git files for Core and Admin From 05dadad2e1568ac5f5c383be526f9501197514dc Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 21:22:46 +0100 Subject: [PATCH 14/17] repair sounds better than refresh --- automated install/basic-install.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/automated install/basic-install.sh b/automated install/basic-install.sh index a5de9863..82ef1a53 100755 --- a/automated install/basic-install.sh +++ b/automated install/basic-install.sh @@ -866,8 +866,8 @@ View the web interface at http://pi.hole/admin or http://${IPv4_address%/*}/admi update_dialogs(){ # reconfigure if [ "$reconfigure" = true ]; then - opt1a="Refresh" - opt1b="Refresh will retain existing settings" + opt1a="Repair" + opt1b="Repair will retain existing settings" strAdd="You will remain on the same version" else opt1a="Update" From a65b784907e3d845ffd78f661930916205f0c75b Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 21:26:41 +0100 Subject: [PATCH 15/17] repeat after me: repetition is a bit repetitive. --- automated install/basic-install.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/automated install/basic-install.sh b/automated install/basic-install.sh index 82ef1a53..00acf333 100755 --- a/automated install/basic-install.sh +++ b/automated install/basic-install.sh @@ -867,15 +867,15 @@ update_dialogs(){ # reconfigure if [ "$reconfigure" = true ]; then opt1a="Repair" - opt1b="Repair will retain existing settings" + opt1b="This will retain existing settings" strAdd="You will remain on the same version" else opt1a="Update" - opt1b="Update will retain existing settings." + opt1b="This will retain existing settings." strAdd="You will be updated to the latest version." fi opt2a="Reconfigure" - opt2b="Reconfigure will allow you to enter new settings" + opt2b="This will allow you to enter new settings" UpdateCmd=$(whiptail --title "Existing Install Detected!" --menu "\n\nWe have detected an existing install.\n\nPlease choose from the following options: \n($strAdd)" ${r} ${c} 2 \ "$opt1a" "$opt1b" \ From a84c3adeabb95ce2dba9f73ed9db32f84eff5361 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 23:19:26 +0100 Subject: [PATCH 16/17] if uniformity then dan = happy --- automated install/basic-install.sh | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/automated install/basic-install.sh b/automated install/basic-install.sh index 00acf333..c4d7c01d 100755 --- a/automated install/basic-install.sh +++ b/automated install/basic-install.sh @@ -912,7 +912,7 @@ do done if [[ -f ${setupVars} ]];then - if [ "$runUnattended" = true ]; then + if [[ "${runUnattended}" == true ]]; then echo "::: --unattended passed to install script, no whiptail dialogs will be displayed" useUpdateVars=true else @@ -922,7 +922,7 @@ fi # Start the installer # Verify there is enough disk space for the install -if [[ "$skipSpaceCheck" = true ]]; then +if [[ "${skipSpaceCheck}" ==true ]]; then echo "::: --i_do_not_follow_recommendations passed to script, skipping free disk space verification!" else verifyFreeDiskSpace @@ -940,7 +940,7 @@ install_dependent_packages INSTALLER_DEPS[@] # Install packages used by the Pi-hole install_dependent_packages PIHOLE_DEPS[@] -if [[ "$reconfigure" = true ]]; then +if [[ "${reconfigure}" == true ]]; then echo "::: --reconfigure passed to install script. Not downloading/updating local repos" else # Get Git files for Core and Admin @@ -975,7 +975,7 @@ fi # Move the log file into /etc/pihole for storage mv ${tmpLog} ${instalLogLoc} -if [[ ${useUpdateVars} == false ]]; then +if [[ "${useUpdateVars}" == false ]]; then displayFinalMessage fi @@ -988,7 +988,7 @@ enable_service lighttpd echo " done." echo ":::" -if [[ ${useUpdateVars} == false ]]; then +if [[ "${useUpdateVars}" == false ]]; then echo "::: Installation Complete! Configure your devices to use the Pi-hole as their DNS server using:" echo "::: ${IPv4_address%/*}" echo "::: $IPv6_address" From 3884b01503d86f747424d8e96379bfd27b13acc0 Mon Sep 17 00:00:00 2001 From: Promofaux Date: Sat, 15 Oct 2016 23:21:13 +0100 Subject: [PATCH 17/17] Forgot a ` ` --- automated install/basic-install.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/automated install/basic-install.sh b/automated install/basic-install.sh index c4d7c01d..a423f795 100755 --- a/automated install/basic-install.sh +++ b/automated install/basic-install.sh @@ -922,7 +922,7 @@ fi # Start the installer # Verify there is enough disk space for the install -if [[ "${skipSpaceCheck}" ==true ]]; then +if [[ "${skipSpaceCheck}" == true ]]; then echo "::: --i_do_not_follow_recommendations passed to script, skipping free disk space verification!" else verifyFreeDiskSpace