diff options
Diffstat (limited to 'advanced/Scripts/piholeDebug.sh')
| -rwxr-xr-x | advanced/Scripts/piholeDebug.sh | 647 |
1 files changed, 288 insertions, 359 deletions
diff --git a/advanced/Scripts/piholeDebug.sh b/advanced/Scripts/piholeDebug.sh index aadb083b..6768a8ea 100755 --- a/advanced/Scripts/piholeDebug.sh +++ b/advanced/Scripts/piholeDebug.sh @@ -13,452 +13,381 @@ set -o pipefail ######## GLOBAL VARS ######## +VARSFILE="/etc/pihole/setupVars.conf" DEBUG_LOG="/var/log/pihole_debug.log" DNSMASQFILE="/etc/dnsmasq.conf" -PIHOLECONFFILE="/etc/dnsmasq.d/01-pihole.conf" +DNSMASQCONFFILE="/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" +ADLISTFILE="/etc/pihole/adlists.list" PIHOLELOG="/var/log/pihole.log" WHITELISTMATCHES="/tmp/whitelistmatches.list" +IPV6_READY=false + # Header info and introduction -echo "::: Beginning Pi-hole debug at $(date)!" -echo "::: This debugging process will collect information from your running configuration," -echo "::: and optionally upload the generated log to a unique and random directory on" -echo "::: Termbin.com. NOTE: All log files auto-delete after 1 month and you are the only" -echo "::: person who is given the unique URL. Please consider where you post this link." -echo "::: " - - -######## FIRST CHECK ######## -# Must be root to debug -if [[ "$EUID" -eq 0 ]]; then - echo "::: Script is executing as root user..." -else - echo "::: Non-root user detected..." - # Check if sudo is actually installed - if [ -x "$(command -v sudo)" ]; then - export SUDO="sudo" - echo "::: sudo command located, debug will run under sudo." - else - echo "::: Unable to locate sudo command. Please install sudo or run this as root." - exit 1 - fi -fi +cat << EOM +::: Beginning Pi-hole debug at $(date)! +::: +::: This process collects information from your Pi-hole, and optionally uploads +::: it to a unique and random directory on tricorder.pi-hole.net. +::: +::: NOTE: All log files auto-delete after 24 hours and ONLY the Pi-hole developers +::: can access your data via the given token. We have taken these extra steps to +::: secure your data and will work to further reduce any personal information gathered. +::: +::: Please read and note any issues, and follow any directions advised during this process. +EOM # Ensure the file exists, create if not, clear if exists. -if [ ! -f "$DEBUG_LOG" ]; then - ${SUDO} touch ${DEBUG_LOG} - ${SUDO} chmod 644 ${DEBUG_LOG} - ${SUDO} chown "$USER":root ${DEBUG_LOG} -else - truncate -s 0 ${DEBUG_LOG} -fi +truncate --size=0 "${DEBUG_LOG}" +chmod 644 ${DEBUG_LOG} +chown "$USER":pihole ${DEBUG_LOG} + +source ${VARSFILE} ### Private functions exist here ### -function log_write { - echo "$1" >> "${DEBUG_LOG}" +log_write() { + echo "${1}" >> "${DEBUG_LOG}" } -function version_check { - log_write "############################################################" - log_write "########## Installed Versions ##########" - log_write "############################################################" +log_echo() { + case ${1} in + -n) + echo -n "::: ${2}" + log_write "${2}" + ;; + -r) + echo "::: ${2}" + log_write "${2}" + ;; + -l) + echo "${2}" + log_write "${2}" + ;; + *) + echo "::: ${1}" + log_write "${1}" + esac +} - 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." +header_write() { + log_echo "" + log_echo "${1}" + log_write "" +} - echo "::: Writing lighttpd version to logfile." - light_ver="$(lighttpd -v |& head -n1)" && log_write "${light_ver}" || log_write "lighttpd not installed." +file_parse() { + while read -r line; do + if [ ! -z "${line}" ]; then + [[ "${line}" =~ ^#.*$ || ! "${line}" ]] && continue + log_write "${line}" + fi + done < "${1}" + log_write "" +} - echo "::: Writing PHP version to logfile." - php_ver="$(php -v |& head -n1)" && log_write "${php_ver}" || log_write "PHP not installed." +block_parse() { + log_write "${1}" } -function distro_check { - echo "############################################################" >> ${DEBUG_LOG} - echo "######## Installed OS Distribution #########" >> ${DEBUG_LOG} - echo "############################################################" >> ${DEBUG_LOG} +lsof_parse() { + local user + local process - echo "::: Checking installed OS Distribution release." - TMP=$(cat /etc/*release || echo "Failed to find release") + user=$(echo ${1} | cut -f 3 -d ' ' | cut -c 2-) + process=$(echo ${1} | cut -f 2 -d ' ' | cut -c 2-) + [[ ${2} -eq ${process} ]] \ + && echo "::: Correctly configured." \ + || log_echo "::: Failure: Incorrectly configured daemon." - echo "::: Writing OS Distribution release to logfile." - echo "$TMP" >> ${DEBUG_LOG} - echo >> ${DEBUG_LOG} + log_write "Found user ${user} with process ${process}" } -function ip_check { - echo "############################################################" >> ${DEBUG_LOG} - echo "######## IP Address Information #########" >> ${DEBUG_LOG} - echo "############################################################" >> ${DEBUG_LOG} - - echo "::: Writing local IPs to logfile" - IPADDR="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet") print $(i+1) }')" - echo "$IPADDR" >> ${DEBUG_LOG} - - 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 >> ${DEBUG_LOG} - - 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 - echo "IPv4 Gateway check:" >> ${DEBUG_LOG} - else - echo "IPv4 Gateway check failed:" >> ${DEBUG_LOG} - fi - echo "$GATEWAY_CHECK" >> ${DEBUG_LOG} - echo >> ${DEBUG_LOG} - - echo "::: Pinging Internet via IPv4..." - INET_CHECK=$(ping -q -w 5 -c 3 -n 8.8.8.8 | tail -n3) - if [[ $? = 0 ]] - then - echo "IPv4 Internet check:" >> ${DEBUG_LOG} - else - echo "IPv4 Internet check failed:" >> ${DEBUG_LOG} - fi - echo "$INET_CHECK" >> ${DEBUG_LOG} - echo >> ${DEBUG_LOG} - 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}" | tail -n3) - if [[ $? = 0 ]] - then - echo "IPv6 Gateway check:" >> ${DEBUG_LOG} - else - echo "IPv6 Gateway check failed:" >> ${DEBUG_LOG} - fi - - echo "::: Pinging Internet via IPv6..." - GATEWAY6_CHECK=$(ping6 -q -w 3 -c 3 -n 2001:4860:4860::8888 | tail -n3) - if [[ $? = 0 ]] - then - echo "IPv6 Internet check:" >> ${DEBUG_LOG} - else - echo "IPv6 Internet check failed:" >> ${DEBUG_LOG} - fi +version_check() { + header_write "Detecting Installed Package Versions:" - else - GATEWAY_CHECK="No IPv6 Gateway Detected" - fi - echo "$GATEWAY_CHECK" >> ${DEBUG_LOG} + local error_found + error_found=0 + + local pi_hole_ver="$(cd /etc/.pihole/ && git describe --tags --abbrev=0)" \ + && log_echo -r "Pi-hole: $pi_hole_ver" || (log_echo "Pi-hole git repository not detected." && error_found=1) + local admin_ver="$(cd /var/www/html/admin && git describe --tags --abbrev=0)" \ + && log_echo -r "WebUI: $admin_ver" || (log_echo "Pi-hole Admin Pages git repository not detected." && error_found=1) + local light_ver="$(lighttpd -v |& head -n1 | cut -d " " -f1)" \ + && log_echo -r "${light_ver}" || (log_echo "lighttpd not installed." && error_found=1) + local php_ver="$(php -v |& head -n1)" \ + && log_echo -r "${php_ver}" || (log_echo "PHP not installed." && error_found=1) + return "${error_found}" +} + +files_check() { + #Check non-zero length existence of ${1} + header_write "Detecting existence of ${1}:" + local search_file="${1}" + if [[ -s ${search_file} ]]; then + echo "::: File exists" + file_parse "${search_file}" + return 0 + else + log_echo "${1} not found!" + return 1 + fi + echo ":::" +} +source_file() { + local file_found=$(files_check "${1}") \ + && (source "${1}" &> /dev/null && echo "${file_found} and was successfully sourced") \ + || log_echo -l "${file_found} and could not be sourced" +} - echo >> ${DEBUG_LOG} +distro_check() { + local soft_fail + header_write "Detecting installed OS Distribution" + soft_fail=0 + local distro="$(cat /etc/*release)" && block_parse "${distro}" || (log_echo "Distribution details not found." && soft_fail=1) + return "${soft_fail}" } -function hostnameCheck { - echo "############################################################" >> ${DEBUG_LOG} - echo "######## Hostname Information #########" >> ${DEBUG_LOG} - echo "############################################################" >> ${DEBUG_LOG} +processor_check() { + header_write "Checking processor variety" + log_write $(uname -m) && return 0 || return 1 +} - echo "::: Writing locally configured hostnames to logfile" - # Write the hostname output to compare against entries in /etc/hosts, which is logged next - echo "This Pi-hole is: $(hostname)" >> ${DEBUG_LOG} +ipv6_check() { + # Check if system is IPv6 enabled, for use in other functions + if [[ $IPv6_address ]]; then + ls /proc/net/if_inet6 &>/dev/null && IPV6_READY=true + return 0 + else + return 1 + fi +} - echo "::: Writing hosts file to debug log..." - echo "### Hosts ###" >> ${DEBUG_LOG} - if [ -e "$HOSTSFILE" ] - then - cat "$HOSTSFILE" >> ${DEBUG_LOG} - echo >> ${DEBUG_LOG} +ip_check() { + header_write "IP Address Information" + # Get the current interface for Internet traffic + + # Check if IPv6 enabled + local IPv6_interface + local IPv4_interface + ipv6_check && IPv6_interface=${piholeInterface:-$(ip -6 r | grep default | cut -d ' ' -f 5)} + # If declared in setupVars.conf use it, otherwise defer to default + # http://stackoverflow.com/questions/2013547/assigning-default-values-to-shell-variables-with-a-single-command-in-bash + IPv4_interface=${piholeInterface:-$(ip r | grep default | cut -d ' ' -f 5)} + + + if [[ IPV6_READY ]]; then + local IPv6_addr_list="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet6") print $(i+1) }')" \ + && (log_write "${IPv6_addr_list}" && echo "::: IPv6 addresses located") \ + || log_echo "No IPv6 addresses found." + + local IPv6_def_gateway=$(ip -6 r | grep default | cut -d ' ' -f 3) + if [[ $? = 0 ]] && [[ -n ${IPv6_def_gateway} ]]; then + echo -n "::: Pinging default IPv6 gateway: " + local IPv6_def_gateway_check="$(ping6 -q -W 3 -c 3 -n "${IPv6_def_gateway}" -I "${IPv6_interface}"| tail -n3)" \ + && echo "Gateway Responded." \ + || echo "Gateway did not respond." + block_parse "${IPv6_def_gateway_check}" + + echo -n "::: Pinging Internet via IPv6: " + local IPv6_inet_check=$(ping6 -q -W 3 -c 3 -n 2001:4860:4860::8888 -I "${IPv6_interface}"| tail -n3) \ + && echo "Query responded." \ + || echo "Query did not respond." + block_parse "${IPv6_inet_check}" else - echo "No hosts file found!" >> ${DEBUG_LOG} - printf ":::\tNo hosts file found!\n" + log_echo="No IPv6 Gateway Detected" fi -} -function portCheck { - echo "############################################################" >> ${DEBUG_LOG} - echo "######## Open Port Information #########" >> ${DEBUG_LOG} - echo "############################################################" >> ${DEBUG_LOG} +local IPv4_addr_list="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet") print $(i+1) }')" \ + && (block_parse "${IPv4_addr_list}" && echo "::: IPv4 addresses located")\ + || log_echo "No IPv4 addresses found." + + local IPv4_def_gateway=$(ip r | grep default | cut -d ' ' -f 3) + if [[ $? = 0 ]]; then + echo -n "::: Pinging default IPv4 gateway: " + local IPv4_def_gateway_check="$(ping -q -w 3 -c 3 -n "${IPv4_def_gateway}" -I "${IPv4_interface}" | tail -n3)" \ + && echo "Gateway responded." \ + || echo "Gateway did not respond." + block_parse "${IPv4_def_gateway_check}" + + echo -n "::: Pinging Internet via IPv4: " + local IPv4_inet_check="$(ping -q -w 5 -c 3 -n 8.8.8.8 -I "${IPv4_interface}" | tail -n3)" \ + && echo "Query responded." \ + || echo "Query did not respond." + block_parse "${IPv4_inet_check}" + fi + + fi +} - echo "::: Detecting local server port 80 and 53 processes." +port_check() { + local lsof_value - ${SUDO} lsof -i :80 >> ${DEBUG_LOG} - ${SUDO} lsof -i :53 >> ${DEBUG_LOG} - echo >> ${DEBUG_LOG} + lsof_value=$(lsof -i ${1}:${2} -FcL | tr '\n' ' ') \ + && lsof_parse "${lsof_value}" "${3}" \ + || log_echo "Failure: IPv${1} Port not in use" } -function testResolver { - echo "############################################################" >> ${DEBUG_LOG} - echo "############ Resolver Functions Check ############" >> ${DEBUG_LOG} - echo "############################################################" >> ${DEBUG_LOG} +daemon_check() { + # Check for daemon ${1} on port ${2} + header_write "Daemon Process Information" + + echo "::: Checking ${2} port for ${1} listener." + + if [[ ${IPV6_READY} ]]; then + port_check 6 "${2}" "${1}" + fi + lsof_value=$(lsof -i 4:${2} -FcL | tr '\n' ' ') \ + port_check 4 "${2}" "${1}" +} +testResolver() { + header_write "Resolver Functions Check" # Find a blocked url that has not been whitelisted. - TESTURL="doubleclick.com" - if [ -s "$WHITELISTMATCHES" ]; then + TESTURL="doubleclick.com" + if [ -s "${WHITELISTMATCHES}" ]; then while read -r line; do CUTURL=${line#*" "} - if [ "$CUTURL" != "Pi-Hole.IsWorking.OK" ]; then + if [ "${CUTURL}" != "Pi-Hole.IsWorking.OK" ]; then while read -r line2; do CUTURL2=${line2#*" "} - if [ "$CUTURL" != "$CUTURL2" ]; then - TESTURL="$CUTURL" + if [ "${CUTURL}" != "${CUTURL2}" ]; then + TESTURL="${CUTURL}" break 2 fi - done < "$WHITELISTMATCHES" + done < "${WHITELISTMATCHES}" fi - done < "$GRAVITYFILE" + done < "${GRAVITYFILE}" fi - echo "Resolution of $TESTURL from Pi-hole:" >> ${DEBUG_LOG} - LOCALDIG=$(dig "$TESTURL" @127.0.0.1) - if [[ $? = 0 ]] - then - echo "$LOCALDIG" >> ${DEBUG_LOG} + log_write "Resolution of ${TESTURL} from Pi-hole:" + LOCALDIG=$(dig "${TESTURL}" @127.0.0.1) + if [[ $? = 0 ]]; then + log_write "${LOCALDIG}" else - echo "Failed to resolve $TESTURL on Pi-hole" >> ${DEBUG_LOG} + log_write "Failed to resolve ${TESTURL} on Pi-hole" fi - echo >> ${DEBUG_LOG} + log_write "" - echo "Resolution of $TESTURL from 8.8.8.8:" >> ${DEBUG_LOG} - REMOTEDIG=$(dig "$TESTURL" @8.8.8.8) - if [[ $? = 0 ]] - then - echo "$REMOTEDIG" >> ${DEBUG_LOG} + log_write "Resolution of ${TESTURL} from 8.8.8.8:" + REMOTEDIG=$(dig "${TESTURL}" @8.8.8.8) + if [[ $? = 0 ]]; then + log_write "${REMOTEDIG}" else - echo "Failed to resolve $TESTURL on 8.8.8.8" >> ${DEBUG_LOG} + log_write "Failed to resolve ${TESTURL} on 8.8.8.8" fi - echo >> ${DEBUG_LOG} - - echo "Pi-hole dnsmasq specific records lookups" >> ${DEBUG_LOG} - echo "Cache Size:" >> ${DEBUG_LOG} - dig +short chaos txt cachesize.bind >> ${DEBUG_LOG} - echo "Insertions count:" >> ${DEBUG_LOG} - dig +short chaos txt insertions.bind >> ${DEBUG_LOG} - echo "Evictions count:" >> ${DEBUG_LOG} - dig +short chaos txt evictions.bind >> ${DEBUG_LOG} - echo "Misses count:" >> ${DEBUG_LOG} - dig +short chaos txt misses.bind >> ${DEBUG_LOG} - echo "Hits count:" >> ${DEBUG_LOG} - dig +short chaos txt hits.bind >> ${DEBUG_LOG} - echo "Auth count:" >> ${DEBUG_LOG} - dig +short chaos txt auth.bind >> ${DEBUG_LOG} - echo "Upstream Servers:" >> ${DEBUG_LOG} - dig +short chaos txt servers.bind >> ${DEBUG_LOG} - echo >> ${DEBUG_LOG} + log_write "" + + log_write "Pi-hole dnsmasq specific records lookups" + log_write "Cache Size:" + dig +short chaos txt cachesize.bind >> ${DEBUG_LOG} + log_write "Upstream Servers:" + dig +short chaos txt servers.bind >> ${DEBUG_LOG} + log_write "" } -function checkProcesses { - echo "#######################################" >> ${DEBUG_LOG} - echo "########### Processes Check ###########" >> ${DEBUG_LOG} - echo "#######################################" >> ${DEBUG_LOG} - echo ":::" - echo "::: Logging status of lighttpd and dnsmasq..." +checkProcesses() { + header_write "Processes Check" + + echo "::: Logging status of lighttpd and dnsmasq..." PROCESSES=( lighttpd dnsmasq ) - for i in "${PROCESSES[@]}" - do - echo "" >> ${DEBUG_LOG} - echo -n "$i" >> "$DEBUG_LOG" - echo " processes status:" >> ${DEBUG_LOG} - ${SUDO} systemctl -l status "$i" >> "$DEBUG_LOG" + for i in "${PROCESSES[@]}"; do + log_write "" + log_write "${i}" + log_write " processes status:" + systemctl -l status "${i}" >> "${DEBUG_LOG}" done - echo >> ${DEBUG_LOG} + log_write "" } -function debugLighttpd { - echo "::: Writing lighttpd to debug log..." - echo "#######################################" >> ${DEBUG_LOG} - echo "############ lighttpd.conf ############" >> ${DEBUG_LOG} - echo "#######################################" >> ${DEBUG_LOG} - if [ -e "$LIGHTTPDFILE" ] - then - while read -r line; do - if [ ! -z "$line" ]; then - [[ "$line" =~ ^#.*$ ]] && continue - echo "$line" >> ${DEBUG_LOG} - fi - done < "$LIGHTTPDFILE" - echo >> ${DEBUG_LOG} - else - echo "No lighttpd.conf file found!" >> ${DEBUG_LOG} - printf ":::\tNo lighttpd.conf file found\n" - fi - - if [ -e "$LIGHTTPDERRFILE" ] - then - echo "#######################################" >> ${DEBUG_LOG} - echo "######### lighttpd error.log ##########" >> ${DEBUG_LOG} - echo "#######################################" >> ${DEBUG_LOG} - cat "$LIGHTTPDERRFILE" >> ${DEBUG_LOG} - else - echo "No lighttpd error.log file found!" >> ${DEBUG_LOG} - printf ":::\tNo lighttpd error.log file found\n" - fi - echo >> ${DEBUG_LOG} +debugLighttpd() { + echo "::: Checking for necessary lighttpd files." + files_check "${LIGHTTPDFILE}" + files_check "${LIGHTTPDERRFILE}" + echo ":::" } ### END FUNCTIONS ### -version_check -distro_check +# Gather version of required packages / repositories +version_check || echo "REQUIRED FILES MISSING" +# Check for newer setupVars storage file +source_file "/etc/pihole/setupVars.conf" +# Gather information about the running distribution +distro_check || echo "Distro Check soft fail" +# Gather processor type +processor_check || echo "Processor Check soft fail" + ip_check -hostnameCheck -portCheck + +daemon_check lighttpd http +daemon_check dnsmasq domain checkProcesses testResolver debugLighttpd -echo "::: Writing dnsmasq.conf to debug log..." -echo "#######################################" >> ${DEBUG_LOG} -echo "############### Dnsmasq ###############" >> ${DEBUG_LOG} -echo "#######################################" >> ${DEBUG_LOG} -if [ -e "$DNSMASQFILE" ] -then - #cat $DNSMASQFILE >> $DEBUG_LOG - while read -r line; do - if [ ! -z "$line" ]; then - [[ "$line" =~ ^#.*$ ]] && continue - echo "$line" >> ${DEBUG_LOG} - fi - done < "$DNSMASQFILE" - echo >> ${DEBUG_LOG} -else - echo "No dnsmasq.conf file found!" >> ${DEBUG_LOG} - printf ":::\tNo dnsmasq.conf file found!\n" -fi - -echo "::: Writing 01-pihole.conf to debug log..." -echo "#######################################" >> ${DEBUG_LOG} -echo "########### 01-pihole.conf ############" >> ${DEBUG_LOG} -echo "#######################################" >> ${DEBUG_LOG} -if [ -e "$PIHOLECONFFILE" ] -then - while read -r line; do - if [ ! -z "$line" ]; then - [[ "$line" =~ ^#.*$ ]] && continue - echo "$line" >> ${DEBUG_LOG} - fi - done < "$PIHOLECONFFILE" - echo >> ${DEBUG_LOG} -else - echo "No 01-pihole.conf file found!" >> ${DEBUG_LOG} - printf ":::\tNo 01-pihole.conf file found\n" -fi - -echo "::: Writing size of gravity.list to debug log..." -echo "#######################################" >> ${DEBUG_LOG} -echo "############ gravity.list #############" >> ${DEBUG_LOG} -echo "#######################################" >> ${DEBUG_LOG} -if [ -e "$GRAVITYFILE" ] -then - wc -l "$GRAVITYFILE" >> ${DEBUG_LOG} - echo >> ${DEBUG_LOG} -else - echo "No gravity.list file found!" >> ${DEBUG_LOG} - printf ":::\tNo gravity.list file found\n" -fi - - -### Pi-hole application specific logging ### -echo "::: Writing whitelist to debug log..." -echo "#######################################" >> ${DEBUG_LOG} -echo "############## Whitelist ##############" >> ${DEBUG_LOG} -echo "#######################################" >> ${DEBUG_LOG} -if [ -e "$WHITELISTFILE" ] -then - cat "$WHITELISTFILE" >> ${DEBUG_LOG} - echo >> ${DEBUG_LOG} -else - echo "No whitelist.txt file found!" >> ${DEBUG_LOG} - printf ":::\tNo whitelist.txt file found!\n" -fi - -echo "::: Writing blacklist to debug log..." -echo "#######################################" >> ${DEBUG_LOG} -echo "############## Blacklist ##############" >> ${DEBUG_LOG} -echo "#######################################" >> ${DEBUG_LOG} -if [ -e "$BLACKLISTFILE" ] -then - cat "$BLACKLISTFILE" >> ${DEBUG_LOG} - echo >> ${DEBUG_LOG} -else - echo "No blacklist.txt file found!" >> ${DEBUG_LOG} - printf ":::\tNo blacklist.txt file found!\n" -fi - -echo "::: Writing adlists.list to debug log..." -echo "#######################################" >> ${DEBUG_LOG} -echo "############ adlists.list #############" >> ${DEBUG_LOG} -echo "#######################################" >> ${DEBUG_LOG} -if [ -e "$ADLISTSFILE" ] -then - while read -r line; do - if [ ! -z "$line" ]; then - [[ "$line" =~ ^#.*$ ]] && continue - echo "$line" >> ${DEBUG_LOG} - fi - done < "$ADLISTSFILE" - echo >> ${DEBUG_LOG} -else - echo "No adlists.list file found... using adlists.default!" >> ${DEBUG_LOG} - printf ":::\tNo adlists.list file found... using adlists.default!\n" -fi +files_check "${DNSMASQFILE}" +files_check "${DNSMASQCONFFILE}" +files_check "${WHITELISTFILE}" +files_check "${BLACKLISTFILE}" +files_check "${ADLISTFILE}" + +header_write "Analyzing gravity.list" + + gravity_length=$(wc -l "${GRAVITYFILE}") \ + && log_write "${GRAVITYFILE} is ${gravity_length} lines long." \ + || log_echo "Warning: No gravity.list file found!" # Continuously append the pihole.log file to the pihole_debug.log file -function dumpPiHoleLog { +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)" - echo "#######################################" >> ${DEBUG_LOG} - echo "############# pihole.log ##############" >> ${DEBUG_LOG} - echo "#######################################" >> ${DEBUG_LOG} - if [ -e "$PIHOLELOG" ] - then + echo "::: " + echo "::: --= User Action Required =--" + echo -e "::: Try loading a site that you are having trouble with now from a client web browser.. \n:::\t(Press CTRL+C to finish logging.)" + header_write "pihole.log" + if [ -e "${PIHOLELOG}" ]; then while true; do - tail -f "$PIHOLELOG" >> ${DEBUG_LOG} - echo >> ${DEBUG_LOG} + tail -f "${PIHOLELOG}" >> ${DEBUG_LOG} + log_write "" done else - echo "No pihole.log file found!" >> ${DEBUG_LOG} + 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 -function 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 +finalWork() { + local tricorder + echo "::: Finshed debugging!" + echo "::: The debug log can be uploaded to tricorder.pi-hole.net for sharing with developers only." + read -r -p "::: Would you like to upload the log? [y/N] " response + case ${response} in + [yY][eE][sS]|[yY]) + tricorder=$(cat /var/log/pihole_debug.log | nc tricorder.pi-hole.net 9999) + ;; + *) + echo "::: Log will NOT be uploaded to tricorder." + ;; + esac + + # Check if tricorder.pi-hole.net is reachable and provide token. + if [ -n "${tricorder}" ]; then + echo "::: Your debug token is : ${tricorder}" + echo "::: Please contact the Pi-hole team with your token to being assistance." + echo "::: Thank you." + fi + echo "::: Debug log can be found at : /var/log/pihole_debug.log" } trap finalWork EXIT |