pi-hole/pihole

204 lines
6.4 KiB
Text
Raw Normal View History

2016-08-26 22:10:22 +00:00
#!/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
if [ -x "$(command -v sudo)" ];then
echo "::: Elevating to root with sudo"
exec sudo bash "$0" "$@"
exit $?
else
echo "::: sudo is needed to run pihole commands. Please run this script as root or install sudo."
exit 1
fi
2016-08-26 22:10:22 +00:00
fi
function whitelistFunc {
shift
/opt/pihole/whitelist.sh "$@"
2016-10-15 16:16:44 +00:00
exit 0
2016-08-26 22:10:22 +00:00
}
function blacklistFunc {
shift
/opt/pihole/blacklist.sh "$@"
2016-10-15 16:16:44 +00:00
exit 0
2016-08-26 22:10:22 +00:00
}
function debugFunc {
/opt/pihole/piholeDebug.sh
2016-10-15 16:16:44 +00:00
exit 0
2016-08-26 22:10:22 +00:00
}
function flushFunc {
/opt/pihole/piholeLogFlush.sh
2016-10-15 16:16:44 +00:00
exit 0
2016-08-26 22:10:22 +00:00
}
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/",$//')
2016-09-12 17:57:19 +00:00
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 ":::"
2016-09-12 17:57:19 +00:00
if [[ ${piholeVersion} == ${piholeVersionLatest} ]] ; then
2016-09-12 17:57:19 +00:00
echo "::: Pi-hole Base files are already up to date! Version: ${piholeVersionLatest}"
echo "::: No need to update!"
echo ":::"
2016-09-12 17:57:19 +00:00
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
git pull origin master
2016-09-12 17:57:19 +00:00
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
git pull origin master
/etc/.pihole/automated\ install/basic-install.sh pihole
2016-09-12 17:57:19 +00:00
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 ":::"
2016-09-12 17:57:19 +00:00
echo "::: See https://changes.pi-hole.net for details"
fi
2016-10-15 16:16:44 +00:00
exit 0
2016-08-26 22:10:22 +00:00
}
function reconfigurePiholeFunc {
/etc/.pihole/automated\ install/basic-install.sh
2016-10-15 16:16:44 +00:00
exit 0;
}
2016-08-26 22:10:22 +00:00
function updateGravityFunc {
/opt/pihole/gravity.sh "$@"
2016-10-15 16:16:44 +00:00
exit 0
2016-08-26 22:10:22 +00:00
}
function setupLCDFunction {
/opt/pihole/setupLCD.sh
2016-10-15 16:16:44 +00:00
exit 0
2016-08-26 22:10:22 +00:00
}
2016-08-26 08:39:27 +00:00
function queryFunc {
domain=$2
for list in /etc/pihole/list.*
do
count=$(grep ${domain} $list | wc -l)
2016-09-06 18:21:56 +00:00
echo "::: ${list} (${count} results)"
if [[ ${count} > 0 ]]; then
grep ${domain} ${list}
fi
2016-09-06 18:21:56 +00:00
echo ""
done
2016-10-15 16:16:44 +00:00
exit 0
2016-08-26 08:39:27 +00:00
}
2016-08-26 22:10:22 +00:00
function chronometerFunc {
shift
/opt/pihole/chronometer.sh "$@"
2016-10-15 16:16:44 +00:00
exit 0
2016-08-26 22:10:22 +00:00
}
function uninstallFunc {
/opt/pihole/uninstall.sh
2016-10-15 16:16:44 +00:00
exit 0
2016-08-26 22:10:22 +00:00
}
function versionFunc {
/opt/pihole/version.sh
2016-10-15 16:16:44 +00:00
exit 0
2016-08-26 22:10:22 +00:00
}
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"
2016-08-26 22:10:22 +00:00
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"
2016-08-26 08:39:27 +00:00
echo "::: -q, query Query the adlists for a specific domain"
2016-08-26 22:10:22 +00:00
echo "::: uninstall Uninstall Pi-Hole from your system :(!"
2016-10-15 16:16:44 +00:00
exit 0
2016-08-26 22:10:22 +00:00
}
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;;
"-up" | "updatePihole" ) updatePiholeFunc;;
"-r" | "reconfigure" ) reconfigurePiholeFunc;;
2016-08-26 22:10:22 +00:00
"-g" | "updateGravity" ) updateGravityFunc "$@";;
"-s" | "setupLCD" ) setupLCDFunction;;
"-c" | "chronometer" ) chronometerFunc "$@";;
"-h" | "help" ) helpFunc;;
"-v" | "version" ) versionFunc;;
"-q" | "query" ) queryFunc "$@";;
2016-08-26 22:10:22 +00:00
"uninstall" ) uninstallFunc;;
* ) helpFunc;;
esac