Pi-hole/pi-hole
Pi-hole/pi-hole
1
0
Fork 0
mirror of https://github.com/pi-hole/pi-hole.git synced 2024-11-15 10:43:55 +00:00
Code Issues Projects Releases Packages Wiki Activity

Consistency

Browse source 
Yet more cleanup
This commit is contained in:
Marcus Hildum 2016-10-22 00:32:36 -07:00
parent 6e94bf5b6d
commit d0b3727c5d
1 changed files with 170 additions and 190 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

158
advanced/Scripts/piholeDebug.sh
View file

@ -1,4 +1,4 @@
#/usr/bin/env bash usr/bin/env bash
# Pi-hole: A black hole for Internet advertisements # Pi-hole: A black hole for Internet advertisements
# (c) 2015, 2016 by Jacob Salmela # (c) 2015, 2016 by Jacob Salmela
# Network-wide ad blocking via your Raspberry Pi # Network-wide ad blocking via your Raspberry Pi
@ -39,7 +39,7 @@ EOM
######## FIRST CHECK ######## ######## FIRST CHECK ########
# Must be root to debug # Must be root to debug
if [[ "$EUID" -eq 0 ]]; then if [[ "${EUID}" -eq 0 ]]; then
echo "::: Script is executing as root user..." echo "::: Script is executing as root user..."
else else
echo "::: Non-root user detected..." echo "::: Non-root user detected..."
@ -54,7 +54,7 @@ else
fi fi
# Ensure the file exists, create if not, clear if exists. # Ensure the file exists, create if not, clear if exists.
if [ ! -f "$DEBUG_LOG" ]; then if [ ! -f "${DEBUG_LOG}" ]; then
${SUDO} touch ${DEBUG_LOG} ${SUDO} touch ${DEBUG_LOG}
${SUDO} chmod 644 ${DEBUG_LOG} ${SUDO} chmod 644 ${DEBUG_LOG}
${SUDO} chown "$USER":root ${DEBUG_LOG} ${SUDO} chown "$USER":root ${DEBUG_LOG}
@ -64,7 +64,7 @@ fi
### Private functions exist here ### ### Private functions exist here ###
log_write() { log_write() {
echo "$1" >> "${DEBUG_LOG}" echo "${1}" >> "${DEBUG_LOG}"
} }
version_check() { version_check() {
@ -94,7 +94,7 @@ distro_check() {
TMP=$(cat /etc/*release || echo "Failed to find release") TMP=$(cat /etc/*release || echo "Failed to find release")
echo "::: Writing OS Distribution release to logfile." echo "::: Writing OS Distribution release to logfile."
echo "$TMP" >> ${DEBUG_LOG} echo "${TMP}" >> ${DEBUG_LOG}
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
} }
@ -105,46 +105,41 @@ ip_check() {
echo "::: Writing local IPs to logfile" echo "::: Writing local IPs to logfile"
IPADDR="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet") print $(i+1) }')" IPADDR="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet") print $(i+1) }')"
echo "$IPADDR" >> ${DEBUG_LOG} echo "${IPADDR}" >> ${DEBUG_LOG}
IP6ADDR="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet6") print $(i+1) }')" \ 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 "${IP6ADDR}" >> ${DEBUG_LOG} || echo "No IPv6 addresses found." >> ${DEBUG_LOG}
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
echo "::: Locating default gateway and checking connectivity" echo "::: Locating default gateway and checking connectivity"
GATEWAY=$(ip r | grep default | cut -d ' ' -f 3) GATEWAY=$(ip r | grep default | cut -d ' ' -f 3)
if [[ $? = 0 ]] if [[ $? = 0 ]]; then
then
echo "::: Pinging default IPv4 gateway..." echo "::: Pinging default IPv4 gateway..."
GATEWAY_CHECK=$(ping -q -w 3 -c 3 -n "${GATEWAY}" | tail -n3) GATEWAY_CHECK=$(ping -q -w 3 -c 3 -n "${GATEWAY}" | tail -n3)
if [[ $? = 0 ]] if [[ $? = 0 ]]; then
then
echo "IPv4 Gateway check:" >> ${DEBUG_LOG} echo "IPv4 Gateway check:" >> ${DEBUG_LOG}
else else
echo "IPv4 Gateway check failed:" >> ${DEBUG_LOG} echo "IPv4 Gateway check failed:" >> ${DEBUG_LOG}
fi fi
echo "$GATEWAY_CHECK" >> ${DEBUG_LOG} echo "${GATEWAY_CHECK}" >> ${DEBUG_LOG}
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
echo "::: Pinging Internet via IPv4..." echo "::: Pinging Internet via IPv4..."
INET_CHECK=$(ping -q -w 5 -c 3 -n 8.8.8.8 | tail -n3) INET_CHECK=$(ping -q -w 5 -c 3 -n 8.8.8.8 | tail -n3)
if [[ $? = 0 ]] if [[ $? = 0 ]]; then
then
echo "IPv4 Internet check:" >> ${DEBUG_LOG} echo "IPv4 Internet check:" >> ${DEBUG_LOG}
else else
echo "IPv4 Internet check failed:" >> ${DEBUG_LOG} echo "IPv4 Internet check failed:" >> ${DEBUG_LOG}
fi fi
echo "$INET_CHECK" >> ${DEBUG_LOG} echo "${INET_CHECK}" >> ${DEBUG_LOG}
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
fi fi
GATEWAY6=$(ip -6 r | grep default | cut -d ' ' -f 3) GATEWAY6=$(ip -6 r | grep default | cut -d ' ' -f 3)
if [[ $? = 0 ]] if [[ $? = 0 ]]; then
then
echo "::: Pinging default IPv6 gateway..." echo "::: Pinging default IPv6 gateway..."
GATEWAY6_CHECK=$(ping6 -q -w 3 -c 3 -n "${GATEWAY6}" | tail -n3) GATEWAY6_CHECK=$(ping6 -q -w 3 -c 3 -n "${GATEWAY6}" | tail -n3)
if [[ $? = 0 ]] if [[ $? = 0 ]]; then
then
echo "IPv6 Gateway check:" >> ${DEBUG_LOG} echo "IPv6 Gateway check:" >> ${DEBUG_LOG}
else else
echo "IPv6 Gateway check failed:" >> ${DEBUG_LOG} echo "IPv6 Gateway check failed:" >> ${DEBUG_LOG}
@ -152,8 +147,7 @@ ip_check() {
echo "::: Pinging Internet via IPv6..." echo "::: Pinging Internet via IPv6..."
GATEWAY6_CHECK=$(ping6 -q -w 3 -c 3 -n 2001:4860:4860::8888 | tail -n3) GATEWAY6_CHECK=$(ping6 -q -w 3 -c 3 -n 2001:4860:4860::8888 | tail -n3)
if [[ $? = 0 ]] if [[ $? = 0 ]]; then
then
echo "IPv6 Internet check:" >> ${DEBUG_LOG} echo "IPv6 Internet check:" >> ${DEBUG_LOG}
else else
echo "IPv6 Internet check failed:" >> ${DEBUG_LOG} echo "IPv6 Internet check failed:" >> ${DEBUG_LOG}
@ -162,7 +156,7 @@ ip_check() {
else else
GATEWAY_CHECK="No IPv6 Gateway Detected" GATEWAY_CHECK="No IPv6 Gateway Detected"
fi fi
echo "$GATEWAY_CHECK" >> ${DEBUG_LOG} echo "${GATEWAY_CHECK}" >> ${DEBUG_LOG}
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
@ -180,9 +174,8 @@ hostnameCheck() {
echo "::: Writing hosts file to debug log..." echo "::: Writing hosts file to debug log..."
echo "### Hosts ###" >> ${DEBUG_LOG} echo "### Hosts ###" >> ${DEBUG_LOG}
if [ -e "$HOSTSFILE" ] if [ -e "${HOSTSFILE}" ]; then
then cat "${HOSTSFILE}" >> ${DEBUG_LOG}
cat "$HOSTSFILE" >> ${DEBUG_LOG}
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
else else
echo "No hosts file found!" >> ${DEBUG_LOG} echo "No hosts file found!" >> ${DEBUG_LOG}
@ -210,39 +203,37 @@ testResolver() {
# Find a blocked url that has not been whitelisted. # Find a blocked url that has not been whitelisted.
TESTURL="doubleclick.com" TESTURL="doubleclick.com"
if [ -s "$WHITELISTMATCHES" ]; then if [ -s "${WHITELISTMATCHES}" ]; then
while read -r line; do while read -r line; do
CUTURL=${line#*" "} CUTURL=${line#*" "}
if [ "$CUTURL" != "Pi-Hole.IsWorking.OK" ]; then if [ "${CUTURL}" != "Pi-Hole.IsWorking.OK" ]; then
while read -r line2; do while read -r line2; do
CUTURL2=${line2#*" "} CUTURL2=${line2#*" "}
if [ "$CUTURL" != "$CUTURL2" ]; then if [ "${CUTURL}" != "${CUTURL2}" ]; then
TESTURL="$CUTURL" TESTURL="${CUTURL}"
break 2 break 2
fi fi
done < "$WHITELISTMATCHES" done < "${WHITELISTMATCHES}"
fi fi
done < "$GRAVITYFILE" done < "${GRAVITYFILE}"
fi fi
echo "Resolution of $TESTURL from Pi-hole:" >> ${DEBUG_LOG} echo "Resolution of ${TESTURL} from Pi-hole:" >> ${DEBUG_LOG}
LOCALDIG=$(dig "$TESTURL" @127.0.0.1) LOCALDIG=$(dig "${TESTURL}" @127.0.0.1)
if [[ $? = 0 ]] if [[ $? = 0 ]]; then
then echo "${LOCALDIG}" >> ${DEBUG_LOG}
echo "$LOCALDIG" >> ${DEBUG_LOG}
else else
echo "Failed to resolve $TESTURL on Pi-hole" >> ${DEBUG_LOG} echo "Failed to resolve ${TESTURL} on Pi-hole" >> ${DEBUG_LOG}
fi fi
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
echo "Resolution of $TESTURL from 8.8.8.8:" >> ${DEBUG_LOG} echo "Resolution of ${TESTURL} from 8.8.8.8:" >> ${DEBUG_LOG}
REMOTEDIG=$(dig "$TESTURL" @8.8.8.8) REMOTEDIG=$(dig "${TESTURL}" @8.8.8.8)
if [[ $? = 0 ]] if [[ $? = 0 ]]; then
then echo "${REMOTEDIG}" >> ${DEBUG_LOG}
echo "$REMOTEDIG" >> ${DEBUG_LOG}
else else
echo "Failed to resolve $TESTURL on 8.8.8.8" >> ${DEBUG_LOG} echo "Failed to resolve ${TESTURL} on 8.8.8.8" >> ${DEBUG_LOG}
fi fi
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
@ -271,12 +262,11 @@ checkProcesses() {
echo ":::" echo ":::"
echo "::: Logging status of lighttpd and dnsmasq..." echo "::: Logging status of lighttpd and dnsmasq..."
PROCESSES=( lighttpd dnsmasq ) PROCESSES=( lighttpd dnsmasq )
for i in "${PROCESSES[@]}" for i in "${PROCESSES[@]}"; do
do
echo "" >> ${DEBUG_LOG} echo "" >> ${DEBUG_LOG}
echo -n "$i" >> "$DEBUG_LOG" echo -n "${i}" >> "${DEBUG_LOG}"
echo " processes status:" >> ${DEBUG_LOG} echo " processes status:" >> ${DEBUG_LOG}
${SUDO} systemctl -l status "$i" >> "$DEBUG_LOG" ${SUDO} systemctl -l status "${i}" >> "${DEBUG_LOG}"
done done
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
} }
@ -286,26 +276,24 @@ debugLighttpd() {
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
echo "############ lighttpd.conf ############" >> ${DEBUG_LOG} echo "############ lighttpd.conf ############" >> ${DEBUG_LOG}
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
if [ -e "$LIGHTTPDFILE" ] if [ -e "${LIGHTTPDFILE}" ]; then
then
while read -r line; do while read -r line; do
if [ ! -z "$line" ]; then if [ ! -z "${line}" ]; then
[[ "$line" =~ ^#.*$ ]] && continue [[ "${line}" =~ ^#.*$ ]] && continue
echo "$line" >> ${DEBUG_LOG} echo "${line}" >> ${DEBUG_LOG}
fi fi
done < "$LIGHTTPDFILE" done < "${LIGHTTPDFILE}"
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
else else
echo "No lighttpd.conf file found!" >> ${DEBUG_LOG} echo "No lighttpd.conf file found!" >> ${DEBUG_LOG}
printf ":::\tNo lighttpd.conf file found\n" printf ":::\tNo lighttpd.conf file found\n"
fi fi
if [ -e "$LIGHTTPDERRFILE" ] if [ -e "${LIGHTTPDERRFILE}" ]; then
then
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
echo "######### lighttpd error.log ##########" >> ${DEBUG_LOG} echo "######### lighttpd error.log ##########" >> ${DEBUG_LOG}
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
cat "$LIGHTTPDERRFILE" >> ${DEBUG_LOG} cat "${LIGHTTPDERRFILE}" >> ${DEBUG_LOG}
else else
echo "No lighttpd error.log file found!" >> ${DEBUG_LOG} echo "No lighttpd error.log file found!" >> ${DEBUG_LOG}
printf ":::\tNo lighttpd error.log file found\n" printf ":::\tNo lighttpd error.log file found\n"
@ -328,15 +316,14 @@ echo "::: Writing dnsmasq.conf to debug log..."
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
echo "############### Dnsmasq ###############" >> ${DEBUG_LOG} echo "############### Dnsmasq ###############" >> ${DEBUG_LOG}
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
if [ -e "$DNSMASQFILE" ] if [ -e "${DNSMASQFILE}" ]; then
then
#cat $DNSMASQFILE >> $DEBUG_LOG #cat $DNSMASQFILE >> $DEBUG_LOG
while read -r line; do while read -r line; do
if [ ! -z "$line" ]; then if [ ! -z "${line}" ]; then
[[ "$line" =~ ^#.*$ ]] && continue [[ "${line}" =~ ^#.*$ ]] && continue
echo "$line" >> ${DEBUG_LOG} echo "${line}" >> ${DEBUG_LOG}
fi fi
done < "$DNSMASQFILE" done < "${DNSMASQFILE}"
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
else else
echo "No dnsmasq.conf file found!" >> ${DEBUG_LOG} echo "No dnsmasq.conf file found!" >> ${DEBUG_LOG}
@ -347,14 +334,13 @@ echo "::: Writing 01-pihole.conf to debug log..."
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
echo "########### 01-pihole.conf ############" >> ${DEBUG_LOG} echo "########### 01-pihole.conf ############" >> ${DEBUG_LOG}
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
if [ -e "$PIHOLECONFFILE" ] if [ -e "${PIHOLECONFFILE}" ]; then
then
while read -r line; do while read -r line; do
if [ ! -z "$line" ]; then if [ ! -z "${line}" ]; then
[[ "$line" =~ ^#.*$ ]] && continue [[ "${line}" =~ ^#.*$ ]] && continue
echo "$line" >> ${DEBUG_LOG} echo "${line}" >> ${DEBUG_LOG}
fi fi
done < "$PIHOLECONFFILE" done < "${PIHOLECONFFILE}"
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
else else
echo "No 01-pihole.conf file found!" >> ${DEBUG_LOG} echo "No 01-pihole.conf file found!" >> ${DEBUG_LOG}
@ -365,9 +351,8 @@ echo "::: Writing size of gravity.list to debug log..."
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
echo "############ gravity.list #############" >> ${DEBUG_LOG} echo "############ gravity.list #############" >> ${DEBUG_LOG}
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
if [ -e "$GRAVITYFILE" ] if [ -e "${GRAVITYFILE}" ]; then
then wc -l "${GRAVITYFILE}" >> ${DEBUG_LOG}
wc -l "$GRAVITYFILE" >> ${DEBUG_LOG}
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
else else
echo "No gravity.list file found!" >> ${DEBUG_LOG} echo "No gravity.list file found!" >> ${DEBUG_LOG}
@ -380,9 +365,8 @@ echo "::: Writing whitelist to debug log..."
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
echo "############## Whitelist ##############" >> ${DEBUG_LOG} echo "############## Whitelist ##############" >> ${DEBUG_LOG}
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
if [ -e "$WHITELISTFILE" ] if [ -e "${WHITELISTFILE}" ]; then
then cat "${WHITELISTFILE}" >> ${DEBUG_LOG}
cat "$WHITELISTFILE" >> ${DEBUG_LOG}
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
else else
echo "No whitelist.txt file found!" >> ${DEBUG_LOG} echo "No whitelist.txt file found!" >> ${DEBUG_LOG}
@ -393,9 +377,8 @@ echo "::: Writing blacklist to debug log..."
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
echo "############## Blacklist ##############" >> ${DEBUG_LOG} echo "############## Blacklist ##############" >> ${DEBUG_LOG}
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
if [ -e "$BLACKLISTFILE" ] if [ -e "${BLACKLISTFILE}" ]; then
then cat "${BLACKLISTFILE}" >> ${DEBUG_LOG}
cat "$BLACKLISTFILE" >> ${DEBUG_LOG}
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
else else
echo "No blacklist.txt file found!" >> ${DEBUG_LOG} echo "No blacklist.txt file found!" >> ${DEBUG_LOG}
@ -406,14 +389,13 @@ echo "::: Writing adlists.list to debug log..."
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
echo "############ adlists.list #############" >> ${DEBUG_LOG} echo "############ adlists.list #############" >> ${DEBUG_LOG}
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
if [ -e "$ADLISTSFILE" ] if [ -e "${ADLISTSFILE}" ]; then
then
while read -r line; do while read -r line; do
if [ ! -z "$line" ]; then if [ ! -z "${line}" ]; then
[[ "$line" =~ ^#.*$ ]] && continue [[ "${line}" =~ ^#.*$ ]] && continue
echo "$line" >> ${DEBUG_LOG} echo "${line}" >> ${DEBUG_LOG}
fi fi
done < "$ADLISTSFILE" done < "${ADLISTSFILE}"
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
else else
echo "No adlists.list file found... using adlists.default!" >> ${DEBUG_LOG} echo "No adlists.list file found... using adlists.default!" >> ${DEBUG_LOG}
@ -428,10 +410,9 @@ dumpPiHoleLog() {
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
echo "############# pihole.log ##############" >> ${DEBUG_LOG} echo "############# pihole.log ##############" >> ${DEBUG_LOG}
echo "#######################################" >> ${DEBUG_LOG} echo "#######################################" >> ${DEBUG_LOG}
if [ -e "$PIHOLELOG" ] if [ -e "${PIHOLELOG}" ]; then
then
while true; do while true; do
tail -f "$PIHOLELOG" >> ${DEBUG_LOG} tail -f "${PIHOLELOG}" >> ${DEBUG_LOG}
echo >> ${DEBUG_LOG} echo >> ${DEBUG_LOG}
done done
else else
@ -455,9 +436,8 @@ finalWork() {
esac esac
# Check if termbin.com is reachable. When it's not, point to local log instead # Check if termbin.com is reachable. When it's not, point to local log instead
if [ -n "$TERMBIN" ] if [ -n "${TERMBIN}" ]; then
then echo "::: Debug log can be found at : ${TERMBIN}"
echo "::: Debug log can be found at : $TERMBIN"
else else
echo "::: Debug log can be found at : /var/log/pihole_debug.log" echo "::: Debug log can be found at : /var/log/pihole_debug.log"
fi fi