Merge pull request #96 from dschaper/feature/AtomicFunctions

Feature/atomic functions

gravity.sh

@@ -4,6 +4,7 @@
 # Network-wide ad blocking via your Raspberry Pi
 # http://pi-hole.net
 # Compiles a list of ad-serving domains by downloading them from multiple sources
+
 piholeIPfile=/tmp/piholeIP
 if [[ -f $piholeIPfile ]];then
     # 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
@@ -17,7 +18,8 @@ else
 fi
 
 # Ad-list sources--one per line in single quotes
-# The mahakala source is commented out due to many users having issues with it blocking legitimate domains.  Uncomment at your own risk
+# The mahakala source is commented out due to many users having issues with it blocking legitimate domains.
+# Uncomment at your own risk
 sources=('https://adaway.org/hosts.txt'
 'http://adblock.gjtech.net/?format=unix-hosts'
 #'http://adblock.mahakala.is/'
@@ -47,6 +49,7 @@ if [[ -r $piholeDir/pihole.conf ]];then
     echo "** Local calibration requested..."
         . $piholeDir/pihole.conf
 fi
+
 ###########################
 # collapse - begin formation of pihole
 function gravity_collapse() {
@@ -65,8 +68,7 @@ else
 	fi
 }
 
-# patternCheck - check to see if curl downloaded any new files, and then process those
-# files so they are in host format.
+# patternCheck - check to see if curl downloaded any new files.
 function gravity_patternCheck() {
 	patternBuffer=$1
 	# check if the patternbuffer is a non-zero length file
@@ -75,18 +77,19 @@ function gravity_patternCheck() {
 		# and stored as is. They can be processed for content after they
 		# have been saved.
 		cp $patternBuffer $saveLocation
-                echo "Done."
+		echo "List updated, transport successful..."
 	else
 		# curl didn't download any host files, probably because of the date check
-                echo "Transporter logic detected no changes, pattern skipped..."
+		echo "No changes detected, transport skipped..."
 	fi
 }
 
-# transport - curl the specified url with any needed command extentions, then patternCheck
+# transport - curl the specified url with any needed command extentions
 function gravity_transport() {
 	url=$1
 	cmd_ext=$2
 	agent=$3
+	
 	# tmp file, so we don't have to store the (long!) lists in RAM
 	patternBuffer=$(mktemp)
 	heisenbergCompensator=""
@@ -94,19 +97,20 @@ function gravity_transport() {
 		# if domain has been saved, add file for date check to only download newer
 		heisenbergCompensator="-z $saveLocation"
 	fi
+
 	# Silently curl url
 	curl -s $cmd_ext $heisenbergCompensator -A "$agent" $url > $patternBuffer
-
+	# Check for list updates
 	gravity_patternCheck $patternBuffer
 
 	# Cleanup
 	rm -f $patternBuffer
-
 }
+
 # spinup - main gravity function
 function gravity_spinup() {
 
-# Loop through domain list.  Download each one and remove commented lines (lines beginning with '# 'or '/') and blank lines
+	# Loop through domain list.  Download each one and remove commented lines (lines beginning with '# 'or '/') and	 		# blank lines
 	for ((i = 0; i < "${#sources[@]}"; i++))
 	do
         url=${sources[$i]}
@@ -119,7 +123,7 @@ do
 
         agent="Mozilla/10.0"
 
-        echo -n "Getting $domain list... "
+        echo -n "  Getting $domain list: "
 
         # Use a case statement to download lists that need special cURL commands
         # to complete properly and reset the user agent when required
@@ -150,6 +154,10 @@ for i in "${activeDomains[@]}"
 	do	
    		cat $i |tr -d '\r' >> $piholeDir/$matter
 	done
+}
+
+# Pulsar - White/blacklist application
+function gravity_pulsar() {
 	
 	# Append blacklist entries if they exist
 	if [[ -r $blacklist ]];then
@@ -157,9 +165,6 @@ if [[ -r $blacklist ]];then
         echo "** Blacklisting $numberOf domain(s)..."
         cat $blacklist >> $piholeDir/$matter
 	fi
-}
-
-function gravity_pulsar() {
 
 	# Whitelist (if applicable) domains
 	if [[ -r $whitelist ]];then
@@ -194,6 +199,7 @@ function gravity_unique() {
 	numberOf=$(wc -l < $piholeDir/$eventHorizon)
 	echo "** $numberOf unique domains trapped in the event horizon."
 }
+
 function gravity_hostFormat() {
 	# Format domain list as "192.168.x.x domain.com"
 	echo "** Formatting domains into a HOSTS file..."
@@ -201,9 +207,13 @@ function gravity_hostFormat() {
 	# Copy the file over as /etc/pihole/gravity.list so dnsmasq can use it
 	cp $piholeDir/$accretionDisc $adList
 }
+
+# blackbody - remove any remnant files from script processes
 function gravity_blackbody() {
+	# Loop through list files	
 	for file in $piholeDir/*.$justDomainsExtension
 	do
+		# If list is in active array then leave it (noop) else rm the list
 		if [[ " ${activeDomains[@]} " =~ " ${file} " ]]; then
 			:
 		else
@@ -211,8 +221,8 @@ function gravity_blackbody() {
 		fi
 	done
 }
-function gravity_advanced() {
 
+function 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
@@ -222,6 +232,7 @@ function gravity_advanced() {
 
 	numberOf=$(wc -l < $piholeDir/$supernova)
 	echo "** $numberOf domains being pulled in by gravity..."
+
 	gravity_unique
 	
 	sudo kill -HUP $(pidof dnsmasq)