@ -1,289 +1,377 @@
#!/usr/bin/env bash
# shellcheck disable=SC1090
# Pi-hole: A black hole for Internet advertisements
# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
# Network-wide ad blocking via your own hardware.
#
# Usage: "pihole -g"
# Compiles a list of ad-serving domains by downloading them from multiple sources
#
# This file is copyright under the latest version of the EUPL.
# Please see LICENSE file for your rights under this license.
# Run this script as root or under sudo
coltable = "/opt/pihole/COL_TABLE"
source ${ coltable }
helpFunc( ) {
echo " Usage: pihole -g
Update domains from blocklists specified in adlists.list
basename = "pihole"
PIHOLE_COMMAND = " /usr/local/bin/ ${ basename } "
WHITELIST_COMMAND = " ${ PIHOLE_COMMAND } -w "
Options:
-f, --force Force the download of all specified blocklists
-h, --help Show this help dialog"
exit 0
}
piholeDir = " /etc/ ${ basename } "
piholeRepo = " /etc/. ${ basename } "
adListFile = " ${ piholeDir } /adlists.list "
adListDefault = " ${ piholeDir } /adlists.default "
adListRepoDefault = " ${ piholeRepo } /adlists.default "
PIHOLE_COMMAND = "/usr/local/bin/pihole"
whitelistFile = " ${ piholeDir } /whitelist.txt "
blacklistFile = " ${ piholeDir } /blacklist.txt "
wildcardFile = "/etc/dnsmasq.d/03-pihole-wildcard.conf"
adListFile = /etc/pihole/adlists.list
adListDefault = /etc/pihole/adlists.default # Deprecated
adListRepoDefault = /etc/.pihole/adlists.default
whitelistScript = " ${ PIHOLE_COMMAND } -w "
whitelistFile = /etc/pihole/whitelist.txt
blacklistFile = /etc/pihole/blacklist.txt
readonly wildcardlist = "/etc/dnsmasq.d/03-pihole-wildcard.conf"
adList = " ${ piholeDir } /gravity.list "
blackList = " ${ piholeDir } /black.list "
localList = " ${ piholeDir } /local.list "
# Source the setupVars from install script for the IP
setupVars = /etc/pihole/setupVars.conf
domainsExtension = "domains"
matterAndLight = " ${ basename } .0.matterandlight.txt "
supernova = " ${ basename } .1.supernova.txt "
preEventHorizon = "list.preEventHorizon"
eventHorizon = " ${ basename } .2.supernova.txt "
accretionDisc = " ${ basename } .3.accretionDisc.txt "
skipDownload = "false"
# Source setupVars from install script
setupVars = " ${ piholeDir } /setupVars.conf "
if [ [ -f " ${ setupVars } " ] ] ; then
. /etc/pihole/setupVars.conf
source " ${ setupVars } "
# Remove CIDR mask from IPv4/6 addresses
IPV4_ADDRESS = " ${ IPV4_ADDRESS %/* } "
IPV6_ADDRESS = " ${ IPV6_ADDRESS %/* } "
else
echo -e " ${ COL_LIGHT_RED } Error: /etc/pihole/setupVars.conf missing. Possible installation failure. ${ COL_NC }
Please run 'pihole -r' , and choose the 'reconfigure' option to reconfigure."
echo -e " ${ COL_LIGHT_RED } Installation Failure: ${ setupVars } does not exist! ${ COL_NC }
Please run 'pihole -r' , and choose the 'reconfigure' option to fix ."
exit 1
fi
# Remove the /* from the end of the IP addresses
IPV4_ADDRESS = ${ IPV4_ADDRESS %/* }
IPV6_ADDRESS = ${ IPV6_ADDRESS %/* }
# Variables for various stages of downloading and formatting the list
basename = pihole
piholeDir = /etc/${ basename }
adList = ${ piholeDir } /gravity.list
blackList = ${ piholeDir } /black.list
localList = ${ piholeDir } /local.list
justDomainsExtension = domains
matterAndLight = ${ basename } .0.matterandlight.txt
supernova = ${ basename } .1.supernova.txt
preEventHorizon = list.preEventHorizon
eventHorizon = ${ basename } .2.supernova.txt
accretionDisc = ${ basename } .3.accretionDisc.txt
skipDownload = false
# Warn users still using pihole.conf that it no longer has any effect
if [ [ -r ${ piholeDir } /pihole.conf ] ] ; then
echo -e " ${ COL_LIGHT_RED } pihole.conf file no longer supported. Overrides in this file are ignored. ${ COL_NC } "
if [ [ -r " ${ piholeDir } /pihole.conf " ] ] ; then
echo -e " ${ COL_LIGHT_RED } Ignoring overrides specified within pihole.conf! ${ COL_NC } "
fi
###########################
# Collapse - begin formation of pihole
gravity_collapse( ) {
helpFunc( ) {
echo " Usage: pihole -g
Update domains from blocklists specified in adlists.list
Options:
-f, --force Force the download of all specified blocklists
-h, --help Show this help dialog"
exit 0
}
#New Logic:
# Does /etc/pihole/adlists.list exist? If so leave it alone
# If not, cp /etc/.pihole/adlists.default /etc/pihole/adlists.list
# Read from adlists.list
# Retrieve blocklist URLs from adlists.list
gravity_Collapse( ) {
echo -e " ${ INFO } Neutrino emissions detected... "
# The following two blocks will sort out any missing adlists in the /etc/pihole directory, and remove legacy adlists.default
# Handle "adlists.list" and "adlists.default" files
if [ [ -f " ${ adListDefault } " ] ] && [ [ -f " ${ adListFile } " ] ] ; then
rm " ${ adListDefault } "
# Remove superceded $adListDefault file
rm " ${ adListDefault } " 2> /dev/null || \
echo -e " ${ CROSS } Unable to remove ${ adListDefault } "
elif [ [ ! -f " ${ adListFile } " ] ] ; then
# Create "adlists.list"
cp " ${ adListRepoDefault } " " ${ adListFile } " 2> /dev/null || \
echo -e " ${ CROSS } Unable to copy ${ adListFile ##*/ } from ${ piholeRepo } "
fi
if [ ! -f " ${ adListFile } " ] ; then
cp " ${ adListRepoDefault } " " ${ adListFile } "
fi
echo -e " ${ INFO } Neutrino emissions detected... "
echo ""
local str = "Pulling source lists into range"
local str = "Pulling blocklist source list into range"
echo -ne " ${ INFO } ${ str } ... "
sources = ( )
while IFS = read -r line || [ [ -n " $line " ] ] ; do
# Do not read commented out or blank lines
if [ [ ${ line } = \# * ] ] || [ [ ! ${ line } ] ] ; then
echo "" > /dev/null
# Retrieve source URLs from $adListFile
# Logic: Remove comments, CR line endings and empty lines
mapfile -t sources < <( awk '!/^[#@;!\[]/ {gsub(/\r$/, "", $0); if ($1) { print $1 } }' " ${ adListFile } " 2> /dev/null)
# Parse source domains from $sources
# Logic: Split by folder/port and remove URL protocol/password
mapfile -t sourceDomains < <(
awk -F '[/:]' ' {
gsub( /( .*:\/ \/ | .*:.*@) /, "" , $0 )
print $1
} ' <<< "$(printf ' %s\n ' " ${ sources [@] } " ) " 2> /dev/null
)
if [ [ -n " ${ sources [*] } " ] ] || [ [ -n " ${ sourceDomains [*] } " ] ] ; then
echo -e " ${ OVER } ${ TICK } ${ str } "
else
echo -e " ${ OVER } ${ CROSS } ${ str } "
gravity_Cleanup "error"
fi
}
# Parse source file into domains-only format
gravity_ParseFileAsDomains( ) {
local source destination hostsFilter firstLine abpFilter
source = " ${ 1 } "
destination = " ${ 2 } "
# Determine how to parse source file
if [ [ " ${ source } " = = " ${ piholeDir } / ${ matterAndLight } " ] ] ; then
# Symbols used as comments: "#;@![/"
commentPattern = "[#;@![\\/]"
# Parse consolidated file by removing comments and hosts IP's
# Logic: Process lines which do not begin with comments
awk '!/^' " ${ commentPattern } " ' / {
# If there are multiple words seperated by space
if ( NF>1) {
# Remove comments (Inc. prefixed spaces/tabs)
if ( $0 ~ /'"${commentPattern}"' /) { gsub( "( | )'" ${ commentPattern } "'.*" , "" , $0 ) }
# Print consecutive domains
if ( $3 ) {
$1 = ""
gsub( "^ " , "" , $0 )
print $0
# Print single domain
} else if ( $2 ) {
print $2
}
# Print single domain
} else if ( $1 ) {
print $1
}
} ' " ${ source } " 2> /dev/null > " ${ destination } "
else
# Individual file parsing
# Logic: comments are kept, and domains are extracted from each line
read -r firstLine < " ${ source } "
# Determine how to parse individual source file
if [ [ " ${ firstLine ,, } " = ~ "adblock" ] ] || [ [ " ${ firstLine ,, } " = ~ "ublock" ] ] || [ [ " ${ firstLine ,, } " = ~ "! checksum" ] ] ; then
# Parse Adblock domains & comments: https://adblockplus.org/filter-cheatsheet
abpFilter = "/^(\\[|!)|^(\\|\\|.*\\^)/"
awk '' " ${ abpFilter } " ' {
# Remove valid adblock type options
gsub( /~?( important| third-party| popup| subdocument| websocket) ,?/, "" , $0 )
# Remove starting domain name anchor "||" and ending seperator "^$" ($ optional)
gsub( /( \| \| | \^ \$ ?$) /, "" , $0 )
# Remove lines which are only IPv4 addresses or contain "^/*"
if ( $0 ~ /( ^[ 0-9] +\. [ 0-9] +\. [ 0-9] +\. [ 0-9] +$| [ \\ ^\/ \* ] ) /) { $0 = "" }
# Print if not empty
if ( $0 ) { print $0 }
} ' " ${ source } " 2> /dev/null > " ${ destination } "
echo -e " ${ TICK } Format: Adblock "
elif grep -q -E " ^(https?://|([0-9]{1,3}\.){3}[0-9]{1,3} $) " " ${ source } " & > /dev/null; then
# Parse URLs
awk ' {
# Remove URL protocol, optional "username:password@", and ":?/;"
if ( $0 ~ /[ :?\/ ; ] /) { gsub( /( ^.*:\/ \/ ( .*:.*@) ?| [ :?\/ ; ] .*) /, "" , $0 ) }
# Remove lines which are only IPv4 addresses
if ( $0 ~ /^[ 0-9] +\. [ 0-9] +\. [ 0-9] +\. [ 0-9] +$/) { $0 = "" }
if ( $0 ) { print $0 }
} ' " ${ source } " 2> /dev/null > " ${ destination } "
echo -e " ${ TICK } Format: URL "
else
sources += ( ${ line } )
# Keep hosts/domains file in same format as it was downloaded
output = $( { mv " ${ source } " " ${ destination } " ; } 2>& 1 )
status = " $? "
if [ [ " ${ status } " -ne 0 ] ] ; then
echo -e " ${ CROSS } Unable to move tmp file to ${ piholeDir }
${ output } "
gravity_Cleanup "error"
fi
fi
done < ${ adListFile }
echo -e " ${ OVER } ${ TICK } ${ str } "
fi
}
# patternCheck - check to see if curl downloaded any new files.
gravity_patternCheck( ) {
patternBuffer = $1
success = $2
error = $3
# Determine output based on gravity_Transport() status
gravity_AdvancedTransport( ) {
local patternBuffer success error output status
patternBuffer = " ${ 1 } "
success = " ${ 2 } "
error = " ${ 3 } "
if [ [ " ${ success } " = true ] ] ; then
# Check if download was successful but list has not been modified
if [ [ " ${ error } " = = "304" ] ] ; then
echo -e " ${ TICK } No changes detected, transport skipped! "
: # Print no output
# Check if the patternbuffer is a non-zero length file
elif [ [ -s " ${ patternBuffer } " ] ] ; then
# Some blocklists are copyright, they need to be downloaded and stored
# as is. They can be processed for content after they have been saved.
mv " ${ patternBuffer } " " ${ saveLocation } "
echo -e " ${ TICK } List updated, transport successful! "
# Parse Adblock/URL format blocklists and include comments
# HOSTS format is moved as-is
gravity_ParseFileAsDomains " ${ patternBuffer } " " ${ saveLocation } " "1"
else
# Empty file -> use previously downloaded list
echo -e " ${ INFO } Received empty file, ${ COL_LIGHT_GREEN } using cached one ${ COL_NC } (list not updated!) "
# Fall back to previously cached list if current $patternBuffer is empty
echo -e " ${ INFO } Received empty file : ${ COL_LIGHT_GREEN } using previously cached list ${ COL_NC } "
fi
else
# Check if cached list exists
# Determine if cached list exists
if [ [ -r " ${ saveLocation } " ] ] ; then
echo -e " ${ CROSS } List download failed, using cached list (list not updated!) "
echo -e " ${ CROSS } List download failed : ${ COL_LIGHT_GREEN } using previously cached list ${ COL_NC } "
else
echo -e " ${ CROSS } Download failed and no cached list available (list will not be considered) "
echo -e " ${ CROSS } List download failed: ${ COL_LIGHT_RED } no cached list available ${ COL_NC } "
fi
fi
}
# transport - curl the specified url with any needed command extentions
gravity_transport( ) {
url = $1
cmd_ext = $2
agent = $3
# Curl the specified URL with any necessary command extentions
gravity_Transport( ) {
local url cmd_ext agent
url = " ${ 1 } "
cmd_ext = " ${ 2 } "
agent = " ${ 3 } "
# tmp file, so we don't have to store the (long!) lists in RAM
# Store downloaded content to temp file instead of RAM
patternBuffer = $( mktemp)
heisenbergCompensator = ""
if [ [ -r ${ saveLocation } ] ] ; then
if [ [ -r " ${ saveLocation } " ] ] ; then
# If domain has been saved, add file for date check to only download newer
heisenbergCompensator = " -z ${ saveLocation } "
fi
# Silently curl url
echo -e " ${ OVER } ${ TICK } ${ str } "
local str = "Status:"
echo -ne " ${ INFO } ${ str } Pending "
err = $( curl -s -L ${ cmd_ext } ${ heisenbergCompensator } -w %{ http_code} -A " ${ agent } " ${ url } -o ${ patternBuffer } )
# Analyze http response
case " $err " in
"200" ) echo -e " ${ OVER } ${ TICK } ${ str } Success (OK) " ; success = true; ;
"304" ) echo -e " ${ OVER } ${ TICK } ${ str } Not modified " ; success = true; ;
"403" ) echo -e " ${ OVER } ${ CROSS } ${ str } Forbidden " ; success = false; ;
"404" ) echo -e " ${ OVER } ${ CROSS } ${ str } Not found " ; success = false; ;
"408" ) echo -e " ${ OVER } ${ CROSS } ${ str } Time-out " ; success = false; ;
"451" ) echo -e " ${ OVER } ${ CROSS } ${ str } Unavailable For Legal Reasons " ; success = false; ;
"521" ) echo -e " ${ OVER } ${ CROSS } ${ str } Web Server Is Down (Cloudflare) " ; success = false; ;
"522" ) echo -e " ${ OVER } ${ CROSS } ${ str } Connection Timed Out (Cloudflare) " ; success = false; ;
"500" ) echo -e " ${ OVER } ${ CROSS } ${ str } Internal Server Error " ; success = false; ;
* ) echo -e " ${ OVER } ${ CROSS } ${ str } Status $err " ; success = false; ;
echo -ne " ${ INFO } ${ str } Pending... "
# shellcheck disable=SC2086
httpCode = $( curl -s -L ${ cmd_ext } ${ heisenbergCompensator } -w "%{http_code}" -A " ${ agent } " " ${ url } " -o " ${ patternBuffer } " 2> /dev/null)
# Determine "Status:" output based on HTTP response
case " $httpCode " in
"200" ) echo -e " ${ OVER } ${ TICK } ${ str } Transport successful " ; success = true; ;
"304" ) echo -e " ${ OVER } ${ TICK } ${ str } No changes detected " ; success = true; ;
"403" ) echo -e " ${ OVER } ${ CROSS } ${ str } Forbidden " ; success = false; ;
"404" ) echo -e " ${ OVER } ${ CROSS } ${ str } Not found " ; success = false; ;
"408" ) echo -e " ${ OVER } ${ CROSS } ${ str } Time-out " ; success = false; ;
"451" ) echo -e " ${ OVER } ${ CROSS } ${ str } Unavailable For Legal Reasons " ; success = false; ;
"521" ) echo -e " ${ OVER } ${ CROSS } ${ str } Web Server Is Down (Cloudflare) " ; success = false; ;
"522" ) echo -e " ${ OVER } ${ CROSS } ${ str } Connection Timed Out (Cloudflare) " ; success = false; ;
"500" ) echo -e " ${ OVER } ${ CROSS } ${ str } Internal Server Error " ; success = false; ;
* ) echo -e " ${ OVER } ${ CROSS } ${ str } Status $httpCode " ; success = false; ;
esac
# Process result
gravity_patternCheck " ${ patternBuffer } " " ${ success } " " ${ err } "
# Output additional info if success=false
gravity_AdvancedTransport " ${ patternBuffer } " " ${ success } " " ${ httpCod e} "
# Delete temp file if it hasn't been moved
# Delete temp file if it has no t been moved
if [ [ -f " ${ patternBuffer } " ] ] ; then
rm " ${ patternBuffer } "
fi
}
# spinup - main gravity function
gravity_spinup( ) {
# Define User Agent and options for each blocklist
gravity_Pull( ) {
local agent url domain cmd_ext str
echo ""
# Loop through domain list. Download each one and remove commented lines (lines beginning with '# 'or '/') and # blank lines
# Loop through $sources to download each one
for ( ( i = 0; i < " ${# sources [@] } " ; i++) ) ; do
url = ${ sources [ $i ] }
# Get just the domain from the URL
domain = $( cut -d'/' -f3 <<< " ${ url } " )
url = " ${ sources [ $i ] } "
domain = " ${ sourceDomains [ $i ] } "
# Save the file as list.#.domain
saveLocation = ${ piholeDir } /list.${ i } .${ domain } .${ justDomainsExtension }
activeDomains[ $i ] = ${ saveLocation }
saveLocation = " ${ piholeDir } /list. ${ i } . ${ domain } . ${ domainsExtension } "
activeDomains[ $i ] = " ${ saveLocation } "
agent = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.0 Safari/537.36"
# Use a case statement to download lists that need special cURL commands
# to complete properly and reset the user agent when required
# Use a case statement to download lists that need special commands
case " ${ domain } " in
"pgl.yoyo.org" )
cmd_ext = "-d mimetype=plaintext -d hostformat=hosts"
; ;
# Default is a simple request
*) cmd_ext = ""
"pgl.yoyo.org" ) cmd_ext = "-d mimetype=plaintext -d hostformat=hosts" ; ;
*) cmd_ext = "" ; ;
esac
if [ [ " ${ skipDownload } " = = false ] ] ; then
local str = " Aiming tractor beam at $domain "
echo -ne " ${ INFO } ${ str } ... "
str = " Target: $domain ( ${ url ##*/ } ) "
echo -e " ${ INFO } ${ str } "
gravity_Transport " $url " " $cmd_ext " " $agent " " $str "
gravity_transport " $url " " $cmd_ext " " $agent " " $str "
echo ""
fi
done
}
# Schwarzchild - aggreg ate domains to one list and add blacklisted domains
gravity_Schwarzchild( ) {
echo ""
# Find all active domains and compile them into one file and remove CRs
local str = "Aggregating list of domain
# Consolid ate domains to one list and add blacklisted domains
gravity_Schwarzs child( ) {
local str lastLine
str = "Consolidating blocklist
echo -ne " ${ INFO } ${ str } ... "
truncate -s 0 ${ piholeDir } /${ matterAndLight }
# Compile all blacklisted domains into one file and remove CRs
truncate -s 0 " ${ piholeDir } / ${ matterAndLight } "
for i in " ${ activeDomains [@] } " ; do
# Only assimilate list if it is available (download might have failed permanently)
if [ [ -r " ${ i } " ] ] ; then
cat " ${ i } " | tr -d '\r' >> ${ piholeDir } /${ matterAndLight }
tr -d '\r' < " ${ i } " >> " ${ piholeDir } / ${ matterAndLight } "
# Ensure each source blocklist has a final newline
lastLine = $( tail -1 " ${ piholeDir } / ${ matterAndLight } " )
[ [ " ${# lastLine } " -gt 0 ] ] && echo "" >> " ${ piholeDir } / ${ matterAndLight } "
fi
done
echo -e " ${ OVER } ${ TICK } ${ str } "
}
# Append blacklist entries to eventHorizon if they exist
gravity_Blacklist( ) {
# Append blacklist entries to eventHorizon if they exist
local numBlacklisted plural str
if [ [ -f " ${ blacklistFile } " ] ] ; then
numBlacklisted = $( wc -l < " ${ blacklistFile } " )
plural = ; [ [ " $ numBlacklisted" != "1" ] ] && plural = s
local str = " Exact blocked domain ${ plural } : $numBlacklisted "
numBlacklisted = $( printf "%'.0f" " $( " ${ blacklistFile } " ) " )
plural = ; [ [ " ${ } " != "1" ] ] && plural = s
str = " Exact blocked domain ${ plural } : $numBlacklisted "
echo -e " ${ INFO } ${ str } "
else
echo -e " ${ INFO } Nothing to blacklist! "
fi
}
# Return number of wildcards in output
gravity_Wildcard( ) {
# Return number of wildcards in output - don't actually handle wildcards
if [ [ -f " ${ wildcardlist } " ] ] ; then
numWildcards = $( grep -c ^ " ${ wildcardlist } " )
local numWildcards plural
if [ [ -f " ${ wildcardFile } " ] ] ; then
numWildcards = $( grep -c ^ " ${ wildcardFile } " )
if [ [ -n " ${ IPV4_ADDRESS } " ] ] && [ [ -n " ${ IPV6_ADDRESS } " ] ] ; then
let numWildcards/= 2
fi
plural = ; [ [ " $ numWildcards" != "1" ] ] && plural = s
plural = ; [ [ " ${ } " != "1" ] ] && plural = s
echo -e " ${ INFO } Wildcard blocked domain ${ plural } : $numWildcards "
else
echo -e " ${ INFO } No wildcards used! "
fi
}
# Prevent the domains of adlist sources from being blacklisted by other blocklists
gravity_Whitelist( ) {
local plural str
echo ""
# Prevent our sources from being pulled into the hole
plural = ; [ [ " ${ sources [@] } " != "1" ] ] && plural = s
local str = " Adding adlist source ${ plural } to the whitelist "
plural = ; [ [ " ${# sources [*] } " != "1" ] ] && plural = s
str = " Adding blocklist source ${ plural } to the whitelist "
echo -ne " ${ INFO } ${ str } ... "
urls = ( )
for url in " ${ sources [@] } " ; do
tmp = $( awk -F '/' '{print $3}' <<< " ${ url } " )
urls = ( " ${ urls [@] } " ${ tmp } )
done
# Create array of unique $sourceDomains
# shellcheck disable=SC2046
read -r -a uniqDomains <<< $( awk '{ if(!a[$1]++) { print $1 } }' <<< " $( printf '%s\n' " ${ sourceDomains [@] } " ) " )
echo -e " ${ OVER } ${ TICK } ${ str } "
${ WHITELIST_COMMAND } -nr -q " ${ uniqDomains [*] } " > /dev/null
# Ensure adlist domains are in whitelist.txt
${ whitelistScript } -nr -q " ${ urls [@] } " > /dev/null
echo -e " ${ OVER } ${ TICK } ${ str } "
# Check whitelist.txt exists.
# Test existence of whitelist.txt
if [ [ -f " ${ whitelistFile } " ] ] ; then
# Remove anything in whitelist.txt from the Event Horizon
numWhitelisted = $( wc -l < " ${ whitelistFile } " )
plural = ; [ [ " $ numWhitelisted" != "1" ] ] && plural = s
plural = ; [ [ " ${ } " != "1" ] ] && plural = s
local str = " Whitelisting $numWhitelisted domain ${ plural } "
echo -ne " ${ INFO } ${ str } ... "
# Print everything from preEventHorizon into eventHorizon EXCEPT domains in whitelist.txt
grep -F -x -v -f ${ whitelistFile } ${ piholeDir } /${ preEventHorizon } > ${ piholeDir } /${ eventHorizon }
grep -F -x -v -f " ${ whitelistFile } " " ${ piholeDir } ${ preEventHorizon } " " ${ piholeDir } ${ eventHorizon } "
echo -e " ${ OVER } ${ TICK } ${ str } "
else
@ -291,140 +379,155 @@ gravity_Whitelist() {
fi
}
gravity_unique( ) {
# Sort and remove duplicates
local str = "Removing duplicate domains"
echo -ne " ${ INFO } ${ str } ... "
sort -u ${ piholeDir } /${ supernova } > ${ piholeDir } /${ preEventHorizon }
# Sort and remove duplicate blacklisted domains
gravity_Unique( ) {
local str numberOf
str = "Removing duplicate domains"
echo -ne " ${ INFO } ${ str } ... "
sort -u " ${ piholeDir } / ${ supernova } " > " ${ piholeDir } / ${ preEventHorizon } "
echo -e " ${ OVER } ${ TICK } ${ str } "
numberOf = $( wc -l < ${ piholeDir } /${ preEventHorizon } )
echo -e " ${ INFO } ${ COL_LIGHT_BLUE } ${ numberOf } ${ COL_NC } unique domains trapped in the event horizon. "
numberOf = $( printf "%'.0f" " $( wc -l < " ${ piholeDir } / ${ preEventHorizon } " ) " )
echo -e " ${ INFO } ${ COL_LIGHT_BLUE } ${ numberOf } ${ COL_NC } unique domains trapped in the Event Horizon "
}
gravity_doHostFormat( ) {
# Check vars from setupVars.conf to see if we're using IPv4, IPv6, Or both.
if [ [ -n " ${ IPV4_ADDRESS } " ] ] && [ [ -n " ${ IPV6_ADDRESS } " ] ] ; then
# Both IPv4 and IPv6
awk -v ipv4addr = " $IPV4_ADDRESS " -v ipv6addr = " $IPV6_ADDRESS " '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> " ${ 2 } " < " ${ 1 } "
elif [ [ -n " ${ IPV4_ADDRESS } " ] ] && [ [ -z " ${ IPV6_ADDRESS } " ] ] ; then
# Only IPv4
awk -v ipv4addr = " $IPV4_ADDRESS " '{sub(/\r$/,""); print ipv4addr" "$0}' >> " ${ 2 } " < " ${ 1 } "
elif [ [ -z " ${ IPV4_ADDRESS } " ] ] && [ [ -n " ${ IPV6_ADDRESS } " ] ] ; then
# Only IPv6
awk -v ipv6addr = " $IPV6_ADDRESS " '{sub(/\r$/,""); print ipv6addr" "$0}' >> " ${ 2 } " < " ${ 1 } "
elif [ [ -z " ${ IPV4_ADDRESS } " ] ] && [ [ -z " ${ IPV6_ADDRESS } " ] ] ; then
# Parse list of domains into hosts format
gravity_ParseDomainsIntoHosts( ) {
if [ [ -n " ${ IPV4_ADDRESS } " ] ] || [ [ -n " ${ IPV6_ADDRESS } " ] ] ; then
awk -v ipv4addr = " $IPV4_ADDRESS " -v ipv6addr = " $IPV6_ADDRESS " \
'{sub(/\r$/,""); if(ipv4addr) { print ipv4addr" "$0; }; if(ipv6addr) { print ipv6addr" "$0; }}' >> " ${ 2 } " < " ${ 1 } "
else
echo -e " ${ OVER } ${ CROSS } ${ str } "
echo -e " ${ COL_LIGHT_RED } No IP Values found! Please run 'pihole -r' and choose reconfigure to restore values${ COL_NC } "
exit 1
echo -e " ${ COL_LIGHT_RED } No IP addresses found! Please run 'pihole -r' to reconfigure ${ COL_NC } \\n "
gravity_Cleanup "error"
fi
}
gravity_hostFormatLocal( ) {
# Format domain list as "192.168.x.x domain.com"
# Create "localhost" entries
gravity_ParseLocalDomains( ) {
if [ [ -f "/etc/hostname" ] ] ; then
hostname = $( < /etc/hostname)
elif [ -x " $( command -v hostname) " ] ; then
hostname = $( < " " )
elif command -v hostname & > /dev/null; then
hostname = $( hostname -f)
else
echo -e " ${ CROSS } Unable to determine fully qualified domain name of host "
fi
echo -e " ${ hostname } \npi.hole " > " ${ localList } .tmp "
echo -e " ${ hostname } \\npi.hole " > " ${ localList } .tmp "
# Copy the file over as /etc/pihole/local.list so dnsmasq can use it
rm " ${ localList } "
gravity_doHostFormat " ${ localList } .tmp " " ${ localList } "
rm " ${ localList } .tmp "
rm " ${ localList } " 2> /dev/null || \
echo -e " ${ CROSS } Unable to remove ${ localList } "
gravity_ParseDomainsIntoHosts " ${ localList } .tmp " " ${ localList } "
rm " ${ localList } .tmp " 2> /dev/null || \
echo -e " ${ CROSS } Unable to remove ${ localList } .tmp "
}
gravity_hostFormatGravity( ) {
# Format domain list as "192.168.x.x domain.com"
echo "" > " ${ piholeDir } / ${ accretionDisc } "
gravity_doHostFormat " ${ piholeDir } / ${ eventHorizon } " " ${ piholeDir } / ${ accretionDisc } "
# Create primary blacklist entries
gravity_ParseBlacklistDomains( ) {
# Create $accretionDisc
[ [ ! -f " ${ piholeDir } / ${ accretionDisc } " ] ] && echo "" > " ${ piholeDir } / ${ accretionDisc } "
gravity_ParseDomainsIntoHosts " ${ piholeDir } / ${ eventHorizon } " " ${ piholeDir } / ${ accretionDisc } "
# Copy the file over as /etc/pihole/gravity.list so dnsmasq can use it
mv " ${ piholeDir } / ${ accretionDisc } " " ${ adList } "
output = $( { mv " ${ piholeDir } / ${ accretionDisc } " " ${ adList } " ; } 2>& 1 )
status = " $? "
if [ [ " ${ status } " -ne 0 ] ] ; then
echo -e " ${ CROSS } Unable to move ${ accretionDisc } from ${ piholeDir }
${ output } "
gravity_Cleanup "error"
fi
}
gravity_hostFormatBlack( ) {
# Create user-added blacklist entries
gravity_ParseUserDomains( ) {
if [ [ -f " ${ blacklistFile } " ] ] ; then
numBlacklisted = $( wc -l < " ${ blacklistFile } " )
# Format domain list as "192.168.x.x domain.com"
gravity_doHostFormat " ${ blacklistFile } " " ${ blackList } .tmp "
numBlacklisted = $( printf "%'.0f" " $( wc -l < " ${ blacklistFile } " ) " )
gravity_ParseDomainsIntoHosts " ${ blacklistFile } " " ${ blackList } .tmp "
# Copy the file over as /etc/pihole/black.list so dnsmasq can use it
mv " ${ blackList } .tmp " " ${ blackList } "
mv " ${ blackList } .tmp " " ${ blackList } " 2> /dev/null || \
echo -e " ${ CROSS } Unable to move ${ blackList ##*/ } .tmp to ${ piholeDir } "
else
echo -e " ${ INFO } Nothing to blacklist! "
fi
}
# blackbody - remove any remnant files from script processes
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
rm -f " ${ file } "
fi
done
}
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
local str = "Formatting list of domains to remove comments"
# Parse consolidated blocklist into domains-only format
gravity_Advanced( ) {
local str = "Extracting domains from blocklists"
echo -ne " ${ INFO } ${ str } ... "
#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')
#Awk -F splits on given IFS, we grab the right hand side (chops trailing #coments and /'s to grab the domain only.
#Last awk command takes non-commented lines and if they have 2 fields, take the left field (the domain) and leave
#+ the right (IP address), otherwise grab the single field.
cat ${ piholeDir } /${ matterAndLight } | \
awk -F '#' '{print $1}' | \
awk -F '/' '{print $1}' | \
awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' | \
sed -nr -e 's/\.{2,}/./g' -e '/\./p' > ${ piholeDir } /${ supernova }
# Parse files as Hosts
gravity_ParseFileAsDomains " ${ piholeDir } / ${ matterAndLight } " " ${ piholeDir } / ${ supernova } "
echo -e " ${ OVER } ${ TICK } ${ str } "
numberOf = $( printf "%'.0f" " $( wc -l < " ${ piholeDir } / ${ supernova } " ) " )
echo -e " ${ OVER } ${ TICK } ${ str }
${ INFO } ${ COL_LIGHT_BLUE } ${ numberOf } ${ COL_NC } domains being pulled in by gravity"
numberOf = $( wc -l < ${ piholeDir } /${ supernova } )
echo -e " ${ INFO } ${ COL_LIGHT_BLUE } ${ numberOf } ${ COL_NC } domains being pulled in by gravity "
gravity_Unique
}
gravity_unique
# Trap Ctrl-C
gravity_Trap( ) {
trap '{ echo -e "\\n\\n ${INFO} ${COL_LIGHT_RED}User-abort detected${COL_NC}"; gravity_Cleanup "error"; }' INT
}
gravity_reload( ) {
# Reload hosts file
echo ""
local str = "Refreshing lists in dnsmasq"
echo -e " ${ INFO } ${ str } ... "
# Clean up after Gravity
gravity_Cleanup( ) {
local error = " ${ 1 :- } "
str = "Cleaning up debris"
echo -ne " ${ INFO } ${ str } ... "
# Ensure /etc/dnsmasq.d/01-pihole.conf is pointing at the correct list!
# First escape forward slashes in the path:
adList = ${ adList // \/ / \\ \/ }
# Now replace the line in dnsmasq file
# sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf
rm ${ piholeDir } /pihole.*.txt 2> /dev/null
rm ${ piholeDir } /*.tmp 2> /dev/null
# Remove any unused .domains files
for file in ${ piholeDir } /*.${ domainsExtension } ; do
# If list is in active array then leave it (noop) else rm the list
if [ [ " ${ activeDomains [*] } " = ~ ${ file } ] ] ; then
:
else
rm -f " ${ file } " 2> /dev/null || \
echo -e " ${ CROSS } Failed to remove ${ file ##*/ } "
fi
done
" ${ PIHOLE_COMMAND } " restartdns
echo -e " ${ OVER } ${ TICK } ${ str } "
[ [ -n " $error " ] ] && echo ""
# Only restart DNS service if offline
if ! pidof dnsmasq & > /dev/null; then
" ${ PIHOLE_COMMAND } " restartdns
fi
if [ [ -n " $error " ] ] ; then
" ${ PIHOLE_COMMAND } " status
exit 1
fi
}
for var in " $@ " ; do
case " ${ var } " in
"-f" | "--force" ) forceGrav = true; ;
"-h" | "--help" ) helpFunc; ;
"-sd" | "--skip-download" ) skipDownload = true; ;
"-b" | "--blacklist-only" ) blackListOnly = true; ;
"-f" | "--force" ) forceDelete = true; ;
"-h" | "--help" ) helpFunc; ;
"-sd" | "--skip-download" ) skipDownload = true; ;
"-b" | "--blacklist-only" ) blackListOnly = true; ;
"-w" | "--wildcard" ) dnsRestart = "restart" ; ;
esac
done
if [ [ " ${ forceGrav } " = = true ] ] ; then
# Main Gravity Execution
gravity_Trap
# Use "force-reload" when restarting dnsmasq for Blacklists and Whitelists
[ [ -z " ${ dnsRestart } " ] ] && dnsRestart = "force-reload"
if [ [ " ${ forceDelete } " = = true ] ] ; then
str = "Deleting exising list cache"
echo -ne " ${ INFO } ${ str } ... "
@ -435,42 +538,41 @@ if [[ "${forceGrav}" == true ]]; then
fi
fi
# If $blackListOnly is true, only run essential functions
if [ [ ! " ${ blackListOnly } " = = true ] ] ; then
gravity_collapse
gravity_spinup
gravity_Collapse
gravity_Pull
if [ [ " ${ skipDownload } " = = false ] ] ; then
gravity_Schwarzchild
gravity_a dvanced
gravity_Schwarzs child
gravity_A dvanced
else
echo -e " ${ INFO } Using cached Event Horizon list... "
numberOf = $( wc -l < ${ piholeDir } /${ preEventHorizon } )
echo -e " ${ INFO } ${ COL_LIGHT_BLUE } $ numberOf${ COL_NC } unique domains trapped in the event horizon. "
numberOf = $( printf "%'.0f" " $( " ${ piholeDir } ${ preEventHorizon } " ) " )
echo -e " ${ INFO } ${ COL_LIGHT_BLUE } ${ } ${ COL_NC } unique domains trapped in the Event Horizon "
fi
gravity_Whitelist
fi
gravity_Blacklist
gravity_Wildcard
str = " Formatting domains into a HOSTS file "
str = " Parsing domains into hosts format "
echo -ne " ${ INFO } ${ str } ... "
if [ [ ! " ${ blackListOnly } " = = true ] ] ; then
gravity_hostFormatLocal
gravity_hostFormatGravity
gravity_ParseLocalDomains
gravity_ParseBlacklistDomains
fi
gravity_hostFormatBlack
echo -e " ${ OVER } ${ TICK } ${ str } "
gravity_blackbody
gravity_ParseUserDomains
echo -e " ${ OVER } ${ TICK } ${ str } "
if [ [ ! " ${ blackListOnly } " = = true ] ] ; then
# Clear no longer needed files...
str = "Cleaning up un-needed files"
echo -ne " ${ INFO } ${ str } ... "
rm ${ piholeDir } /pihole.*.txt 2> /dev/null
echo -e " ${ OVER } ${ TICK } ${ str } "
gravity_Cleanup
fi
gravity_reload
echo ""
" ${ PIHOLE_COMMAND } " restartdns " ${ dnsRestart } "
" ${ PIHOLE_COMMAND } " status
WaLLy3K
7 years ago
committed by