pi-hole/advanced/Scripts/piholeDebug.sh

#!/usr/bin/env bash
# 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
# Generates pihole_debug.log to be used for troubleshooting.
#
# 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.

set -o pipefail

######## GLOBAL VARS ########
DEBUG_LOG="/var/log/pihole_debug.log"
DNSMASQFILE="/etc/dnsmasq.conf"
PIHOLECONFFILE="/etc/dnsmasq.d/01-pihole.conf"
LIGHTTPDFILE="/etc/lighttpd/lighttpd.conf"
LIGHTTPDERRFILE="/var/log/lighttpd/error.log"
GRAVITYFILE="/etc/pihole/gravity.list"
HOSTSFILE="/etc/hosts"
WHITELISTFILE="/etc/pihole/whitelist.txt"
BLACKLISTFILE="/etc/pihole/blacklist.txt"
ADLISTSFILE="/etc/pihole/adlists.list"
PIHOLELOG="/var/log/pihole.log"
WHITELISTMATCHES="/tmp/whitelistmatches.list"

# Header info and introduction
cat << EOM
::: Beginning Pi-hole debug at $(date)!
::: This debugging process will collect information from your running configuration,
::: and optionally upload the generated log to a unique and random directory on
::: Termbin.com. NOTE: All log files auto-delete after 1 month and you are the only
::: person who is given the unique URL. Please consider where you post this link.
:::
EOM

# Ensure the file exists, create if not, clear if exists.
if [ ! -f "${DEBUG_LOG}" ]; then
	touch ${DEBUG_LOG}
	chmod 644 ${DEBUG_LOG}
	chown "$USER":root ${DEBUG_LOG}
else
	truncate -s 0 ${DEBUG_LOG}
fi

### Private functions exist here ###
log_write() {
	echo "${1}" >> "${DEBUG_LOG}"
}

version_check() {
	log_write "############################################################"
	log_write "##########           Installed Versions           ##########"
	log_write "############################################################"

	echo "::: Detecting Pi-hole installed versions."
	pi_hole_ver="$(cd /etc/.pihole/ && git describe --tags --abbrev=0)" \
	&& log_write "Pi-hole Version: $pi_hole_ver" || log_write "Pi-hole git repository not detected."
	admin_ver="$(cd /var/www/html/admin && git describe --tags --abbrev=0)" \
	&& log_write "WebUI Version: $admin_ver" || log_write "Pi-hole Admin Pages git repository not detected."

	echo "::: Writing lighttpd version to logfile."
	light_ver="$(lighttpd -v |& head -n1)" && log_write "${light_ver}" || log_write "lighttpd not installed."

	echo "::: Writing PHP version to logfile."
	php_ver="$(php -v |& head -n1)" && log_write "${php_ver}" || log_write "PHP not installed."
}

files_check() {
	log_write "############################################################"
	log_write "##########              Files Check               ##########"
	log_write "############################################################"

    #Check existence of setupVars.conf, and source it to get configured network interface for later use in script.
    echo -n "::: Detecting existence setupVars.conf..."
    setupVars=/etc/pihole/setupVars.conf
    if [[ -f ${setupVars} ]];then
        echo " found!"
        log_write "/etc/pihole/setupVars.conf exists! Contents:"
        while read -r line; do
			if [ ! -z "${line}" ]; then
				[[ "${line}" =~ ^#.*$ ]] && continue
				log_write "${line}"
			fi
		done < "${setupVars}"
		log_write ""

        . "${setupVars}"
        if [[ -n "${piholeInterface}" ]]; then
            # prepend % to the beginning of piholeInterface for later use
            piholeInterface="%${piholeInterface}"
        fi
    else
        echo " NOT FOUND!"
        log_write "/etc/pihole/setupVars.conf not found!"
    fi
}

distro_check() {
	log_write "############################################################"
	log_write "########          Installed OS Distribution        #########"
	log_write "############################################################"

	echo "::: Checking installed OS Distribution release."
	TMP=$(cat /etc/*release || echo "Failed to find release")

	echo "::: Writing OS Distribution release to logfile."
	log_write "${TMP}"
	log_write ""
}

ip_check() {
	log_write "############################################################"
	log_write "########           IP Address Information          #########"
	log_write "############################################################"

	echo "::: Writing local IPs to logfile"
	IPADDR="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet") print $(i+1) }')"
	log_write "${IPADDR}"

	IP6ADDR="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet6") print $(i+1) }')" \
	&& log_write "${IP6ADDR}" || log_write "No IPv6 addresses found."
	log_write ""

	echo "::: Locating default gateway and checking connectivity"
	GATEWAY=$(ip r | grep default | cut -d ' ' -f 3)
	if [[ $? = 0 ]]; then
		echo "::: Pinging default IPv4 gateway..."
		GATEWAY_CHECK=$(ping -q -w 3 -c 3 -n "${GATEWAY}" | tail -n3)
		if [[ $? = 0 ]]; then
			log_write "IPv4 Gateway check:"
		else
			log_write "IPv4 Gateway check failed:"
		fi
		log_write "${GATEWAY_CHECK}"
		log_write ""

		echo "::: Pinging Internet via IPv4..."
		INET_CHECK=$(ping -q -w 5 -c 3 -n 8.8.8.8 | tail -n3)
		if [[ $? = 0 ]]; then
			log_write "IPv4 Internet check:"
		else
			log_write "IPv4 Internet check failed:"
		fi
		log_write "${INET_CHECK}"
		log_write ""
	fi

	GATEWAY6=$(ip -6 r | grep default | cut -d ' ' -f 3)
	if [[ $? = 0 ]]; then
		echo "::: Pinging default IPv6 gateway..."
		GATEWAY6_CHECK=$(ping6 -q -w 3 -c 3 -n "${GATEWAY6}""${piholeInterface}" | tail -n3)
		if [[ $? = 0 ]]; then
			log_write "IPv6 Gateway check:"
		else
			log_write "IPv6 Gateway check failed:"
		fi

		echo "::: Pinging Internet via IPv6..."
		GATEWAY6_CHECK=$(ping6 -q -w 3 -c 3 -n 2001:4860:4860::8888"${piholeInterface}" | tail -n3)
		if [[ $? = 0 ]]; then
			log_write "IPv6 Internet check:"
		else
			log_write "IPv6 Internet check failed:"
		fi

	else
		GATEWAY_CHECK="No IPv6 Gateway Detected"
	fi
	log_write "${GATEWAY_CHECK}"


	log_write ""
}

hostnameCheck() {
	log_write "############################################################"
	log_write "########            Hostname Information           #########"
	log_write "############################################################"

	echo "::: Writing locally configured hostnames to logfile"
	# Write the hostname output to compare against entries in /etc/hosts, which is logged next
	log_write "This Pi-hole is: $(hostname)"

	echo "::: Writing hosts file to debug log..."
	log_write "###              Hosts              ###"

	if [ -e "${HOSTSFILE}" ]; then
		cat "${HOSTSFILE}" >> ${DEBUG_LOG}
		log_write ""
	else
		log_write "No hosts file found!"
		printf ":::\tNo hosts file found!\n"
	fi
}

portCheck() {
	log_write "############################################################"
	log_write "########           Open Port Information           #########"
	log_write "############################################################"

	echo "::: Detecting local server port 80 and 53 processes."

	lsof -i :80 >> ${DEBUG_LOG}
	lsof -i :53 >> ${DEBUG_LOG}
	log_write ""
}

testResolver() {
	log_write "############################################################"
	log_write "############      Resolver Functions Check      ############"
	log_write "############################################################"


	# Find a blocked url that has not been whitelisted.
	TESTURL="doubleclick.com"
	if [ -s "${WHITELISTMATCHES}" ]; then
		while read -r line; do
			CUTURL=${line#*" "}
			if [ "${CUTURL}" != "Pi-Hole.IsWorking.OK" ]; then
				while read -r line2; do
					CUTURL2=${line2#*" "}
					if [ "${CUTURL}" != "${CUTURL2}" ]; then
						TESTURL="${CUTURL}"
						break 2
					fi
				done < "${WHITELISTMATCHES}"
			fi
		done < "${GRAVITYFILE}"
	fi

	log_write "Resolution of ${TESTURL} from Pi-hole:"
	LOCALDIG=$(dig "${TESTURL}" @127.0.0.1)
	if [[ $? = 0 ]]; then
		log_write "${LOCALDIG}"
	else
		log_write "Failed to resolve ${TESTURL} on Pi-hole"
	fi
	log_write ""


	log_write "Resolution of ${TESTURL} from 8.8.8.8:"
	REMOTEDIG=$(dig "${TESTURL}" @8.8.8.8)
	if [[ $? = 0 ]]; then
		log_write "${REMOTEDIG}"
	else
		log_write "Failed to resolve ${TESTURL} on 8.8.8.8"
	fi
	log_write ""

	log_write "Pi-hole dnsmasq specific records lookups"
	log_write "Cache Size:"
	dig +short chaos txt cachesize.bind >> ${DEBUG_LOG}
	log_write "Insertions count:"
	dig +short chaos txt insertions.bind >> ${DEBUG_LOG}
	log_write "Evictions count:"
	dig +short chaos txt evictions.bind >> ${DEBUG_LOG}
	log_write "Misses count:"
	dig +short chaos txt misses.bind >> ${DEBUG_LOG}
	log_write "Hits count:"
	dig +short chaos txt hits.bind >> ${DEBUG_LOG}
	log_write "Auth count:"
	dig +short chaos txt auth.bind >> ${DEBUG_LOG}
	log_write "Upstream Servers:"
	dig +short chaos txt servers.bind >> ${DEBUG_LOG}
	log_write ""
}

checkProcesses() {
	log_write "#######################################"
	log_write "########### Processes Check ###########"
	log_write "#######################################"
	log_write ":::"
	echo "::: Logging status of lighttpd and dnsmasq..."
	PROCESSES=( lighttpd dnsmasq )
	for i in "${PROCESSES[@]}"; do
		log_write ""
		log_write -n "${i}"
		log_write " processes status:"
		systemctl -l status "${i}" >> "${DEBUG_LOG}"
	done
	log_write ""
}

debugLighttpd() {
	log_write "::: Writing lighttpd to debug log..."
	log_write "#######################################"
	log_write "############ lighttpd.conf ############"
	log_write "#######################################"
	if [ -e "${LIGHTTPDFILE}" ]; then
		while read -r line; do
			if [ ! -z "${line}" ]; then
				[[ "${line}" =~ ^#.*$ ]] && continue
				log_write "${line}"
			fi
		done < "${LIGHTTPDFILE}"
		log_write ""
	else
		log_write "No lighttpd.conf file found!"
		printf ":::\tNo lighttpd.conf file found\n"
	fi

	if [ -e "${LIGHTTPDERRFILE}" ]; then
		log_write "#######################################"
		log_write "######### lighttpd error.log ##########"
		log_write "#######################################"
		cat "${LIGHTTPDERRFILE}" >> ${DEBUG_LOG}
	else
		log_write "No lighttpd error.log file found!"
		printf ":::\tNo lighttpd error.log file found\n"
	fi
	log_write ""
}

### END FUNCTIONS ###

version_check
files_check
distro_check
ip_check
hostnameCheck
portCheck
checkProcesses
testResolver
debugLighttpd

echo "::: Writing dnsmasq.conf to debug log..."
log_write "#######################################"
log_write "############### Dnsmasq ###############"
log_write "#######################################"
if [ -e "${DNSMASQFILE}" ]; then
	#cat $DNSMASQFILE >> $DEBUG_LOG
	while read -r line; do
		if [ ! -z "${line}" ]; then
			[[ "${line}" =~ ^#.*$ ]] && continue
			log_write "${line}"
		fi
	done < "${DNSMASQFILE}"
	log_write ""
else
	log_write "No dnsmasq.conf file found!"
	printf ":::\tNo dnsmasq.conf file found!\n"
fi

echo "::: Writing 01-pihole.conf to debug log..."
log_write "#######################################"
log_write "########### 01-pihole.conf ############"
log_write "#######################################"
if [ -e "${PIHOLECONFFILE}" ]; then
	while read -r line; do
		if [ ! -z "${line}" ]; then
			[[ "${line}" =~ ^#.*$ ]] && continue
			log_write "${line}"
		fi
	done < "${PIHOLECONFFILE}"
	log_write
else
	log_write "No 01-pihole.conf file found!"
	printf ":::\tNo 01-pihole.conf file found\n"
fi

echo "::: Writing size of gravity.list to debug log..."
log_write "#######################################"
log_write "############ gravity.list #############"
log_write "#######################################"
if [ -e "${GRAVITYFILE}" ]; then
	wc -l "${GRAVITYFILE}" >> ${DEBUG_LOG}
	log_write ""
else
	log_write "No gravity.list file found!"
	printf ":::\tNo gravity.list file found\n"
fi


### Pi-hole application specific logging ###
echo "::: Writing whitelist to debug log..."
log_write "#######################################"
log_write "############## Whitelist ##############"
log_write "#######################################"
if [ -e "${WHITELISTFILE}" ]; then
	cat "${WHITELISTFILE}" >> ${DEBUG_LOG}
	log_write
else
	log_write "No whitelist.txt file found!"
	printf ":::\tNo whitelist.txt file found!\n"
fi

echo "::: Writing blacklist to debug log..."
log_write "#######################################"
log_write "############## Blacklist ##############"
log_write "#######################################"
if [ -e "${BLACKLISTFILE}" ]; then
	cat "${BLACKLISTFILE}" >> ${DEBUG_LOG}
	log_write
else
	log_write "No blacklist.txt file found!"
	printf ":::\tNo blacklist.txt file found!\n"
fi

echo "::: Writing adlists.list to debug log..."
log_write "#######################################"
log_write "############ adlists.list #############"
log_write "#######################################"
if [ -e "${ADLISTSFILE}" ]; then
	while read -r line; do
		if [ ! -z "${line}" ]; then
			[[ "${line}" =~ ^#.*$ ]] && continue
			log_write "${line}"
		fi
	done < "${ADLISTSFILE}"
	log_write
else
	log_write "No adlists.list file found... using adlists.default!"
	printf ":::\tNo adlists.list file found... using adlists.default!\n"
fi


# Continuously append the pihole.log file to the pihole_debug.log file
dumpPiHoleLog() {
	trap '{ echo -e "\n::: Finishing debug write from interrupt... Quitting!" ; exit 1; }' INT
	echo -e "::: Writing current Pi-hole traffic to debug log...\n:::\tTry loading any/all sites that you are having trouble with now... \n:::\t(Press ctrl+C to finish)"
	log_write "#######################################"
	log_write "############# pihole.log ##############"
	log_write "#######################################"
	if [ -e "${PIHOLELOG}" ]; then
		while true; do
			tail -f "${PIHOLELOG}" >> ${DEBUG_LOG}
			log_write ""
		done
	else
		log_write "No pihole.log file found!"
		printf ":::\tNo pihole.log file found!\n"
	fi
}

# Anything to be done after capturing of pihole.log terminates
finalWork() {
	echo "::: Finshed debugging!"
	echo "::: The debug log can be uploaded to Termbin.com for easier sharing."
	read -r -p "::: Would you like to upload the log? [y/N] " response
	case ${response} in
		[yY][eE][sS]|[yY])
			TERMBIN=$(cat /var/log/pihole_debug.log | nc termbin.com 9999)
			;;
		*)
			echo "::: Log will NOT be uploaded to Termbin."
			;;
	esac

	# Check if termbin.com is reachable. When it's not, point to local log instead
	if [ -n "${TERMBIN}" ]; then
		echo "::: Debug log can be found at : ${TERMBIN}"
	else
		echo "::: Debug log can be found at : /var/log/pihole_debug.log"
	fi
}

trap finalWork EXIT

### Method calls for additional logging ###
dumpPiHoleLog