pi-hole/advanced/Scripts/blacklist.sh

167 lines
4.2 KiB
Bash
Raw Normal View History

2016-01-17 14:09:06 +00:00
#!/usr/bin/env bash
2016-01-30 20:12:40 +00:00
# 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
# Blacklists domains
2016-01-17 14:09:06 +00:00
#
# 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.
helpFunc() {
cat << EOM
::: Immediately blacklists one or more domains in the hosts file
:::
:::
::: Usage: pihole -b domain1 [domain2 ...]
::: Options:
::: -d, --delmode Remove domains from the blacklist
::: -nr, --noreload Update blacklist without refreshing dnsmasq
::: -q, --quiet output is less verbose
::: -h, --help Show this help dialog
::: -l, --list Display your blacklisted domains
EOM
2016-05-25 21:07:12 +00:00
exit 1
}
2016-01-17 14:09:06 +00:00
if [[ $# = 0 ]]; then
helpFunc
2016-01-17 14:09:06 +00:00
fi
#globals
2016-04-04 20:08:45 +00:00
basename=pihole
2016-08-21 01:12:02 +00:00
piholeDir=/etc/${basename}
adList=${piholeDir}/gravity.list
blacklist=${piholeDir}/blacklist.txt
reload=false
2016-01-17 14:09:06 +00:00
addmode=true
verbose=true
2016-04-04 20:08:45 +00:00
2016-01-17 14:09:06 +00:00
domList=()
domToRemoveList=()
HandleOther(){
2016-01-17 14:09:06 +00:00
#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/')
2016-01-17 14:09:06 +00:00
if [ -z "$validDomain" ]; then
echo "::: $1 is not a valid argument or domain name"
2016-04-10 20:17:58 +00:00
else
2016-10-22 07:10:25 +00:00
domList=("${domList[@]}" ${validDomain})
2016-01-17 14:09:06 +00:00
fi
}
PopBlacklistFile() {
2016-01-17 14:09:06 +00:00
#check blacklist file exists, and if not, create it
2016-10-22 07:10:25 +00:00
if [[ ! -f ${blacklist} ]]; then
touch ${blacklist}
fi
2016-03-28 17:53:21 +00:00
for dom in "${domList[@]}"; do
2016-10-22 07:10:25 +00:00
if "${addmode}"; then
AddDomain "${dom}"
else
RemoveDomain "${dom}"
fi
2016-01-17 14:09:06 +00:00
done
}
AddDomain() {
2016-10-22 07:10:25 +00:00
#| sed 's/\./\\./g'
2016-01-17 14:09:06 +00:00
bool=false
2016-08-21 01:12:02 +00:00
grep -Ex -q "$1" ${blacklist} || bool=true
if ${bool}; then
2016-10-22 07:10:25 +00:00
#domain not found in the blacklist file, add it!
if ${verbose}; then
echo -n "::: Adding $1 to blacklist file..."
fi
echo "${1}" >> ${blacklist}
2016-01-17 14:09:06 +00:00
modifyHost=true
2016-01-24 17:18:37 +00:00
echo " done!"
2016-01-17 14:09:06 +00:00
else
2016-08-21 01:12:02 +00:00
if ${verbose}; then
2016-10-22 07:10:25 +00:00
echo "::: ${1} already exists in ${blacklist}! No need to add"
2016-01-17 14:09:06 +00:00
fi
fi
}
RemoveDomain() {
2016-10-22 07:10:25 +00:00
bool=false
grep -Ex -q "$1" ${blacklist} || bool=true
if ${bool}; then
#Domain is not in the blacklist file, no need to Remove
if ${verbose}; then
echo "::: $1 is NOT blacklisted! No need to remove"
fi
else
#Domain is in the blacklist file, remove it
2016-10-22 07:10:25 +00:00
if ${verbose}; then
echo "::: Un-blacklisting ${dom}..."
fi
echo "$1" | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /'{}'(?!.)/;' ${blacklist}
2016-10-22 07:10:25 +00:00
fi
2016-01-17 14:09:06 +00:00
}
ModifyHostFile() {
2016-10-22 07:10:25 +00:00
if ${addmode}; then
#add domains to the hosts file
if [[ -r ${blacklist} ]]; then
numberOf=$(cat ${blacklist} | sed '/^\s*$/d' | wc -l)
plural=; [[ "${numberOf}" != "1" ]] && plural=s
echo ":::"
echo -n "::: Modifying HOSTS file to blacklist $numberOf domain${plural}..."
if [[ -n ${piholeIPv6} ]]; then
2016-08-21 01:12:02 +00:00
cat ${blacklist} | awk -v ipv4addr="$piholeIP" -v ipv6addr="$piholeIPv6" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> ${adList}
2016-10-22 07:10:25 +00:00
else
2016-08-21 01:12:02 +00:00
cat ${blacklist} | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' >>${adList}
2016-10-22 07:10:25 +00:00
fi
fi
else
2016-01-24 17:18:37 +00:00
echo ":::"
2016-10-22 07:10:25 +00:00
for dom in "${domToRemoveList[@]}"; do
#we need to remove the domains from the blacklist file and the host file
echo "::: ${dom}"
2016-03-28 17:53:21 +00:00
echo -n "::: removing from HOSTS file..."
2016-10-22 07:10:25 +00:00
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
2016-03-28 17:53:21 +00:00
fi
2016-01-17 14:09:06 +00:00
}
Reload() {
pihole -g -sd
2016-01-17 14:09:06 +00:00
}
DisplayBlist() {
verbose=false
2016-04-08 14:14:17 +00:00
echo -e " Displaying Gravity Affected Domains \n"
count=1
2016-10-22 07:10:25 +00:00
while IFS= read -r AD; do
echo "${count}: ${AD}"
2016-04-08 14:14:17 +00:00
count=$((count+1))
2016-10-22 07:10:25 +00:00
done < "${blacklist}"
2016-10-23 18:49:51 +00:00
exit 0;
}
2016-01-17 14:09:06 +00:00
###################################################
2016-10-22 07:10:25 +00:00
for var in "$@"; do
case "$var" in
"-nr"| "--noreload" ) reload=false;;
"-d" | "--delmode" ) addmode=false;;
"-q" | "--quiet" ) verbose=false;;
"-h" | "--help" ) helpFunc;;
"-l" | "--list" ) DisplayBlist;;
* ) HandleOther "$var";;
esac
2016-01-17 14:09:06 +00:00
done
PopBlacklistFile
2016-08-21 01:12:02 +00:00
if ${reload}; then
2016-01-17 14:09:06 +00:00
Reload
fi