Merge pull request #392 from pi-hole/development

Pi-hole v2.6

Author: PromoFaux

.github/PULL_REQUEST_TEMPLATE.md

@@ -8,4 +8,4 @@ Changes proposed in this pull request:
 
 - 
 
-@pihole/gravity
+@pi-hole/gravity

.gitignore

@@ -0,0 +1 @@
+.DS_Store

README.md

@@ -1,9 +1,11 @@
 # Automated Install 
-##### Designed For Raspberry Pi A+, B, B+, 2, and Zero (with an Ethernet/Wi-Fi adapter)
+##### Designed For Raspberry Pi A+, B, B+, 2, Zero, and 3B (with an Ethernet/Wi-Fi adapter) (Works on most Debian distributions!)
+
 
 [![Join the chat at https://gitter.im/pi-hole/pi-hole](https://badges.gitter.im/pi-hole/pi-hole.svg)](https://gitter.im/pi-hole/pi-hole?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 1. Install Raspbian 
+
 2. Run the command below
 
 ### ```curl -L https://install.pi-hole.net | bash```

adlists.default

@@ -5,11 +5,11 @@
 #    2. run `nano /etc/pihole/adlists.list`                                    #
 #    3. Uncomment or comment any of the below lists                            #
 #                                                                              #
-#  Know of any other lists? Feel free to let us know about them, or add them   # 
+#  Know of any other lists? Feel free to let us know about them, or add them   #
 #  to this file!                                                               #
 ################################################################################
 
-# The below list amalgamates several lists we used previously. 
+# The below list amalgamates several lists we used previously.
 # See `https://github.com/StevenBlack/hosts` for details
 https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts
 
@@ -31,15 +31,18 @@ http://hosts-file.net/ad_servers.txt
 # ADZHOSTS list. Has been known to block legitimate domains
 #http://optimate.dl.sourceforge.net/project/adzhosts/HOSTS.txt
 
-# Windows 10 telemetry list - warning this one may block windows update
-#https://raw.githubusercontent.com/crazy-max/HostsWindowsBlocker/master/hosts.txt
+# Windows 10 telemetry list
+#https://raw.githubusercontent.com/crazy-max/WindowsSpyBlocker/master/hostsBlockWindowsSpy.txt
 
 # Securemecca.com list - Also blocks "adult" sites (pornography/gambling etc)
 #http://securemecca.com/Downloads/hosts.txt
 
 # Quidsup's tracker list
 https://raw.githubusercontent.com/quidsup/notrack/master/trackers.txt
 
+# Block the BBC News website Breaking News banner
+#https://raw.githubusercontent.com/BreakingTheNews/BreakingTheNews.github.io/master/hosts
+
 
 # Untested Lists:
 #https://raw.githubusercontent.com/reek/anti-adblock-killer/master/anti-adblock-killer-filters.txt

advanced/Scripts/blacklist.sh

@@ -11,52 +11,58 @@
 # (at your option) any later version.
 
 if [[ $# = 0 ]]; then
-    echo "Immediately blacklists one or more domains in the hosts file"
-    echo " "
-    echo "Usage: blacklist.sh domain1 [domain2 ...]"
-    echo "  "
-    echo "Options:"
-    echo "  -d, --delmode		Remove domains from the blacklist"
-    echo "  -nr, --noreload	Update blacklist without refreshing dnsmasq"
-    echo "  -f, --force		Force updating of the hosts files, even if there are no changes"
-    echo "  -q, --quiet		output is less verbose"
+    echo "::: Immediately blacklists one or more domains in the hosts file"
+    echo ":::"
+    echo "::: Usage: sudo pihole.sh -b domain1 [domain2 ...]"
+    echo ":::"
+    echo "::: Options:"
+    echo ":::  -d, --delmode		Remove domains from the blacklist"
+    echo ":::  -nr, --noreload		Update blacklist without refreshing dnsmasq"
+    echo ":::  -f, --force			Force updating of the hosts files, even if there are no changes"
+    echo ":::  -q, --quiet			output is less verbose"
     exit 1
 fi
 
 #globals
-blacklist=/etc/pihole/blacklist.txt
-adList=/etc/pihole/gravity.list
+basename=pihole
+piholeDir=/etc/$basename
+adList=$piholeDir/gravity.list
+blacklist=$piholeDir/blacklist.txt
 reload=true
 addmode=true
 force=false
 versbose=true
+
 domList=()
 domToRemoveList=()
 
-
-piholeIPfile=/tmp/piholeIP
 piholeIPv6file=/etc/pihole/.useIPv6
 
 # 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
 IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
-piholeIPCIDR=$(ip -o -f inet addr show dev $IPv4dev | awk '{print $4}' | awk 'END {print}')
+piholeIPCIDR=$(ip -o -f inet addr show dev "$IPv4dev" | awk '{print $4}' | awk 'END {print}')
 piholeIP=${piholeIPCIDR%/*}
 
 modifyHost=false
 
+# After setting defaults, check if there's local overrides
+if [[ -r $piholeDir/pihole.conf ]];then
+    echo "::: Local calibration requested..."
+        . $piholeDir/pihole.conf
+fi
+
 
 if [[ -f $piholeIPv6file ]];then
     # If the file exists, then the user previously chose to use IPv6 in the automated installer
     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(){	
+function HandleOther(){
   #check validity of domain
-	validDomain=$(echo $1 | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/')
-	
+	validDomain=$(echo "$1" | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/')
 	if [ -z "$validDomain" ]; then
-		echo $1 is not a valid argument or domain name
+		echo "::: $1 is not a valid argument or domain name"
 	else	  
 	  domList=("${domList[@]}" $validDomain)
 	fi
@@ -66,13 +72,12 @@ function PopBlacklistFile(){
 	#check blacklist file exists, and if not, create it
 	if [[ ! -f $blacklist ]];then
   	  touch $blacklist
-	fi	
-	for dom in "${domList[@]}"
-	do	  
-	  if $addmode; then
-	  	AddDomain $dom
+	fi
+	for dom in "${domList[@]}"; do
+	  if "$addmode"; then
+	  	AddDomain "$dom"
 	  else
-	    RemoveDomain $dom
+	    RemoveDomain "$dom"
 	  fi
 	done
 }
@@ -86,18 +91,18 @@ function AddDomain(){
 	  if $versbose; then
 	  echo -n "::: Adding $1 to blacklist file..."
 	  fi
-		echo $1 >> $blacklist
+		echo "$1" >> $blacklist
 		modifyHost=true
 		echo " done!"
 	else
 	if $versbose; then
-		echo "::: $1 already exists in blacklist.txt! No need to add"
+		echo "::: $1 already exists in $blacklist! No need to add"
 		fi
 	fi
 }
 
 function RemoveDomain(){
-  
+
   bool=false
   grep -Ex -q "$1" $blacklist || bool=true
   if $bool; then
@@ -110,12 +115,12 @@ function RemoveDomain(){
     if $versbose; then
     echo "::: Un-blacklisting $dom..."
     fi
-    domToRemoveList=("${domToRemoveList[@]}" $1)    
-    modifyHost=true	  	
-  fi  	
+    domToRemoveList=("${domToRemoveList[@]}" $1)
+    modifyHost=true
+  fi
 }
 
-function ModifyHostFile(){	
+function ModifyHostFile(){
 	 if $addmode; then
 	    #add domains to the hosts file
 	    if [[ -r $blacklist ]];then
@@ -124,28 +129,25 @@ function ModifyHostFile(){
         echo ":::"
         echo -n "::: Modifying HOSTS file to blacklist $numberOf domain${plural}..."	   		    
 	    	if [[ -n $piholeIPv6 ]];then	    	  
-	    	  cat $blacklist | awk -v ipv4addr="$piholeIP" -v ipv6addr="$piholeIPv6" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> $adList
-	      else	        
-	      	cat $blacklist | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' >>$adList
-	      fi		    
-		   
+				cat $blacklist | awk -v ipv4addr="$piholeIP" -v ipv6addr="$piholeIPv6" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> $adList
+	      	else	        
+				cat $blacklist | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' >>$adList
+	      	fi		    
 	  	fi
 	  else
-		
 		echo ":::"
-	  for dom in "${domToRemoveList[@]}"
-		do	  
-	      #we need to remove the domains from the blacklist file and the host file	     
-				echo "::: $dom"
-				echo -n ":::    removing from HOSTS file..."
-	      echo $dom | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /[^.]'{}'(?!.)/;' $adList  
-	      echo " done!"
-	      echo -n ":::    removing from blackist.txt..."
-	      echo $dom | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /'{}'(?!.)/;' $blacklist
-	      echo " done!"
-		done	  
-		fi
-	  
+	  	for dom in "${domToRemoveList[@]}"
+		do
+	      #we need to remove the domains from the blacklist file and the host file
+			echo "::: $dom"
+			echo -n ":::    removing from HOSTS file..."
+	      	echo "$dom" | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /[^.]'{}'(?!.)/;' $adList  
+	      	echo " done!"
+	      	echo -n ":::    removing from blackist.txt..."
+	      	echo "$dom" | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /'{}'(?!.)/;' $blacklist
+	      	echo " done!"
+		done
+	fi
 }
 
 function Reload() {
@@ -157,7 +159,7 @@ function Reload() {
 
 	if [[ $dnsmasqPid ]]; then
 		# service already running - reload config
-		sudo kill -HUP $dnsmasqPid
+		sudo kill -HUP "$dnsmasqPid"
 	else
 		# service not running, start it up
 		sudo service dnsmasq start
@@ -170,17 +172,17 @@ function Reload() {
 for var in "$@"
 do
   case "$var" in
-    "-nr"| "--noreload"  ) reload=false;;        			
+    "-nr"| "--noreload"  ) reload=false;;
     "-d" | "--delmode"   ) addmode=false;;
     "-f" | "--force"     ) force=true;;
     "-q" | "--quiet"     ) versbose=false;;  			
-    *                    ) HandleOther $var;;
+    *                    ) HandleOther "$var";;
   esac
 done
 
 PopBlacklistFile
 
-if $modifyHost || $force; then	
+if $modifyHost || $force; then
 	ModifyHostFile
 else
   if $versbose; then

advanced/Scripts/chronometer.sh

@@ -73,9 +73,9 @@ function outputJSON(){
 	CalcQueriesToday
 	CalcblockedToday
 	CalcPercentBlockedToday
-	
+
 	CalcBlockedDomains
-	
+
 	printf '{"domains_being_blocked":"%s","dns_queries_today":"%s","ads_blocked_today":"%s","ads_percentage_today":"%s"}\n' "$blockedDomainsTotal" "$queriesToday" "$blockedToday" "$percentBlockedToday"
 }
 
@@ -88,44 +88,45 @@ function normalChrono(){
 		echo "        $(ifconfig eth0 | awk '/inet addr/ {print $2}' | cut -d':' -f2)"
 		echo ""
 		uptime | cut -d' ' -f11-
-		uptime -p
+		#uptime -p	#Doesn't work on all versions of uptime
+		uptime | awk -F'( |,|:)+' '{if ($7=="min") m=$6; else {if ($7~/^day/) {d=$6;h=$8;m=$9} else {h=$6;m=$7}}} {print d+0,"days,",h+0,"hours,",m+0,"minutes."}'
 		echo "-------------------------------"
 		# Uncomment to continually read the log file and display the current domain being blocked
 		#tail -f /var/log/pihole.log | awk '/\/etc\/pihole\/gravity.list/ {if ($7 != "address" && $7 != "name" && $7 != "/etc/pihole/gravity.list") print $7; else;}'
-		
+
 		#uncomment next 4 lines to use original query count calculation
 		#today=$(date "+%b %e")
 		#todaysQueryCount=$(cat /var/log/pihole.log | grep "$today" | awk '/query/ {print $7}' | wc -l)
 		#todaysQueryCountV4=$(cat /var/log/pihole.log | grep "$today" | awk '/query/ && /\[A\]/ {print $7}' | wc -l)
 		#todaysQueryCountV6=$(cat /var/log/pihole.log | grep "$today" | awk '/query/ && /\[AAAA\]/ {print $7}' | wc -l)
-				
-		
+
+
 		CalcQueriesToday
 		CalcblockedToday
 		CalcPercentBlockedToday
-		
+
 		CalcBlockedDomains
-		
+
 		echo "Blocking:      $blockedDomainsTotal"
 		#below commented line does not add up to todaysQueryCount
 		#echo "Queries:       $todaysQueryCountV4 / $todaysQueryCountV6"
 		echo "Queries:       $queriesToday" #same total calculation as dashboard
 	  echo "Pi-holed:      $blockedToday ($percentBlockedToday%)"
-		
+
 		sleep 5
 	done
 }
 
 function displayHelp(){
- echo "Displays stats about your piHole!"
-    echo " "
-    echo "Usage: chronometer.sh [optional:-j]"
-    echo "Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds"
-    echo "  "
-    echo "Options:"
-    echo "  -j, --json		output stats as JSON formatted string"
-    echo "  -h, --help	display this help text"
-    
+ 	echo "::: Displays stats about your piHole!"
+    echo ":::"
+    echo "::: Usage: sudo pihole.sh -c [optional:-j]"
+    echo "::: Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds"
+    echo ":::"
+    echo "::: Options:"
+    echo ":::  -j, --json		output stats as JSON formatted string"
+    echo ":::  -h, --help		display this help text"
+
     exit 1
 }
 
@@ -137,7 +138,7 @@ for var in "$@"
 do
   case "$var" in
     "-j" | "--json"  ) outputJSON;;
-    "-h" | "--help"  ) displayHelp;;        			
+    "-h" | "--help"  ) displayHelp;;
     *                ) exit 1;;
   esac
 done