Merge pull request #794 from pi-hole/development

[RELEASE] v2.9.3

.github/ISSUE_TEMPLATE.md

@@ -1,7 +1,42 @@
-##### Expected Behaviour:
+_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
+
+**In raising this issue, I confirm the following (please check boxes, eg [X]):**
+
+- [ ] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md).
+- [ ] The issue I am reporting can be *replicated*
+- [ ] The issue I'm reporting isn't a duplicate (see [FAQs](https://github.com/pi-hole/pi-hole/wiki/FAQs), [closed issues](https://github.com/pi-hole/pi-hole/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), and [open issues](https://github.com/pi-hole/pi-hole/issues)).
+
+**How familiar are you with the codebase?:**
+
+- [ ] 1 (very unfamiliar)
+- [ ] 2
+- [ ] 3
+- [ ] 4
+- [ ] 5
+- [ ] 6
+- [ ] 7
+- [ ] 8
+- [ ] 9
+- [ ] 10 (very familiar)
+
+---
+**[FEATURE REQUEST | QUESTION | OTHER]:**
+
+_{replace this section with your content or delete if not a FEATURE REQUEST/QUESTION/OTHER}_
+
+**[BUG | ISSUE] Expected Behaviour:**
 
 
-##### Actual Behaviour:
+**[BUG | ISSUE] Actual Behaviour:**
 
 
-##### Steps to reproduce this issue:
+**[BUG | ISSUE] Steps to reproduce:**
+
+-
+-
+-
+-
+
+**(Optional) Debug Log generated by `pihole -d`:**
+
+`http://termbin.com/<something>`

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,11 +1,25 @@
-Fixes #[issue number] .
+_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
 
-Changes proposed in this pull request:
+**By submitting this pull request, I confirm the following (please check boxes, eg [X]):**
 
-- 
+- [ ] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md).
+- [ ] I have checked that [another pull request](https://github.com/pi-hole/pi-hole/pulls) for this purpose does not exist.
+- [ ] I have considered, and confirmed that this submission will be valuable to others.
+- [ ] I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
+- [ ] I give this submission freely, and claim no ownership to its content.
 
-- 
+**How familiar are you with the codebase?:**
 
-- 
+- [ ] 1 (very unfamiliar)
+- [ ] 2
+- [ ] 3
+- [ ] 4
+- [ ] 5
+- [ ] 6
+- [ ] 7
+- [ ] 8
+- [ ] 9
+- [ ] 10 (very familiar)
 
-@pi-hole/gravity
+---
+_{replace this line with your pull request content}_

.pullapprove.yml

@@ -1,6 +1,6 @@
 approve_by_comment: true
-approve_regex: '^(Approved|:shipit:|:\+1:)'
+approve_regex: '^(Approved|:shipit:|:\+1:|Engage)'
-reject_regex: '^(Rejected|:-1:)'
+reject_regex: '^(Rejected|:-1:|Borg)'
 reset_on_push: true
 author_approval: required
 reviewers:
@@ -12,3 +12,8 @@ reviewers:
   - PromoFaux
   name: pullapprove
   required: 3
+always_pending:
+  title_regex: '(WIP|wip)'
+  labels:
+    - wip
+  explanation: 'This PR is a work in progress...'

CONTRIBUTING.md

@@ -1,8 +1,37 @@
-This is a basic checklist for now, We will update it in the future.
+_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
 
-* Fork the repo and create your new branch based on the `development` branch.
+# Contributors Guide
-* Commit Unix line endings
+
-* If you want, try to keep to the theme of black holes/gravity. This can add some fun to your submission.
+Please read and understand the contribution guide before creating an issue or pull request.
-* Submit Pull Requests to the development branch only.
+
-* Before Submitting your Pull Request, merge `development` with your new branch and fix any conflicts. (Make sure you don't break anything in development!)
+## Etiquette
-* Be patient. We will review all submitted pull requests, but our focus is on stability.. please don't be offended if we reject your PR, or it appears we're doing nothing with it! We'll get around to it..
+
+- Our goal for Pi-hole is **stability before features**.  This means we focus on squashing critical bugs before adding new features.  Often, we can do both in tandem, but bugs will take priority over a new feature.
+- Pi-hole is open source and [powered by donations](https://pi-hole.net/donate/), and as such, we give our **free time** to build, maintain, and **provide user support** for this project.  It would be extremely unfair for us to suffer abuse or anger for our hard work, so please take a moment to consider that.
+- Please be considerate towards the developers and other users when raising issues or presenting pull requests.
+- Respect our decision(s), and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many people, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+**Before filing an issue:**
+
+- Attempt to replicate and **document** the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+**Before submitting a pull request:**
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Technical Requirements
+
+- Submit Pull Requests to the **development branch only**.
+- Before Submitting your Pull Request, merge `development` with your new branch and fix any conflicts. (Make sure you don't break anything in development!)
+- Commit Unix line endings.
+- (Optional fun) keep to the theme of Star Trek/black holes/gravity.

README.md

@@ -93,7 +93,7 @@ You can view [real-time stats](http://pi-hole.net/faq/install-the-real-time-lcd-
 -   [Pi-hole stats in your Mac's menu bar](https://getbitbar.com/plugins/Network/pi-hole.1m.py)
 -   [Get LED alerts for each blocked ad](http://www.stinebaugh.info/get-led-alerts-for-each-blocked-ad-using-pi-hole/)
 -   [Pi-hole on Ubuntu 14.04 on VirtualBox](http://hbalagtas.blogspot.com/2016/02/adblocking-with-pi-hole-and-ubuntu-1404.html)
--   [x86 Docker container that runs Pi-hole](https://hub.docker.com/r/diginc/pi-hole/)
+-   [Docker Pi-hole container (x86 and ARM)](https://hub.docker.com/r/diginc/pi-hole/)
 -   [Splunk: Pi-hole Visualizser](https://splunkbase.splunk.com/app/3023/)
 -   [Pi-hole Chrome extension](https://chrome.google.com/webstore/detail/pi-hole-list-editor/hlnoeoejkllgkjbnnnhfolapllcnaglh) ([open source](https://github.com/packtloss/pihole-extension))
 -   [Go Bananas for CHiP-hole ad blocking](https://www.hackster.io/jacobsalmela/chip-hole-network-wide-ad-blocker-98e037)

adlists.default

@@ -14,7 +14,6 @@
 https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts
 
 # Other lists we consider safe:
-http://adblock.gjtech.net/?format=unix-hosts
 http://mirror1.malwaredomains.com/files/justdomains
 http://sysctl.org/cameleon/hosts
 https://zeustracker.abuse.ch/blocklist.php?download=domainblocklist

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
+helpFunc()
-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 "::: 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,24 +163,32 @@ function ModifyHostFile(){
 	fi
 }
 
-function Reload() {
+Reload() {
 	# Reload hosts file
 	echo ":::"
 	echo -n "::: Refresh lists in dnsmasq..."
 
-	dnsmasqPid=$(pidof dnsmasq)
+    dnsmasqPid=$(pidof dnsmasq)
 
 	if [[ ${dnsmasqPid} ]]; then
-		# service already running - reload config
+	    # service already running - reload config
-		${SUDO} killall -s HUP dnsmasq
+	    if [ -x "$(command -v systemctl)" ]; then
+            systemctl restart dnsmasq
+        else
+            service dnsmasq restart
+        fi
 	else
-		# service not running, start it up
+	    # service not running, start it up
-		${SUDO} service dnsmasq start
+	    if [ -x "$(command -v systemctl)" ]; then
+            systemctl start dnsmasq
+        else
+            service dnsmasq start
+        fi
 	fi
 	echo " done!"
 }
 
-function DisplayBlist() {
+DisplayBlist() {
 	verbose=false
 	echo -e " Displaying Gravity Affected Domains \n"
 	count=1

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]"

advanced/Scripts/piholeDebug.sh

@@ -3,13 +3,14 @@
 # (c) 2015, 2016 by Jacob Salmela
 # Network-wide ad blocking via your Raspberry Pi
 # http://pi-hole.net
-# Generates pihole_debug.log in /var/log/ to be used for troubleshooting.
+# Generates pihole_debug.log to be used for troubleshooting.
 #
 # 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.
 
+set -o pipefail
 
 ######## GLOBAL VARS ########
 DEBUG_LOG="/var/log/pihole_debug.log"
@@ -25,18 +26,27 @@ ADLISTSFILE="/etc/pihole/adlists.list"
 PIHOLELOG="/var/log/pihole.log"
 WHITELISTMATCHES="/tmp/whitelistmatches.list"
 
+# Header info and introduction
+echo "::: Beginning Pi-hole debug at $(date)!"
+echo "::: This debugging process will collect information from your running configuration,"
+echo "::: and optionally upload the generated log to a unique and random directory on"
+echo "::: Termbin.com. NOTE: All log files auto-delete after 1 month and you are the only"
+echo "::: person who is given the unique URL. Please consider where you post this link."
+echo "::: "
+
 
 ######## FIRST CHECK ########
 # Must be root to debug
-if [[ $EUID -eq 0 ]]; then
+if [[ "$EUID" -eq 0 ]]; then
-	echo "::: You are root... Beginning debug!"
+	echo "::: Script is executing as root user..."
 else
-	echo "::: Sudo will be used for debugging."
+	echo "::: Non-root user detected..."
 	# Check if sudo is actually installed
 	if [ -x "$(command -v sudo)" ]; then
 		export SUDO="sudo"
+		echo "::: sudo command located, debug will run under sudo."
 	else
-		echo "::: Please install sudo or run this as root."
+		echo "::: Unable to locate sudo command. Please install sudo or run this as root."
 		exit 1
 	fi
 fi
@@ -51,68 +61,153 @@ else
 fi
 
 ### Private functions exist here ###
-function versionCheck {
+function log_write {
-	echo "#######################################" >> ${DEBUG_LOG}
+  echo "$1" >> "${DEBUG_LOG}"
-	echo "########## Versions Section ###########" >> ${DEBUG_LOG}
-	echo "#######################################" >> ${DEBUG_LOG}
-	
-	TMP=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
-	echo "Pi-hole Version: $TMP" >> ${DEBUG_LOG}
-	
-	TMP=$(cd /var/www/html/admin && git describe --tags --abbrev=0)
-	echo "WebUI Version: $TMP" >> ${DEBUG_LOG}
-	echo >> ${DEBUG_LOG}
 }
 
-function distroCheck {
+function version_check {
-	echo "#######################################" >> ${DEBUG_LOG}
+  log_write "############################################################"
-	echo "######## Distribution Section #########" >> ${DEBUG_LOG}
+  log_write "##########           Installed Versions           ##########"
-	echo "#######################################" >> ${DEBUG_LOG}
+  log_write "############################################################"
-	
+
+  echo "::: Detecting Pi-hole installed versions."
+  pi_hole_ver="$(cd /etc/.pihole/ && git describe --tags --abbrev=0)" \
+  && log_write "Pi-hole Version: $pi_hole_ver" || log_write "Pi-hole git repository not detected."
+  admin_ver="$(cd /var/www/html/admin && git describe --tags --abbrev=0)" \
+  && log_write "WebUI Version: $admin_ver" || log_write "Pi-hole Admin Pages git repository not detected."
+
+  echo "::: Writing lighttpd version to logfile."
+  light_ver="$(lighttpd -v |& head -n1)" && log_write "${light_ver}" || log_write "lighttpd not installed."
+
+  echo "::: Writing PHP version to logfile."
+  php_ver="$(php -v |& head -n1)" && log_write "${php_ver}" || log_write "PHP not installed."
+}
+
+function distro_check {
+	echo "############################################################" >> ${DEBUG_LOG}
+	echo "########          Installed OS Distribution        #########" >> ${DEBUG_LOG}
+	echo "############################################################" >> ${DEBUG_LOG}
+
+	echo "::: Checking installed OS Distribution release."
 	TMP=$(cat /etc/*release || echo "Failed to find release")
-	echo "Distribution Version: $TMP" >> ${DEBUG_LOG}
-}
-	
-function compareWhitelist {
-	if [ ! -f "$WHITELISTMATCHES" ]; then
-		${SUDO} touch ${WHITELISTMATCHES}
-		${SUDO} chmod 644 ${WHITELISTMATCHES}
-		${SUDO} chown "$USER":root ${WHITELISTMATCHES}
-	else
-		truncate -s 0 ${WHITELISTMATCHES}
-	fi
 
-	echo "#######################################" >> ${DEBUG_LOG}
+	echo "::: Writing OS Distribution release to logfile."
-	echo "######## Whitelist Comparison #########" >> ${DEBUG_LOG}
+	echo "$TMP" >> ${DEBUG_LOG}
-	echo "#######################################" >> ${DEBUG_LOG}
-	while read -r line; do
-		TMP=$(grep -w ".* $line$" "$GRAVITYFILE")
-		if [ ! -z "$TMP" ]; then
-			echo "$TMP" >> ${DEBUG_LOG}
-			echo "$TMP"	>> ${WHITELISTMATCHES}
-		fi
-	done < "$WHITELISTFILE"
 	echo >> ${DEBUG_LOG}
 }
 
-function compareBlacklist {
+function ip_check {
-	echo "#######################################" >> ${DEBUG_LOG}
+	echo "############################################################" >> ${DEBUG_LOG}
-	echo "######## Blacklist Comparison #########" >> ${DEBUG_LOG}
+	echo "########           IP Address Information          #########" >> ${DEBUG_LOG}
-	echo "#######################################" >> ${DEBUG_LOG}
+	echo "############################################################" >> ${DEBUG_LOG}
-	while read -r line; do
+
-		if [ ! -z "$line" ]; then
+    echo "::: Writing local IPs to logfile"
-			grep -w ".* $line$" "$GRAVITYFILE" >> ${DEBUG_LOG}
+    IPADDR="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet") print $(i+1) }')"
-		fi
+    echo "$IPADDR" >> ${DEBUG_LOG}
-	done < "$BLACKLISTFILE"
+
-	echo >> ${DEBUG_LOG}
+    IP6ADDR="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet6") print $(i+1) }')" \
+    && echo "$IP6ADDR" >> ${DEBUG_LOG} || echo "No IPv6 addresses found." >> ${DEBUG_LOG}
+    echo >> ${DEBUG_LOG}
+
+    echo "::: Locating default gateway and checking connectivity"
+    GATEWAY=$(ip r | grep default | cut -d ' ' -f 3)
+    if [[ $? = 0 ]]
+    then
+    echo "::: Pinging default IPv4 gateway..."
+    GATEWAY_CHECK=$(ping -q -w 3 -c 3 -n "${GATEWAY}" | tail -n3)
+        if [[ $? = 0 ]]
+        then
+        echo "IPv4 Gateway check:" >> ${DEBUG_LOG}
+        else
+        echo "IPv4 Gateway check failed:" >> ${DEBUG_LOG}
+        fi
+    echo "$GATEWAY_CHECK" >> ${DEBUG_LOG}
+    echo >> ${DEBUG_LOG}
+
+    echo "::: Pinging Internet via IPv4..."
+    INET_CHECK=$(ping -q -w 5 -c 3 -n 8.8.8.8 | tail -n3)
+        if [[ $? = 0 ]]
+        then
+        echo "IPv4 Internet check:" >> ${DEBUG_LOG}
+        else
+        echo "IPv4 Internet check failed:" >> ${DEBUG_LOG}
+        fi
+    echo "$INET_CHECK" >> ${DEBUG_LOG}
+    echo >> ${DEBUG_LOG}
+    fi
+
+    GATEWAY6=$(ip -6 r | grep default | cut -d ' ' -f 3)
+    if [[ $? = 0 ]]
+    then
+    echo "::: Pinging default IPv6 gateway..."
+    GATEWAY6_CHECK=$(ping6 -q -w 3 -c 3 -n "${GATEWAY6}" | tail -n3)
+        if [[ $? = 0 ]]
+        then
+        echo "IPv6 Gateway check:" >> ${DEBUG_LOG}
+        else
+        echo "IPv6 Gateway check failed:" >> ${DEBUG_LOG}
+        fi
+
+    echo "::: Pinging Internet via IPv6..."
+    GATEWAY6_CHECK=$(ping6 -q -w 3 -c 3 -n 2001:4860:4860::8888 | tail -n3)
+        if [[ $? = 0 ]]
+        then
+        echo "IPv6 Internet check:" >> ${DEBUG_LOG}
+        else
+        echo "IPv6 Internet check failed:" >> ${DEBUG_LOG}
+        fi
+
+    else
+    GATEWAY_CHECK="No IPv6 Gateway Detected"
+    fi
+    echo "$GATEWAY_CHECK" >> ${DEBUG_LOG}
+
+
+    echo >> ${DEBUG_LOG}
 }
 
-function testNslookup {
+function hostnameCheck {
-	TESTURL="doubleclick.com"
+    echo "############################################################" >> ${DEBUG_LOG}
-	echo "#######################################" >> ${DEBUG_LOG}
+	echo "########            Hostname Information           #########" >> ${DEBUG_LOG}
-	echo "############ NSLookup Test ############" >> ${DEBUG_LOG}
+	echo "############################################################" >> ${DEBUG_LOG}
-	echo "#######################################" >> ${DEBUG_LOG}
+
+    echo "::: Writing locally configured hostnames to logfile"
+    # Write the hostname output to compare against entries in /etc/hosts, which is logged next
+    echo "This Pi-hole is: $(hostname)" >> ${DEBUG_LOG}
+
+    echo "::: Writing hosts file to debug log..."
+    echo "###              Hosts              ###" >> ${DEBUG_LOG}
+
+    if [ -e "$HOSTSFILE" ]
+    then
+	    cat "$HOSTSFILE" >> ${DEBUG_LOG}
+	    echo >> ${DEBUG_LOG}
+    else
+	    echo "No hosts file found!" >> ${DEBUG_LOG}
+	    printf ":::\tNo hosts file found!\n"
+    fi
+}
+
+function portCheck {
+  echo "############################################################" >> ${DEBUG_LOG}
+	echo "########           Open Port Information           #########" >> ${DEBUG_LOG}
+	echo "############################################################" >> ${DEBUG_LOG}
+
+    echo "::: Detecting local server port 80 and 53 processes."
+
+    ${SUDO} lsof -i :80 >> ${DEBUG_LOG}
+    ${SUDO} lsof -i :53 >> ${DEBUG_LOG}
+    echo >> ${DEBUG_LOG}
+}
+
+function testResolver {
+	echo "############################################################" >> ${DEBUG_LOG}
+	echo "############      Resolver Functions Check      ############" >> ${DEBUG_LOG}
+	echo "############################################################" >> ${DEBUG_LOG}
+
+
 	# Find a blocked url that has not been whitelisted.
+    TESTURL="doubleclick.com"
 	if [ -s "$WHITELISTMATCHES" ]; then
 		while read -r line; do
 			CUTURL=${line#*" "}
@@ -128,12 +223,43 @@ function testNslookup {
 		done < "$GRAVITYFILE"
 	fi
 
-	echo "NSLOOKUP of $TESTURL from PiHole:" >> ${DEBUG_LOG}
+	echo "Resolution of $TESTURL from Pi-hole:" >> ${DEBUG_LOG}
-	nslookup "$TESTURL" >> ${DEBUG_LOG}
+	LOCALDIG=$(dig "$TESTURL" @127.0.0.1)
+	if [[ $? = 0 ]]
+	then
+	    echo "$LOCALDIG" >> ${DEBUG_LOG}
+	else
+	    echo "Failed to resolve $TESTURL on Pi-hole" >> ${DEBUG_LOG}
+	fi
 	echo >> ${DEBUG_LOG}
-	echo "NSLOOKUP of $TESTURL from 8.8.8.8:" >> ${DEBUG_LOG}
+
-	nslookup "$TESTURL" 8.8.8.8 >> ${DEBUG_LOG}
+
+	echo "Resolution of $TESTURL from 8.8.8.8:" >> ${DEBUG_LOG}
+	REMOTEDIG=$(dig "$TESTURL" @8.8.8.8)
+	if [[ $? = 0 ]]
+	then
+	    echo "$REMOTEDIG" >> ${DEBUG_LOG}
+	else
+	    echo "Failed to resolve $TESTURL on 8.8.8.8" >> ${DEBUG_LOG}
+	fi
 	echo >> ${DEBUG_LOG}
+
+	echo "Pi-hole dnsmasq specific records lookups" >> ${DEBUG_LOG}
+    echo "Cache Size:" >> ${DEBUG_LOG}
+    dig +short chaos txt cachesize.bind >> ${DEBUG_LOG}
+    echo "Insertions count:" >> ${DEBUG_LOG}
+    dig +short chaos txt insertions.bind >> ${DEBUG_LOG}
+    echo "Evictions count:" >> ${DEBUG_LOG}
+    dig +short chaos txt evictions.bind >> ${DEBUG_LOG}
+    echo "Misses count:" >> ${DEBUG_LOG}
+    dig +short chaos txt misses.bind >> ${DEBUG_LOG}
+    echo "Hits count:" >> ${DEBUG_LOG}
+    dig +short chaos txt hits.bind >> ${DEBUG_LOG}
+    echo "Auth count:" >> ${DEBUG_LOG}
+    dig +short chaos txt auth.bind >> ${DEBUG_LOG}
+    echo "Upstream Servers:" >> ${DEBUG_LOG}
+    dig +short chaos txt servers.bind >> ${DEBUG_LOG}
+    echo >> ${DEBUG_LOG}
 }
 
 function checkProcesses {
@@ -150,6 +276,7 @@ function checkProcesses {
 		echo " processes status:" >> ${DEBUG_LOG}
 		${SUDO} systemctl -l status "$i" >> "$DEBUG_LOG"
 	done
+	echo >> ${DEBUG_LOG}
 }
 
 function debugLighttpd {
@@ -186,26 +313,13 @@ function debugLighttpd {
 
 ### END FUNCTIONS ###
 
-### Check Pi internet connections ###
+version_check
-# Log the IP addresses of this Pi
+distro_check
-IPADDR=$(${SUDO} ifconfig | perl -nle 's/dr:(\S+)/print $1/e')
+ip_check
-echo "::: Writing local IPs to debug log"
+hostnameCheck
-echo "IP Addresses of this Pi:" >> ${DEBUG_LOG}
+portCheck
-echo "$IPADDR" >> ${DEBUG_LOG}
-echo >> ${DEBUG_LOG}
-
-# Check if we can connect to the local gateway
-GATEWAY_CHECK=$(ping -q -w 1 -c 1 "$(ip r | grep default | cut -d ' ' -f 3)" > /dev/null && echo ok || echo error)
-echo "Gateway check:" >> ${DEBUG_LOG}
-echo "$GATEWAY_CHECK" >> ${DEBUG_LOG}
-echo >> ${DEBUG_LOG}
-
-versionCheck
-distroCheck
-compareWhitelist
-compareBlacklist
-testNslookup
 checkProcesses
+testResolver
 debugLighttpd
 
 echo "::: Writing dnsmasq.conf to debug log..."
@@ -258,24 +372,8 @@ else
 	printf ":::\tNo gravity.list file found\n"
 fi
 
-# Write the hostname output to compare against entries in /etc/hosts, which is logged next
-echo "Hostname of this pihole is: " >> ${DEBUG_LOG}
-hostname >> ${DEBUG_LOG}
 
-echo "::: Writing hosts file to debug log..."
+### Pi-hole application specific logging ###
-echo "#######################################" >> ${DEBUG_LOG}
-echo "################ Hosts ################" >> ${DEBUG_LOG}
-echo "#######################################" >> ${DEBUG_LOG}
-if [ -e "$HOSTSFILE" ]
-then
-	cat "$HOSTSFILE" >> ${DEBUG_LOG}
-	echo >> ${DEBUG_LOG}
-else
-	echo "No hosts file found!" >> ${DEBUG_LOG}
-	printf ":::\tNo hosts file found!\n"
-fi
-
-### PiHole application specific logging ###
 echo "::: Writing whitelist to debug log..."
 echo "#######################################" >> ${DEBUG_LOG}
 echo "############## Whitelist ##############" >> ${DEBUG_LOG}
@@ -308,7 +406,12 @@ echo "############ adlists.list #############" >> ${DEBUG_LOG}
 echo "#######################################" >> ${DEBUG_LOG}
 if [ -e "$ADLISTSFILE" ]
 then
-	cat "$ADLISTSFILE" >> ${DEBUG_LOG}
+  while read -r line; do
+    if [ ! -z "$line" ]; then
+		  [[ "$line" =~ ^#.*$ ]] && continue
+			echo "$line" >> ${DEBUG_LOG}
+	fi
+	done < "$ADLISTSFILE"
 	echo >> ${DEBUG_LOG}
 else
 	echo "No adlists.list file found... using adlists.default!" >> ${DEBUG_LOG}
@@ -319,7 +422,7 @@ fi
 # Continuously append the pihole.log file to the pihole_debug.log file
 function dumpPiHoleLog {
 	trap '{ echo -e "\n::: Finishing debug write from interrupt... Quitting!" ; exit 1; }' INT
-	echo -e "::: Writing current pihole traffic to debug log...\n:::\tTry loading any/all sites that you are having trouble with now... \n:::\t(Press ctrl+C to finish)"
+	echo -e "::: Writing current Pi-hole traffic to debug log...\n:::\tTry loading any/all sites that you are having trouble with now... \n:::\t(Press ctrl+C to finish)"
 	echo "#######################################" >> ${DEBUG_LOG}
 	echo "############# pihole.log ##############" >> ${DEBUG_LOG}
 	echo "#######################################" >> ${DEBUG_LOG}
@@ -338,7 +441,7 @@ function dumpPiHoleLog {
 # Anything to be done after capturing of pihole.log terminates
 function finalWork {
         echo "::: Finshed debugging!"
-    echo "::: The degug log can be uploaded to Termbin.com for easier sharing."
+    echo "::: The debug log can be uploaded to Termbin.com for easier sharing."
         read -r -p "::: Would you like to upload the log? [y/N] " response
     case ${response} in
         [yY][eE][sS]|[yY])

advanced/Scripts/piholeLogFlush.sh

@@ -11,5 +11,5 @@
 # (at your option) any later version.
 
 echo -n "::: Flushing /var/log/pihole.log ..."
-truncate -s 0 /var/log/pihole.log
+echo " " > /var/log/pihole.log
 echo "... done!"

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
+      systemctl set-default multi-user.target
-      ${SUDO} ln -fs /etc/systemd/system/autologin@.service /etc/systemd/system/getty.target.wants/getty@tty1.service
+      ln -fs /etc/systemd/system/autologin@.service /etc/systemd/system/getty.target.wants/getty@tty1.service
     else
-      ${SUDO} update-rc.d lightdm disable 2
+      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/"
+      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
+curl -SLs https://apt.adafruit.com/add-pin | bash
-${SUDO} apt-get -y install raspberrypi-bootloader
+apt-get -y install raspberrypi-bootloader
-${SUDO} apt-get -y install adafruit-pitft-helper
+apt-get -y install adafruit-pitft-helper
-${SUDO} adafruit-pitft-helper -t 28r
+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
+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
+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
+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
+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

advanced/Scripts/updateDashboard.sh

@@ -1,69 +0,0 @@
-#!/usr/bin/env 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
-# Updates the Pi-hole web interface
-#
-# 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.
-
-WEB_INTERFACE_GIT_URL="https://github.com/pi-hole/AdminLTE.git"
-WEB_INTERFACE_DIR="/var/www/html/admin"
-
-main() {
-    prerequisites
-    if ! is_repo; then
-        make_repo
-    fi
-    update_repo
-}
-
-prerequisites() {
-
-    # must be root to update
-    if [[ $EUID -ne 0 ]]; then
-        sudo bash "$0" "$@"
-        exit $?
-    fi
-
-    # web interface must already exist. this is a (lazy)
-    # check to make sure pihole is actually installed.
-    if [ ! -d "$WEB_INTERFACE_DIR" ]; then
-        echo "$WEB_INTERFACE_DIR not found. Exiting."
-        exit 1
-    fi
-
-    if ! type "git" > /dev/null; then
-        apt-get -y install git
-    fi
-}
-
-is_repo() {
-    # if the web interface directory does not have a .git folder
-    # it means its using the master.zip archive from the install
-    # script.
-    if [ ! -d "$WEB_INTERFACE_DIR/.git" ]; then
-        return 1
-    fi
-    return 0
-}
-
-# removes the web interface installed from the master.zip archive and
-# replaces it with the current master branch from github
-make_repo() {
-    # remove the non-repod interface and clone the interface
-    rm -rf ${WEB_INTERFACE_DIR}
-    git clone "$WEB_INTERFACE_GIT_URL" "$WEB_INTERFACE_DIR"
-}
-
-# pulls the latest master branch from github
-update_repo() {
-    # pull the latest commits
-    cd "$WEB_INTERFACE_DIR"
-    git pull
-}
-
-main

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,23 +181,31 @@ function ModifyHostFile(){
 	  fi
 }
 
-function Reload() {
+Reload() {
 	# Reload hosts file
 	echo ":::"
 	echo -n "::: Refresh lists in dnsmasq..."
-	dnsmasqPid=$(pidof dnsmasq)
+    dnsmasqPid=$(pidof dnsmasq)
 
 	if [[ ${dnsmasqPid} ]]; then
-		# service already running - reload config
+	    # service already running - reload config
-		${SUDO} killall -s HUP dnsmasq
+	    if [ -x "$(command -v systemctl)" ]; then
+            systemctl restart dnsmasq
+        else
+            service dnsmasq restart
+        fi
 	else
-		# service not running, start it up
+	    # service not running, start it up
-		${SUDO} service dnsmasq start
+	    if [ -x "$(command -v systemctl)" ]; then
+            systemctl start dnsmasq
+        else
+            service dnsmasq start
+        fi
 	fi
 	echo " done!"
 }
 
-function DisplayWlist() {
+DisplayWlist() {
 	verbose=false
 	echo -e " Displaying Gravity Resistant Domains \n"
 	count=1
@@ -251,4 +245,4 @@ fi
 
 if ${reload}; then
 	Reload
-fi
+fi

advanced/bash-completion/pihole

@@ -4,7 +4,7 @@ _pihole()
     COMPREPLY=()
     cur="${COMP_WORDS[COMP_CWORD]}"
     prev="${COMP_WORDS[COMP_CWORD-1]}"
-    opts="whitelist blacklist debug flush updateDashboard updateGravity setupLCD chronometer uninstall help"
+    opts="blacklist chronometer debug flush help query reconfigure setupLCD uninstall updateGravity updatePihole version whitelist"
 
     COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
     return 0

advanced/lighttpd.conf.fedora

@@ -46,7 +46,8 @@ mimetype.assign   = ( ".png"  => "image/png",
                       ".css" => "text/css; charset=utf-8",
                       ".js" => "application/javascript",
                       ".json" => "application/json",
-                      ".txt"  => "text/plain" )
+                      ".txt"  => "text/plain",
+                      ".svg"  => "image/svg+xml" )
 
 # default listening port for IPv6 falls back to the IPv4 port
 #include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port

advanced/pihole.cron

@@ -13,14 +13,13 @@
 #          Download any updates from the adlists
 59 1    * * 7   root    /usr/local/bin/pihole updateGravity
 
-# Pi-hole: Update the Web interface shortly after gravity runs
+# Pi-hole: Update Pi-hole! Uncomment to enable auto update
-#          This should also update the version number if it is changed in the dashboard repo
+#30 2    * * 7   root    /usr/local/bin/pihole updatePihole
-30 2    * * 7   root    /usr/local/bin/pihole updateDashboard
 
 # Pi-hole: Parse the log file before it is flushed and save the stats to a database
 #          This will be used for a historical view of your Pi-hole's performance
 #50 23  * * *   root    /usr/local/bin/dailyLog.sh # note: this is outdated
 
-# Pi-hole: Flush the log daily at 11:58 so it doesn't get out of control
+# Pi-hole: Flush the log daily at 00:00 so it doesn't get out of control
 #          Stats will be viewable in the Web interface thanks to the cron job above
-58 23   * * *   root    /usr/local/bin/pihole flush
+00 00   * * *   root    /usr/local/bin/pihole flush

gravity.sh

@@ -13,21 +13,7 @@
 # Run this script as root or under sudo
 echo ":::"
 
-if [[ $EUID -eq 0 ]];then
+helpFunc()
-	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"
 	echo ":::"
@@ -39,54 +25,43 @@ function helpFunc()
 	exit 1
 }
 
-piholeIPfile=/etc/pihole/piholeIP
-piholeIPv6file=/etc/pihole/.useIPv6
 
 adListFile=/etc/pihole/adlists.list
 adListDefault=/etc/pihole/adlists.default
 whitelistScript=/opt/pihole/whitelist.sh
 blacklistScript=/opt/pihole/blacklist.sh
 
-if [[ -f ${piholeIPfile} ]];then
+#Source the setupVars from install script for the IP
-    # If the file exists, it means it was exported from the installation script and we should use that value instead of detecting it in this script
+setupVars=/etc/pihole/setupVars.conf
-    piholeIP=$(cat ${piholeIPfile})
+if [[ -f ${setupVars} ]];then
-    #rm $piholeIPfile
+    . /etc/pihole/setupVars.conf
 else
-    # Otherwise, the IP address can be taken directly from the machine, which will happen when the script is run by the user and not the installation script
+    echo "::: WARNING: /etc/pihole/setupVars.conf missing. Possible installation failure."
-    IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
+    echo ":::          Please run 'pihole -r', and choose the 'install' option to reconfigure."
-    piholeIPCIDR=$(ip -o -f inet addr show dev "$IPv4dev" | awk '{print $4}' | awk 'END {print}')
+    exit 1
-    piholeIP=${piholeIPCIDR%/*}
 fi
 
-if [[ -f ${piholeIPv6file} ]];then
+#Remove the /* from the end of the IPv4addr.
-    # If the file exists, then the user previously chose to use IPv6 in the automated installer
+IPv4addr=${IPv4_address%/*}
-    piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
-fi
 
 # Variables for various stages of downloading and formatting the list
-## Nate 3/26/2016 - Commented unused variables
 basename=pihole
 piholeDir=/etc/${basename}
 adList=${piholeDir}/gravity.list
-#blacklist=$piholeDir/blacklist.txt
-#whitelist=$piholeDir/whitelist.txt
-#latentWhitelist=$piholeDir/latentWhitelist.txt
 justDomainsExtension=domains
-matterandlight=${basename}.0.matterandlight.txt
+matterAndLight=${basename}.0.matterandlight.txt
 supernova=${basename}.1.supernova.txt
 eventHorizon=${basename}.2.eventHorizon.txt
 accretionDisc=${basename}.3.accretionDisc.txt
-#eyeOfTheNeedle=$basename.4.wormhole.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..."
+    echo "::: pihole.conf file no longer supported. Over-rides in this file are ignored."
-        . ${piholeDir}/pihole.conf
 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.
@@ -123,18 +98,18 @@ 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
 }
 
 # 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
@@ -150,7 +125,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
@@ -172,7 +147,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++))
@@ -209,19 +184,19 @@ 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..."
-	truncate -s 0 ${piholeDir}/${matterandlight}
+	truncate -s 0 ${piholeDir}/${matterAndLight}
 	for i in "${activeDomains[@]}"
 	do
-		cat "$i" | tr -d '\r' >> ${piholeDir}/${matterandlight}
+		cat "$i" | tr -d '\r' >> ${piholeDir}/${matterAndLight}
 	done
 	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
@@ -231,7 +206,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
@@ -252,7 +227,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}
@@ -261,20 +236,26 @@ 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..."
-	hostname=$(</etc/hostname)
+	if [[ -f /etc/hostname ]]; then
+		hostname=$(</etc/hostname)
+	elif [ -x "$(command -v hostname)" ]; then
+		hostname=$(hostname -f)
+	else
+		echo "::: Error: Unable to determine fully qualified domain name of host"
+	fi
 	# If there is a value in the $piholeIPv6, then IPv6 will be used, so the awk command modified to create a line for both protocols
-	if [[ -n ${piholeIPv6} ]];then
+	if [[ -n "${IPv6_address}" ]];then
 		# Add hostname and dummy domain to the top of gravity.list to make ping result return a friendlier looking domain! Also allows for an easy way to access the Pi-hole admin console (pi.hole/admin)
-		echo -e "$piholeIP $hostname\n$piholeIPv6 $hostname\n$piholeIP pi.hole\n$piholeIPv6 pi.hole" > ${piholeDir}/${accretionDisc}
+		echo -e "$IPv4addr $hostname\n$IPv6_address $hostname\n$IPv4addr pi.hole\n$IPv6_address pi.hole" > ${piholeDir}/${accretionDisc}
-		cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$piholeIP" -v ipv6addr="$piholeIPv6" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc}
+		cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPv4addr" -v ipv6addr="$IPv6_address" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc}
 	else
 		# Otherwise, just create gravity.list as normal using IPv4
 		# Add hostname and dummy domain to the top of gravity.list to make ping result return a friendlier looking domain! Also allows for an easy way to access the Pi-hole admin console (pi.hole/admin)
-		echo -e "$piholeIP $hostname\n$piholeIP pi.hole" > ${piholeDir}/${accretionDisc}
+		echo -e "$IPv4addr $hostname\n$IPv4addr pi.hole" > ${piholeDir}/${accretionDisc}
-		cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' >> ${piholeDir}/${accretionDisc}
+		cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPv4addr" '{sub(/\r$/,""); print ipv4addr" "$0}' >> ${piholeDir}/${accretionDisc}
 	fi
 
 	# Copy the file over as /etc/pihole/gravity.list so dnsmasq can use it
@@ -282,7 +263,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
@@ -295,13 +276,16 @@ 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
 	# It also helps with debugging so each stage of the script can be researched more in depth
 	echo -n "::: Formatting list of domains to remove comments...."
-	awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' ${piholeDir}/${matterandlight} | sed -nr -e 's/\.{2,}/./g' -e '/\./p' >  ${piholeDir}/${supernova}
+	#awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' ${piholeDir}/${matterAndLight} | sed -nr -e 's/\.{2,}/./g' -e '/\./p' >  ${piholeDir}/${supernova}
+	#Above line does not correctly grab domains where comment is on the same line (e.g 'addomain.com #comment')
+	#Add additional awk command to read all lines up to a '#', and then continue as we were
+	cat ${piholeDir}/${matterAndLight} | awk -F'#' '{print $1}' | awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' | sed -nr -e 's/\.{2,}/./g' -e '/\./p' >  ${piholeDir}/${supernova}
 	echo " done!"
 
 	numberOf=$(wc -l < ${piholeDir}/${supernova})
@@ -310,11 +294,11 @@ function gravity_advanced() {
 	gravity_unique
 }
 
-function gravity_reload() {
+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
@@ -325,19 +309,26 @@ 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 chmod 666 {} \;
 
-    find "$piholeDir" -type f -exec ${SUDO} chmod 666 {} \;
+    dnsmasqPid=$(pidof dnsmasq)
 
 	if [[ ${dnsmasqPid} ]]; then
-		# service already running - reload config
+	    # service already running - reload config
-		${SUDO} killall -s HUP dnsmasq
+	    if [ -x "$(command -v systemctl)" ]; then
+            systemctl restart dnsmasq
+        else
+            service dnsmasq restart
+        fi
 	else
-		# service not running, start it up
+	    # service not running, start it up
-		${SUDO} service dnsmasq start
+	    if [ -x "$(command -v systemctl)" ]; then
+            systemctl start dnsmasq
+        else
+            service dnsmasq start
+        fi
 	fi
-	echo " done!"
 }
 
 
@@ -349,15 +340,14 @@ do
   esac
 done
 
-#Overwrite adlists.default from /etc/.pihole in case any changes have been made. Changes should be saved in /etc/adlists.list
-
 if [[ ${forceGrav} == true ]]; then
 	echo -n "::: Deleting exising list cache..."
-	${SUDO} rm /etc/pihole/list.*
+	rm /etc/pihole/list.*
 	echo " done!"
 fi
 
-${SUDO} cp /etc/.pihole/adlists.default /etc/pihole/adlists.default
+#Overwrite adlists.default from /etc/.pihole in case any changes have been made. Changes should be saved in /etc/adlists.list
+cp /etc/.pihole/adlists.default /etc/pihole/adlists.default
 gravity_collapse
 gravity_spinup
 gravity_Schwarzchild

pihole

@@ -12,88 +12,154 @@
 
 # Must be root to use this tool
 if [[ ! $EUID -eq 0 ]];then
-    #echo "::: You are root."
+    if [ -x "$(command -v sudo)" ];then
-#else
+        echo "::: Elevating to root with sudo"
-    #echo "::: Sudo will be used for this tool."
+        exec sudo bash "$0" "$@"
-  # Check if it is actually installed
+        exit $?
-  # If it isn't, exit because the pihole cannot be invoked without privileges.
+    else
-  if [ -x "$(command -v sudo)" ];then
+        echo "::: sudo is needed to run pihole commands.  Please run this script as root or install sudo."
-        export SUDO="sudo"
+        exit 1
-  else
+    fi
-    echo "::: Please install sudo or run this as root."
-    exit 1
-  fi
 fi
 
-function whitelistFunc {
+whitelistFunc() {
     shift
-    ${SUDO} /opt/pihole/whitelist.sh "$@"
+    /opt/pihole/whitelist.sh "$@"
-    exit 1
+    exit 0
 }
 
-function blacklistFunc {
+blacklistFunc() {
     shift
-    ${SUDO} /opt/pihole/blacklist.sh "$@"
+    /opt/pihole/blacklist.sh "$@"
-    exit 1
+    exit 0
 }
 
-function debugFunc {
+debugFunc() {
-    ${SUDO} /opt/pihole/piholeDebug.sh
+    /opt/pihole/piholeDebug.sh
-    exit 1
+    exit 0
 }
 
-function flushFunc {
+flushFunc() {
-    ${SUDO} /opt/pihole/piholeLogFlush.sh
+    /opt/pihole/piholeLogFlush.sh
-    exit 1
+    exit 0
 }
 
-function updateDashboardFunc {
+
-    ${SUDO} /opt/pihole/updateDashboard.sh
+updatePiholeFunc() {
-    exit 1
+
+    if [ ! -d "/etc/.pihole" ]; then #This is unlikely
+        echo "::: Critical Error: Pi-Hole repo missing from system!"
+        echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
+        exit 1;
+    fi
+    if [ ! -d "/var/www/html/admin" ]; then #This is unlikely
+        echo "::: Critical Error: Pi-Hole repo missing from system!"
+        echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
+        exit 1;
+    fi
+
+    echo "::: Checking for updates..."
+    piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
+    piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+
+    webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
+    webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+
+    echo "::: Pi-hole version is $piholeVersion (Latest version is $piholeVersionLatest)"
+    echo "::: Web Admin version is $webVersion (Latest version is $webVersionLatest)"
+    echo ":::"
+
+    if [[ ${piholeVersion} == ${piholeVersionLatest} ]] ; then
+        echo "::: Pi-hole Base files are already up to date! Version: ${piholeVersionLatest}"
+        echo "::: No need to update!"
+        echo ":::"
+
+        if [[ ${webVersion} == ${webVersionLatest} ]] ; then
+            echo "::: Web Admin files are already up to date!"
+            echo "::: No need to update!"
+            echo ":::"
+        else
+            echo "::: An Update is available for the Web Admin!"
+            echo ":::"
+            echo "::: Fetching latest changes from GitHub..."
+            cd /var/www/html/admin
+            git pull origin master
+            echo ":::"
+            echo "::: Pi-hole Web Admin has been updated to ${webVersion}"
+            echo "::: See https://changes.pi-hole.net for details"
+        fi
+    else
+        echo -n "::: An update is available for "
+        if [[ ${webVersion} == ${webVersionLatest} ]] ; then
+            echo " Pi-Hole!"
+        else
+            echo " Pi-Hole base files and the Web Admin. Both will be updated!"
+        fi
+
+        echo "::: Fetching latest changes from GitHub..."
+        cd /etc/.pihole
+        git pull origin master
+        /etc/.pihole/automated\ install/basic-install.sh --unattended
+
+        echo ":::"
+        echo "::: Pi-hole has been updated to version ${piholeVersionLatest}"
+        if [[ ${webVersion} != ${webVersionLatest} ]] ; then
+            echo "::: Web Admin has been updated to version ${webVersionLatest}"
+        fi
+        echo ":::"
+        echo "::: See https://changes.pi-hole.net for details"
+    fi
+
+    exit 0
 }
 
-function updatePiholeFunc {
+reconfigurePiholeFunc() {
-    echo "::: Fetching latest changes from Github..."
+    /etc/.pihole/automated\ install/basic-install.sh --reconfigure
-    cd /etc/.pihole
+    exit 0;
-    ${SUDO} git pull
-    ${SUDO} /etc/.pihole/automated\ install/basic-install.sh pihole
-    exit 1
 }
 
-function updateGravityFunc {
+updateGravityFunc() {
-    ${SUDO} /opt/pihole/gravity.sh "$@"
+    /opt/pihole/gravity.sh "$@"
-    exit 1
+    exit 0
 }
 
-function setupLCDFunction {
+setupLCDFunction() {
-    ${SUDO} /opt/pihole/setupLCD.sh
+    /opt/pihole/setupLCD.sh
-    exit 1
+    exit 0
 }
 
-function queryFunc {
+queryFunc() {
     domain=$2
-    for list in /etc/pihole/list.*;do echo $list;grep ${domain} $list;done
+    for list in /etc/pihole/list.*
-    exit 1
+    do
+        count=$(grep ${domain} $list | wc -l)
+        echo "::: ${list} (${count} results)"
+        if [[ ${count} > 0 ]]; then
+            grep ${domain} ${list}
+        fi
+        echo ""
+    done
+    exit 0
 }
 
-function chronometerFunc {
+chronometerFunc() {
     shift
-    ${SUDO} /opt/pihole/chronometer.sh "$@"
+    /opt/pihole/chronometer.sh "$@"
-    exit 1
+    exit 0
 }
 
 
-function uninstallFunc {
+uninstallFunc() {
-    ${SUDO} /opt/pihole/uninstall.sh
+    /opt/pihole/uninstall.sh
-    exit 1
+    exit 0
 }
 
-function versionFunc {
+versionFunc() {
-    ${SUDO} /opt/pihole/version.sh
+    /opt/pihole/version.sh
-    exit 1
+    exit 0
 }
 
-function helpFunc {
+helpFunc() {
     echo "::: Control all PiHole specific functions!"
     echo ":::"
     echo "::: Usage: pihole [options]"
@@ -104,8 +170,7 @@ function helpFunc {
     echo ":::  -b, blacklist            Blacklist domains"
     echo ":::  -d, debug                Start a debugging session if having trouble"
     echo ":::  -f, flush                Flush the pihole.log file"
-    echo ":::  -ud, updateDashboard      Update the web dashboard manually"
+    echo ":::  -up, updatePihole        Update Pi-hole"
-    echo ":::  -up, updatePihole           Update Pi-hole"
     echo ":::  -g, updateGravity        Update the list of ad-serving domains"
     echo ":::  -s, setupLCD             Automatically configures the Pi to use the 2.8 LCD screen to display stats on it"
     echo ":::  -c, chronometer          Calculates stats and displays to an LCD"
@@ -113,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
@@ -126,8 +191,8 @@ case "$1" in
 "-b" | "blacklist"			) blacklistFunc "$@";;
 "-d" | "debug"				) debugFunc;;
 "-f" | "flush"				) flushFunc;;
-"-ud" | "updateDashboard"	) updateDashboardFunc;;
 "-up" | "updatePihole"      ) updatePiholeFunc;;
+"-r"  | "reconfigure"       ) reconfigurePiholeFunc;;
 "-g" | "updateGravity"		) updateGravityFunc "$@";;
 "-s" | "setupLCD"			) setupLCDFunction;;
 "-c" | "chronometer"		) chronometerFunc "$@";;