mirror of
https://github.com/pi-hole/pi-hole.git
synced 2024-12-01 10:33:18 +00:00
214 lines
7 KiB
Bash
Executable file
214 lines
7 KiB
Bash
Executable file
#!/bin/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
|
|
# Controller for all pihole scripts and functions.
|
|
#
|
|
# 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.
|
|
|
|
# Must be root to use this tool
|
|
if [[ ! $EUID -eq 0 ]];then
|
|
#echo "::: You are root."
|
|
#else
|
|
#echo "::: Sudo will be used for this tool."
|
|
# Check if it is actually installed
|
|
# If it isn't, exit because the pihole cannot be invoked without privileges.
|
|
if [ -x "$(command -v sudo)" ];then
|
|
export SUDO="sudo"
|
|
else
|
|
echo "::: Please install sudo or run this as root."
|
|
exit 1
|
|
fi
|
|
fi
|
|
|
|
function whitelistFunc {
|
|
shift
|
|
${SUDO} /opt/pihole/whitelist.sh "$@"
|
|
exit 1
|
|
}
|
|
|
|
function blacklistFunc {
|
|
shift
|
|
${SUDO} /opt/pihole/blacklist.sh "$@"
|
|
exit 1
|
|
}
|
|
|
|
function debugFunc {
|
|
${SUDO} /opt/pihole/piholeDebug.sh
|
|
exit 1
|
|
}
|
|
|
|
function flushFunc {
|
|
echo "::: Saving current summary..."
|
|
python /opt/pihole/summaryDB.py
|
|
echo "::: Flushing queries from database..."
|
|
sqlite3 /etc/pihole/pihole.db "DROP TABLE IF EXISTS queries"
|
|
sqlite3 /etc/pihole/pihole.db "DROP TABLE IF EXISTS forwards"
|
|
sqlite3 /etc/pihole/pihole.db "DROP TABLE IF EXISTS replies"
|
|
exit 1
|
|
}
|
|
|
|
function databaseFunc {
|
|
echo "::: Importing /var/log/pihole/log to /etc/pihole/pihole.db"
|
|
python /opt/pihole/dnsmasq_parse.py /var/log/pihole.log
|
|
${SUDO} /opt/pihole/piholeLogFlush.sh
|
|
exit 1
|
|
|
|
}
|
|
|
|
function updatePiholeFunc {
|
|
|
|
if [ ! -d "/etc/.pihole" ]; then #This is unlikely
|
|
echo "::: Critical Error: Pi-Hole repo missing from system!"
|
|
echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
|
|
exit 1;
|
|
fi
|
|
if [ ! -d "/var/www/html/admin" ]; then #This is unlikely
|
|
echo "::: Critical Error: Pi-Hole repo missing from system!"
|
|
echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
|
|
exit 1;
|
|
fi
|
|
|
|
echo "::: Checking for updates..."
|
|
piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
|
|
piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
|
|
|
|
webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
|
|
webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' | perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
|
|
|
|
echo "::: Pi-hole version is $piholeVersion (Latest version is $piholeVersionLatest)"
|
|
echo "::: Web Admin version is $webVersion (Latest version is $webVersionLatest)"
|
|
echo ":::"
|
|
|
|
if [[ ${piholeVersion} == ${piholeVersionLatest} ]] ; then
|
|
echo "::: Pi-hole Base files are already up to date! Version: ${piholeVersionLatest}"
|
|
echo "::: No need to update!"
|
|
echo ":::"
|
|
|
|
if [[ ${webVersion} == ${webVersionLatest} ]] ; then
|
|
echo "::: Web Admin files are already up to date!"
|
|
echo "::: No need to update!"
|
|
echo ":::"
|
|
else
|
|
echo "::: An Update is available for the Web Admin!"
|
|
echo ":::"
|
|
echo "::: Fetching latest changes from GitHub..."
|
|
cd /var/www/html/admin
|
|
${SUDO} git pull origin master
|
|
echo ":::"
|
|
echo "::: Pi-hole Web Admin has been updated to ${webVersion}"
|
|
echo "::: See https://changes.pi-hole.net for details"
|
|
fi
|
|
else
|
|
echo -n "::: An update is available for "
|
|
if [[ ${webVersion} == ${webVersionLatest} ]] ; then
|
|
echo " Pi-Hole!"
|
|
else
|
|
echo " Pi-Hole base files and the Web Admin. Both will be updated!"
|
|
fi
|
|
|
|
echo "::: Fetching latest changes from GitHub..."
|
|
cd /etc/.pihole
|
|
${SUDO} git pull origin master
|
|
${SUDO} /etc/.pihole/automated\ install/basic-install.sh pihole
|
|
|
|
echo ":::"
|
|
echo "::: Pi-hole has been updated to version ${piholeVersionLatest}"
|
|
if [[ ${webVersion} != ${webVersionLatest} ]] ; then
|
|
echo "::: Web Admin has been updated to version ${webVersionLatest}"
|
|
fi
|
|
echo ":::"
|
|
echo "::: See https://changes.pi-hole.net for details"
|
|
fi
|
|
|
|
exit 1
|
|
}
|
|
|
|
function updateGravityFunc {
|
|
${SUDO} /opt/pihole/gravity.sh "$@"
|
|
exit 1
|
|
}
|
|
|
|
function setupLCDFunction {
|
|
${SUDO} /opt/pihole/setupLCD.sh
|
|
exit 1
|
|
}
|
|
|
|
function queryFunc {
|
|
domain=$2
|
|
for list in /etc/pihole/list.*
|
|
do
|
|
count=$(grep ${domain} $list | wc -l)
|
|
echo "::: ${list} (${count} results)"
|
|
if [[ ${count} > 0 ]]; then
|
|
grep ${domain} ${list}
|
|
fi
|
|
echo ""
|
|
done
|
|
exit 1
|
|
}
|
|
|
|
function chronometerFunc {
|
|
shift
|
|
${SUDO} /opt/pihole/chronometer.sh "$@"
|
|
exit 1
|
|
}
|
|
|
|
|
|
function uninstallFunc {
|
|
${SUDO} /opt/pihole/uninstall.sh
|
|
exit 1
|
|
}
|
|
|
|
function versionFunc {
|
|
${SUDO} /opt/pihole/version.sh
|
|
exit 1
|
|
}
|
|
|
|
function helpFunc {
|
|
echo "::: Control all PiHole specific functions!"
|
|
echo ":::"
|
|
echo "::: Usage: pihole [options]"
|
|
echo "::: Add -h after -w (whitelist), -b (blacklist), or -c (chronometer) for more information on usage"
|
|
echo ":::"
|
|
echo "::: Options:"
|
|
echo "::: -w, whitelist Whitelist domains"
|
|
echo "::: -b, blacklist Blacklist domains"
|
|
echo "::: -d, debug Start a debugging session if having trouble"
|
|
echo "::: -f, flush Flush the pihole.log file"
|
|
echo "::: -up, updatePihole Update Pi-hole"
|
|
echo "::: -g, updateGravity Update the list of ad-serving domains"
|
|
echo "::: -s, setupLCD Automatically configures the Pi to use the 2.8 LCD screen to display stats on it"
|
|
echo "::: -c, chronometer Calculates stats and displays to an LCD"
|
|
echo "::: -h, help Show this help dialog"
|
|
echo "::: -v, version Show current versions"
|
|
echo "::: -q, query Query the adlists for a specific domain"
|
|
echo "::: uninstall Uninstall Pi-Hole from your system :(!"
|
|
exit 1
|
|
}
|
|
|
|
if [[ $# = 0 ]]; then
|
|
helpFunc
|
|
fi
|
|
|
|
# Handle redirecting to specific functions based on arguments
|
|
case "$1" in
|
|
"-w" | "whitelist" ) whitelistFunc "$@";;
|
|
"-b" | "blacklist" ) blacklistFunc "$@";;
|
|
"-d" | "debug" ) debugFunc;;
|
|
"-f" | "flush" ) flushFunc;;
|
|
"-i" | "importLogToDatabase" ) databaseFunc;;
|
|
"-up" | "updatePihole" ) updatePiholeFunc;;
|
|
"-g" | "updateGravity" ) updateGravityFunc "$@";;
|
|
"-s" | "setupLCD" ) setupLCDFunction;;
|
|
"-c" | "chronometer" ) chronometerFunc "$@";;
|
|
"-h" | "help" ) helpFunc;;
|
|
"-v" | "version" ) versionFunc;;
|
|
"-q" | "query" ) queryFunc "$@";;
|
|
"uninstall" ) uninstallFunc;;
|
|
* ) helpFunc;;
|
|
esac
|