Merge pull request #1041 from pi-hole/development

[RELEASE] Pi-Hole Core 2.10.2

.gitattributes

@@ -0,0 +1,38 @@
+# FROM https://github.com/libgit2/libgit2sharp
+# Text files that should be normalized to LF in odb.
+*.cs     text diff=csharp
+*.config text
+
+*.sln     text
+*.csproj  text
+
+*.md       text
+*.sh       text
+*.ps1      text
+*.cmd      text
+*.bat      text
+*.markdown text
+*.msbuild  text
+
+Lib/*  binary
+GitHub.Tests.Integration/Resources/*  binary
+
+
+# Binary files that should not be normalized or diffed
+*.png    binary
+*.jpg    binary
+*.gif    binary
+
+*.pfx    binary
+*.snk    binary
+*.dll    binary
+*.exe    binary
+*.lib    binary
+*.exp    binary
+*.pdb    binary
+*.sdf    binary
+*.7z     binary
+
+
+# Catch all for anything we forgot. Add rules if you get CRLF -> LF warnings.
+* text=auto

.github/ISSUE_TEMPLATE.md

@@ -1,28 +1,17 @@
-_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
+**In raising this issue, I confirm the following (please check boxes, eg [X]) Failure to fill the template will close your issue:**
 
-**In raising this issue, I confirm the following (please check boxes, eg [X]):**
+- [] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md).
-
+- [] The issue I am reporting can be *replicated*
-- [ ] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md).
+- [] The issue I'm reporting isn't a duplicate (see [FAQs](https://github.com/pi-hole/pi-hole/wiki/FAQs), [closed issues](https://github.com/pi-hole/pi-hole/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), and [open issues](https://github.com/pi-hole/pi-hole/issues)).
-- [ ] The issue I am reporting can be *replicated*
-- [ ] The issue I'm reporting isn't a duplicate (see [FAQs](https://github.com/pi-hole/pi-hole/wiki/FAQs), [closed issues](https://github.com/pi-hole/pi-hole/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), and [open issues](https://github.com/pi-hole/pi-hole/issues)).
 
 **How familiar are you with the codebase?:**
 
-- [ ] 1 (very unfamiliar)
+_{replace this text with a number from 1 to 10, with 1 being not familiar, and 10 being very familiar}_
-- [ ] 2
-- [ ] 3
-- [ ] 4
-- [ ] 5
-- [ ] 6
-- [ ] 7
-- [ ] 8
-- [ ] 9
-- [ ] 10 (very familiar)
 
 ---
 **[FEATURE REQUEST | QUESTION | OTHER]:**
 
-_{replace this section with your content or delete if not a FEATURE REQUEST/QUESTION/OTHER}_
+Please [submit your feature request here](https://discourse.pi-hole.net/c/feature-requests), so it is votable by the community.  It's also easier for us to track.
 
 **[BUG | ISSUE] Expected Behaviour:**
 
@@ -37,6 +26,8 @@ _{replace this section with your content or delete if not a FEATURE REQUEST/QUES
 -
 -
 
-**(Optional) Debug Log generated by `pihole -d`:**
+**(Optional) Debug token generated by `pihole -d`:**
 
-`http://termbin.com/<something>`
+`<token>`
+
+_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,25 +1,19 @@
-_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
+**By submitting this pull request, I confirm the following (please check boxes, eg [X]) _Failure to fill the template will close your PR_:**
 
-**By submitting this pull request, I confirm the following (please check boxes, eg [X]):**
+***Please submit all pull requests against the `development` branch. Failure to do so will delay or deny your request***
 
-- [ ] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md).
+- [] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md).
-- [ ] I have checked that [another pull request](https://github.com/pi-hole/pi-hole/pulls) for this purpose does not exist.
+- [] I have checked that [another pull request](https://github.com/pi-hole/pi-hole/pulls) for this purpose does not exist.
-- [ ] I have considered, and confirmed that this submission will be valuable to others.
+- [] I have considered, and confirmed that this submission will be valuable to others.
-- [ ] I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
+- [] I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
-- [ ] I give this submission freely, and claim no ownership to its content.
+- [] I give this submission freely, and claim no ownership to its content.
 
 **How familiar are you with the codebase?:**
 
-- [ ] 1 (very unfamiliar)
+_{replace this text with a number from 1 to 10, with 1 being not familiar, and 10 being very familiar}_
-- [ ] 2
-- [ ] 3
-- [ ] 4
-- [ ] 5
-- [ ] 6
-- [ ] 7
-- [ ] 8
-- [ ] 9
-- [ ] 10 (very familiar)
 
 ---
 _{replace this line with your pull request content}_
+
+
+_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._

.gitignore

@@ -1 +1,7 @@
 .DS_Store
+*.pyc
+*.swp
+__pycache__
+.cache
+.pullapprove.yml
+

.idea/codeStyleSettings.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectCodeStyleSettingsManager">
+    <option name="PER_PROJECT_SETTINGS">
+      <value>
+        <option name="OTHER_INDENT_OPTIONS">
+          <value>
+            <option name="INDENT_SIZE" value="2" />
+            <option name="CONTINUATION_INDENT_SIZE" value="8" />
+            <option name="TAB_SIZE" value="2" />
+            <option name="USE_TAB_CHARACTER" value="false" />
+            <option name="SMART_TABS" value="false" />
+            <option name="LABEL_INDENT_SIZE" value="0" />
+            <option name="LABEL_INDENT_ABSOLUTE" value="false" />
+            <option name="USE_RELATIVE_INDENTS" value="false" />
+          </value>
+        </option>
+      </value>
+    </option>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </component>
+</project>

.pullapprove.yml

@@ -1,19 +1,38 @@
-approve_by_comment: true
+version: 2
-approve_regex: '^(Approved|:shipit:|:\+1:|Engage)'
+
-reject_regex: '^(Rejected|:-1:|Borg)'
-reset_on_push: true
-author_approval: required
-reviewers:
-  members:
-  - brantje
-  - dschaper
-  - jacobsalmela
-  - Mcat12
-  - PromoFaux
-  name: pullapprove
-  required: 3
 always_pending:
-  title_regex: '(WIP|wip)'
+  title_regex: '(WIP|wip)'  
   labels:
     - wip
   explanation: 'This PR is a work in progress...'
+
+group_defaults:
+  reset_on_push:
+    enabled: true
+  reject_value: -2
+  approve_regex: '^(Approved|:shipit:|:\+1:|Engage)'
+  reject_regex: '^(Rejected|:-1:|Borg)'
+  author_approval:
+    auto: true
+
+
+groups:
+  development:
+    approve_by_comment:
+      enabled: true
+    conditions:
+      branches:
+        - development        
+    required: 2
+    teams:
+      - approvers
+  
+  master:
+    approve_by_comment:
+      enabled: true
+    conditions:
+      branches:
+        - master
+    required: -1
+    teams:
+      - admin

.travis.yml

@@ -0,0 +1,10 @@
+sudo: required
+services:
+  - docker
+language: python
+python:
+  - "2.7"
+install:
+  - pip install -r requirements.txt
+
+script: py.test -vv

CONTRIBUTING.md

@@ -33,5 +33,6 @@ When requesting or submitting new features, first consider whether it might be u
 
 - Submit Pull Requests to the **development branch only**.
 - Before Submitting your Pull Request, merge `development` with your new branch and fix any conflicts. (Make sure you don't break anything in development!)
+- Please use the [Google Style Guide for Shell](https://google.github.io/styleguide/shell.xml) for your code submission styles. 
 - Commit Unix line endings.
 - (Optional fun) keep to the theme of Star Trek/black holes/gravity.

README.md

@@ -1,52 +1,80 @@
-[![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=3011939)](https://www.bountysource.com/trackers/3011939-pi-hole-pi-hole?utm_source=3011939&utm_medium=shield&utm_campaign=TRACKER_BADGE)   
+<p align="center">
+<a href=https://www.bountysource.com/trackers/3011939-pi-hole-pi-hole?utm_source=3011939&utm_medium=shield&utm_campaign=TRACKER_BADGE><img src="https://www.bountysource.com/badge/tracker?tracker_id=3011939"></a>
+<a href="https://www.codacy.com/app/Pi-hole/pi-hole?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=pi-hole/pi-hole&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/c558a0f8d7124c99b02b84f0f5564238"/></a>
+<a href=https://travis-ci.org/pi-hole/pi-hole><img src="https://travis-ci.org/pi-hole/pi-hole.svg?branch=development"></a>
+</p>
 
-# Automated Install
+<p align="center">
+<a href=https://discourse.pi-hole.net><img src="https://assets.pi-hole.net/static/Vortex_text.png" width=210></a>
+</p>
 
-Designed For Raspberry Pi A+, B, B+, 2, 3B, and Zero (with an Ethernet/Wi-Fi adapter)
+## The multi-platform, network-wide ad blocker
-Works on most Debian and CentOS/RHEL based distributions!
 
-1.  Install Raspbian
+Block ads for **all** your devices _without_ the need to install client-side software.  The Pi-hole blocks ads at the DNS-level, so all your devices are protected.
-2.  Run the command below (downloads [this script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) in case you want to read over it first!)
 
-## `curl -L https://install.pi-hole.net | bash`
+- Web Browsers
+- Cell Phones
+- Smart TV's
+- Internet-connected home automation
+- Anything that communicates with the Internet
 
-### Alternative Semi-Automated install
+<p align="center">
+<a href=http://www.digitalocean.com/?refcode=344d234950e1><img src="https://assets.pi-hole.net/static/DOHostingSlug.png"></a>
+</p>
+
+## Your Support Still Matters
+
+Digital Ocean helps with our infrastructure, but our developers are all volunteers so *your donations help keep us innovating*. Sending a donation using our links below helps us offset a portion of our monthly costs.
+
+-   ![Paypal](https://assets.pi-hole.net/static/paypal.png) [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
+-   ![Bitcoin](https://assets.pi-hole.net/static/Bitcoin.png) Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
+
+### One-Step Automated Install
+1.  Install a [supported operating system](https://discourse.pi-hole.net/t/hardware-software-requirements/273/1)
+2.  Run the command below (it downloads [this script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) in case you want to read over it first!)
+
+### `curl -sSL https://install.pi-hole.net | bash`
+
+#### Alternative Semi-Automated Install Methods
+_If you wish to read over the script before running it, run `nano basic-install.sh` to open the file in a text viewer._
+
+##### Clone our repository and run the automated installer from your device.
+
+```
+git clone --depth 1 https://github.com/pi-hole/pi-hole.git Pi-hole
+cd Pi-hole/automated_installer/
+bash basic-install.sh
+```
+
+##### Or
 
 ```bash
 wget -O basic-install.sh https://install.pi-hole.net
-chmod +x basic-install.sh
+bash basic-install.sh
-./basic-install.sh
 ```
 
-If you wish to read over the script before running it, then after the `wget` command, do `nano basic-install.sh` to open a text viewer
+Once installed, [configure your router to have **DHCP clients use the Pi as their DNS server**](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245) and then any device that connects to your network will have ads blocked without any further configuration. Alternatively, you can manually set each device to [use the Raspberry Pi as its DNS server](http://pi-hole.net/faq/how-do-i-use-the-pi-hole-as-my-dns-server/).
 
-Once installed, [configure your router to have **DHCP clients use the Pi as their DNS server**](http://pi-hole.net/faq/can-i-set-the-pi-hole-to-be-the-dns-server-at-my-router-so-i-dont-have-to-change-settings-for-my-devices/) and then any device that connects to your network will have ads blocked without any further configuration. Alternatively, you can manually set each device to [use the Raspberry Pi as its DNS server](http://pi-hole.net/faq/how-do-i-use-the-pi-hole-as-my-dns-server/).
+## Installing the Pi-hole (Click to Watch!)
+<p align="center">
+<a href=https://www.youtube.com/watch?v=TzFLJqUeirA><img src="https://assets.pi-hole.net/static/global.png"></a>
+</p>
 
-## How To Install Pi-hole
+## Would you like to know more?
-
-[![60-second install tutorial](http://i.imgur.com/5TEc3a6.png)](https://www.youtube.com/watch?v=TzFLJqUeirA)
-
-## How It Works
 
 **Watch the 60-second video below to get a quick overview**
-
+<p align="center">
-[![Pi-hole exlplained](http://i.imgur.com/pG1m937.png)](https://youtu.be/9Eti3xibiho)
+<a href=https://youtu.be/9Eti3xibiho><img src="https://assets.pi-hole.net/static/blackhole_web.png"></a>
-
+</p>
-## Pi-hole Is Free, But Powered By Your Donations
-
-Send a one-time donation or sign up for Optimal.com's service using our link below to provide us with a small portion of the monthly fee.
-
--   ![Paypal](http://i.imgur.com/3muNfxu.png) : [Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
--   ![Flattr](http://i.imgur.com/ZFceFRu.png) : [Donate](https://flattr.com/submit/auto?user_id=jacobsalmela&url=https://github.com/pi-hole/pi-hole)
--   ![Bitcoin](http://i.imgur.com/FIlmOMG.png) : 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
 
 ## Get Help Or Connect With Us On The Web
 
--   [@The_Pi_Hole](https://twitter.com/The_Pi_Hole)
+-   [Users Forum](https://discourse.pi-hole.net/)
--   [/r/pihole](https://www.reddit.com/r/pihole/)
+-   [FAQs](https://discourse.pi-hole.net/c/faqs)
--   [Pi-hole YouTube channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w)
+-   [Wiki](https://github.com/pi-hole/pi-hole/wiki)
--   [Wiki](https://github.com/pi-hole/pi-hole/wiki/Customization)
+-   ![Twitter](https://assets.pi-hole.net/static/twitter.png) [Tweet @The_Pi_Hole](https://twitter.com/The_Pi_Hole)
--   [FAQs](https://pi-hole.net/help/)
+-   ![Reddit](https://assets.pi-hole.net/static/reddit.png) [Reddit /r/pihole](https://www.reddit.com/r/pihole/)
+-   ![YouTube](https://assets.pi-hole.net/static/youtube.png)  [Pi-hole channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w)
 -   [![Join the chat at https://gitter.im/pi-hole/pi-hole](https://badges.gitter.im/pi-hole/pi-hole.svg)](https://gitter.im/pi-hole/pi-hole?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 ## Technical Details
@@ -55,25 +83,34 @@ The Pi-hole is an **advertising-aware DNS/Web server**. If an ad domain is queri
 
 ### Gravity
 
-The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/gravity.sh) does most of the magic. The script pulls in ad domains from many sources and compiles them into a single list of [over 1.6 million entries](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0) (if you decide to use the [mahakala list](https://github.com/pi-hole/pi-hole/commit/963eacfe0537a7abddf30441c754c67ca1e40965)).
+The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/gravity.sh) does most of the magic. The script pulls in ad domains from many sources and compiles them into a single list of [over 1.6 million entries](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0) (if you decide to use the [mahakala list](https://github.com/pi-hole/pi-hole/commit/963eacfe0537a7abddf30441c754c67ca1e40965)). This script is controlled by the `pihole` command. Please run `pihole -h` to see what commands can be run via `pihole`.
 
-## Web Interface
 
-The [Web interface](https://github.com/jacobsalmela/AdminLTE#pi-hole-admin-dashboard) will be installed automatically so you can view stats and change settings. You can find it at:
+
+#### Other Operating Systems
+
+The automated install is only for a clean install of a Debian family or Fedora based system, such as the Raspberry Pi. However, this script will work for most UNIX-like systems, some with some slight **modifications** that we can help you work through. If you can install `dnsmasq` and a Webserver, it should work OK. If there are other platforms you'd like supported, let us know.
+
+### Web Interface
+
+The [Web interface](https://github.com/pi-hole/AdminLTE#pi-hole-admin-dashboard) will be installed automatically so you can view stats and change settings. You can find it at:
 
 `http://192.168.1.x/admin/index.php` or `http://pi.hole/admin`
 
-![Pi-hole Advanced Stats Dashboard](http://i.imgur.com/gTq2GbS.png)
+![Pi-hole Advanced Stats Dashboard](https://assets.pi-hole.net/static/dashboard.png)
 
 ### Whitelist and blacklist
 
-Domains can be whitelisted and blacklisted using two pre-installed scripts. See [the wiki page](https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting) for more details ![Whitelist editor in the Web interface](http://i.imgur.com/ogu2ewg.png)
+Domains can be whitelisted and blacklisted using either the web interface or the command line. See [the wiki page](https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting) for more details 
+<p align="center">
+<a href=https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting><img src="https://assets.pi-hole.net/static/controlpanel.png"></a>
+</p>
 
 ## API
 
 A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON:
 
-```json
+``` json
 {
     "domains_being_blocked": "136708",
     "dns_queries_today": "18108",
@@ -103,6 +140,8 @@ You can view [real-time stats](http://pi-hole.net/faq/install-the-real-time-lcd-
 -   [Pi-hole on/off button](http://thetimmy.silvernight.org/pages/endisbutton/)
 -   [Minibian Pi-hole](http://munkjensen.net/wiki/index.php/See_my_Pi-Hole#Minibian_Pi-hole)
 -   [Windows Tray Stat Application](https://github.com/goldbattle/copernicus)
+-   [Let your blink1 device blink when Pi-hole filters ads](https://gist.github.com/elpatron68/ec0b4c582e5abf604885ac1e068d233f)
+-   [Pi-Hole Prometheus exporter](https://github.com/nlamirault/pihole_exporter) : a [Prometheus](https://prometheus.io/) exporter for Pi-Hole
 
 ## Coverage
 
@@ -119,7 +158,4 @@ You can view [real-time stats](http://pi-hole.net/faq/install-the-real-time-lcd-
 -   [Foolish Tech Show](https://youtu.be/bYyena0I9yc?t=2m4s)
 -   [Pi-hole on Ubuntu](http://www.boyter.org/2015/12/pi-hole-ubuntu-14-04/)
 -   [Catchpoint: iOS 9 Ad Blocking](http://blog.catchpoint.com/2015/09/14/ad-blocking-apple/)
-
+-   [Build an Ad-Blocker for less than 10$ with Orange-Pi](http://www.devacron.com/orangepi-zero-as-an-ad-block-server-with-pi-hole/)
-## Other Operating Systems
-
-This script will work for other UNIX-like systems with some slight **modifications**. As long as you can install `dnsmasq` and a Webserver, it should work OK. The automated install is only for a clean install of a Debian based system, such as the Raspberry Pi.

adlists.default

@@ -1,4 +1,4 @@
-## Pi-hole ad-list default sources. Updated 22/05/2016 #########################
+## Pi-hole ad-list default sources. Updated 29/10/2016 #########################
 #                                                                              #
 #  To make changes to this file:                                               #
 #    1. run `cp /etc/pihole/adlists.default /etc/pihole/adlists.list`          #
@@ -28,7 +28,7 @@ https://hosts-file.net/ad_servers.txt
 #http://adblock.mahakala.is/
 
 # ADZHOSTS list. Has been known to block legitimate domains
-#http://optimate.dl.sourceforge.net/project/adzhosts/HOSTS.txt
+#http://pilotfiber.dl.sourceforge.net/project/adzhosts/HOSTS.txt
 
 # Windows 10 telemetry list
 #https://raw.githubusercontent.com/crazy-max/WindowsSpyBlocker/master/data/hosts/win10/spy.txt
@@ -42,9 +42,6 @@ https://raw.githubusercontent.com/quidsup/notrack/master/trackers.txt
 # Block the BBC News website Breaking News banner
 #https://raw.githubusercontent.com/BreakingTheNews/BreakingTheNews.github.io/master/hosts
 
-# List of known C&C malware servers (see https://github.com/pi-hole/pi-hole/issues/528)
-https://ransomwaretracker.abuse.ch/downloads/RW_DOMBL.txt
-
 # Untested Lists:
 #https://raw.githubusercontent.com/reek/anti-adblock-killer/master/anti-adblock-killer-filters.txt
 #https://raw.githubusercontent.com/Dawsey21/Lists/master/main-blacklist.txt

advanced/01-pihole.conf

@@ -9,53 +9,36 @@
 # the Free Software Foundation, either version 2 of the License, or
 # (at your option) any later version.
 
-# If you want dnsmasq to read another file, as well as /etc/hosts, use
+###############################################################################
-# this.
+#      FILE AUTOMATICALLY POPULATED BY PI-HOLE INSTALL/UPDATE PROCEDURE.      #
+# ANY CHANGES MADE TO THIS FILE AFTER INSTALL WILL BE LOST ON THE NEXT UPDATE #
+#                                                                             #
+#        IF YOU WISH TO CHANGE THE UPSTREAM SERVERS, CHANGE THEM IN:          #
+#                      /etc/pihole/setupVars.conf                             #
+#                                                                             #
+#        ANY OTHER CHANGES SHOULD BE MADE IN A SEPERATE CONFIG FILE           #
+#                        OR IN /etc/dnsmasq.conf                              #
+###############################################################################
+
 addn-hosts=/etc/pihole/gravity.list
+addn-hosts=/etc/pihole/local.list
 
-# The following two options make you a better netizen, since they
-# tell dnsmasq to filter out queries which the public DNS cannot
-# answer, and which load the servers (especially the root servers)
-# unnecessarily. If you have a dial-on-demand link they also stop
-# these requests from bringing up the link unnecessarily.
-
-# Never forward plain names (without a dot or domain part)
 domain-needed
-# Never forward addresses in the non-routed address spaces.
+
 bogus-priv
 
-# If you don't want dnsmasq to read /etc/resolv.conf or any other
-# file, getting its servers from this file instead (see below), then
-# uncomment this.
 no-resolv
 
-# Add other name servers here, with domain specs if they are for
-# non-public domains.
 server=@DNS1@
 server=@DNS2@
 
-# If you want dnsmasq to listen for DHCP and DNS requests only on
-# specified interfaces (and the loopback) give the name of the
-# interface (eg eth0) here.
 interface=@INT@
-# Or which to listen on by address (remember to include 127.0.0.1 if
-# you use this.)
-listen-address=127.0.0.1
 
-# Set the cachesize here.
 cache-size=10000
 
-# For debugging purposes, log each DNS query as it passes through
-# dnsmasq.
 log-queries
 log-facility=/var/log/pihole.log
 
-# Normally responses which come from /etc/hosts and the DHCP lease
-# file have Time-To-Live set as zero, which conventionally means
-# do not cache further. If you are happy to trade lower load on the
-# server for potentially stale date, you can set a time-to-live (in
-# seconds) here.
 local-ttl=300
 
-# This allows it to continue functioning without being blocked by syslog, and allows syslog to use dnsmasq for DNS queries without risking deadlock
 log-async

advanced/Scripts/blacklist.sh

@@ -1,237 +0,0 @@
-#!/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
-# Blacklists domains
-#
-# 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.
-
-#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()
-{
-	echo "::: Immediately blacklists one or more domains in the hosts file"
-	echo ":::"
-	echo ":::"
-	echo "::: Usage: pihole -b domain1 [domain2 ...]"
-	echo "::: Options:"
-	echo ":::  -d, --delmode			Remove domains from the blacklist"
-	echo ":::  -nr, --noreload			Update blacklist without refreshing dnsmasq"
-	echo ":::  -f, --force				Force updating of the hosts files, even if there are no changes"
-	echo ":::  -q, --quiet				output is less verbose"
-	echo ":::  -h, --help				Show this help dialog"
-	echo ":::  -l, --list				Display your blacklisted domains"
-	exit 1
-}
-
-if [[ $# = 0 ]]; then
-	helpFunc
-fi
-
-#globals
-basename=pihole
-piholeDir=/etc/${basename}
-adList=${piholeDir}/gravity.list
-blacklist=${piholeDir}/blacklist.txt
-reload=true
-addmode=true
-force=false
-verbose=true
-
-domList=()
-domToRemoveList=()
-
-piholeIPfile=/etc/pihole/piholeIP
-piholeIPv6file=/etc/pihole/.useIPv6
-
-if [[ -f ${piholeIPfile} ]];then
-    # If the file exists, it means it was exported from the installation script and we should use that value instead of detecting it in this script
-    piholeIP=$(cat ${piholeIPfile})
-    #rm $piholeIPfile
-else
-    # Otherwise, the IP address can be taken directly from the machine, which will happen when the script is run by the user and not the installation script
-    IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
-    piholeIPCIDR=$(ip -o -f inet addr show dev "$IPv4dev" | awk '{print $4}' | awk 'END {print}')
-    piholeIP=${piholeIPCIDR%/*}
-fi
-
-modifyHost=false
-
-# After setting defaults, check if there's local overrides
-if [[ -r ${piholeDir}/pihole.conf ]];then
-    echo "::: Local calibration requested..."
-        . ${piholeDir}/pihole.conf
-fi
-
-
-if [[ -f ${piholeIPv6file} ]];then
-    # If the file exists, then the user previously chose to use IPv6 in the automated installer
-    piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
-fi
-
-function HandleOther(){
-  #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/')
-	if [ -z "$validDomain" ]; then
-		echo "::: $1 is not a valid argument or domain name"
-	else
-	  domList=("${domList[@]}" ${validDomain})
-	fi
-}
-
-function PopBlacklistFile(){
-	#check blacklist file exists, and if not, create it
-	if [[ ! -f ${blacklist} ]];then
-  	  touch ${blacklist}
-	fi
-	for dom in "${domList[@]}"; do
-	  if "$addmode"; then
-	  	AddDomain "$dom"
-	  else
-	    RemoveDomain "$dom"
-	  fi
-	done
-}
-
-function AddDomain(){
-#| sed 's/\./\\./g'
-	bool=false
-	grep -Ex -q "$1" ${blacklist} || bool=true
-	if ${bool}; then
-	  #domain not found in the blacklist file, add it!
-	  if ${verbose}; then
-	  echo -n "::: Adding $1 to blacklist file..."
-	  fi
-		echo "$1" >> ${blacklist}
-		modifyHost=true
-		echo " done!"
-	else
-	if ${verbose}; then
-		echo "::: $1 already exists in $blacklist! No need to add"
-		fi
-	fi
-}
-
-function RemoveDomain(){
-
-  bool=false
-  grep -Ex -q "$1" ${blacklist} || bool=true
-  if ${bool}; then
-  	#Domain is not in the blacklist file, no need to Remove
-  	if ${verbose}; then
-  	echo "::: $1 is NOT blacklisted! No need to remove"
-  	fi
-  else
-    #Domain is in the blacklist file, add to a temporary array
-    if ${verbose}; then
-    echo "::: Un-blacklisting $dom..."
-    fi
-    domToRemoveList=("${domToRemoveList[@]}" $1)
-    modifyHost=true
-  fi
-}
-
-function ModifyHostFile(){
-	 if ${addmode}; then
-	    #add domains to the hosts file
-	    if [[ -r ${blacklist} ]];then
-	      numberOf=$(cat ${blacklist} | sed '/^\s*$/d' | wc -l)
-        plural=; [[ "$numberOf" != "1" ]] && plural=s
-        echo ":::"
-        echo -n "::: Modifying HOSTS file to blacklist $numberOf domain${plural}..."
-	    	if [[ -n ${piholeIPv6} ]];then
-				cat ${blacklist} | awk -v ipv4addr="$piholeIP" -v ipv6addr="$piholeIPv6" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> ${adList}
-	      	else
-				cat ${blacklist} | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' >>${adList}
-	      	fi
-	  	fi
-	  else
-		echo ":::"
-	  	for dom in "${domToRemoveList[@]}"
-		do
-	      #we need to remove the domains from the blacklist file and the host file
-			echo "::: $dom"
-			echo -n ":::    removing from HOSTS file..."
-	      	echo "$dom" | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /[^.]'{}'(?!.)/;' ${adList}
-	      	echo " done!"
-	      	echo -n ":::    removing from blackist.txt..."
-	      	echo "$dom" | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /'{}'(?!.)/;' ${blacklist}
-	      	echo " done!"
-		done
-	fi
-}
-
-function Reload() {
-	# Reload hosts file
-	echo ":::"
-	echo -n "::: Refresh lists in dnsmasq..."
-
-	dnsmasqPid=$(pidof dnsmasq)
-
-	if [[ ${dnsmasqPid} ]]; then
-		# service already running - reload config
-		${SUDO} killall -s HUP dnsmasq
-	else
-		# service not running, start it up
-		${SUDO} service dnsmasq start
-	fi
-	echo " done!"
-}
-
-function DisplayBlist() {
-	verbose=false
-	echo -e " Displaying Gravity Affected Domains \n"
-	count=1
-	while IFS= read -r AD
-	do
-		echo "${count}: $AD"
-		count=$((count+1))
-	done < "$blacklist"
-}
-
-###################################################
-
-for var in "$@"
-do
-  case "$var" in
-    "-nr"| "--noreload"  ) reload=false;;
-    "-d" | "--delmode"   ) addmode=false;;
-    "-f" | "--force"     ) force=true;;
-    "-q" | "--quiet"     ) verbose=false;;
-    "-h" | "--help"	     ) helpFunc;;
-    "-l" | "--list"      ) DisplayBlist;;
-    *                    ) HandleOther "$var";;
-  esac
-done
-
-PopBlacklistFile
-
-if ${modifyHost} || ${force}; then
-	ModifyHostFile
-else
-  if ${verbose}; then
-		echo "::: No changes need to be made"
-	fi
-	exit 1
-fi
-
-if ${reload}; then
-	Reload
-fi

advanced/Scripts/chronometer.sh

@@ -15,17 +15,15 @@
 piLog="/var/log/pihole.log"
 gravity="/etc/pihole/gravity.list"
 
-today=$(date "+%b %e")
+. /etc/pihole/setupVars.conf
 
-function CalcBlockedDomains(){
+CalcBlockedDomains() {
-	CheckIPv6
+	if [ -e "${gravity}" ]; then
-	if [ -e "$gravity" ]; then
+		# if BOTH IPV4 and IPV6 are in use, then we need to divide total domains by 2.
-		#Are we IPV6 or IPV4?
+		if [[ -n "${IPV4_ADDRESS}" && -n "${IPV6_ADDRESS}" ]]; then
-		if [[ -n ${piholeIPv6} ]];then
-			#We are IPV6
 			blockedDomainsTotal=$(wc -l /etc/pihole/gravity.list | awk '{print $1/2}')
 		else
-			#We are IPV4
+			# only one is set.
 			blockedDomainsTotal=$(wc -l /etc/pihole/gravity.list | awk '{print $1}')
 		fi
 	else
@@ -33,43 +31,35 @@ function CalcBlockedDomains(){
 	fi
 }
 
-function CalcQueriesToday(){
+CalcQueriesToday() {
-	if [ -e "$piLog" ];then
+	if [ -e "${piLog}" ]; then
-		queriesToday=$(cat "$piLog" | grep "$today" | awk '/query/ {print $6}' | wc -l)
+		queriesToday=$(awk '/query\[/ {print $6}' < "${piLog}" | wc -l)
 	else
 		queriesToday="Err."
 	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=$(awk '/\/etc\/pihole\/gravity.list/ && !/address/ {print $6}' < "${piLog}" | wc -l)
 	else
 		blockedToday="Err."
 	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
-			percentBlockedToday=$(echo "scale=4; $blockedToday/$queriesToday*100" | bc)
+			percentBlockedToday=$(echo "scale=4; ${blockedToday}/${queriesToday}*100" | bc)
-			percentBlockedToday=$(sed 's/.\{2\}$//' <<< "$percentBlockedToday")
+			percentBlockedToday=$(sed 's/.\{2\}$//' <<< "${percentBlockedToday}")
 		else
 			percentBlockedToday=0
 		fi
 	fi
 }
 
-function CheckIPv6(){
+outputJSON() {
-	piholeIPv6file="/etc/pihole/.useIPv6"
-	if [[ -f ${piholeIPv6file} ]];then
-	    # If the file exists, then the user previously chose to use IPv6 in the automated installer
-	    piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
-	fi
-}
-
-function outputJSON(){
 	CalcQueriesToday
 	CalcblockedToday
 	CalcPercentBlockedToday
@@ -79,9 +69,8 @@ function outputJSON(){
 	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
 		# Displays a colorful Pi-hole logo
 		echo " ___ _     _        _"
@@ -89,7 +78,7 @@ function normalChrono(){
 		echo "|  _/ |___| ' \/ _ \ / -_)"
 		echo "|_| |_|   |_||_\___/_\___|"
 		echo ""
-		echo "        $(ifconfig eth0 | awk '/inet addr/ {print $2}' | cut -d':' -f2)"
+		echo "        ${IPV4_ADDRESS}"
 		echo ""
 		uptime | cut -d' ' -f11-
 		#uptime -p	#Doesn't work on all versions of uptime
@@ -111,38 +100,36 @@ function normalChrono(){
 
 		CalcBlockedDomains
 
-		echo "Blocking:      $blockedDomainsTotal"
+		echo "Blocking:      ${blockedDomainsTotal}"
-		#below commented line does not add up to todaysQueryCount
+		echo "Queries:       ${queriesToday}" #same total calculation as dashboard
-		#echo "Queries:       $todaysQueryCountV4 / $todaysQueryCountV6"
+		echo "Pi-holed:      ${blockedToday} (${percentBlockedToday}%)"
-		echo "Queries:       $queriesToday" #same total calculation as dashboard
-	  echo "Pi-holed:      $blockedToday ($percentBlockedToday%)"
 
 		sleep 5
 	done
 }
 
-function displayHelp(){
+displayHelp() {
- 	echo "::: Displays stats about your piHole!"
+	cat << EOM
-    echo ":::"
+::: Displays stats about your piHole!
-    echo "::: Usage: sudo pihole -c [optional:-j]"
+:::
-    echo "::: Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds"
+::: Usage: sudo pihole -c [optional:-j]
-    echo ":::"
+::: Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds
-    echo "::: Options:"
+:::
-    echo ":::  -j, --json		output stats as JSON formatted string"
+::: Options:
-    echo ":::  -h, --help		display this help text"
+:::  -j, --json		output stats as JSON formatted string
-
+:::  -h, --help		display this help text
-    exit 1
+EOM
+    exit 0
 }
 
 if [[ $# = 0 ]]; then
 	normalChrono
 fi
 
-for var in "$@"
+for var in "$@"; do
-do
+	case "$var" in
-  case "$var" in
+		"-j" | "--json"  ) outputJSON;;
-    "-j" | "--json"  ) outputJSON;;
+		"-h" | "--help"  ) displayHelp;;
-    "-h" | "--help"  ) displayHelp;;
+		*                ) exit 1;;
-    *                ) exit 1;;
+	esac
-  esac
 done

advanced/Scripts/list.sh

@@ -0,0 +1,177 @@
+#!/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
+# Whitelists and blacklists domains
+#
+# 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.
+
+#globals
+basename=pihole
+piholeDir=/etc/${basename}
+whitelist=${piholeDir}/whitelist.txt
+blacklist=${piholeDir}/blacklist.txt
+reload=false
+addmode=true
+verbose=true
+
+domList=()
+domToRemoveList=()
+
+listMain=""
+listAlt=""
+
+helpFunc() {
+
+    if [[ ${listMain} == ${whitelist} ]]; then
+        letter="w"
+        word="white"
+    else
+        letter="b"
+        word="black"
+    fi
+
+	cat << EOM
+::: Immediately ${word}lists one or more domains in the hosts file
+:::
+::: Usage: pihole -${letter} domain1 [domain2 ...]
+:::
+::: Options:
+:::  -d, --delmode			Remove domains from the ${word}list
+:::  -nr, --noreload		Update ${word}list without refreshing dnsmasq
+:::  -q, --quiet			output is less verbose
+:::  -h, --help				Show this help dialog
+:::  -l, --list				Display your ${word}listed domains
+EOM
+	exit 0
+}
+
+EscapeRegexp() {
+    # This way we may safely insert an arbitrary
+    # string in our regular expressions
+    echo $* | sed "s/[]\\.|$(){}?+*^]/\\\\&/g" | sed "s/\\//\\\\\//g"
+}
+
+HandleOther(){
+	# First, convert everything to lowercase
+	domain=$(sed -e "y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/" <<< "$1")
+
+	#check validity of domain
+	validDomain=$(perl -ne "print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/" <<< "$domain")
+	if [ -z "${validDomain}" ]; then
+		echo "::: $1 is not a valid argument or domain name"
+	else
+		domList=("${domList[@]}" ${validDomain})
+	fi
+}
+
+PoplistFile() {
+	#check whitelist file exists, and if not, create it
+	if [[ ! -f ${whitelist} ]]; then
+		touch ${whitelist}
+	fi
+	for dom in "${domList[@]}"; do
+	    # Logic : If addmode then add to desired list and remove from the other; if delmode then remove from desired list but do not add to the other
+		if ${addmode}; then
+			AddDomain "${dom}" "${listMain}"
+			RemoveDomain "${dom}" "${listAlt}"
+		else
+			RemoveDomain "${dom}" "${listMain}"
+		fi
+	done
+}
+
+AddDomain() {
+	list="$2"
+    domain=$(EscapeRegexp "$1")
+
+	bool=true
+	#Is the domain in the list we want to add it to?
+	grep -Ex -q "${domain}" ${list} > /dev/null 2>&1 || bool=false
+
+	if [[ "${bool}" == false ]]; then
+	  #domain not found in the whitelist file, add it!
+	  if [[ "${verbose}" == true ]]; then
+		echo "::: Adding $1 to $list..."
+	  fi
+	  reload=true
+	  # Add it to the list we want to add it to
+	  echo "$1" >> ${list}
+	else
+        if [[ "${verbose}" == true ]]; then
+            echo "::: ${1} already exists in ${list}, no need to add!"
+        fi
+	fi
+}
+
+RemoveDomain() {
+    list="$2"
+    domain=$(EscapeRegexp "$1")
+
+    bool=true
+    #Is it in the list? Logic follows that if its whitelisted it should not be blacklisted and vice versa
+    grep -Ex -q "${domain}" ${list} > /dev/null 2>&1 || bool=false
+    if [[ "${bool}" == true ]]; then
+        # Remove it from the other one
+        echo "::: Removing $1 from $list..."
+        # /I flag: search case-insensitive
+        sed -i "/${domain}/Id" ${list}
+        reload=true
+    else
+        if [[ "${verbose}" == true ]]; then
+            echo "::: ${1} does not exist in ${list}, no need to remove!"
+        fi
+    fi
+}
+
+Reload() {
+	# Reload hosts file
+	pihole -g -sd
+}
+
+Displaylist() {
+    if [[ ${listMain} == ${whitelist} ]]; then
+        string="gravity resistant domains"
+    else
+        string="domains caught in the sinkhole"
+    fi
+	verbose=false
+	echo -e " Displaying $string \n"
+	count=1
+	while IFS= read -r RD; do
+		echo "${count}: ${RD}"
+		count=$((count+1))
+	done < "${listMain}"
+	exit 0;
+}
+
+for var in "$@"; do
+	case "${var}" in
+	    "-w" | "whitelist"   ) listMain="${whitelist}"; listAlt="${blacklist}";;
+	    "-b" | "blacklist"   ) listMain="${blacklist}"; listAlt="${whitelist}";;
+		"-nr"| "--noreload"  ) reload=false;;
+		"-d" | "--delmode"   ) addmode=false;;
+		"-f" | "--force"     ) force=true;;
+		"-q" | "--quiet"     ) verbose=false;;
+		"-h" | "--help"      ) helpFunc;;
+		"-l" | "--list"      ) Displaylist;;
+		*                    ) HandleOther "${var}";;
+	esac
+done
+
+shift
+
+if [[ $# = 0 ]]; then
+	helpFunc
+fi
+
+PoplistFile
+
+if ${reload}; then
+	Reload
+fi
+

advanced/Scripts/piholeDebug.sh

@@ -13,452 +13,393 @@
 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
+TIMEOUT=60
 # Header info and introduction
-echo "::: Beginning Pi-hole debug at $(date)!"
+cat << EOM
-echo "::: This debugging process will collect information from your running configuration,"
+::: Beginning Pi-hole debug at $(date)!
-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"
+::: This process collects information from your Pi-hole, and optionally uploads
-echo "::: person who is given the unique URL. Please consider where you post this link."
+::: it to a unique and random directory on tricorder.pi-hole.net.
-echo "::: "
+:::
-
+::: 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
-######## FIRST CHECK ########
+::: secure your data and will work to further reduce any personal information gathered.
-# Must be root to debug
+:::
-if [[ "$EUID" -eq 0 ]]; then
+::: Please read and note any issues, and follow any directions advised during this process.
-	echo "::: Script is executing as root user..."
+EOM
-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
 
 # Ensure the file exists, create if not, clear if exists.
-if [ ! -f "$DEBUG_LOG" ]; then
+truncate --size=0 "${DEBUG_LOG}"
-	${SUDO} touch ${DEBUG_LOG}
+chmod 644 ${DEBUG_LOG}
-	${SUDO} chmod 644 ${DEBUG_LOG}
+chown "$USER":pihole ${DEBUG_LOG}
-	${SUDO} chown "$USER":root ${DEBUG_LOG}
+
-else 
+source ${VARSFILE}
-	truncate -s 0 ${DEBUG_LOG}
-fi
 
 ### Private functions exist here ###
-function log_write {
+log_write() {
-  echo "$1" >> "${DEBUG_LOG}"
+    echo "${1}" >> "${DEBUG_LOG}"
 }
 
-function version_check {
+log_echo() {
-  log_write "############################################################"
+  case ${1} in
-  log_write "##########           Installed Versions           ##########"
+    -n)
-  log_write "############################################################"
+      echo -n ":::       ${2}"
-
+      log_write "${2}"
-  echo "::: Detecting Pi-hole installed versions."
+      ;;
-  pi_hole_ver="$(cd /etc/.pihole/ && git describe --tags --abbrev=0)" \
+    -r)
-  && log_write "Pi-hole Version: $pi_hole_ver" || log_write "Pi-hole git repository not detected."
+      echo ":::       ${2}"
-  admin_ver="$(cd /var/www/html/admin && git describe --tags --abbrev=0)" \
+      log_write "${2}"
-  && log_write "WebUI Version: $admin_ver" || log_write "Pi-hole Admin Pages git repository not detected."
+      ;;
-
+    -l)
-  echo "::: Writing lighttpd version to logfile."
+      echo "${2}"
-  light_ver="$(lighttpd -v |& head -n1)" && log_write "${light_ver}" || log_write "lighttpd not installed."
+      log_write "${2}"
-
+      ;;
-  echo "::: Writing PHP version to logfile."
+     *)
-  php_ver="$(php -v |& head -n1)" && log_write "${php_ver}" || log_write "PHP not installed."
+      echo ":::  ${1}"
+      log_write "${1}"
+  esac
 }
 
-function distro_check {
+header_write() {
-	echo "############################################################" >> ${DEBUG_LOG}
+  log_echo ""
-	echo "########          Installed OS Distribution        #########" >> ${DEBUG_LOG}
+  log_echo "${1}"
-	echo "############################################################" >> ${DEBUG_LOG}
+  log_write ""
-
-	echo "::: Checking installed OS Distribution release."
-	TMP=$(cat /etc/*release || echo "Failed to find release")
-
-	echo "::: Writing OS Distribution release to logfile."
-	echo "$TMP" >> ${DEBUG_LOG}
-	echo >> ${DEBUG_LOG}
 }
 
-function ip_check {
+file_parse() {
-	echo "############################################################" >> ${DEBUG_LOG}
+    while read -r line; do
-	echo "########           IP Address Information          #########" >> ${DEBUG_LOG}
+		  if [ ! -z "${line}" ]; then
-	echo "############################################################" >> ${DEBUG_LOG}
+			  [[ "${line}" =~ ^#.*$  || ! "${line}" ]] && continue
+				log_write "${line}"
+			fi
+		done < "${1}"
+		log_write ""
+}
 
-    echo "::: Writing local IPs to logfile"
+block_parse() {
-    IPADDR="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet") print $(i+1) }')"
+  log_write "${1}"
-    echo "$IPADDR" >> ${DEBUG_LOG}
+}
 
-    IP6ADDR="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet6") print $(i+1) }')" \
+lsof_parse() {
-    && echo "$IP6ADDR" >> ${DEBUG_LOG} || echo "No IPv6 addresses found." >> ${DEBUG_LOG}
+  local user
-    echo >> ${DEBUG_LOG}
+  local process
 
-    echo "::: Locating default gateway and checking connectivity"
+  user=$(echo ${1} | cut -f 3 -d ' ' | cut -c 2-)
-    GATEWAY=$(ip r | grep default | cut -d ' ' -f 3)
+  process=$(echo ${1} | cut -f 2 -d ' ' | cut -c 2-)
-    if [[ $? = 0 ]]
+  [[ ${2} -eq ${process} ]] \
-    then
+  && echo ":::       Correctly configured." \
-    echo "::: Pinging default IPv4 gateway..."
+  || log_echo ":::       Failure: Incorrectly configured daemon."
-    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..."
+  log_write "Found user ${user} with process ${process}"
-    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..."
+version_check() {
-    GATEWAY6_CHECK=$(ping6 -q -w 3 -c 3 -n 2001:4860:4860::8888 | tail -n3)
+  header_write "Detecting Installed Package Versions:"
-        if [[ $? = 0 ]]
-        then
-        echo "IPv6 Internet check:" >> ${DEBUG_LOG}
-        else
-        echo "IPv6 Internet check failed:" >> ${DEBUG_LOG}
-        fi
 
+  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"
+}
+
+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}"
+}
+
+processor_check() {
+  header_write "Checking processor variety"
+  log_write $(uname -m) && return 0 || return 1
+}
+
+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
+}
+
+
+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
-    GATEWAY_CHECK="No IPv6 Gateway Detected"
+      log_echo="No IPv6 Gateway Detected"
     fi
-    echo "$GATEWAY_CHECK" >> ${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."
 
-    echo >> ${DEBUG_LOG}
+	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
 }
 
-function hostnameCheck {
+port_check() {
-    echo "############################################################" >> ${DEBUG_LOG}
+  local lsof_value
-	echo "########            Hostname Information           #########" >> ${DEBUG_LOG}
-	echo "############################################################" >> ${DEBUG_LOG}
 
-    echo "::: Writing locally configured hostnames to logfile"
+  lsof_value=$(lsof -i ${1}:${2} -FcL | tr '\n' ' ') \
-    # Write the hostname output to compare against entries in /etc/hosts, which is logged next
+  && lsof_parse "${lsof_value}" "${3}" \
-    echo "This Pi-hole is: $(hostname)" >> ${DEBUG_LOG}
+  || log_echo "Failure: IPv${1} Port not in use"
-
-    echo "::: Writing hosts file to debug log..."
-    echo "###              Hosts              ###" >> ${DEBUG_LOG}
-
-    if [ -e "$HOSTSFILE" ]
-    then
-	    cat "$HOSTSFILE" >> ${DEBUG_LOG}
-	    echo >> ${DEBUG_LOG}
-    else
-	    echo "No hosts file found!" >> ${DEBUG_LOG}
-	    printf ":::\tNo hosts file found!\n"
-    fi
 }
 
-function portCheck {
+daemon_check() {
-  echo "############################################################" >> ${DEBUG_LOG}
+  # Check for daemon ${1} on port ${2}
-	echo "########           Open Port Information           #########" >> ${DEBUG_LOG}
+	header_write "Daemon Process Information"
-	echo "############################################################" >> ${DEBUG_LOG}
 
-    echo "::: Detecting local server port 80 and 53 processes."
+	echo ":::     Checking ${2} port for ${1} listener."
 
-    ${SUDO} lsof -i :80 >> ${DEBUG_LOG}
+	if [[ ${IPV6_READY} ]]; then
-    ${SUDO} lsof -i :53 >> ${DEBUG_LOG}
+	  port_check 6 "${2}" "${1}"
-    echo >> ${DEBUG_LOG}
+  fi
+	lsof_value=$(lsof -i 4:${2} -FcL | tr '\n' ' ') \
+    port_check 4 "${2}" "${1}"
 }
 
-function testResolver {
+testResolver() {
-	echo "############################################################" >> ${DEBUG_LOG}
+	header_write "Resolver Functions Check"
-	echo "############      Resolver Functions Check      ############" >> ${DEBUG_LOG}
-	echo "############################################################" >> ${DEBUG_LOG}
-
 
 	# Find a blocked url that has not been whitelisted.
-    TESTURL="doubleclick.com"
+	TESTURL="doubleclick.com"
-	if [ -s "$WHITELISTMATCHES" ]; then
+	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
+					if [ "${CUTURL}" != "${CUTURL2}" ]; then
-						TESTURL="$CUTURL"
+						TESTURL="${CUTURL}"
 						break 2
 					fi
-				done < "$WHITELISTMATCHES"
+				done < "${WHITELISTMATCHES}"
 			fi
-		done < "$GRAVITYFILE"
+		done < "${GRAVITYFILE}"
 	fi
 
-	echo "Resolution of $TESTURL from Pi-hole:" >> ${DEBUG_LOG}
+	log_write "Resolution of ${TESTURL} from Pi-hole:"
-	LOCALDIG=$(dig "$TESTURL" @127.0.0.1)
+	LOCALDIG=$(dig "${TESTURL}" @127.0.0.1)
-	if [[ $? = 0 ]]
+	if [[ $? = 0 ]]; then
-	then
+		log_write "${LOCALDIG}"
-	    echo "$LOCALDIG" >> ${DEBUG_LOG}
 	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}
+	log_write "Resolution of ${TESTURL} from 8.8.8.8:"
-	REMOTEDIG=$(dig "$TESTURL" @8.8.8.8)
+	REMOTEDIG=$(dig "${TESTURL}" @8.8.8.8)
-	if [[ $? = 0 ]]
+	if [[ $? = 0 ]]; then
-	then
+		log_write "${REMOTEDIG}"
-	    echo "$REMOTEDIG" >> ${DEBUG_LOG}
 	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}
+	log_write ""
 
-	echo "Pi-hole dnsmasq specific records lookups" >> ${DEBUG_LOG}
+	log_write "Pi-hole dnsmasq specific records lookups"
-    echo "Cache Size:" >> ${DEBUG_LOG}
+	log_write "Cache Size:"
-    dig +short chaos txt cachesize.bind >> ${DEBUG_LOG}
+	dig +short chaos txt cachesize.bind >> ${DEBUG_LOG}
-    echo "Insertions count:" >> ${DEBUG_LOG}
+	log_write "Upstream Servers:"
-    dig +short chaos txt insertions.bind >> ${DEBUG_LOG}
+	dig +short chaos txt servers.bind >> ${DEBUG_LOG}
-    echo "Evictions count:" >> ${DEBUG_LOG}
+	log_write ""
-    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}
 }
 
-function checkProcesses {
+checkProcesses() {
-	echo "#######################################" >> ${DEBUG_LOG}
+	header_write "Processes Check"
-	echo "########### Processes Check ###########" >> ${DEBUG_LOG}
+
-	echo "#######################################" >> ${DEBUG_LOG}
+	echo ":::     Logging status of lighttpd and dnsmasq..."
-	echo ":::"
-	echo "::: Logging status of lighttpd and dnsmasq..."
 	PROCESSES=( lighttpd dnsmasq )
-	for i in "${PROCESSES[@]}"
+	for i in "${PROCESSES[@]}"; do
-	do
+		log_write ""
-		echo "" >> ${DEBUG_LOG}
+		log_write "${i}"
-		echo -n "$i" >> "$DEBUG_LOG"
+		log_write " processes status:"
-		echo " processes status:" >> ${DEBUG_LOG}
+		systemctl -l status "${i}" >> "${DEBUG_LOG}"
-		${SUDO} systemctl -l status "$i" >> "$DEBUG_LOG"
 	done
-	echo >> ${DEBUG_LOG}
+	log_write ""
 }
 
-function debugLighttpd {
+debugLighttpd() {
-	echo "::: Writing lighttpd to debug log..."
+  echo ":::     Checking for necessary lighttpd files."
-	echo "#######################################" >> ${DEBUG_LOG}
+  files_check "${LIGHTTPDFILE}"
-	echo "############ lighttpd.conf ############" >> ${DEBUG_LOG}
+  files_check "${LIGHTTPDERRFILE}"
-	echo "#######################################" >> ${DEBUG_LOG}
+  echo ":::"
-	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}
 }
 
+countdown() {
+  tuvix=${TIMEOUT}
+  printf "::: Logging will automatically teminate in ${TIMEOUT} seconds\n"
+  while [ $tuvix -ge 1 ]
+  do
+    printf ":::\t${tuvix} seconds left. \r"
+    sleep 5
+    tuvix=$(( tuvix - 5 ))
+  done
+}
 ### END FUNCTIONS ###
 
-version_check
+# Gather version of required packages / repositories
-distro_check
+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..."
+files_check "${DNSMASQFILE}"
-echo "#######################################" >> ${DEBUG_LOG}
+files_check "${DNSMASQCONFFILE}"
-echo "############### Dnsmasq ###############" >> ${DEBUG_LOG}
+files_check "${WHITELISTFILE}"
-echo "#######################################" >> ${DEBUG_LOG}
+files_check "${BLACKLISTFILE}"
-if [ -e "$DNSMASQFILE" ]
+files_check "${ADLISTFILE}"
-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 ###
+header_write "Analyzing gravity.list"
-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
 
+	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 "::: "
-	echo "#######################################" >> ${DEBUG_LOG}
+	echo "::: --= User Action Required =--"
-	echo "############# pihole.log ##############" >> ${DEBUG_LOG}
+	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.)"
-	echo "#######################################" >> ${DEBUG_LOG}
+	header_write "pihole.log"
-	if [ -e "$PIHOLELOG" ]
+	if [ -e "${PIHOLELOG}" ]; then
-	then
+	# Dummy process to use for flagging down tail to terminate
-		while true; do
+	  countdown &
-			tail -f "$PIHOLELOG" >> ${DEBUG_LOG}
+		tail -n0 -f --pid=$! "${PIHOLELOG}" >> ${DEBUG_LOG}
-			echo >> ${DEBUG_LOG}
-		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 {
+finalWork() {
-        echo "::: Finshed debugging!"
+  local tricorder
-    echo "::: The debug log can be uploaded to Termbin.com for easier sharing."
+	echo "::: Finshed debugging!"
-        read -r -p "::: Would you like to upload the log? [y/N] " response
+	echo "::: The debug log can be uploaded to tricorder.pi-hole.net for sharing with developers only."
-    case ${response} in
+	read -r -p "::: Would you like to upload the log? [y/N] " response
-        [yY][eE][sS]|[yY])
+	case ${response} in
-            TERMBIN=$(cat /var/log/pihole_debug.log | nc termbin.com 9999)
+		[yY][eE][sS]|[yY])
-            ;;
+			tricorder=$(cat /var/log/pihole_debug.log | nc tricorder.pi-hole.net 9999)
-        *)
+			;;
-            echo "::: Log will NOT be uploaded to Termbin."
+		*)
-            ;;
+			echo "::: Log will NOT be uploaded to tricorder."
-    esac
+			;;
+	esac
 
-        # Check if termbin.com is reachable. When it's not, point to local log instead
+	# Check if tricorder.pi-hole.net is reachable and provide token.
-        if [ -n "$TERMBIN" ]
+	if [ -n "${tricorder}" ]; then
-        then
+		echo "::: Your debug token is : ${tricorder}"
-                echo "::: Debug log can be found at : $TERMBIN"
+		echo "::: Please contact the Pi-hole team with your token for assistance."
-        else
+		echo "::: Thank you."
-                echo "::: Debug log can be found at : /var/log/pihole_debug.log"
+	else
-        fi
+		echo "::: There was an error uploading your debug log."
+		echo "::: Please try again or contact the Pi-hole team for assistance."
+	fi
+		echo "::: A local copy of the Debug log can be found at : /var/log/pihole_debug.log"
 }
 
 trap finalWork EXIT

advanced/Scripts/setupLCD.sh

@@ -11,47 +11,32 @@
 # (at your option) any later version.
 
 ############ 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
 # https://github.com/adafruit/Adafruit-PiTFT-Helper/blob/master/adafruit-pitft-helper#L324-L334
 getInitSys() {
-  if command -v systemctl > /dev/null && systemctl | grep -q '\-\.mount'; then
+	if command -v systemctl > /dev/null && systemctl | grep -q '\-\.mount'; then
-    SYSTEMD=1
+		SYSTEMD=1
-  elif [ -f /etc/init.d/cron ] && [ ! -h /etc/init.d/cron ]; then
+	elif [ -f /etc/init.d/cron ] && [ ! -h /etc/init.d/cron ]; then
-    SYSTEMD=0
+		SYSTEMD=0
-  else
+	else
-    echo "Unrecognised init system"
+		echo "Unrecognised init system"
-    return 1
+		return 1
-  fi
+	fi
 }
 
 # Borrowed from adafruit-pitft-helper:
 # https://github.com/adafruit/Adafruit-PiTFT-Helper/blob/master/adafruit-pitft-helper#L274-L285
 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
 }
 
 ######### SCRIPT ###########
@@ -66,23 +51,23 @@ echo /usr/local/bin/chronometer.sh >> /home/pi/.bashrc
 
 # Set up the LCD screen based on Adafruits instuctions:
 # 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
-${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
-${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
-${SUDO} setupcon
+setupcon
 
-${SUDO} reboot
+reboot
 
 # 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

advanced/Scripts/update.sh

@@ -0,0 +1,176 @@
+#!/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
+# Check Pi-hole core and admin pages versions and determine what
+# upgrade (if any) is required. Automatically updates and reinstalls
+# application if update is detected.
+#
+# 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.
+
+# Variables
+
+readonly ADMIN_INTERFACE_GIT_URL="https://github.com/pi-hole/AdminLTE.git"
+readonly ADMIN_INTERFACE_DIR="/var/www/html/admin"
+readonly PI_HOLE_GIT_URL="https://github.com/pi-hole/pi-hole.git"
+readonly PI_HOLE_FILES_DIR="/etc/.pihole"
+
+is_repo() {
+  # Use git to check if directory is currently under VCS, return the value
+  local directory="${1}"
+  local curdir
+  local rc
+
+  curdir="${PWD}"
+  cd "${directory}" &> /dev/null || return 1
+  git status --short &> /dev/null
+  rc=$?
+  cd "${curdir}" &> /dev/null || return 1
+  return $rc
+}
+
+prep_repo() {
+  # Prepare directory for local repository building
+  local directory="${1}"
+
+  rm -rf "${directory}" &> /dev/null
+  return
+}
+
+make_repo() {
+  # Remove the non-repod interface and clone the interface
+  local remoteRepo="${2}"
+  local directory="${1}"
+
+  (prep_repo "${directory}" && git clone -q --depth 1 "${remoteRepo}" "${directory}" > /dev/null)
+     return
+}
+
+update_repo() {
+  local directory="${1}"
+  local curdir
+  # Pull the latest commits
+
+  curdir="${PWD}"
+  cd "${directory}" &> /dev/null || return 1
+  # Stash all files not tracked for later retrieval
+  git stash --all --quiet &> /dev/null
+  # Force a clean working directory for cloning
+  git clean --force -d &> /dev/null
+  # Fetch latest changes and apply
+  git pull --quiet &> /dev/null
+  cd "${curdir}" &> /dev/null || return 1
+
+  return
+}
+
+getGitFiles() {
+  # Setup git repos for directory and repository passed
+  # as arguments 1 and 2
+  local directory="${1}"
+  local remoteRepo="${2}"
+  echo ":::"
+  echo "::: Checking for existing repository..."
+  if is_repo "${directory}"; then
+    echo -n ":::     Updating repository in ${directory}..."
+    update_repo "${directory}" || (echo "*** Error: Could not update local repository. Contact support."; exit 1)
+    echo " done!"
+  else
+    echo -n ":::    Cloning ${remoteRepo} into ${directory}..."
+    make_repo "${directory}" "${remoteRepo}" || (echo "Unable to clone repository, please contact support"; exit 1)
+    echo " done!"
+  fi
+}
+
+main() {
+  local pihole_version_current
+  local pihole_version_latest
+  local web_version_current
+  local web_version_latest
+
+  if ! is_repo "${PI_HOLE_FILES_DIR}" || ! is_repo "${ADMIN_INTERFACE_DIR}" ; then #This is unlikely
+    echo "::: Critical Error: One or more Pi-Hole repos are missing from system!"
+    echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
+    exit 1;
+  fi
+
+  echo "::: Checking for updates..."
+  # Checks Pi-hole version string in format vX.X.X
+  pihole_version_current="$(/usr/local/bin/pihole version --pihole --current)"
+  pihole_version_latest="$(/usr/local/bin/pihole version --pihole --latest)"
+  web_version_current="$(/usr/local/bin/pihole version --admin --current)"
+  web_version_latest="$(/usr/local/bin/pihole version --admin --latest)"
+
+  if [[ "${pihole_version_latest}" == "-1" || "${web_version_latest}" == "-1" ]]; then
+    echo "*** Unable to contact GitHub for latest version. Please try again later, contact support if this continues."
+    exit 1
+  fi
+
+  # Logic
+  # If latest versions are blank - we've probably hit Github rate limit (stop running `pihole -up so often!):
+  #            Update anyway
+  # If Core up to date AND web up to date:
+  #            Do nothing
+  # If Core up to date AND web NOT up to date:
+  #            Pull web repo
+  # If Core NOT up to date AND web up to date:
+  #            pull pihole repo, run install --unattended -- reconfigure
+  # if Core NOT up to date AND web NOT up to date:
+  #            pull pihole repo run install --unattended
+
+  if [[ "${pihole_version_current}" == "${pihole_version_latest}" ]] && [[ "${web_version_current}" == "${web_version_latest}" ]]; then
+    echo ":::"
+    echo "::: Pi-hole version is $pihole_version_current"
+    echo "::: Web Admin version is $web_version_current"
+    echo ":::"
+    echo "::: Everything is up to date!"
+    exit 0
+
+  elif [[ "${pihole_version_current}" == "${pihole_version_latest}" ]] && [[ "${web_version_current}" < "${web_version_latest}" ]]; then
+    echo ":::"
+    echo "::: Pi-hole Web Admin files out of date"
+    getGitFiles "${ADMIN_INTERFACE_DIR}" "${ADMIN_INTERFACE_GIT_URL}"
+
+    web_updated=true
+
+  elif [[ "${pihole_version_current}" < "${pihole_version_latest}" ]] && [[ "${web_version_current}" == "${web_version_latest}" ]]; then
+    echo "::: Pi-hole core files out of date"
+    getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
+    /etc/.pihole/automated\ install/basic-install.sh --reconfigure --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
+    core_updated=true
+
+  elif [[ "${pihole_version_current}" < "${pihole_version_latest}" ]] && [[ "${web_version_current}" < "${web_version_latest}" ]]; then
+    echo "::: Updating Everything"
+    getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
+    /etc/.pihole/automated\ install/basic-install.sh --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
+    web_updated=true
+    core_updated=true
+  else
+    echo "*** Update script has malfunctioned, fallthrough reached. Please contact support"
+    exit 1
+  fi
+
+  if [[ "${web_updated}" == true ]]; then
+    web_version_current="$(/usr/local/bin/pihole version --admin --current)"
+    echo ":::"
+    echo "::: Web Admin version is now at ${web_version_current}"
+    echo "::: If you had made any changes in '/var/www/html/admin/', they have been stashed using 'git stash'"
+  fi
+
+  if [[ "${core_updated}" == true ]]; then
+    pihole_version_current="$(/usr/local/bin/pihole version --pihole --current)"
+    echo ":::"
+    echo "::: Pi-hole version is now at ${pihole_version_current}"
+    echo "::: If you had made any changes in '/etc/.pihole/', they have been stashed using 'git stash'"
+  fi
+
+  echo ""
+  exit 0
+
+}
+
+main

advanced/Scripts/version.sh

@@ -3,18 +3,100 @@
 # (c) 2015, 2016 by Jacob Salmela
 # Network-wide ad blocking via your Raspberry Pi
 # http://pi-hole.net
-# Whitelists domains
+# shows version numbers
 #
 # 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.
 
-piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
+# Flags:
-webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
+latest=false
+current=false
 
-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/",$//')
+DEFAULT="-1"
-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)"
+normalOutput() {
-echo "::: Web-Admin version is $webVersion (Latest version is $webVersionLatest)"
+	piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
+	webVersion=$(cd /var/www/html/admin/ && 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/",$//')
+	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:-${DEFAULT}})"
+	echo "::: Web-Admin version is ${webVersion} (Latest version is ${webVersionLatest:-${DEFAULT}})"
+}
+
+webOutput() {
+	for var in "$@"; do
+		case "${var}" in
+			"-l" | "--latest"    ) latest=true;;
+			"-c" | "--current"   ) current=true;;
+			*                    ) echo "::: Invalid Option!"; exit 1;
+		esac
+	done
+
+	if [[ "${latest}" == true && "${current}" == false ]]; then
+		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 "${webVersionLatest:--1}"
+	elif [[ "${latest}" == false && "${current}" == true ]]; then
+		webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
+		echo "${webVersion}"
+	else
+		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 "::: Web-Admin version is ${webVersion} (Latest version is ${webVersionLatest:-${DEFAULT}})"
+	fi
+}
+
+coreOutput() {
+	for var in "$@"; do
+		case "${var}" in
+			"-l" | "--latest"    ) latest=true;;
+			"-c" | "--current"   ) current=true;;
+			*                    ) echo "::: Invalid Option!"; exit 1;
+		esac
+	done
+
+	if [[ "${latest}" == true && "${current}" == false ]]; then
+		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/",$//')
+		echo "${piholeVersionLatest:--1}"
+	elif [[ "${latest}" == false && "${current}" == true ]]; then
+		piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
+		echo "${piholeVersion}"
+	else
+		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/",$//')
+		echo "::: Pi-hole version is ${piholeVersion} (Latest version is ${piholeVersionLatest:-${DEFAULT}})"
+	fi
+}
+
+helpFunc() {
+	cat << EOM
+:::
+::: Show Pi-hole/Web Admin versions
+:::
+::: Usage: pihole -v [ -a | -p ] [ -l | -c ]
+:::
+::: Options:
+:::  -a, --admin          Show both current and latest versions of web admin
+:::  -p, --pihole         Show both current and latest versions of Pi-hole core files
+:::  -l, --latest         (Only after -a | -p) Return only latest version
+:::  -c, --current        (Only after -a | -p) Return only current version
+:::  -h, --help           Show this help dialog
+:::
+EOM
+	exit 0
+}
+
+if [[ $# = 0 ]]; then
+	normalOutput
+fi
+
+for var in "$@"; do
+	case "${var}" in
+	"-a" | "--admin"     ) shift; webOutput "$@";;
+	"-p" | "--pihole"    ) shift; coreOutput "$@" ;;
+	"-h" | "--help"      ) helpFunc;;
+	esac
+done

advanced/Scripts/webpage.sh

@@ -0,0 +1,258 @@
+#!/usr/bin/env bash
+# Pi-hole: A black hole for Internet advertisements
+# Network-wide ad blocking via your Raspberry Pi
+# http://pi-hole.net
+# Web interface settings
+#
+# 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.
+
+args=("$@")
+
+helpFunc() {
+	cat << EOM
+::: Set admin options for the web interface of pihole
+:::
+::: Usage: pihole -a [options]
+:::
+::: Options:
+:::  -p, password		Set web interface password, an empty input will remove any previously set password
+:::  -c, celsius		Set Celsius temperature unit
+:::  -f, fahrenheit		Set Fahrenheit temperature unit
+:::  -k, kelvin			Set Kelvin temperature unit
+:::  -h, --help			Show this help dialog
+EOM
+	exit 0
+}
+
+SetTemperatureUnit(){
+
+	# Remove setting from file (create backup setupVars.conf.bak)
+	sed -i.bak '/TEMPERATUREUNIT/d' /etc/pihole/setupVars.conf
+	# Save setting to file
+	echo "TEMPERATUREUNIT=${unit}" >> /etc/pihole/setupVars.conf
+
+}
+
+SetWebPassword(){
+
+	if [ "${SUDO_USER}" == "www-data" ]; then
+		echo "Security measure: user www-data is not allowed to change webUI password!"
+		echo "Exiting"
+		exit 1
+	fi
+
+	if [ "${SUDO_USER}" == "lighttpd" ]; then
+		echo "Security measure: user lighttpd is not allowed to change webUI password!"
+		echo "Exiting"
+		exit 1
+	fi
+
+	# Remove password from file (create backup setupVars.conf.bak)
+	sed -i.bak '/WEBPASSWORD/d' /etc/pihole/setupVars.conf
+	# Set password only if there is one to be set
+	if (( ${#args[2]} > 0 )) ; then
+		# Compute password hash twice to avoid rainbow table vulnerability
+		hash=$(echo -n ${args[2]} | sha256sum | sed 's/\s.*$//')
+		hash=$(echo -n ${hash} | sha256sum | sed 's/\s.*$//')
+		# Save hash to file
+		echo "WEBPASSWORD=${hash}" >> /etc/pihole/setupVars.conf
+		echo "New password set"
+	else
+		echo "WEBPASSWORD=" >> /etc/pihole/setupVars.conf
+		echo "Password removed"
+	fi
+
+}
+
+SetDNSServers(){
+
+	# Remove setting from file (create backup setupVars.conf.bak)
+	sed -i.bak '/PIHOLE_DNS_1/d;/PIHOLE_DNS_2/d;/DNS_FQDN_REQUIRED/d;/DNS_BOGUS_PRIV/d;' /etc/pihole/setupVars.conf
+	# Save setting to file
+	echo "PIHOLE_DNS_1=${args[2]}" >> /etc/pihole/setupVars.conf
+	if [[ "${args[3]}" != "none" ]]; then
+		echo "PIHOLE_DNS_2=${args[3]}" >> /etc/pihole/setupVars.conf
+	else
+		echo "PIHOLE_DNS_2=" >> /etc/pihole/setupVars.conf
+	fi
+
+	# Replace within actual dnsmasq config file
+	sed -i '/server=/d;' /etc/dnsmasq.d/01-pihole.conf
+	echo "server=${args[2]}" >> /etc/dnsmasq.d/01-pihole.conf
+	if [[ "${args[3]}" != "none" ]]; then
+		echo "server=${args[3]}" >> /etc/dnsmasq.d/01-pihole.conf
+	fi
+
+	# Remove domain-needed entry
+	sed -i '/domain-needed/d;' /etc/dnsmasq.d/01-pihole.conf
+
+	# Readd it if required
+	if [[ "${args[4]}" == "domain-needed" ]]; then
+		echo "domain-needed" >> /etc/dnsmasq.d/01-pihole.conf
+		echo "DNS_FQDN_REQUIRED=true" >> /etc/pihole/setupVars.conf
+	else
+		# Leave it deleted if not wanted
+		echo "DNS_FQDN_REQUIRED=false" >> /etc/pihole/setupVars.conf
+	fi
+
+	# Remove bogus-priv entry
+	sed -i '/bogus-priv/d;' /etc/dnsmasq.d/01-pihole.conf
+
+	# Readd it if required
+	if [[ "${args[5]}" == "bogus-priv" ]]; then
+		echo "bogus-priv" >> /etc/dnsmasq.d/01-pihole.conf
+		echo "DNS_BOGUS_PRIV=true" >> /etc/pihole/setupVars.conf
+	else
+		# Leave it deleted if not wanted
+		echo "DNS_BOGUS_PRIV=false" >> /etc/pihole/setupVars.conf
+	fi
+
+	# Restart dnsmasq to load new configuration
+	RestartDNS
+
+}
+
+SetExcludeDomains(){
+
+	# Remove setting from file (create backup setupVars.conf.bak)
+	sed -i.bak '/API_EXCLUDE_DOMAINS/d;' /etc/pihole/setupVars.conf
+	# Save setting to file
+	echo "API_EXCLUDE_DOMAINS=${args[2]}" >> /etc/pihole/setupVars.conf
+}
+
+SetExcludeClients(){
+
+	# Remove setting from file (create backup setupVars.conf.bak)
+	sed -i.bak '/API_EXCLUDE_CLIENTS/d;' /etc/pihole/setupVars.conf
+	# Save setting to file
+	echo "API_EXCLUDE_CLIENTS=${args[2]}" >> /etc/pihole/setupVars.conf
+}
+
+Reboot(){
+
+	nohup bash -c "sleep 5; reboot" &> /dev/null </dev/null &
+
+}
+
+RestartDNS(){
+
+	if [ -x "$(command -v systemctl)" ]; then
+		systemctl restart dnsmasq &> /dev/null
+	else
+		service dnsmasq restart &> /dev/null
+	fi
+
+}
+
+SetQueryLogOptions(){
+
+	# Remove setting from file (create backup setupVars.conf.bak)
+	sed -i.bak '/API_QUERY_LOG_SHOW/d;' /etc/pihole/setupVars.conf
+	# Save setting to file
+	echo "API_QUERY_LOG_SHOW=${args[2]}" >> /etc/pihole/setupVars.conf
+}
+
+EnableDHCP(){
+
+	# Remove setting from file (create backup setupVars.conf.bak)
+	sed -i.bak '/DHCP_/d;' /etc/pihole/setupVars.conf
+	echo "DHCP_ACTIVE=true" >> /etc/pihole/setupVars.conf
+	echo "DHCP_START=${args[2]}" >> /etc/pihole/setupVars.conf
+	echo "DHCP_END=${args[3]}" >> /etc/pihole/setupVars.conf
+	echo "DHCP_ROUTER=${args[4]}" >> /etc/pihole/setupVars.conf
+
+	# Remove setting from file
+	sed -i '/dhcp-/d;/quiet-dhcp/d;' /etc/dnsmasq.d/01-pihole.conf
+	# Save setting to file
+	echo "dhcp-range=${args[2]},${args[3]},infinite" >> /etc/dnsmasq.d/01-pihole.conf
+	echo "dhcp-option=option:router,${args[4]}" >> /etc/dnsmasq.d/01-pihole.conf
+	# Changes the behaviour from strict RFC compliance so that DHCP requests on unknown leases from unknown hosts are not ignored. This allows new hosts to get a lease without a tedious timeout under all circumstances. It also allows dnsmasq to rebuild its lease database without each client needing to reacquire a lease, if the database is lost.
+	echo "dhcp-authoritative" >> /etc/dnsmasq.d/01-pihole.conf
+	# Use the specified file to store DHCP lease information
+	echo "dhcp-leasefile=/etc/pihole/dhcp.leases" >> /etc/dnsmasq.d/01-pihole.conf
+	# Suppress logging of the routine operation of these protocols. Errors and problems will still be logged, though.
+	echo "quiet-dhcp" >> /etc/dnsmasq.d/01-pihole.conf
+	echo "quiet-dhcp6" >> /etc/dnsmasq.d/01-pihole.conf
+
+	RestartDNS
+}
+
+DisableDHCP(){
+
+	# Remove setting from file (create backup setupVars.conf.bak)
+	sed -i.bak '/DHCP_ACTIVE/d;' /etc/pihole/setupVars.conf
+	echo "DHCP_ACTIVE=false" >> /etc/pihole/setupVars.conf
+
+	# Remove setting from file
+	sed -i '/dhcp-/d;/quiet-dhcp/d;' /etc/dnsmasq.d/01-pihole.conf
+
+	RestartDNS
+}
+
+SetWebUILayout(){
+
+	# Remove setting from file (create backup setupVars.conf.bak)
+	sed -i.bak '/WEBUIBOXEDLAYOUT/d;' /etc/pihole/setupVars.conf
+	echo "WEBUIBOXEDLAYOUT=${args[2]}" >> /etc/pihole/setupVars.conf
+
+}
+
+SetDNSDomainName(){
+
+	# Remove setting from file (create backup setupVars.conf.bak)
+	sed -i.bak '/PIHOLE_DOMAIN/d;' /etc/pihole/setupVars.conf
+	# Save setting to file
+	echo "PIHOLE_DOMAIN=${args[2]}" >> /etc/pihole/setupVars.conf
+
+	# Replace within actual dnsmasq config file
+	sed -i '/domain=/d;' /etc/dnsmasq.d/01-pihole.conf
+	echo "domain=${args[2]}" >> /etc/dnsmasq.d/01-pihole.conf
+
+	# Restart dnsmasq to load new configuration
+	RestartDNS
+
+}
+
+ResolutionSettings() {
+
+	typ=${args[2]}
+	state=${args[3]}
+
+	if [[ "${typ}" == "forward" ]]; then
+		sed -i.bak '/API_GET_UPSTREAM_DNS_HOSTNAME/d;' /etc/pihole/setupVars.conf
+		echo "API_GET_UPSTREAM_DNS_HOSTNAME=${state}" >> /etc/pihole/setupVars.conf
+	elif [[ "${typ}" == "clients" ]]; then
+		sed -i.bak '/API_GET_CLIENT_HOSTNAME/d;' /etc/pihole/setupVars.conf
+		echo "API_GET_CLIENT_HOSTNAME=${state}" >> /etc/pihole/setupVars.conf
+	fi
+}
+
+case "${args[1]}" in
+	"-p" | "password"   ) SetWebPassword;;
+	"-c" | "celsius"    ) unit="C"; SetTemperatureUnit;;
+	"-f" | "fahrenheit" ) unit="F"; SetTemperatureUnit;;
+	"-k" | "kelvin"     ) unit="K"; SetTemperatureUnit;;
+	"setdns"            ) SetDNSServers;;
+	"setexcludedomains" ) SetExcludeDomains;;
+	"setexcludeclients" ) SetExcludeClients;;
+	"reboot"            ) Reboot;;
+	"restartdns"        ) RestartDNS;;
+	"setquerylog"       ) SetQueryLogOptions;;
+	"enabledhcp"        ) EnableDHCP;;
+	"disabledhcp"       ) DisableDHCP;;
+	"layout"            ) SetWebUILayout;;
+	"-h" | "--help"     ) helpFunc;;
+	"domainname"        ) SetDNSDomainName;;
+	"resolve"           ) ResolutionSettings;;
+	*                   ) helpFunc;;
+esac
+
+shift
+
+if [[ $# = 0 ]]; then
+	helpFunc
+fi
+

advanced/Scripts/whitelist.sh

@@ -1,254 +0,0 @@
-#!/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
-# Whitelists domains
-#
-# 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.
-
-#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()
-{
-	echo "::: Immediately whitelists one or more domains in the hosts file"
-	echo ":::"
-	echo "::: Usage: pihole -w domain1 [domain2 ...]"
-	echo ":::"
-	echo "::: Options:"
-	echo ":::  -d, --delmode			Remove domains from the whitelist"
-	echo ":::  -nr, --noreload			Update Whitelist without refreshing dnsmasq"
-	echo ":::  -f, --force				Force updating of the hosts files, even if there are no changes"
-	echo ":::  -q, --quiet				output is less verbose"
-	echo ":::  -h, --help				Show this help dialog"
-	echo ":::  -l, --list				Display your whitelisted domains"
-	exit 1
-}
-
-if [[ $# = 0 ]]; then
-	helpFunc
-fi
-
-#globals
-basename=pihole
-piholeDir=/etc/${basename}
-adList=${piholeDir}/gravity.list
-whitelist=${piholeDir}/whitelist.txt
-reload=true
-addmode=true
-force=false
-verbose=true
-
-domList=()
-domToRemoveList=()
-
-piholeIPfile=/etc/pihole/piholeIP
-piholeIPv6file=/etc/pihole/.useIPv6
-
-if [[ -f ${piholeIPfile} ]];then
-    # If the file exists, it means it was exported from the installation script and we should use that value instead of detecting it in this script
-    piholeIP=$(cat ${piholeIPfile})
-    #rm $piholeIPfile
-else
-    # Otherwise, the IP address can be taken directly from the machine, which will happen when the script is run by the user and not the installation script
-    IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
-    piholeIPCIDR=$(ip -o -f inet addr show dev "$IPv4dev" | awk '{print $4}' | awk 'END {print}')
-    piholeIP=${piholeIPCIDR%/*}
-fi
-
-modifyHost=false
-
-# After setting defaults, check if there's local overrides
-if [[ -r ${piholeDir}/pihole.conf ]];then
-    echo "::: Local calibration requested..."
-        . ${piholeDir}/pihole.conf
-fi
-
-if [[ -f ${piholeIPv6file} ]];then
-    # If the file exists, then the user previously chose to use IPv6 in the automated installer
-    piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
-fi
-
-function HandleOther(){
-  #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/')
-	if [ -z "$validDomain" ]; then
-		echo "::: $1 is not a valid argument or domain name"
-	else
-	  domList=("${domList[@]}" ${validDomain})
-	fi
-}
-
-function PopWhitelistFile(){
-	#check whitelist file exists, and if not, create it
-	if [[ ! -f ${whitelist} ]];then
-  	  touch ${whitelist}
-	fi
-	for dom in "${domList[@]}"
-	do
-	  if ${addmode}; then
-	  	AddDomain "$dom"
-	  else
-	    RemoveDomain "$dom"
-	  fi
-	done
-}
-
-function AddDomain(){
-#| sed 's/\./\\./g'
-	bool=false
-
-	grep -Ex -q "$1" ${whitelist} || bool=true
-	if ${bool}; then
-	  #domain not found in the whitelist file, add it!
-	  if ${verbose}; then
-		echo -n "::: Adding $1 to $whitelist..."
-	  fi
-	  echo "$1" >> ${whitelist}
-		modifyHost=true
-		if ${verbose}; then
-	  	echo " done!"
-	  fi
-	else
-		if ${verbose}; then
-			echo "::: $1 already exists in $whitelist, no need to add!"
-		fi
-	fi
-}
-
-function RemoveDomain(){
-
-  bool=false
-  grep -Ex -q "$1" ${whitelist} || bool=true
-  if ${bool}; then
-  	#Domain is not in the whitelist file, no need to Remove
-  	if ${verbose}; then
-  	echo "::: $1 is NOT whitelisted! No need to remove"
-  	fi
-  else
-    #Domain is in the whitelist file, add to a temporary array and remove from whitelist file
-    #if $verbose; then
-    #echo "::: Un-whitelisting $dom..."
-    #fi
-    domToRemoveList=("${domToRemoveList[@]}" $1)
-    modifyHost=true
-  fi
-}
-
-function ModifyHostFile(){
-	 if ${addmode}; then
-	    #remove domains in  from hosts file
-	    if [[ -r ${whitelist} ]];then
-        # Remove whitelist entries
-				numberOf=$(cat ${whitelist} | sed '/^\s*$/d' | wc -l)
-        plural=; [[ "$numberOf" != "1" ]] && plural=s
-        echo ":::"
-        echo -n "::: Modifying HOSTS file to whitelist $numberOf domain${plural}..."
-        awk -F':' '{print $1}' ${whitelist} | while read -r line; do echo "$piholeIP $line"; done > /etc/pihole/whitelist.tmp
-        awk -F':' '{print $1}' ${whitelist} | while read -r line; do echo "$piholeIPv6 $line"; done >> /etc/pihole/whitelist.tmp
-        echo "l" >> /etc/pihole/whitelist.tmp
-        grep -F -x -v -f ${piholeDir}/whitelist.tmp ${adList} > ${piholeDir}/gravity.tmp
-        rm ${adList}
-        mv ${piholeDir}/gravity.tmp ${adList}
-        rm ${piholeDir}/whitelist.tmp
-        echo " done!"
-
-	  	fi
-	  else
-	    #we need to add the removed domains to the hosts file
-	    echo ":::"
-	    echo "::: Modifying HOSTS file to un-whitelist domains..."
-	    for rdom in "${domToRemoveList[@]}"
-        do
-          if grep -q "$rdom" /etc/pihole/*.domains; then
-            echo ":::    AdLists contain $rdom, re-adding block"
-            if [[ -n ${piholeIPv6} ]];then
-              echo -n ":::        Restoring block for $rdom on IPv4 and IPv6..."
-              echo "$rdom" | awk -v ipv4addr="$piholeIP" -v ipv6addr="$piholeIPv6" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> ${adList}
-              echo " done!"
-            else
-              echo -n ":::        Restoring block for $rdom on IPv4..."
-              echo "$rdom" | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' >>${adList}
-              echo " done!"
-            fi
-          fi
-          echo -n ":::    Removing $rdom from $whitelist..."
-          echo "$rdom" | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /'{}'(?!.)/;' ${whitelist}
-          echo " done!"
-        done
-	  fi
-}
-
-function Reload() {
-	# Reload hosts file
-	echo ":::"
-	echo -n "::: Refresh lists in dnsmasq..."
-	dnsmasqPid=$(pidof dnsmasq)
-
-	if [[ ${dnsmasqPid} ]]; then
-		# service already running - reload config
-		${SUDO} killall -s HUP dnsmasq
-	else
-		# service not running, start it up
-		${SUDO} service dnsmasq start
-	fi
-	echo " done!"
-}
-
-function DisplayWlist() {
-	verbose=false
-	echo -e " Displaying Gravity Resistant Domains \n"
-	count=1
-	while IFS= read -r RD
-	do
-		echo "${count}: $RD"
-		count=$((count+1))
-	done < "$whitelist"
-}
-
-###################################################
-
-for var in "$@"
-do
-  case "$var" in
-    "-nr"| "--noreload"  ) reload=false;;
-    "-d" | "--delmode"   ) addmode=false;;
-    "-f" | "--force"     ) force=true;;
-    "-q" | "--quiet"     ) verbose=false;;
-    "-h" | "--help"      ) helpFunc;;
-    "-l" | "--list"      ) DisplayWlist;;
-    *                    ) HandleOther "$var";;
-  esac
-done
-
-PopWhitelistFile
-
-if ${modifyHost} || ${force}; then
-	 ModifyHostFile
-else
-  if ${verbose}; then
-	  echo ":::"
-		echo "::: No changes need to be made"
-	fi
-	exit 1
-fi
-
-if ${reload}; then
-	Reload
-fi

advanced/bash-completion/pihole

@@ -1,12 +1,11 @@
-_pihole() 
+_pihole() {
-{
+	local cur prev opts
-    local cur prev opts
+	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="admin blacklist chronometer debug disable enable flush help logging query reconfigure restartdns setupLCD status tail uninstall updateGravity updatePihole version whitelist"
-    opts="blacklist chronometer debug flush help query setupLCD uninstall updateDashboard updateGravity updatePihole version whitelist"
 
-    COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+	COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
-    return 0
+	return 0
 }
-complete -F _pihole pihole
+complete -F _pihole pihole

advanced/lighttpd.conf.debian

@@ -12,6 +12,7 @@
 server.modules = (
 	"mod_access",
 	"mod_accesslog",
+	"mod_auth",
 	"mod_expire",
 	"mod_compress",
 	"mod_redirect",
@@ -52,10 +53,14 @@ $HTTP["url"] =~ "^/admin/" {
     )
 }
 
+# Rewite js requests, must be out of $HTTP block due to bug #2526
+url.rewrite = ( "^(?!/admin/).*\.js$"  => "pihole/index.js"   )
+
 # If the URL does not start with /admin, then it is a query for an ad domain
 $HTTP["url"] =~ "^(?!/admin)/.*" {
     # Create a response header for debugging using curl -I
     setenv.add-response-header = ( "X-Pi-hole" => "A black hole for Internet advertisements." )
-    # rewrite only js requests
-    url.rewrite = ("(.*).js" => "pihole/index.js")
 }
+
+# Add user chosen options held in external file
+include_shell "cat external.conf 2>/dev/null"

advanced/lighttpd.conf.fedora

@@ -11,6 +11,7 @@
 
 server.modules = (
 	"mod_access",
+	"mod_auth",
 	"mod_fastcgi",
 	"mod_accesslog",
 	"mod_expire",
@@ -46,7 +47,8 @@ mimetype.assign   = ( ".png"  => "image/png",
                       ".css" => "text/css; charset=utf-8",
                       ".js" => "application/javascript",
                       ".json" => "application/json",
-                      ".txt"  => "text/plain" )
+                      ".txt"  => "text/plain",
+                      ".svg"  => "image/svg+xml" )
 
 # default listening port for IPv6 falls back to the IPv4 port
 #include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
@@ -68,10 +70,14 @@ $HTTP["url"] =~ "^/admin/" {
 	setenv.add-response-header = ( "X-Pi-hole" => "The Pi-hole Web interface is working!" )
 }
 
+# Rewite js requests, must be out of $HTTP block due to bug #2526
+url.rewrite = ( "^(?!/admin/).*\.js$"  => "pihole/index.js"   )
+
 # If the URL does not start with /admin, then it is a query for an ad domain
 $HTTP["url"] =~ "^(?!/admin)/.*" {
 	# Create a response header for debugging using curl -I
 	setenv.add-response-header = ( "X-Pi-hole" => "A black hole for Internet advertisements." )
-        # rewrite only js requests
-        url.rewrite = ("(.*).js" => "pihole/index.js")
 }
+
+# Add user chosen options held in external file
+include_shell "cat external.conf 2>/dev/null"

advanced/pihole.cron

@@ -8,18 +8,19 @@
 # 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.
+#
+# This file is under source-control of the Pi-hole installation and update
+# scripts, any changes made to this file will be overwritten when the softare
+# is updated or re-installed. Please make any changes to the appropriate crontab
+# or other cron file snippets.
 
 # Pi-hole: Update the ad sources once a week on Sunday at 01:59
 #          Download any updates from the adlists
-59 1    * * 7   root    /usr/local/bin/pihole updateGravity
+59 1    * * 7   root    PATH="$PATH:/usr/local/bin/" pihole updateGravity
 
 # Pi-hole: Update Pi-hole! Uncomment to enable auto update
-#30 2    * * 7   root    /usr/local/bin/pihole updatePihole
+#30 2    * * 7   root    PATH="$PATH:/usr/local/bin/" pihole updatePihole
-
-# Pi-hole: Parse the log file before it is flushed and save the stats to a database
-#          This will be used for a historical view of your Pi-hole's performance
-#50 23  * * *   root    /usr/local/bin/dailyLog.sh # note: this is outdated
 
 # Pi-hole: Flush the log daily at 00:00 so it doesn't get out of control
 #          Stats will be viewable in the Web interface thanks to the cron job above
-00 00   * * *   root    /usr/local/bin/pihole flush
+00 00   * * *   root    PATH="$PATH:/usr/local/bin/" pihole flush

advanced/pihole.sudo

@@ -9,4 +9,3 @@
 # the Free Software Foundation, either version 2 of the License, or
 # (at your option) any later version.
 
-www-data ALL=NOPASSWD: /usr/local/bin/pihole

advanced/selinux/pihole.te

@@ -1,87 +0,0 @@
-module pihole 1.0;
-
-require {
-        type var_log_t;
-        type unconfined_t;
-        type init_t;
-        type auditd_t;
-        type syslogd_t;
-        type NetworkManager_t;
-        type mdadm_t;
-        type tuned_t;
-        type avahi_t;
-        type irqbalance_t;
-        type system_dbusd_t;
-        type kernel_t;
-        type httpd_sys_script_t;
-        type systemd_logind_t;
-        type httpd_t;
-        type policykit_t;
-        type dnsmasq_t;
-        type udev_t;
-        type postfix_pickup_t;
-        type sshd_t;
-        type crond_t;
-        type getty_t;
-        type lvm_t;
-        type postfix_qmgr_t;
-        type postfix_master_t;
-        class dir { getattr search };
-        class file { read open setattr };
-}
-
-#============= dnsmasq_t ==============
-allow dnsmasq_t var_log_t:file { open setattr };
-
-#============= httpd_t ==============
-allow httpd_t var_log_t:file { read open };
-
-#============= httpd_sys_script_t (class: dir) ==============
-allow httpd_sys_script_t NetworkManager_t:dir { getattr search };
-allow httpd_sys_script_t auditd_t:dir { getattr search };
-allow httpd_sys_script_t avahi_t:dir { getattr search };
-allow httpd_sys_script_t crond_t:dir { getattr search };
-allow httpd_sys_script_t dnsmasq_t:dir { getattr search };
-allow httpd_sys_script_t getty_t:dir { getattr search };
-allow httpd_sys_script_t httpd_t:dir { getattr search };
-allow httpd_sys_script_t init_t:dir { getattr search };
-allow httpd_sys_script_t irqbalance_t:dir { getattr search };
-allow httpd_sys_script_t kernel_t:dir { getattr search };
-allow httpd_sys_script_t lvm_t:dir { getattr search };
-allow httpd_sys_script_t mdadm_t:dir { getattr search };
-allow httpd_sys_script_t policykit_t:dir { getattr search };
-allow httpd_sys_script_t postfix_master_t:dir { getattr search };
-allow httpd_sys_script_t postfix_pickup_t:dir { getattr search };
-allow httpd_sys_script_t postfix_qmgr_t:dir { getattr search };
-allow httpd_sys_script_t sshd_t:dir { getattr search };
-allow httpd_sys_script_t syslogd_t:dir { getattr search };
-allow httpd_sys_script_t system_dbusd_t:dir { getattr search };
-allow httpd_sys_script_t systemd_logind_t:dir { getattr search };
-allow httpd_sys_script_t tuned_t:dir { getattr search };
-allow httpd_sys_script_t udev_t:dir { getattr search };
-allow httpd_sys_script_t unconfined_t:dir { getattr search };
-
-#============= httpd_sys_script_t (class: file) ==============
-allow httpd_sys_script_t NetworkManager_t:file { read open };
-allow httpd_sys_script_t auditd_t:file { read open };
-allow httpd_sys_script_t avahi_t:file { read open };
-allow httpd_sys_script_t crond_t:file { read open };
-allow httpd_sys_script_t dnsmasq_t:file { read open };
-allow httpd_sys_script_t getty_t:file { read open };
-allow httpd_sys_script_t httpd_t:file { read open };
-allow httpd_sys_script_t init_t:file { read open };
-allow httpd_sys_script_t irqbalance_t:file { read open };
-allow httpd_sys_script_t kernel_t:file { read open };
-allow httpd_sys_script_t lvm_t:file { read open };
-allow httpd_sys_script_t mdadm_t:file { read open };
-allow httpd_sys_script_t policykit_t:file { read open };
-allow httpd_sys_script_t postfix_master_t:file { read open };
-allow httpd_sys_script_t postfix_pickup_t:file { read open };
-allow httpd_sys_script_t postfix_qmgr_t:file { read open };
-allow httpd_sys_script_t sshd_t:file { read open };
-allow httpd_sys_script_t syslogd_t:file { read open };
-allow httpd_sys_script_t system_dbusd_t:file { read open };
-allow httpd_sys_script_t systemd_logind_t:file { read open };
-allow httpd_sys_script_t tuned_t:file { read open };
-allow httpd_sys_script_t udev_t:file { read open };
-allow httpd_sys_script_t unconfined_t:file { read open };

automated install/uninstall.sh

@@ -11,29 +11,29 @@
 # (at your option) any later version.
 
 # Must be root to uninstall
-if [[ $EUID -eq 0 ]];then
+if [[ ${EUID} -eq 0 ]]; then
 	echo "::: You are root."
 else
 	echo "::: Sudo will be used for the uninstall."
-  # Check if it is actually installed
+	# Check if it is actually installed
-  # If it isn't, exit because the unnstall cannot complete
+	# If it isn't, exit because the unnstall cannot complete
-  if [ -x "$(command -v sudo)" ];then
+	if [ -x "$(command -v sudo)" ]; then
 		export SUDO="sudo"
-  else
+	else
-    echo "::: Please install sudo or run this as root."
+		echo "::: Please install sudo or run this as root."
-    exit 1
+		exit 1
-  fi
+	fi
 fi
 
 # Compatability
-if [ -x "$(command -v rpm)" ];then
+if [ -x "$(command -v rpm)" ]; then
 	# Fedora Family
-	if [ -x "$(command -v dnf)" ];then
+	if [ -x "$(command -v dnf)" ]; then
 		PKG_MANAGER="dnf"
 	else
 		PKG_MANAGER="yum"
 	fi
-	PKG_REMOVE="$PKG_MANAGER remove -y"
+	PKG_REMOVE="${PKG_MANAGER} remove -y"
 	PIHOLE_DEPS=( bind-utils bc dnsmasq lighttpd lighttpd-fastcgi php-common git curl unzip wget findutils )
 	package_check() {
 		rpm -qa | grep ^$1- > /dev/null
@@ -41,10 +41,10 @@ if [ -x "$(command -v rpm)" ];then
 	package_cleanup() {
 		${SUDO} ${PKG_MANAGER} -y autoremove
 	}
-elif [ -x "$(command -v apt-get)" ];then
+elif [ -x "$(command -v apt-get)" ]; then
 	# Debian Family
 	PKG_MANAGER="apt-get"
-	PKG_REMOVE="$PKG_MANAGER -y remove --purge"
+	PKG_REMOVE="${PKG_MANAGER} -y remove --purge"
 	PIHOLE_DEPS=( dnsutils bc dnsmasq lighttpd php5-common git curl unzip wget )
 	package_check() {
 		dpkg-query -W -f='${Status}' "$1" 2>/dev/null | grep -c "ok installed"
@@ -58,37 +58,36 @@ else
 	exit
 fi
 
-spinner()
+spinner() {
-{
+	local pid=$1
-    local pid=$1
+	local delay=0.50
-    local delay=0.50
+	local spinstr='/-\|'
-    local spinstr='/-\|'
+	while [ "$(ps a | awk '{print $1}' | grep "${pid}")" ]; do
-    while [ "$(ps a | awk '{print $1}' | grep "$pid")" ]; do
+		local temp=${spinstr#?}
-        local temp=${spinstr#?}
+		printf " [%c]  " "${spinstr}"
-        printf " [%c]  " "$spinstr"
+		local spinstr=${temp}${spinstr%"$temp}"}
-        local spinstr=${temp}${spinstr%"$temp"}
+		sleep ${delay}
-        sleep ${delay}
+		printf "\b\b\b\b\b\b"
-        printf "\b\b\b\b\b\b"
+	done
-    done
+	printf "    \b\b\b\b"
-    printf "    \b\b\b\b"
 }
 
-function removeAndPurge {
+removeAndPurge() {
 	# Purge dependencies
-echo ":::"
+	echo ":::"
 	for i in "${PIHOLE_DEPS[@]}"; do
 		package_check ${i} > /dev/null
 		if [ $? -eq 0 ]; then
 			while true; do
-				read -rp "::: Do you wish to remove $i from your system? [y/n]: " yn
+				read -rp "::: Do you wish to remove ${i} from your system? [y/n]: " yn
 				case ${yn} in
-					[Yy]* ) printf ":::\tRemoving %s..." "$i"; ${SUDO} ${PKG_REMOVE} "$i" &> /dev/null & spinner $!; printf "done!\n"; break;;
+					[Yy]* ) printf ":::\tRemoving %s..." "${i}"; ${SUDO} ${PKG_REMOVE} "${i}" &> /dev/null & spinner $!; printf "done!\n"; break;;
-					[Nn]* ) printf ":::\tSkipping %s" "$i\n"; break;;
+					[Nn]* ) printf ":::\tSkipping %s\n" "${i}"; break;;
 					* ) printf "::: You must answer yes or no!\n";;
 				esac
 			done
 		else
-			printf ":::\tPackage %s not installed... Not removing.\n" "$i"
+			printf ":::\tPackage %s not installed... Not removing.\n" "${i}"
 		fi
 	done
 
@@ -104,7 +103,7 @@ echo ":::"
 	removeNoPurge
 }
 
-function removeNoPurge {
+removeNoPurge() {
 	echo ":::"
 	# Only web directories/files that are created by pihole should be removed.
 	echo "::: Removing the Pi-hole Web server files..."
@@ -137,7 +136,7 @@ function removeNoPurge {
 	fi
 
 	echo "::: Removing config files and scripts..."
-	package_check ${i} > /dev/null
+	package_check lighttpd > /dev/null
 	if [ $? -eq 1 ]; then
 		${SUDO} rm -rf /etc/lighttpd/ &> /dev/null
 	else
@@ -155,6 +154,12 @@ function removeNoPurge {
 	${SUDO} rm /usr/local/bin/pihole &> /dev/null
 	${SUDO} rm /etc/bash_completion.d/pihole &> /dev/null
 	${SUDO} rm /etc/sudoers.d/pihole &> /dev/null
+	
+	# If the pihole user exists, then remove
+	if id "pihole" >/dev/null 2>&1; then
+        	echo "::: Removing pihole user..."
+		${SUDO} userdel -r pihole
+	fi
 
 	echo ":::"
 	printf "::: Finished removing PiHole from your system. Sorry to see you go!\n"

autotest

@@ -0,0 +1 @@
+py.test -v -f test/

gravity.sh

@@ -13,62 +13,62 @@
 # Run this script as root or under sudo
 echo ":::"
 
-if [[ $EUID -eq 0 ]];then
+helpFunc() {
-	echo "::: You are root."
+	cat << EOM
-else
+::: Pull in domains from adlists
-	echo "::: sudo will be used."
+:::
-	# Check if it is actually installed
+::: Usage: pihole -g
-	# If it isn't, exit because the install cannot complete
+:::
-	if [ -x "$(command -v sudo)" ];then
+::: Options:
-		export SUDO="sudo"
+:::  -f, --force			Force lists to be downloaded, even if they don't need updating.
-	else
+:::  -h, --help				Show this help dialog
-		echo "::: Please install sudo or run this script as root."
+EOM
-		exit 1
+	exit 0
-	fi
-fi
-
-function helpFunc()
-{
-	echo "::: Pull in domains from adlists"
-	echo ":::"
-	echo "::: Usage: pihole -g"
-	echo ":::"
-	echo "::: Options:"
-	echo ":::  -f, --force				Force lists to be downloaded, even if they don't need updating."
-	echo ":::  -h, --help				Show this help dialog"
-	exit 1
 }
 
 
 adListFile=/etc/pihole/adlists.list
 adListDefault=/etc/pihole/adlists.default
-whitelistScript=/opt/pihole/whitelist.sh
+whitelistScript="pihole -w"
-blacklistScript=/opt/pihole/blacklist.sh
+whitelistFile=/etc/pihole/whitelist.txt
+blacklistFile=/etc/pihole/blacklist.txt
 
 #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 'reconfigure' option to reconfigure."
+	exit 1
+fi
+
 #Remove the /* from the end of the IPv4addr.
-IPv4addr=${IPv4addr%/*}
+IPV4_ADDRESS=${IPV4_ADDRESS%/*}
+IPV6_ADDRESS=${IPV6_ADDRESS}
 
 # Variables for various stages of downloading and formatting the list
 basename=pihole
 piholeDir=/etc/${basename}
 adList=${piholeDir}/gravity.list
+localList=${piholeDir}/local.list
 justDomainsExtension=domains
 matterAndLight=${basename}.0.matterandlight.txt
 supernova=${basename}.1.supernova.txt
-eventHorizon=${basename}.2.eventHorizon.txt
+preEventHorizon=list.preEventHorizon
+eventHorizon=${basename}.2.supernova.txt
 accretionDisc=${basename}.3.accretionDisc.txt
 
-# After setting defaults, check if there's local overrides
+skipDownload=false
-if [[ -r ${piholeDir}/pihole.conf ]];then
+
-    echo "::: Local calibration requested..."
+# Warn users still using pihole.conf that it no longer has any effect (I imagine about 2 people use it)
-        . ${piholeDir}/pihole.conf
+if [[ -r ${piholeDir}/pihole.conf ]]; then
+	echo "::: pihole.conf file no longer supported. Over-rides in this file are ignored."
 fi
 
 ###########################
 # collapse - begin formation of pihole
-function gravity_collapse() {
+gravity_collapse() {
 	echo "::: Neutrino emissions detected..."
 	echo ":::"
 	#Decide if we're using a custom ad block list, or defaults.
@@ -99,40 +99,40 @@ function gravity_collapse() {
 		done < ${adListDefault}
 		echo " done!"
 	fi
-
-	# Create the pihole resource directory if it doesn't exist.  Future files will be stored here
-	if [[ -d ${piholeDir} ]];then
-        # Temporary hack to allow non-root access to pihole directory
-        # Will update later, needed for existing installs, new installs should
-        # create this directory as non-root
-        ${SUDO} chmod 777 ${piholeDir}
-        echo ":::"
-        echo "::: Existing pihole directory found"
-	else
-        echo "::: Creating pihole directory..."
-        mkdir ${piholeDir}
-        ${SUDO} chmod 777 ${piholeDir}
-	fi
 }
 
 # patternCheck - check to see if curl downloaded any new files.
-function gravity_patternCheck() {
+gravity_patternCheck() {
 	patternBuffer=$1
-	# check if the patternbuffer is a non-zero length file
+	success=$2
-	if [[ -s "$patternBuffer" ]];then
+	error=$3
-		# Some of the blocklists are copyright, they need to be downloaded
+	if [ $success = true ]; then
-		# and stored as is. They can be processed for content after they
+		# check if download was successful but list has not been modified
-		# have been saved.
+		if [ "${error}" == "304" ]; then
-		cp "$patternBuffer" "$saveLocation"
+			echo ":::   No changes detected, transport skipped!"
-		echo " List updated, transport successful!"
+		# check if the patternbuffer is a non-zero length file
+		elif [[ -s "${patternBuffer}" ]]; then
+			# Some of the blocklists are copyright, they need to be downloaded
+			# and stored as is. They can be processed for content after they
+			# have been saved.
+			mv "${patternBuffer}" "${saveLocation}"
+			echo ":::   List updated, transport successful!"
+		else
+			# Empty file -> use previously downloaded list
+			echo ":::   Received empty file, using cached one (list not updated!)"
+		fi
 	else
-		# curl didn't download any host files, probably because of the date check
+		# check if cached list exists
-		echo " No changes detected, transport skipped!"
+		if [[ -r "${saveLocation}" ]]; then
+			echo ":::   List download failed, using cached list (list not updated!)"
+		else
+			echo ":::   Download failed and no cached list available (list will not be considered)"
+		fi
 	fi
 }
 
 # transport - curl the specified url with any needed command extentions
-function gravity_transport() {
+gravity_transport() {
 	url=$1
 	cmd_ext=$2
 	agent=$3
@@ -142,110 +142,143 @@ function gravity_transport() {
 	heisenbergCompensator=""
 	if [[ -r ${saveLocation} ]]; then
 		# if domain has been saved, add file for date check to only download newer
-		heisenbergCompensator="-z $saveLocation"
+		heisenbergCompensator="-z ${saveLocation}"
 	fi
 
 	# Silently curl url
-	curl -s -L ${cmd_ext} ${heisenbergCompensator} -A "$agent" ${url} > ${patternBuffer}
+	err=$(curl -s -L ${cmd_ext} ${heisenbergCompensator} -w %{http_code} -A "${agent}" ${url} -o ${patternBuffer})
-	# Check for list updates
+
-	gravity_patternCheck "$patternBuffer"
+	echo " done"
-	# Cleanup
+	# Analyze http response
-	rm -f "$patternBuffer"
+	echo -n ":::   Status: "
+	case "$err" in
+		"200"  ) echo "Success (OK)"; success=true;;
+		"304"  ) echo "Not modified"; success=true;;
+		"403"  ) echo "Forbidden"; success=false;;
+		"404"  ) echo "Not found"; success=false;;
+		"408"  ) echo "Time-out"; success=false;;
+		"451"  ) echo "Unavailable For Legal Reasons"; success=false;;
+		"521"  ) echo "Web Server Is Down (Cloudflare)"; success=false;;
+		"522"  ) echo "Connection Timed Out (Cloudflare)"; success=false;;
+		"500"  ) echo "Internal Server Error"; success=false;;
+		*      ) echo "Status $err"; success=false;;
+	esac
+
+	# Process result
+	gravity_patternCheck "${patternBuffer}" ${success} "${err}"
+
 }
 
 # spinup - main gravity function
-function gravity_spinup() {
+gravity_spinup() {
 	echo ":::"
 	# 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++)); do
-	do
+		url=${sources[$i]}
-        url=${sources[$i]}
+		# Get just the domain from the URL
-        # Get just the domain from the URL
+		domain=$(echo "${url}" | cut -d'/' -f3)
-        domain=$(echo "$url" | cut -d'/' -f3)
 
-        # Save the file as list.#.domain
+		# Save the file as list.#.domain
-        saveLocation=${piholeDir}/list.${i}.${domain}.${justDomainsExtension}
+		saveLocation=${piholeDir}/list.${i}.${domain}.${justDomainsExtension}
-        activeDomains[$i]=${saveLocation}
+		activeDomains[$i]=${saveLocation}
 
-        agent="Mozilla/10.0"
+		agent="Mozilla/10.0"
 
-        echo -n "::: Getting $domain list..."
+		# Use a case statement to download lists that need special cURL commands
+		# to complete properly and reset the user agent when required
+		case "${domain}" in
+			"adblock.mahakala.is")
+			agent='Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
+			cmd_ext="-e http://forum.xda-developers.com/"
+		    ;;
 
-        # Use a case statement to download lists that need special cURL commands
+		    "pgl.yoyo.org")
-        # to complete properly and reset the user agent when required
+			cmd_ext="-d mimetype=plaintext -d hostformat=hosts"
-        case "$domain" in
+		    ;;
-            "adblock.mahakala.is")
-                agent='Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
-                cmd_ext="-e http://forum.xda-developers.com/"
-            ;;
-
-            "pgl.yoyo.org")
-                cmd_ext="-d mimetype=plaintext -d hostformat=hosts"
-            ;;
 
             # Default is a simple request
             *) cmd_ext=""
         esac
-        gravity_transport "$url" "$cmd_ext" "$agent"
+        if [[ "${skipDownload}" == false ]]; then
+            echo -n "::: Getting $domain list..."
+            gravity_transport "$url" "$cmd_ext" "$agent"
+        fi
 	done
 }
 
 # Schwarzchild - aggregate domains to one list and add blacklisted domains
-function gravity_Schwarzchild() {
+gravity_Schwarzchild() {
 	echo "::: "
 	# Find all active domains and compile them into one file and remove CRs
 	echo -n "::: Aggregating list of domains..."
 	truncate -s 0 ${piholeDir}/${matterAndLight}
-	for i in "${activeDomains[@]}"
+	for i in "${activeDomains[@]}"; do
-	do
+		# Only assimilate list if it is available (download might have faild permanently)
-		cat "$i" | tr -d '\r' >> ${piholeDir}/${matterAndLight}
+		if [[ -r "${i}" ]]; then
+			cat "${i}" | tr -d '\r' >> ${piholeDir}/${matterAndLight}
+		fi
 	done
 	echo " done!"
 }
 
-function gravity_Blacklist(){
+gravity_Blacklist() {
-	# Append blacklist entries if they exist
+	# Append blacklist entries to eventHorizon if they exist
-	echo -n "::: Running blacklist script to update HOSTS file...."
+	if [[ -f "${blacklistFile}" ]]; then
-	${blacklistScript} -f -nr -q > /dev/null
+	    numBlacklisted=$(wc -l < "${blacklistFile}")
+	    plural=; [[ "$numBlacklisted" != "1" ]] && plural=s
+	    echo -n "::: Blacklisting $numBlacklisted domain${plural}..."
+	    cat ${blacklistFile} >> ${piholeDir}/${eventHorizon}
+	    echo " done!"
+	else
+	    echo "::: Nothing to blacklist!"
+	fi
 
-	numBlacklisted=$(wc -l < "/etc/pihole/blacklist.txt")
-	plural=; [[ "$numBlacklisted" != "1" ]] && plural=s
-	echo " $numBlacklisted domain${plural} blacklisted!"
 }
 
-function gravity_Whitelist() {
+gravity_Whitelist() {
+    #${piholeDir}/${eventHorizon})
 	echo ":::"
 	# Prevent our sources from being pulled into the hole
 	plural=; [[ "${sources[@]}" != "1" ]] && plural=s
-	echo -n "::: Adding ${#sources[@]} adlist source${plural} to the whitelist..."
+	echo -n "::: Adding adlist source${plural} to the whitelist..."
 
 	urls=()
-	for url in "${sources[@]}"
+	for url in "${sources[@]}"; do
-	do
+		tmp=$(echo "${url}" | awk -F '/' '{print $3}')
-        tmp=$(echo "$url" | awk -F '/' '{print $3}')
+		urls=("${urls[@]}" ${tmp})
-        urls=("${urls[@]}" ${tmp})
 	done
 	echo " done!"
 
-	echo -n "::: Running whitelist script to update HOSTS file...."
+	# Ensure adlist domains are in whitelist.txt
-	${whitelistScript} -f -nr -q "${urls[@]}" > /dev/null
+	${whitelistScript} -nr -q "${urls[@]}" > /dev/null
-	numWhitelisted=$(wc -l < "/etc/pihole/whitelist.txt")
+
-	plural=; [[ "$numWhitelisted" != "1" ]] && plural=s
+    # Check whitelist.txt exists.
-	echo " $numWhitelisted domain${plural} whitelisted!"
+	if [[ -f "${whitelistFile}" ]]; then
+        # Remove anything in whitelist.txt from the Event Horizon
+        numWhitelisted=$(wc -l < "${whitelistFile}")
+        plural=; [[ "$numWhitelisted" != "1" ]] && plural=s
+        echo -n "::: Whitelisting $numWhitelisted domain${plural}..."
+        #print everything from preEventHorizon into eventHorizon EXCEPT domains in whitelist.txt
+        grep -F -x -v -f ${whitelistFile} ${piholeDir}/${preEventHorizon} > ${piholeDir}/${eventHorizon}
+        echo " done!"
+	else
+	    echo "::: Nothing to whitelist!"
+	fi
 }
 
-function gravity_unique() {
+gravity_unique() {
 	# Sort and remove duplicates
 	echo -n "::: Removing duplicate domains...."
-	sort -u  ${piholeDir}/${supernova} > ${piholeDir}/${eventHorizon}
+	sort -u  ${piholeDir}/${supernova} > ${piholeDir}/${preEventHorizon}
 	echo " done!"
-	numberOf=$(wc -l < ${piholeDir}/${eventHorizon})
+	numberOf=$(wc -l < ${piholeDir}/${preEventHorizon})
 	echo "::: $numberOf unique domains trapped in the event horizon."
 }
 
-function gravity_hostFormat() {
+gravity_hostFormat() {
 	# Format domain list as "192.168.x.x domain.com"
-	echo "::: Formatting domains into a HOSTS file..."
+	echo -n "::: Formatting domains into a HOSTS file..."
+
 	if [[ -f /etc/hostname ]]; then
 		hostname=$(</etc/hostname)
 	elif [ -x "$(command -v hostname)" ]; then
@@ -253,37 +286,49 @@ function gravity_hostFormat() {
 	else
 		echo "::: Error: Unable to determine fully qualified domain name of host"
 	fi
-	# If there is a value in the $piholeIPv6, then IPv6 will be used, so the awk command modified to create a line for both protocols
+  # Check vars from setupVars.conf to see if we're using IPv4, IPv6, Or both.
-	if [[ -n ${piholeIPv6} ]];then
+  if [[ -n "${IPV4_ADDRESS}" && -n "${IPV6_ADDRESS}" ]];then
-		# Add hostname and dummy domain to the top of gravity.list to make ping result return a friendlier looking domain! Also allows for an easy way to access the Pi-hole admin console (pi.hole/admin)
+
-		echo -e "$IPv4addr $hostname\n$piholeIPv6 $hostname\n$IPv4addr pi.hole\n$piholeIPv6 pi.hole" > ${piholeDir}/${accretionDisc}
+      echo -e "${IPV4_ADDRESS} ${hostname}\n${IPV6_ADDRESS} ${hostname}\n${IPV4_ADDRESS} pi.hole\n${IPV6_ADDRESS} pi.hole" > ${localList}
-		cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPv4addr" -v ipv6addr="$piholeIPv6" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc}
+      # Both IPv4 and IPv6
-	else
+      cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPV4_ADDRESS" -v ipv6addr="$IPV6_ADDRESS" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc}
-		# Otherwise, just create gravity.list as normal using IPv4
+
-		# Add hostname and dummy domain to the top of gravity.list to make ping result return a friendlier looking domain! Also allows for an easy way to access the Pi-hole admin console (pi.hole/admin)
+  elif [[ -n "${IPV4_ADDRESS}" && -z "${IPV6_ADDRESS}" ]];then
-		echo -e "$IPv4addr $hostname\n$IPv4addr pi.hole" > ${piholeDir}/${accretionDisc}
+
-		cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPv4addr" '{sub(/\r$/,""); print ipv4addr" "$0}' >> ${piholeDir}/${accretionDisc}
+      echo -e "${IPV4_ADDRESS} ${hostname}\n${IPV4_ADDRESS} pi.hole" > ${localList}
-	fi
+      # Only IPv4
+      cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPV4_ADDRESS" '{sub(/\r$/,""); print ipv4addr" "$0}' >> ${piholeDir}/${accretionDisc}
+
+  elif [[ -z "${IPV4_ADDRESS}" && -n "${IPV6_ADDRESS}" ]];then
+
+      echo -e "${IPV6_ADDRESS} ${hostname}\n${IPV6_ADDRESS} pi.hole" > ${localList}
+      # Only IPv6
+      cat ${piholeDir}/${eventHorizon} | awk -v ipv6addr="$IPV6_ADDRESS" '{sub(/\r$/,""); print ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc}
+
+  elif [[ -z "${IPV4_ADDRESS}" && -z "${IPV6_ADDRESS}" ]];then
+      echo "::: No IP Values found! Please run 'pihole -r' and choose reconfigure to restore values"
+      exit 1
+  fi
 
 	# Copy the file over as /etc/pihole/gravity.list so dnsmasq can use it
 	cp ${piholeDir}/${accretionDisc} ${adList}
+	echo " done!"
 }
 
 # blackbody - remove any remnant files from script processes
-function gravity_blackbody() {
+gravity_blackbody() {
 	# Loop through list files
-	for file in ${piholeDir}/*.${justDomainsExtension}
+	for file in ${piholeDir}/*.${justDomainsExtension}; do
-	do
 		# If list is in active array then leave it (noop) else rm the list
 		if [[ " ${activeDomains[@]} " =~ ${file} ]]; then
 			:
 		else
-			rm -f "$file"
+			rm -f "${file}"
 		fi
 	done
 }
 
-function gravity_advanced() {
+gravity_advanced() {
 	# 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
 	# This helps with that and makes it easier to read
@@ -291,69 +336,74 @@ function gravity_advanced() {
 	echo -n "::: Formatting list of domains to remove comments...."
 	#awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' ${piholeDir}/${matterAndLight} | sed -nr -e 's/\.{2,}/./g' -e '/\./p' >  ${piholeDir}/${supernova}
 	#Above line does not correctly grab domains where comment is on the same line (e.g 'addomain.com #comment')
-	#Add additional awk command to read all lines up to a '#', and then continue as we were
+	#Awk -F splits on given IFS, we grab the right hand side (chops trailing #coments and /'s to grab the domain only.
-	cat ${piholeDir}/${matterAndLight} | awk -F'#' '{print $1}' | awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' | sed -nr -e 's/\.{2,}/./g' -e '/\./p' >  ${piholeDir}/${supernova}
+	#Last awk command takes non-commented lines and if they have 2 fields, take the left field (the domain) and leave
+	#+ the right (IP address), otherwise grab the single field.
+	cat ${piholeDir}/${matterAndLight} | \
+	    awk -F '#' '{print $1}' | \
+	    awk -F '/' '{print $1}' | \
+	    awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' | \
+	    sed -nr -e 's/\.{2,}/./g' -e '/\./p' >  ${piholeDir}/${supernova}
 	echo " done!"
 
 	numberOf=$(wc -l < ${piholeDir}/${supernova})
-	echo "::: $numberOf domains being pulled in by gravity..."
+	echo "::: ${numberOf} domains being pulled in by gravity..."
 
 	gravity_unique
 }
 
-function gravity_reload() {
+gravity_reload() {
 	#Clear no longer needed files...
 	echo ":::"
 	echo -n "::: Cleaning up un-needed files..."
-	${SUDO} rm ${piholeDir}/pihole.*.txt
+	rm ${piholeDir}/pihole.*.txt
 	echo " done!"
 
 	# Reload hosts file
 	echo ":::"
 	echo -n "::: Refresh lists in dnsmasq..."
-	
+
 	#ensure /etc/dnsmasq.d/01-pihole.conf is pointing at the correct list!
 	#First escape forward slashes in the path:
 	adList=${adList//\//\\\/}
 	#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)
 
-    find "$piholeDir" -type f -exec ${SUDO} chmod 666 {} \;
+	pihole restartdns
-
-	if [[ ${dnsmasqPid} ]]; then
-		# service already running - reload config
-		${SUDO} killall -s HUP dnsmasq
-	else
-		# service not running, start it up
-		${SUDO} service dnsmasq start
-	fi
 	echo " done!"
 }
 
-
+for var in "$@"; do
-for var in "$@"
+	case "${var}" in
-do
+		"-f" | "--force"     ) forceGrav=true;;
-  case "$var" in
+		"-h" | "--help"      ) helpFunc;;
-    "-f" | "--force"     ) forceGrav=true;;
+		"-sd" | "--skip-download"    ) skipDownload=true;;
-    "-h" | "--help"      ) helpFunc;;
+	esac
-  esac
 done
 
-if [[ ${forceGrav} == true ]]; then
+if [[ "${forceGrav}" == true ]]; then
 	echo -n "::: Deleting exising list cache..."
-	${SUDO} rm /etc/pihole/list.*
+	rm /etc/pihole/list.*
 	echo " done!"
 fi
 
 #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_spinup
-gravity_Schwarzchild
+if [[ "${skipDownload}" == false ]]; then
-gravity_advanced
+    gravity_Schwarzchild
-gravity_hostFormat
+    gravity_advanced
-gravity_blackbody
+else
+    echo "::: Using cached Event Horizon list..."
+    numberOf=$(wc -l < ${piholeDir}/${preEventHorizon})
+	echo "::: $numberOf unique domains trapped in the event horizon."
+fi
 gravity_Whitelist
 gravity_Blacklist
+
+gravity_hostFormat
+gravity_blackbody
+
 gravity_reload
+pihole status

pihole

@@ -10,192 +10,274 @@
 # the Free Software Foundation, either version 2 of the License, or
 # (at your option) any later version.
 
+PI_HOLE_SCRIPT_DIR="/opt/pihole"
 # 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"
+    exec sudo bash "$0" "$@"
+    exit $?
   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
   fi
 fi
 
-function whitelistFunc {
+webpageFunc() {
-    shift
+  /opt/pihole/webpage.sh "$@"
-    ${SUDO} /opt/pihole/whitelist.sh "$@"
+  exit 0
-    exit 1
 }
 
-function blacklistFunc {
+whitelistFunc() {
-    shift
+ "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
-    ${SUDO} /opt/pihole/blacklist.sh "$@"
+  exit 0
-    exit 1
 }
 
-function debugFunc {
+blacklistFunc() {
-    ${SUDO} /opt/pihole/piholeDebug.sh
+  "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
-    exit 1
+  exit 0
 }
 
-function flushFunc {
+debugFunc() {
-    ${SUDO} /opt/pihole/piholeLogFlush.sh
+  "${PI_HOLE_SCRIPT_DIR}"/piholeDebug.sh
-    exit 1
+  exit 0
 }
 
+flushFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/piholeLogFlush.sh
+  exit 0
+}
 
-function updatePiholeFunc {
+updatePiholeFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/update.sh
+  exit 0
+}
 
-    if [ ! -d "/etc/.pihole" ]; then #This is unlikely
+reconfigurePiholeFunc() {
-        echo "::: Critical Error: Pi-Hole repo missing from system!"
+  /etc/.pihole/automated\ install/basic-install.sh --reconfigure
-        echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
+  exit 0;
-        exit 1;
+}
-    fi
+
-    if [ ! -d "/var/www/html/admin" ]; then #This is unlikely
+updateGravityFunc() {
-        echo "::: Critical Error: Pi-Hole repo missing from system!"
+  "${PI_HOLE_SCRIPT_DIR}"/gravity.sh "$@"
-        echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
+  exit 0
-        exit 1;
+}
+
+setupLCDFunction() {
+  "${PI_HOLE_SCRIPT_DIR}"/setupLCD.sh
+  exit 0
+}
+
+scanList(){
+  domain="${1}"
+  list="${2}"
+  method="${3}"
+  if [[ ${method} == "-exact" ]] ; then
+    grep -i -E "(^|\s)${domain}($|\s)" "${list}"
+  else
+    grep -i "${domain}" "${list}"
+  fi
+}
+
+queryFunc() {
+  domain="${2}"
+  method="${3}"
+  lists=( /etc/pihole/list.* /etc/pihole/blacklist.txt)
+  for list in ${lists[@]}; do
+    result=$(scanList ${domain} ${list} ${method})
+    # Remove empty lines before couting number of results
+    count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
+    echo "::: ${list} (${count} results)"
+    if [[ ${count} > 0 ]]; then
+      echo "${result}"
     fi
+    echo ""
+  done
+  exit 0
+}
 
-    echo "::: Checking for updates..."
+chronometerFunc() {
-    piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
+  shift
-    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/",$//')
+  "${PI_HOLE_SCRIPT_DIR}"/chronometer.sh "$@"
+  exit 0
+}
 
-    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)"
+uninstallFunc() {
-    echo "::: Web Admin version is $webVersion (Latest version is $webVersionLatest)"
+  "${PI_HOLE_SCRIPT_DIR}"/uninstall.sh
-    echo ":::"
+  exit 0
+}
 
-    if [[ ${piholeVersion} == ${piholeVersionLatest} ]] ; then
+versionFunc() {
-        echo "::: Pi-hole Base files are already up to date! Version: ${piholeVersionLatest}"
+  shift
-        echo "::: No need to update!"
+  "${PI_HOLE_SCRIPT_DIR}"/version.sh "$@"
-        echo ":::"
+  exit 0
+}
 
-        if [[ ${webVersion} == ${webVersionLatest} ]] ; then
+restartDNS() {
-            echo "::: Web Admin files are already up to date!"
+  dnsmasqPid=$(pidof dnsmasq)
-            echo "::: No need to update!"
+  if [[ ${dnsmasqPid} ]]; then
-            echo ":::"
+    # service already running - reload config
-        else
+    if [ -x "$(command -v systemctl)" ]; then
-            echo "::: An Update is available for the Web Admin!"
+      systemctl restart dnsmasq
-            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 "
+      service dnsmasq restart
-        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
-
+  else
-    exit 1
+    # service not running, start it up
+    if [ -x "$(command -v systemctl)" ]; then
+      systemctl start dnsmasq
+    else
+      service dnsmasq start
+    fi
+  fi
 }
 
-function updateGravityFunc {
+piholeEnable() {
-    ${SUDO} /opt/pihole/gravity.sh "$@"
+  if [[ "${1}" == "0" ]] ; then
-    exit 1
+    #Disable Pihole
+    sed -i 's/^addn-hosts=\/etc\/pihole\/gravity.list/#addn-hosts=\/etc\/pihole\/gravity.list/' /etc/dnsmasq.d/01-pihole.conf
+    echo "::: Blocking has been disabled!"
+    if [[ $# > 1 ]] ; then
+      if [[ ${2} == *"s"* ]] ; then
+        tt=${2%"s"}
+        echo "::: Blocking will be re-enabled in ${tt} seconds"
+        nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
+      elif [[ ${2} == *"m"* ]] ; then
+        tt=${2%"m"}
+        echo "::: Blocking will be re-enabled in ${tt} minutes"
+        tt=$((${tt}*60))
+        nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
+      else
+        echo "::: Unknown format for delayed reactivation of the blocking!"
+        echo "::: Example:"
+        echo ":::    pihole disable 5s    -    will disable blocking for 5 seconds"
+        echo ":::    pihole disable 7m    -    will disable blocking for 7 minutes"
+        echo "::: Blocking will not automatically be re-enabled!"
+      fi
+    fi
+  else
+    #Enable pihole
+    echo "::: Blocking has been enabled!"
+    sed -i 's/^#addn-hosts/addn-hosts/' /etc/dnsmasq.d/01-pihole.conf
+  fi
+  restartDNS
 }
 
-function setupLCDFunction {
+piholeLogging() {
-    ${SUDO} /opt/pihole/setupLCD.sh
+  shift
+
+  if [[ "${1}" == "off" ]] ; then
+    #Disable Logging
+    sed -i 's/^log-queries/#log-queries/' /etc/dnsmasq.d/01-pihole.conf
+    sed -i 's/^QUERY_LOGGING=true/QUERY_LOGGING=false/' /etc/pihole/setupVars.conf
+    pihole -f
+    echo "::: Logging has been disabled!"
+  elif [[ "${1}" == "on" ]] ; then
+    #Enable logging
+    sed -i 's/^#log-queries/log-queries/' /etc/dnsmasq.d/01-pihole.conf
+    sed -i 's/^QUERY_LOGGING=false/QUERY_LOGGING=true/' /etc/pihole/setupVars.conf
+    echo "::: Logging has been enabled!"
+  else
+    echo "::: Invalid option passed, please pass 'on' or 'off'"
     exit 1
+  fi
+  restartDNS
 }
 
-function queryFunc {
+piholeStatus() {
-    domain=$2
+  if [[ $(grep -i "^#addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf) ]] ; then
-    for list in /etc/pihole/list.*
+    #list is commented out
-    do
+    if [[ "${1}" == "web" ]] ; then
-        count=$(grep ${domain} $list | wc -l)
+      echo 0;
-        echo "::: ${list} (${count} results)"
+    else
-        if [[ ${count} > 0 ]]; then
+      echo "::: Pi-hole blocking is Disabled";
-            grep ${domain} ${list}
+    fi
-        fi
+  elif [[ $(grep -i "^addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf) ]] ; then
-        echo ""
+    #list set
-    done
+    if [[ "${1}" == "web" ]] ; then
-    exit 1
+      echo 1;
+    else
+      echo "::: Pi-hole blocking is Enabled";
+    fi
+  else
+    #addn-host not found
+    if [[ "${1}" == "web" ]] ; then
+      echo 99
+    else
+      echo ":::  No hosts file linked to dnsmasq, adding it in enabled state"
+    fi
+    #add addn-host= to dnsmasq
+    echo "addn-hosts=/etc/pihole/gravity.list" >> /etc/dnsmasq.d/01-pihole.conf
+    restartDNS
+  fi
 }
 
-function chronometerFunc {
+tailFunc() {
-    shift
+  echo "Press Ctrl-C to exit"
-    ${SUDO} /opt/pihole/chronometer.sh "$@"
+  tail -F /var/log/pihole.log
-    exit 1
+  exit 0
 }
 
-
+helpFunc() {
-function uninstallFunc {
+	cat << EOM
-    ${SUDO} /opt/pihole/uninstall.sh
+::: Control all PiHole specific functions!
-    exit 1
+:::
-}
+::: Usage: pihole [options]
-
+:::		Add -h after -w (whitelist), -b (blacklist), -c (chronometer), or -a (admin)  for more information on usage
-function versionFunc {
+:::
-    ${SUDO} /opt/pihole/version.sh
+::: Options:
-    exit 1
+:::  -w, whitelist            Whitelist domains
-}
+:::  -b, blacklist            Blacklist domains
-
+:::  -d, debug                Start a debugging session if having trouble
-function helpFunc {
+:::  -f, flush                Flush the pihole.log file
-    echo "::: Control all PiHole specific functions!"
+:::  -t, tail                 Output the last lines of the pihole.log file. Lines are appended as the file grows
-    echo ":::"
+:::  -up, updatePihole        Update Pi-hole
-    echo "::: Usage: pihole [options]"
+:::  -r, reconfigure          Reconfigure or Repair Pi-hole
-    echo ":::		Add -h after -w (whitelist), -b (blacklist), or -c (chronometer)  for more information on usage"
+:::  -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 "::: Options:"
+:::  -c, chronometer          Calculates stats and displays to an LCD
-    echo ":::  -w, whitelist            Whitelist domains"
+:::  -h, help                 Show this help dialog
-    echo ":::  -b, blacklist            Blacklist domains"
+:::  -v, version              Show current versions
-    echo ":::  -d, debug                Start a debugging session if having trouble"
+:::  -q, query                Query the adlists for a specific domain
-    echo ":::  -f, flush                Flush the pihole.log file"
+:::                           Use pihole -q domain -exact if you want to see exact matches only
-    echo ":::  -up, updatePihole        Update Pi-hole"
+:::  -l, logging              Enable or Disable logging (pass 'on' or 'off')
-    echo ":::  -g, updateGravity        Update the list of ad-serving domains"
+:::  -a, admin                Admin webpage options
-    echo ":::  -s, setupLCD             Automatically configures the Pi to use the 2.8 LCD screen to display stats on it"
+:::  uninstall                Uninstall Pi-Hole from your system :(!
-    echo ":::  -c, chronometer          Calculates stats and displays to an LCD"
+:::  status                   Is Pi-Hole Enabled or Disabled
-    echo ":::  -h, help                 Show this help dialog"
+:::  enable                   Enable Pi-Hole DNS Blocking
-    echo ":::  -v, version              Show current versions"
+:::  disable                  Disable Pi-Hole DNS Blocking
-    echo ":::  -q, query                Query the adlists for a specific domain"
+:::                           Blocking can also be disabled only temporarily, e.g.,
-    echo ":::  uninstall                Uninstall Pi-Hole from your system :(!"
+:::                           pihole disable 5m - will disable blocking for 5 minutes
-    exit 1
+:::  restartdns               Restart dnsmasq
+EOM
+  exit 0
 }
 
 if [[ $# = 0 ]]; then
-    helpFunc
+  helpFunc
 fi
 
 # Handle redirecting to specific functions based on arguments
-case "$1" in
+case "${1}" in
-"-w" | "whitelist"			) whitelistFunc "$@";;
+  "-w" | "whitelist"            ) whitelistFunc "$@";;
-"-b" | "blacklist"			) blacklistFunc "$@";;
+  "-b" | "blacklist"            ) blacklistFunc "$@";;
-"-d" | "debug"				) debugFunc;;
+  "-d" | "debug"                ) debugFunc;;
-"-f" | "flush"				) flushFunc;;
+  "-f" | "flush"                ) flushFunc;;
-"-up" | "updatePihole"      ) updatePiholeFunc;;
+  "-up" | "updatePihole"        ) updatePiholeFunc;;
-"-g" | "updateGravity"		) updateGravityFunc "$@";;
+  "-r"  | "reconfigure"         ) reconfigurePiholeFunc;;
-"-s" | "setupLCD"			) setupLCDFunction;;
+  "-g" | "updateGravity"        ) updateGravityFunc "$@";;
-"-c" | "chronometer"		) chronometerFunc "$@";;
+  "-s" | "setupLCD"             ) setupLCDFunction;;
-"-h" | "help"				) helpFunc;;
+  "-c" | "chronometer"          ) chronometerFunc "$@";;
-"-v" | "version"            ) versionFunc;;
+  "-h" | "help"                 ) helpFunc;;
-"-q" | "query"              ) queryFunc "$@";;
+  "-v" | "version"              ) versionFunc "$@";;
-"uninstall"					) uninstallFunc;;
+  "-q" | "query"                ) queryFunc "$@";;
-*                    		) helpFunc;;
+  "-l" | "logging"              ) piholeLogging "$@";;
+  "uninstall"                   ) uninstallFunc;;
+  "enable"                      ) piholeEnable 1;;
+  "disable"                     ) piholeEnable 0 $2;;
+  "status"                      ) piholeStatus "$2";;
+  "restartdns"                  ) restartDNS;;
+  "-a" | "admin"                ) webpageFunc "$@";;
+  "-t" | "tail"                 ) tailFunc;;
+  *                             ) helpFunc;;
 esac

requirements.txt

@@ -0,0 +1,5 @@
+docker-compose
+pytest
+pytest-xdist
+pytest-cov
+testinfra

test/centos.Dockerfile

@@ -0,0 +1,16 @@
+FROM centos:7
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/conftest.py

@@ -0,0 +1,61 @@
+import pytest
+import testinfra
+
+check_output = testinfra.get_backend(
+    "local://"
+).get_module("Command").check_output
+
+@pytest.fixture
+def Pihole(Docker):
+    ''' used to contain some script stubbing, now pretty much an alias.
+    Also provides bash as the default run function shell '''
+    def run_bash(self, command, *args, **kwargs):
+        cmd = self.get_command(command, *args)
+        if self.user is not None:
+            out = self.run_local(
+                "docker exec -u %s %s /bin/bash -c %s",
+                self.user, self.name, cmd)
+        else:
+            out = self.run_local(
+                "docker exec %s /bin/bash -c %s", self.name, cmd)
+        out.command = self.encode(cmd)
+        return out
+
+    funcType = type(Docker.run)
+    Docker.run = funcType(run_bash, Docker, testinfra.backend.docker.DockerBackend)
+    return Docker
+
+@pytest.fixture
+def Docker(request, args, image, cmd):
+    ''' combine our fixtures into a docker run command and setup finalizer to cleanup '''
+    assert 'docker' in check_output('id'), "Are you in the docker group?"
+    docker_run = "docker run {} {} {}".format(args, image, cmd)
+    docker_id = check_output(docker_run)
+
+    def teardown():
+        check_output("docker rm -f %s", docker_id)
+    request.addfinalizer(teardown)
+
+    docker_container = testinfra.get_backend("docker://" + docker_id)
+    docker_container.id = docker_id
+    return docker_container
+
+@pytest.fixture
+def args(request):
+    ''' -t became required when tput began being used '''
+    return '-t -d'
+
+@pytest.fixture(params=['debian', 'centos'])
+def tag(request):
+    ''' consumed by image to make the test matrix '''
+    return request.param
+
+@pytest.fixture()
+def image(request, tag):
+    ''' built by test_000_build_containers.py '''
+    return 'pytest_pihole:{}'.format(tag)
+
+@pytest.fixture()
+def cmd(request):
+    ''' default to doing nothing by tailing null, but don't exit '''
+    return 'tail -f /dev/null'

test/debian.Dockerfile

@@ -0,0 +1,16 @@
+FROM debian:jessie
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/test_000_build_containers.py

@@ -0,0 +1,18 @@
+''' This file starts with 000 to make it run first '''
+import pytest
+import testinfra
+
+run_local = testinfra.get_backend(
+    "local://"
+).get_module("Command").run
+
+@pytest.mark.parametrize("image,tag", [
+    ( 'test/debian.Dockerfile', 'pytest_pihole:debian' ),
+    ( 'test/centos.Dockerfile', 'pytest_pihole:centos' ),
+])
+def test_build_pihole_image(image, tag):
+    build_cmd = run_local('docker build -f {} -t {} .'.format(image, tag))
+    if build_cmd.rc != 0:
+        print build_cmd.stdout
+        print build_cmd.stderr
+    assert build_cmd.rc == 0

test/test_automated_install.py

@@ -0,0 +1,102 @@
+import pytest
+from textwrap import dedent
+
+SETUPVARS = {
+    'PIHOLE_INTERFACE' : 'eth99',
+    'IPV4_ADDRESS' : '1.1.1.1',
+    'IPV6_ADDRESS' : 'FE80::240:D0FF:FE48:4672',
+    'PIHOLE_DNS_1' : '4.2.2.1',
+    'PIHOLE_DNS_2' : '4.2.2.2'
+}
+
+def test_setupVars_are_sourced_to_global_scope(Pihole):
+    ''' currently update_dialogs sources setupVars with a dot,
+    then various other functions use the variables.
+    This confirms the sourced variables are in scope between functions '''
+    setup_var_file = 'cat <<EOF> /etc/pihole/setupVars.conf\n'
+    for k,v in SETUPVARS.iteritems():
+        setup_var_file += "{}={}\n".format(k, v)
+    setup_var_file += "EOF\n"
+    Pihole.run(setup_var_file)
+
+    script = dedent('''\
+    set -e
+    printSetupVars() {
+        # Currently debug test function only
+        echo "Outputting sourced variables"
+        echo "PIHOLE_INTERFACE=${PIHOLE_INTERFACE}"
+        echo "IPV4_ADDRESS=${IPV4_ADDRESS}"
+        echo "IPV6_ADDRESS=${IPV6_ADDRESS}"
+        echo "PIHOLE_DNS_1=${PIHOLE_DNS_1}"
+        echo "PIHOLE_DNS_2=${PIHOLE_DNS_2}"
+    }
+    update_dialogs() {
+        . /etc/pihole/setupVars.conf
+    }
+    update_dialogs
+    printSetupVars
+    ''')
+
+    output = run_script(Pihole, script).stdout
+
+    for k,v in SETUPVARS.iteritems():
+        assert "{}={}".format(k, v) in output
+
+def test_setupVars_saved_to_file(Pihole):
+    ''' confirm saved settings are written to a file for future updates to re-use '''
+    set_setup_vars = '\n'  # dedent works better with this and padding matching script below
+    for k,v in SETUPVARS.iteritems():
+        set_setup_vars += "    {}={}\n".format(k, v)
+    Pihole.run(set_setup_vars).stdout
+
+    script = dedent('''\
+    set -e
+    echo start
+    TERM=xterm
+    source /opt/pihole/basic-install.sh
+    {}
+    finalExports
+    cat /etc/pihole/setupVars.conf
+    '''.format(set_setup_vars))
+
+    output = run_script(Pihole, script).stdout
+
+    for k,v in SETUPVARS.iteritems():
+        assert "{}={}".format(k, v) in output
+
+def test_configureFirewall_firewalld_no_errors(Pihole):
+    ''' confirms firewalld rules are applied when appopriate '''
+    mock_command('firewall-cmd', '0', Pihole)
+    configureFirewall = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    configureFirewall
+    ''')
+    expected_stdout = '::: Configuring firewalld for httpd and dnsmasq.'
+    assert expected_stdout in configureFirewall.stdout
+    firewall_calls = Pihole.run('cat /var/log/firewall-cmd').stdout
+    assert 'firewall-cmd --state' in firewall_calls
+    assert 'firewall-cmd --permanent --add-port=80/tcp' in firewall_calls
+    assert 'firewall-cmd --permanent --add-port=53/tcp' in firewall_calls
+    assert 'firewall-cmd --permanent --add-port=53/udp' in firewall_calls
+    assert 'firewall-cmd --reload' in firewall_calls
+
+
+# Helper functions
+def mock_command(script, result, container):
+    ''' Allows for setup of commands we don't really want to have to run for real in unit tests '''
+    ''' TODO: support array of results that enable the results to change over multiple executions of a command '''
+    full_script_path = '/usr/local/bin/{}'.format(script)
+    mock_script = dedent('''\
+    #!/bin/bash -e
+    echo "\$0 \$@" >> /var/log/{script}
+    exit {retcode}
+    '''.format(script=script, retcode=result))
+    container.run('''
+    cat <<EOF> {script}\n{content}\nEOF
+    chmod +x {script}
+    '''.format(script=full_script_path, content=mock_script))
+
+def run_script(Pihole, script):
+    result = Pihole.run(script)
+    assert result.rc == 0
+    return result

test/test_shellcheck.py

@@ -0,0 +1,13 @@
+import pytest
+import testinfra
+
+run_local = testinfra.get_backend(
+    "local://"
+).get_module("Command").run
+
+def test_scripts_pass_shellcheck():
+    ''' Make sure shellcheck does not find anything wrong with our shell scripts '''
+    shellcheck = "find . -type f \( -name 'update.sh' -o -name 'piholeDebug.sh' \) | while read file; do shellcheck \"$file\"; done;"
+    results = run_local(shellcheck)
+    print results.stdout
+    assert '' == results.stdout