Pi-hole/pi-hole
Pi-hole/pi-hole
1
0
Fork 0
mirror of https://github.com/pi-hole/pi-hole.git synced 2024-12-25 06:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #790 from pi-hole/piholeUpdate

Browse source 
Various refactoring.
This commit is contained in:
Adam Warner 2016-10-15 23:51:07 +01:00 committed by GitHub
commit 9ce13f0035
8 changed files with 178 additions and 194 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
advanced/Scripts/blacklist.sh
View file

@ -10,22 +10,7 @@
# the Free Software Foundation, either version 2 of the License, or # the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version. # (at your option) any later version.
#rootcheck helpFunc()
if [[ $EUID -eq 0 ]];then
echo "::: You are root."
else
echo "::: sudo will be used."
# Check if it is actually installed
# If it isn't, exit because the install cannot complete
if [ -x "$(command -v sudo)" ];then
export SUDO="sudo"
else
echo "::: Please install sudo or run this script as root."
exit 1
fi
fi
function helpFunc()
{ {
echo "::: Immediately blacklists one or more domains in the hosts file" echo "::: Immediately blacklists one or more domains in the hosts file"
echo ":::" echo ":::"
@ -86,7 +71,7 @@ if [[ -f ${piholeIPv6file} ]];then
piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }') piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
fi fi
function HandleOther(){ HandleOther(){
#check validity of domain #check validity of domain
validDomain=$(echo "$1" | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/') validDomain=$(echo "$1" | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/')
if [ -z "$validDomain" ]; then if [ -z "$validDomain" ]; then
@ -96,7 +81,7 @@ function HandleOther(){
fi fi
} }
function PopBlacklistFile(){ PopBlacklistFile(){
#check blacklist file exists, and if not, create it #check blacklist file exists, and if not, create it
if [[ ! -f ${blacklist} ]];then if [[ ! -f ${blacklist} ]];then
touch ${blacklist} touch ${blacklist}
@ -110,7 +95,7 @@ function PopBlacklistFile(){
done done
} }
function AddDomain(){ AddDomain(){
#| sed 's/\./\\./g' #| sed 's/\./\\./g'
bool=false bool=false
grep -Ex -q "$1" ${blacklist} || bool=true grep -Ex -q "$1" ${blacklist} || bool=true
@ -129,7 +114,7 @@ function AddDomain(){
fi fi
} }
function RemoveDomain(){ RemoveDomain(){
bool=false bool=false
grep -Ex -q "$1" ${blacklist} || bool=true grep -Ex -q "$1" ${blacklist} || bool=true
@ -148,7 +133,7 @@ function RemoveDomain(){
fi fi
} }
function ModifyHostFile(){ ModifyHostFile(){
if ${addmode}; then if ${addmode}; then
#add domains to the hosts file #add domains to the hosts file
if [[ -r ${blacklist} ]];then if [[ -r ${blacklist} ]];then
@ -178,7 +163,7 @@ function ModifyHostFile(){
fi fi
} }
function Reload() { Reload() {
# Reload hosts file # Reload hosts file
echo ":::" echo ":::"
echo -n "::: Refresh lists in dnsmasq..." echo -n "::: Refresh lists in dnsmasq..."
@ -187,15 +172,15 @@ function Reload() {
if [[ ${dnsmasqPid} ]]; then if [[ ${dnsmasqPid} ]]; then
# service already running - reload config # service already running - reload config
${SUDO} killall -s HUP dnsmasq killall -s HUP dnsmasq
else else
# service not running, start it up # service not running, start it up
${SUDO} service dnsmasq start service dnsmasq start
fi fi
echo " done!" echo " done!"
} }
function DisplayBlist() { DisplayBlist() {
verbose=false verbose=false
echo -e " Displaying Gravity Affected Domains \n" echo -e " Displaying Gravity Affected Domains \n"
count=1 count=1

16
advanced/Scripts/chronometer.sh
View file

@ -17,7 +17,7 @@ gravity="/etc/pihole/gravity.list"
today=$(date "+%b %e") today=$(date "+%b %e")
function CalcBlockedDomains(){ CalcBlockedDomains(){
CheckIPv6 CheckIPv6
if [ -e "$gravity" ]; then if [ -e "$gravity" ]; then
#Are we IPV6 or IPV4? #Are we IPV6 or IPV4?
@ -33,7 +33,7 @@ function CalcBlockedDomains(){
fi fi
} }
function CalcQueriesToday(){ CalcQueriesToday(){
if [ -e "$piLog" ];then if [ -e "$piLog" ];then
queriesToday=$(cat "$piLog" | grep "$today" | awk '/query/ {print $6}' | wc -l) queriesToday=$(cat "$piLog" | grep "$today" | awk '/query/ {print $6}' | wc -l)
else else
@ -41,7 +41,7 @@ function CalcQueriesToday(){
fi fi
} }
function CalcblockedToday(){ CalcblockedToday(){
if [ -e "$piLog" ] && [ -e "$gravity" ];then if [ -e "$piLog" ] && [ -e "$gravity" ];then
blockedToday=$(cat ${piLog} | awk '/\/etc\/pihole\/gravity.list/ && !/address/ {print $6}' | wc -l) blockedToday=$(cat ${piLog} | awk '/\/etc\/pihole\/gravity.list/ && !/address/ {print $6}' | wc -l)
else else
@ -49,7 +49,7 @@ function CalcblockedToday(){
fi fi
} }
function CalcPercentBlockedToday(){ CalcPercentBlockedToday(){
if [ "$queriesToday" != "Err." ] && [ "$blockedToday" != "Err." ]; then if [ "$queriesToday" != "Err." ] && [ "$blockedToday" != "Err." ]; then
if [ "$queriesToday" != 0 ]; then #Fixes divide by zero error :) if [ "$queriesToday" != 0 ]; then #Fixes divide by zero error :)
#scale 2 rounds the number down, so we'll do scale 4 and then trim the last 2 zeros #scale 2 rounds the number down, so we'll do scale 4 and then trim the last 2 zeros
@ -61,7 +61,7 @@ function CalcPercentBlockedToday(){
fi fi
} }
function CheckIPv6(){ CheckIPv6(){
piholeIPv6file="/etc/pihole/.useIPv6" piholeIPv6file="/etc/pihole/.useIPv6"
if [[ -f ${piholeIPv6file} ]];then if [[ -f ${piholeIPv6file} ]];then
# If the file exists, then the user previously chose to use IPv6 in the automated installer # If the file exists, then the user previously chose to use IPv6 in the automated installer
@ -69,7 +69,7 @@ function CheckIPv6(){
fi fi
} }
function outputJSON(){ outputJSON(){
CalcQueriesToday CalcQueriesToday
CalcblockedToday CalcblockedToday
CalcPercentBlockedToday CalcPercentBlockedToday
@ -79,7 +79,7 @@ function outputJSON(){
printf '{"domains_being_blocked":"%s","dns_queries_today":"%s","ads_blocked_today":"%s","ads_percentage_today":"%s"}\n' "$blockedDomainsTotal" "$queriesToday" "$blockedToday" "$percentBlockedToday" printf '{"domains_being_blocked":"%s","dns_queries_today":"%s","ads_blocked_today":"%s","ads_percentage_today":"%s"}\n' "$blockedDomainsTotal" "$queriesToday" "$blockedToday" "$percentBlockedToday"
} }
function normalChrono(){ normalChrono(){
for (( ; ; )) for (( ; ; ))
do do
clear clear
@ -121,7 +121,7 @@ function normalChrono(){
done done
} }
function displayHelp(){ displayHelp(){
echo "::: Displays stats about your piHole!" echo "::: Displays stats about your piHole!"
echo ":::" echo ":::"
echo "::: Usage: sudo pihole -c [optional:-j]" echo "::: Usage: sudo pihole -c [optional:-j]"

43
advanced/Scripts/setupLCD.sh
View file

@ -11,21 +11,6 @@
# (at your option) any later version. # (at your option) any later version.
############ FUNCTIONS ########### ############ FUNCTIONS ###########
# Run this script as root or under sudo
echo ":::"
if [[ $EUID -eq 0 ]];then
echo "::: You are root."
else
echo "::: sudo will be used."
# Check if it is actually installed
# If it isn't, exit because the install cannot complete
if [ -x "$(command -v sudo)" ];then
export SUDO="sudo"
else
echo "::: Please install sudo or run this script as root."
exit 1
fi
fi
# Borrowed from adafruit-pitft-helper < borrowed from raspi-config # Borrowed from adafruit-pitft-helper < borrowed from raspi-config
# https://github.com/adafruit/Adafruit-PiTFT-Helper/blob/master/adafruit-pitft-helper#L324-L334 # https://github.com/adafruit/Adafruit-PiTFT-Helper/blob/master/adafruit-pitft-helper#L324-L334
@ -45,11 +30,11 @@ getInitSys() {
autoLoginPiToConsole() { autoLoginPiToConsole() {
if [ -e /etc/init.d/lightdm ]; then if [ -e /etc/init.d/lightdm ]; then
if [ ${SYSTEMD} -eq 1 ]; then if [ ${SYSTEMD} -eq 1 ]; then
${SUDO} systemctl set-default multi-user.target systemctl set-default multi-user.target
${SUDO} ln -fs /etc/systemd/system/autologin@.service /etc/systemd/system/getty.target.wants/getty@tty1.service ln -fs /etc/systemd/system/autologin@.service /etc/systemd/system/getty.target.wants/getty@tty1.service
else else
${SUDO} update-rc.d lightdm disable 2 update-rc.d lightdm disable 2
${SUDO} sed /etc/inittab -i -e "s/1:2345:respawn:\/sbin\/getty --noclear 38400 tty1/1:2345:respawn:\/bin\/login -f pi tty1 <\/dev\/tty1 >\/dev\/tty1 2>&1/" sed /etc/inittab -i -e "s/1:2345:respawn:\/sbin\/getty --noclear 38400 tty1/1:2345:respawn:\/bin\/login -f pi tty1 <\/dev\/tty1 >\/dev\/tty1 2>&1/"
fi fi
fi fi
} }
@ -66,23 +51,23 @@ echo /usr/local/bin/chronometer.sh >> /home/pi/.bashrc
# Set up the LCD screen based on Adafruits instuctions: # Set up the LCD screen based on Adafruits instuctions:
# https://learn.adafruit.com/adafruit-pitft-28-inch-resistive-touchscreen-display-raspberry-pi/easy-install # https://learn.adafruit.com/adafruit-pitft-28-inch-resistive-touchscreen-display-raspberry-pi/easy-install
curl -SLs https://apt.adafruit.com/add-pin | ${SUDO} bash curl -SLs https://apt.adafruit.com/add-pin | bash
${SUDO} apt-get -y install raspberrypi-bootloader apt-get -y install raspberrypi-bootloader
${SUDO} apt-get -y install adafruit-pitft-helper apt-get -y install adafruit-pitft-helper
${SUDO} adafruit-pitft-helper -t 28r adafruit-pitft-helper -t 28r
# Download the cmdline.txt file that prevents the screen from going blank after a period of time # Download the cmdline.txt file that prevents the screen from going blank after a period of time
${SUDO} mv /boot/cmdline.txt /boot/cmdline.orig mv /boot/cmdline.txt /boot/cmdline.orig
${SUDO} curl -o /boot/cmdline.txt https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/cmdline.txt curl -o /boot/cmdline.txt https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/cmdline.txt
# Back up the original file and download the new one # Back up the original file and download the new one
${SUDO} mv /etc/default/console-setup /etc/default/console-setup.orig mv /etc/default/console-setup /etc/default/console-setup.orig
${SUDO} curl -o /etc/default/console-setup https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/console-setup curl -o /etc/default/console-setup https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/console-setup
# Instantly apply the font change to the LCD screen # Instantly apply the font change to the LCD screen
${SUDO} setupcon setupcon
${SUDO} reboot reboot
# Start showing the stats on the screen by running the command on another tty: # Start showing the stats on the screen by running the command on another tty:
# http://unix.stackexchange.com/questions/170063/start-a-process-on-a-different-tty # http://unix.stackexchange.com/questions/170063/start-a-process-on-a-different-tty

34
advanced/Scripts/whitelist.sh
View file

@ -10,22 +10,8 @@
# the Free Software Foundation, either version 2 of the License, or # the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version. # (at your option) any later version.
#rootcheck
if [[ $EUID -eq 0 ]];then
echo "::: You are root."
else
echo "::: sudo will be used."
# Check if it is actually installed
# If it isn't, exit because the install cannot complete
if [ -x "$(command -v sudo)" ];then
export SUDO="sudo"
else
echo "::: Please install sudo or run this script as root."
exit 1
fi
fi
function helpFunc() helpFunc()
{ {
echo "::: Immediately whitelists one or more domains in the hosts file" echo "::: Immediately whitelists one or more domains in the hosts file"
echo ":::" echo ":::"
@ -85,7 +71,7 @@ if [[ -f ${piholeIPv6file} ]];then
piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }') piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
fi fi
function HandleOther(){ HandleOther(){
#check validity of domain #check validity of domain
validDomain=$(echo "$1" | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/') validDomain=$(echo "$1" | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/')
if [ -z "$validDomain" ]; then if [ -z "$validDomain" ]; then
@ -95,7 +81,7 @@ function HandleOther(){
fi fi
} }
function PopWhitelistFile(){ PopWhitelistFile(){
#check whitelist file exists, and if not, create it #check whitelist file exists, and if not, create it
if [[ ! -f ${whitelist} ]];then if [[ ! -f ${whitelist} ]];then
touch ${whitelist} touch ${whitelist}
@ -110,7 +96,7 @@ function PopWhitelistFile(){
done done
} }
function AddDomain(){ AddDomain(){
#| sed 's/\./\\./g' #| sed 's/\./\\./g'
bool=false bool=false
@ -132,7 +118,7 @@ function AddDomain(){
fi fi
} }
function RemoveDomain(){ RemoveDomain(){
bool=false bool=false
grep -Ex -q "$1" ${whitelist} || bool=true grep -Ex -q "$1" ${whitelist} || bool=true
@ -151,7 +137,7 @@ function RemoveDomain(){
fi fi
} }
function ModifyHostFile(){ ModifyHostFile(){
if ${addmode}; then if ${addmode}; then
#remove domains in from hosts file #remove domains in from hosts file
if [[ -r ${whitelist} ]];then if [[ -r ${whitelist} ]];then
@ -195,7 +181,7 @@ function ModifyHostFile(){
fi fi
} }
function Reload() { Reload() {
# Reload hosts file # Reload hosts file
echo ":::" echo ":::"
echo -n "::: Refresh lists in dnsmasq..." echo -n "::: Refresh lists in dnsmasq..."
@ -203,15 +189,15 @@ function Reload() {
if [[ ${dnsmasqPid} ]]; then if [[ ${dnsmasqPid} ]]; then
# service already running - reload config # service already running - reload config
${SUDO} killall -s HUP dnsmasq killall -s HUP dnsmasq
else else
# service not running, start it up # service not running, start it up
${SUDO} service dnsmasq start service dnsmasq start
fi fi
echo " done!" echo " done!"
} }
function DisplayWlist() { DisplayWlist() {
verbose=false verbose=false
echo -e " Displaying Gravity Resistant Domains \n" echo -e " Displaying Gravity Resistant Domains \n"
count=1 count=1

2
advanced/bash-completion/pihole
View file

@ -4,7 +4,7 @@ _pihole()
COMPREPLY=() COMPREPLY=()
cur="${COMP_WORDS[COMP_CWORD]}" cur="${COMP_WORDS[COMP_CWORD]}"
prev="${COMP_WORDS[COMP_CWORD-1]}" prev="${COMP_WORDS[COMP_CWORD-1]}"
opts="blacklist chronometer debug flush help query setupLCD uninstall updateDashboard updateGravity updatePihole version whitelist" opts="blacklist chronometer debug flush help query reconfigure setupLCD uninstall updateGravity updatePihole version whitelist"
COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) ) COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
return 0 return 0

56
automated install/basic-install.sh
View file

@ -40,6 +40,11 @@ columns=$(tput cols)
r=$(( rows / 2 )) r=$(( rows / 2 ))
c=$(( columns / 2 )) c=$(( columns / 2 ))
######## Undocumented Flags. Shhh ########
skipSpaceCheck=false
reconfigure=false
runUnattended=false
######## FIRST CHECK ######## ######## FIRST CHECK ########
# Must be root to install # Must be root to install
echo ":::" echo ":::"
@ -864,10 +869,22 @@ View the web interface at http://pi.hole/admin or http://${IPv4_address%/*}/admi
} }
update_dialogs(){ update_dialogs(){
# reconfigure
if [ "$reconfigure" = true ]; then
opt1a="Repair"
opt1b="This will retain existing settings"
strAdd="You will remain on the same version"
else
opt1a="Update"
opt1b="This will retain existing settings."
strAdd="You will be updated to the latest version."
fi
opt2a="Reconfigure"
opt2b="This will allow you to enter new settings"
UpdateCmd=$(whiptail --title "Existing Install Detected!" --menu "\n\nWe have detected an existing install.\n\nPlease choose from the following options:" ${r} ${c} 2 \ UpdateCmd=$(whiptail --title "Existing Install Detected!" --menu "\n\nWe have detected an existing install.\n\nPlease choose from the following options: \n($strAdd)" ${r} ${c} 2 \
"Update" "Update install will retain existing settings." \ "$opt1a" "$opt1b" \
"Install" "Install will allow you to enter new settings." 3>&2 2>&1 1>&3) "$opt2a" "$opt2b" 3>&2 2>&1 1>&3)
if [[ $? = 0 ]];then if [[ $? = 0 ]];then
case ${UpdateCmd} in case ${UpdateCmd} in
@ -888,8 +905,19 @@ update_dialogs(){
} }
main() { main() {
# Check arguments for the undocumented flags
for var in "$@"
do
case "$var" in
"--reconfigure" ) reconfigure=true;;
"--i_do_not_follow_recommendations" ) skipSpaceCheck=false;;
"--unattended" ) runUnattended=true;;
esac
done
if [[ -f ${setupVars} ]];then if [[ -f ${setupVars} ]];then
if [ "$1" == "pihole" ]; then if [[ "${runUnattended}" == true ]]; then
echo "::: --unattended passed to install script, no whiptail dialogs will be displayed"
useUpdateVars=true useUpdateVars=true
else else
update_dialogs update_dialogs
@ -898,9 +926,8 @@ fi
# Start the installer # Start the installer
# Verify there is enough disk space for the install # Verify there is enough disk space for the install
if [[ $1 = "--i_do_not_follow_recommendations" ]]; then if [[ "${skipSpaceCheck}" == true ]]; then
echo "::: --i_do_not_follow_recommendations passed to script" echo "::: --i_do_not_follow_recommendations passed to script, skipping free disk space verification!"
echo "::: skipping free disk space verification!"
else else
verifyFreeDiskSpace verifyFreeDiskSpace
fi fi
@ -917,6 +944,14 @@ install_dependent_packages INSTALLER_DEPS[@]
# Install packages used by the Pi-hole # Install packages used by the Pi-hole
install_dependent_packages PIHOLE_DEPS[@] install_dependent_packages PIHOLE_DEPS[@]
if [[ "${reconfigure}" == true ]]; then
echo "::: --reconfigure passed to install script. Not downloading/updating local repos"
else
# Get Git files for Core and Admin
getGitFiles ${piholeFilesDir} ${piholeGitUrl}
getGitFiles ${webInterfaceDir} ${webInterfaceGitUrl}
fi
if [[ ${useUpdateVars} == false ]]; then if [[ ${useUpdateVars} == false ]]; then
# Display welcome dialogs # Display welcome dialogs
welcomeDialogs welcomeDialogs
@ -924,9 +959,6 @@ if [[ ${useUpdateVars} == false ]]; then
mkdir -p /etc/pihole/ mkdir -p /etc/pihole/
# Remove legacy scripts from previous storage location # Remove legacy scripts from previous storage location
remove_legacy_scripts remove_legacy_scripts
# Get Git files for Core and Admin
getGitFiles ${piholeFilesDir} ${piholeGitUrl}
getGitFiles ${webInterfaceDir} ${webInterfaceGitUrl}
# Stop resolver and webserver while installing proceses # Stop resolver and webserver while installing proceses
stop_service dnsmasq stop_service dnsmasq
stop_service lighttpd stop_service lighttpd
@ -947,7 +979,7 @@ fi
# Move the log file into /etc/pihole for storage # Move the log file into /etc/pihole for storage
mv ${tmpLog} ${instalLogLoc} mv ${tmpLog} ${instalLogLoc}
if [[ ${useUpdateVars} == false ]]; then if [[ "${useUpdateVars}" == false ]]; then
displayFinalMessage displayFinalMessage
fi fi
@ -960,7 +992,7 @@ enable_service lighttpd
echo " done." echo " done."
echo ":::" echo ":::"
if [[ ${useUpdateVars} == false ]]; then if [[ "${useUpdateVars}" == false ]]; then
echo "::: Installation Complete! Configure your devices to use the Pi-hole as their DNS server using:" echo "::: Installation Complete! Configure your devices to use the Pi-hole as their DNS server using:"
echo "::: ${IPv4_address%/*}" echo "::: ${IPv4_address%/*}"
echo "::: $IPv6_address" echo "::: $IPv6_address"

73
gravity.sh
View file

@ -13,21 +13,7 @@
# Run this script as root or under sudo # Run this script as root or under sudo
echo ":::" echo ":::"
if [[ $EUID -eq 0 ]];then helpFunc()
echo "::: You are root."
else
echo "::: sudo will be used."
# Check if it is actually installed
# If it isn't, exit because the install cannot complete
if [ -x "$(command -v sudo)" ];then
export SUDO="sudo"
else
echo "::: Please install sudo or run this script as root."
exit 1
fi
fi
function helpFunc()
{ {
echo "::: Pull in domains from adlists" echo "::: Pull in domains from adlists"
echo ":::" echo ":::"
@ -46,7 +32,15 @@ whitelistScript=/opt/pihole/whitelist.sh
blacklistScript=/opt/pihole/blacklist.sh blacklistScript=/opt/pihole/blacklist.sh
#Source the setupVars from install script for the IP #Source the setupVars from install script for the IP
. /etc/pihole/setupVars.conf setupVars=/etc/pihole/setupVars.conf
if [[ -f ${setupVars} ]];then
. /etc/pihole/setupVars.conf
else
echo "::: WARNING: /etc/pihole/setupVars.conf missing. Possible installation failure."
echo "::: Please run 'pihole -r', and choose the 'install' option to reconfigure."
exit 1
fi
#Remove the /* from the end of the IPv4addr. #Remove the /* from the end of the IPv4addr.
IPv4addr=${IPv4_address%/*} IPv4addr=${IPv4_address%/*}
@ -60,15 +54,14 @@ supernova=${basename}.1.supernova.txt
eventHorizon=${basename}.2.eventHorizon.txt eventHorizon=${basename}.2.eventHorizon.txt
accretionDisc=${basename}.3.accretionDisc.txt accretionDisc=${basename}.3.accretionDisc.txt
# After setting defaults, check if there's local overrides # Warn users still using pihole.conf that it no longer has any effect (I imagine about 2 people use it)
if [[ -r ${piholeDir}/pihole.conf ]];then if [[ -r ${piholeDir}/pihole.conf ]];then
echo "::: Local calibration requested..." echo "::: pihole.conf file no longer supported. Over-rides in this file are ignored."
. ${piholeDir}/pihole.conf
fi fi
########################### ###########################
# collapse - begin formation of pihole # collapse - begin formation of pihole
function gravity_collapse() { gravity_collapse() {
echo "::: Neutrino emissions detected..." echo "::: Neutrino emissions detected..."
echo ":::" echo ":::"
#Decide if we're using a custom ad block list, or defaults. #Decide if we're using a custom ad block list, or defaults.
@ -105,18 +98,18 @@ function gravity_collapse() {
# Temporary hack to allow non-root access to pihole directory # Temporary hack to allow non-root access to pihole directory
# Will update later, needed for existing installs, new installs should # Will update later, needed for existing installs, new installs should
# create this directory as non-root # create this directory as non-root
${SUDO} chmod 777 ${piholeDir} chmod 777 ${piholeDir}
echo ":::" echo ":::"
echo "::: Existing pihole directory found" echo "::: Existing pihole directory found"
else else
echo "::: Creating pihole directory..." echo "::: Creating pihole directory..."
mkdir ${piholeDir} mkdir ${piholeDir}
${SUDO} chmod 777 ${piholeDir} chmod 777 ${piholeDir}
fi fi
} }
# patternCheck - check to see if curl downloaded any new files. # patternCheck - check to see if curl downloaded any new files.
function gravity_patternCheck() { gravity_patternCheck() {
patternBuffer=$1 patternBuffer=$1
# check if the patternbuffer is a non-zero length file # check if the patternbuffer is a non-zero length file
if [[ -s "$patternBuffer" ]];then if [[ -s "$patternBuffer" ]];then
@ -132,7 +125,7 @@ function gravity_patternCheck() {
} }
# transport - curl the specified url with any needed command extentions # transport - curl the specified url with any needed command extentions
function gravity_transport() { gravity_transport() {
url=$1 url=$1
cmd_ext=$2 cmd_ext=$2
agent=$3 agent=$3
@ -154,7 +147,7 @@ function gravity_transport() {
} }
# spinup - main gravity function # spinup - main gravity function
function gravity_spinup() { gravity_spinup() {
echo ":::" echo ":::"
# Loop through domain list. Download each one and remove commented lines (lines beginning with '# 'or '/') and # blank lines # Loop through domain list. Download each one and remove commented lines (lines beginning with '# 'or '/') and # blank lines
for ((i = 0; i < "${#sources[@]}"; i++)) for ((i = 0; i < "${#sources[@]}"; i++))
@ -191,7 +184,7 @@ function gravity_spinup() {
} }
# Schwarzchild - aggregate domains to one list and add blacklisted domains # Schwarzchild - aggregate domains to one list and add blacklisted domains
function gravity_Schwarzchild() { gravity_Schwarzchild() {
echo "::: " echo "::: "
# Find all active domains and compile them into one file and remove CRs # Find all active domains and compile them into one file and remove CRs
echo -n "::: Aggregating list of domains..." echo -n "::: Aggregating list of domains..."
@ -203,7 +196,7 @@ function gravity_Schwarzchild() {
echo " done!" echo " done!"
} }
function gravity_Blacklist(){ gravity_Blacklist(){
# Append blacklist entries if they exist # Append blacklist entries if they exist
echo -n "::: Running blacklist script to update HOSTS file...." echo -n "::: Running blacklist script to update HOSTS file...."
${blacklistScript} -f -nr -q > /dev/null ${blacklistScript} -f -nr -q > /dev/null
@ -213,7 +206,7 @@ function gravity_Blacklist(){
echo " $numBlacklisted domain${plural} blacklisted!" echo " $numBlacklisted domain${plural} blacklisted!"
} }
function gravity_Whitelist() { gravity_Whitelist() {
echo ":::" echo ":::"
# Prevent our sources from being pulled into the hole # Prevent our sources from being pulled into the hole
plural=; [[ "${sources[@]}" != "1" ]] && plural=s plural=; [[ "${sources[@]}" != "1" ]] && plural=s
@ -234,7 +227,7 @@ function gravity_Whitelist() {
echo " $numWhitelisted domain${plural} whitelisted!" echo " $numWhitelisted domain${plural} whitelisted!"
} }
function gravity_unique() { gravity_unique() {
# Sort and remove duplicates # Sort and remove duplicates
echo -n "::: Removing duplicate domains...." echo -n "::: Removing duplicate domains...."
sort -u ${piholeDir}/${supernova} > ${piholeDir}/${eventHorizon} sort -u ${piholeDir}/${supernova} > ${piholeDir}/${eventHorizon}
@ -243,7 +236,7 @@ function gravity_unique() {
echo "::: $numberOf unique domains trapped in the event horizon." echo "::: $numberOf unique domains trapped in the event horizon."
} }
function gravity_hostFormat() { gravity_hostFormat() {
# Format domain list as "192.168.x.x domain.com" # Format domain list as "192.168.x.x domain.com"
echo "::: Formatting domains into a HOSTS file..." echo "::: Formatting domains into a HOSTS file..."
if [[ -f /etc/hostname ]]; then if [[ -f /etc/hostname ]]; then
@ -270,7 +263,7 @@ function gravity_hostFormat() {
} }
# blackbody - remove any remnant files from script processes # blackbody - remove any remnant files from script processes
function gravity_blackbody() { gravity_blackbody() {
# Loop through list files # Loop through list files
for file in ${piholeDir}/*.${justDomainsExtension} for file in ${piholeDir}/*.${justDomainsExtension}
do do
@ -283,7 +276,7 @@ function gravity_blackbody() {
done done
} }
function gravity_advanced() { gravity_advanced() {
# Remove comments and print only the domain name # Remove comments and print only the domain name
# Most of the lists downloaded are already in hosts file format but the spacing/formating is not contigious # Most of the lists downloaded are already in hosts file format but the spacing/formating is not contigious
# This helps with that and makes it easier to read # This helps with that and makes it easier to read
@ -301,11 +294,11 @@ function gravity_advanced() {
gravity_unique gravity_unique
} }
function gravity_reload() { gravity_reload() {
#Clear no longer needed files... #Clear no longer needed files...
echo ":::" echo ":::"
echo -n "::: Cleaning up un-needed files..." echo -n "::: Cleaning up un-needed files..."
${SUDO} rm ${piholeDir}/pihole.*.txt rm ${piholeDir}/pihole.*.txt
echo " done!" echo " done!"
# Reload hosts file # Reload hosts file
@ -316,17 +309,17 @@ function gravity_reload() {
#First escape forward slashes in the path: #First escape forward slashes in the path:
adList=${adList//\//\\\/} adList=${adList//\//\\\/}
#Now replace the line in dnsmasq file #Now replace the line in dnsmasq file
${SUDO} sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf
dnsmasqPid=$(pidof dnsmasq) dnsmasqPid=$(pidof dnsmasq)
find "$piholeDir" -type f -exec ${SUDO} chmod 666 {} \; find "$piholeDir" -type f -exec chmod 666 {} \;
if [[ ${dnsmasqPid} ]]; then if [[ ${dnsmasqPid} ]]; then
# service already running - reload config # service already running - reload config
${SUDO} killall -s HUP dnsmasq killall -s HUP dnsmasq
else else
# service not running, start it up # service not running, start it up
${SUDO} service dnsmasq start service dnsmasq start
fi fi
echo " done!" echo " done!"
} }
@ -342,12 +335,12 @@ done
if [[ ${forceGrav} == true ]]; then if [[ ${forceGrav} == true ]]; then
echo -n "::: Deleting exising list cache..." echo -n "::: Deleting exising list cache..."
${SUDO} rm /etc/pihole/list.* rm /etc/pihole/list.*
echo " done!" echo " done!"
fi fi
#Overwrite adlists.default from /etc/.pihole in case any changes have been made. Changes should be saved in /etc/adlists.list #Overwrite adlists.default from /etc/.pihole in case any changes have been made. Changes should be saved in /etc/adlists.list
${SUDO} cp /etc/.pihole/adlists.default /etc/pihole/adlists.default cp /etc/.pihole/adlists.default /etc/pihole/adlists.default
gravity_collapse gravity_collapse
gravity_spinup gravity_spinup
gravity_Schwarzchild gravity_Schwarzchild

89
pihole
View file

@ -12,43 +12,40 @@
# Must be root to use this tool # Must be root to use this tool
if [[ ! $EUID -eq 0 ]];then 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 if [ -x "$(command -v sudo)" ];then
export SUDO="sudo" echo "::: Elevating to root with sudo"
exec sudo bash "$0" "$@"
exit $?
else else
echo "::: Please install sudo or run this as root." echo "::: sudo is needed to run pihole commands. Please run this script as root or install sudo."
exit 1 exit 1
fi fi
fi fi
function whitelistFunc { whitelistFunc() {
shift shift
${SUDO} /opt/pihole/whitelist.sh "$@" /opt/pihole/whitelist.sh "$@"
exit 1 exit 0
} }
function blacklistFunc { blacklistFunc() {
shift shift
${SUDO} /opt/pihole/blacklist.sh "$@" /opt/pihole/blacklist.sh "$@"
exit 1 exit 0
} }
function debugFunc { debugFunc() {
${SUDO} /opt/pihole/piholeDebug.sh /opt/pihole/piholeDebug.sh
exit 1 exit 0
} }
function flushFunc { flushFunc() {
${SUDO} /opt/pihole/piholeLogFlush.sh /opt/pihole/piholeLogFlush.sh
exit 1 exit 0
} }
function updatePiholeFunc { updatePiholeFunc() {
if [ ! -d "/etc/.pihole" ]; then #This is unlikely if [ ! -d "/etc/.pihole" ]; then #This is unlikely
echo "::: Critical Error: Pi-Hole repo missing from system!" echo "::: Critical Error: Pi-Hole repo missing from system!"
@ -86,7 +83,7 @@ function updatePiholeFunc {
echo ":::" echo ":::"
echo "::: Fetching latest changes from GitHub..." echo "::: Fetching latest changes from GitHub..."
cd /var/www/html/admin cd /var/www/html/admin
${SUDO} git pull origin master git pull origin master
echo ":::" echo ":::"
echo "::: Pi-hole Web Admin has been updated to ${webVersion}" echo "::: Pi-hole Web Admin has been updated to ${webVersion}"
echo "::: See https://changes.pi-hole.net for details" echo "::: See https://changes.pi-hole.net for details"
@ -101,8 +98,8 @@ function updatePiholeFunc {
echo "::: Fetching latest changes from GitHub..." echo "::: Fetching latest changes from GitHub..."
cd /etc/.pihole cd /etc/.pihole
${SUDO} git pull origin master git pull origin master
${SUDO} /etc/.pihole/automated\ install/basic-install.sh pihole /etc/.pihole/automated\ install/basic-install.sh --unattended
echo ":::" echo ":::"
echo "::: Pi-hole has been updated to version ${piholeVersionLatest}" echo "::: Pi-hole has been updated to version ${piholeVersionLatest}"
@ -113,20 +110,25 @@ function updatePiholeFunc {
echo "::: See https://changes.pi-hole.net for details" echo "::: See https://changes.pi-hole.net for details"
fi fi
exit 1 exit 0
} }
function updateGravityFunc { reconfigurePiholeFunc() {
${SUDO} /opt/pihole/gravity.sh "$@" /etc/.pihole/automated\ install/basic-install.sh --reconfigure
exit 1 exit 0;
} }
function setupLCDFunction { updateGravityFunc() {
${SUDO} /opt/pihole/setupLCD.sh /opt/pihole/gravity.sh "$@"
exit 1 exit 0
} }
function queryFunc { setupLCDFunction() {
/opt/pihole/setupLCD.sh
exit 0
}
queryFunc() {
domain=$2 domain=$2
for list in /etc/pihole/list.* for list in /etc/pihole/list.*
do do
@ -137,27 +139,27 @@ function queryFunc {
fi fi
echo "" echo ""
done done
exit 1 exit 0
} }
function chronometerFunc { chronometerFunc() {
shift shift
${SUDO} /opt/pihole/chronometer.sh "$@" /opt/pihole/chronometer.sh "$@"
exit 1 exit 0
} }
function uninstallFunc { uninstallFunc() {
${SUDO} /opt/pihole/uninstall.sh /opt/pihole/uninstall.sh
exit 1 exit 0
} }
function versionFunc { versionFunc() {
${SUDO} /opt/pihole/version.sh /opt/pihole/version.sh
exit 1 exit 0
} }
function helpFunc { helpFunc() {
echo "::: Control all PiHole specific functions!" echo "::: Control all PiHole specific functions!"
echo ":::" echo ":::"
echo "::: Usage: pihole [options]" echo "::: Usage: pihole [options]"
@ -176,7 +178,7 @@ function helpFunc {
echo "::: -v, version Show current versions" echo "::: -v, version Show current versions"
echo "::: -q, query Query the adlists for a specific domain" echo "::: -q, query Query the adlists for a specific domain"
echo "::: uninstall Uninstall Pi-Hole from your system :(!" echo "::: uninstall Uninstall Pi-Hole from your system :(!"
exit 1 exit 0
} }
if [[ $# = 0 ]]; then if [[ $# = 0 ]]; then
@ -190,6 +192,7 @@ case "$1" in
"-d" | "debug" ) debugFunc;; "-d" | "debug" ) debugFunc;;
"-f" | "flush" ) flushFunc;; "-f" | "flush" ) flushFunc;;
"-up" | "updatePihole" ) updatePiholeFunc;; "-up" | "updatePihole" ) updatePiholeFunc;;
"-r" | "reconfigure" ) reconfigurePiholeFunc;;
"-g" | "updateGravity" ) updateGravityFunc "$@";; "-g" | "updateGravity" ) updateGravityFunc "$@";;
"-s" | "setupLCD" ) setupLCDFunction;; "-s" | "setupLCD" ) setupLCDFunction;;
"-c" | "chronometer" ) chronometerFunc "$@";; "-c" | "chronometer" ) chronometerFunc "$@";;