Merge pull request #1021 from pi-hole/development

[RELEASE] Pi-Hole Core 2.10.1

.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,7 +1,33 @@
-##### Expected Behaviour:
+**In raising this issue, I confirm the following (please check boxes, eg [X]) Failure to fill the template will close your issue:**
+
+- [] 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*
+- [] 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?:**
+
+_{replace this text with a number from 1 to 10, with 1 being not familiar, and 10 being very familiar}_
+
+---
+**[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:**
 
 
-##### Actual Behaviour:
+**[BUG | ISSUE] Actual Behaviour:**
 
 
-##### Steps to reproduce this issue:
+**[BUG | ISSUE] Steps to reproduce:**
+
+-
+-
+-
+-
+
+**(Optional) Debug token generated by `pihole -d`:**
+
+`<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,11 +1,19 @@
-Fixes #[issue number] .
+**By submitting this pull request, I confirm the following (please check boxes, eg [X]) _Failure to fill the template will close your PR_:**
 
-Changes proposed in this pull request:
+***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 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 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.
 
-- 
+**How familiar are you with the codebase?:**
 
-- 
+_{replace this text with a number from 1 to 10, with 1 being not familiar, and 10 being very familiar}_
 
-@pi-hole/gravity
+---
+_{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

@@ -0,0 +1,38 @@
+version: 2
+
+always_pending:
+  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

@@ -1,8 +1,38 @@
-This is a basic checklist for now, We will update it in the future.
+_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
 
-* Fork the repo and create your new branch based on the `development` branch.
+# Contributors Guide
-* Commit Unix line endings
+
-* If you want, try to keep to the theme of black holes/gravity. This can add some fun to your submission.
+Please read and understand the contribution guide before creating an issue or pull request.
-* 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!)
+## Etiquette
-* Be patient. We will review all submitted pull requests, but our focus is on stability.. please don't be offended if we reject your PR, or it appears we're doing nothing with it! We'll get around to it..
+
+- Our goal for Pi-hole is **stability before features**.  This means we focus on squashing critical bugs before adding new features.  Often, we can do both in tandem, but bugs will take priority over a new feature.
+- Pi-hole is open source and [powered by donations](https://pi-hole.net/donate/), and as such, we give our **free time** to build, maintain, and **provide user support** for this project.  It would be extremely unfair for us to suffer abuse or anger for our hard work, so please take a moment to consider that.
+- Please be considerate towards the developers and other users when raising issues or presenting pull requests.
+- Respect our decision(s), and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many people, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+**Before filing an issue:**
+
+- Attempt to replicate and **document** the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+**Before submitting a pull request:**
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Technical Requirements
+
+- 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,41 +1,136 @@
-# Automated Install 
+<p align="center">
-##### Designed For Raspberry Pi A+, B, B+, 2, Zero, and 3B (with an Ethernet/Wi-Fi adapter) (Works on most Debian distributions!)
+<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>
 
+<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>
 
-[![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)
+## The multi-platform, network-wide ad blocker
 
-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
+- Web Browsers
+- Cell Phones
+- Smart TV's
+- Internet-connected home automation
+- Anything that communicates with the Internet
 
-### ```curl -L https://install.pi-hole.net | bash```
+<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.
 
-#### Alternative Semi-Automated install ####
 ```
+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
 ```
 
-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/).
+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/).
 
-## Pi-hole Is Free, But Powered By Your Donations
+## Installing the Pi-hole (Click to Watch!)
-[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif "Free, but powered by donations")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY "Donate")
+<p align="center">
+<a href=https://www.youtube.com/watch?v=TzFLJqUeirA><img src="https://assets.pi-hole.net/static/global.png"></a>
+</p>
 
-## Catch us out on the net:
+## Would you like to know more?
-Twitter: [@The_Pi_Hole](https://twitter.com/The_Pi_Hole)
 
-reddit: [/r/pihole](https://www.reddit.com/r/pihole/)
-
-## How Does It Work?
 **Watch the 60-second video below to get a quick overview**
+<p align="center">
+<a href=https://youtu.be/9Eti3xibiho><img src="https://assets.pi-hole.net/static/blackhole_web.png"></a>
+</p>
 
-[![Pi-hole exlplained](http://i.imgur.com/qNybJDX.png)](https://vimeo.com/135965232)
+## Get Help Or Connect With Us On The Web
+
+-   [Users Forum](https://discourse.pi-hole.net/)
+-   [FAQs](https://discourse.pi-hole.net/c/faqs)
+-   [Wiki](https://github.com/pi-hole/pi-hole/wiki)
+-   ![Twitter](https://assets.pi-hole.net/static/twitter.png) [Tweet @The_Pi_Hole](https://twitter.com/The_Pi_Hole)
+-   ![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
+
+The Pi-hole is an **advertising-aware DNS/Web server**. If an ad domain is queried, a small Web page or GIF is delivered in place of the advertisement. You can also [replace ads with any image you want](http://pi-hole.net/faq/is-it-possible-to-change-the-blank-page-that-takes-place-of-the-ads-to-something-else/) since it is just a simple Webpage taking place of the ads.
+
+### 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)). This script is controlled by the `pihole` command. Please run `pihole -h` to see what commands can be run via `pihole`.
+
+
+
+#### 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](https://assets.pi-hole.net/static/dashboard.png)
+
+### Whitelist and blacklist
+
+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
+{
+    "domains_being_blocked": "136708",
+    "dns_queries_today": "18108",
+    "ads_blocked_today": "14648",
+    "ads_percentage_today": "80.89"
+}
+```
+
+The same output can be achieved on the CLI by running `chronometer.sh -j`
+
+## Real-time Statistics
+
+You can view [real-time stats](http://pi-hole.net/faq/install-the-real-time-lcd-monitor-chronometer/) via `ssh` or on an [2.8" LCD screen](http://amzn.to/1P0q1Fj). This is accomplished via [`chronometer.sh`](https://github.com/pi-hole/pi-hole/blob/master/advanced/Scripts/chronometer.sh). ![Pi-hole LCD](http://i.imgur.com/nBEqycp.jpg)
 
 ## Pi-hole Projects
+
+-   [Pi-hole stats in your Mac's menu bar](https://getbitbar.com/plugins/Network/pi-hole.1m.py)
 -   [Get LED alerts for each blocked ad](http://www.stinebaugh.info/get-led-alerts-for-each-blocked-ad-using-pi-hole/)
 -   [Pi-hole on Ubuntu 14.04 on VirtualBox](http://hbalagtas.blogspot.com/2016/02/adblocking-with-pi-hole-and-ubuntu-1404.html)
-- [x86 Docker container that runs Pi-hole](https://hub.docker.com/r/diginc/pi-hole/)
+-   [Docker Pi-hole container (x86 and ARM)](https://hub.docker.com/r/diginc/pi-hole/)
 -   [Splunk: Pi-hole Visualizser](https://splunkbase.splunk.com/app/3023/)
 -   [Pi-hole Chrome extension](https://chrome.google.com/webstore/detail/pi-hole-list-editor/hlnoeoejkllgkjbnnnhfolapllcnaglh) ([open source](https://github.com/packtloss/pihole-extension))
 -   [Go Bananas for CHiP-hole ad blocking](https://www.hackster.io/jacobsalmela/chip-hole-network-wide-ad-blocker-98e037)
@@ -44,8 +139,13 @@ reddit: [/r/pihole](https://www.reddit.com/r/pihole/)
 -   [unRaid-hole](https://github.com/spants/unraidtemplates/blob/master/Spants/unRaid-hole.xml#L13)--[Repo and more info](http://lime-technology.com/forum/index.php?PHPSESSID=c0eae3e5ef7e521f7866034a3336489d&topic=38486.0)
 -   [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
+
+-   [Adafruit livestream install](https://www.youtube.com/watch?v=eg4u2j1HYlI)
 -   [TekThing: 5 fun, easy projects for a Raspberry Pi](https://youtu.be/QwrKlyC2kdM?t=1m42s)
 -   [Pi-hole on Adafruit's blog](https://blog.adafruit.com/2016/03/04/pi-hole-is-a-black-hole-for-internet-ads-piday-raspberrypi-raspberry_pi/)
 -   [The Defrag Show - MSDN/Channel 9](https://channel9.msdn.com/Shows/The-Defrag-Show/Defrag-Endoscope-USB-Camera-The-Final-HoloLens-Vote-Adblock-Pi-and-more?WT.mc_id=dlvr_twitter_ch9#time=20m39s)
@@ -58,53 +158,4 @@ reddit: [/r/pihole](https://www.reddit.com/r/pihole/)
 -   [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/)
-## Partnering With Optimal.com
-
-Pi-hole will be teaming up with [Rob Leathern's subscription service to avoid ads](https://medium.com/@robleathern/block-ads-on-all-home-devices-for-53-18-a5f1ec139693#.gj1xpgr5d).  This service is unique and will help content-creators and publishers [still make money from visitors who are using an ad ablocker](http://techcrunch.com/2015/12/17/the-new-optimal/).
-
-## Technical Details
-
-The Pi-hole is an **advertising-aware DNS/Web server**.  If an ad domain is queried, a small Web page or GIF is delivered in place of the advertisement.  You can also [replace ads with any image you want](http://pi-hole.net/faq/is-it-possible-to-change-the-blank-page-that-takes-place-of-the-ads-to-something-else/) since it is just a simple Webpage taking place of the ads.
-
-A more detailed explanation of the installation can be found [here](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0).
-
-## 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)).
-
-## 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
-
-## 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:
-
-`http://192.168.1.x/admin/index.php`
-
-![Pi-hole Advanced Stats Dashboard](http://i.imgur.com/rTlLYPh.png)
-
-### API
-
-A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON:
-```JSON
-{
-	"domains_being_blocked": "136708",
-	"dns_queries_today": "18108",
-	"ads_blocked_today": "14648",
-	"ads_percentage_today": "80.89"
-}
-```
-The same output can be acheived on the CLI by running `chronometer.sh -j`
-
-![Web](http://i.imgur.com/m114SCn.png)
-
-## Real-time Statistics
-
-You can view [real-time stats](http://pi-hole.net/faq/install-the-real-time-lcd-monitor-chronometer/) via `ssh` or on an [2.8" LCD screen](http://amzn.to/1P0q1Fj).  This is accomplished via [`chronometer.sh`](https://github.com/pi-hole/pi-hole/blob/master/advanced/Scripts/chronometer.sh).
-![Pi-hole LCD](http://i.imgur.com/nBEqycp.jpg)
-
-## Help
-- See the [Wiki](https://github.com/pi-hole/pi-hole/wiki/Customization) entry for more details
-- There is also an [FAQ section on pi-hole.net](http://pi-hole.net)
-
-## 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 21/02/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`          #
@@ -14,7 +14,6 @@
 https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts
 
 # Other lists we consider safe:
-http://adblock.gjtech.net/?format=unix-hosts
 http://mirror1.malwaredomains.com/files/justdomains
 http://sysctl.org/cameleon/hosts
 https://zeustracker.abuse.ch/blocklist.php?download=domainblocklist
@@ -22,17 +21,17 @@ https://s3.amazonaws.com/lists.disconnect.me/simple_tracking.txt
 https://s3.amazonaws.com/lists.disconnect.me/simple_ad.txt
 
 # hosts-file.net list. Updated frequently, but has been known to block legitimate sites.
-http://hosts-file.net/ad_servers.txt
+https://hosts-file.net/ad_servers.txt
 
 # Mahakala list. Has been known to block legitimage domains including the entire .com range.
 # Warning: Due to the sheer size of this list, the web admin console will be unresponsive.
 #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/hostsBlockWindowsSpy.txt
+#https://raw.githubusercontent.com/crazy-max/WindowsSpyBlocker/master/data/hosts/win10/spy.txt
 
 # Securemecca.com list - Also blocks "adult" sites (pornography/gambling etc)
 #http://securemecca.com/Downloads/hosts.txt
@@ -43,8 +42,12 @@ 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
 
-
 # Untested Lists:
 #https://raw.githubusercontent.com/reek/anti-adblock-killer/master/anti-adblock-killer-filters.txt
-#http://spam404bl.com/spam404scamlist.txt
+#https://raw.githubusercontent.com/Dawsey21/Lists/master/main-blacklist.txt
 #http://malwaredomains.lehigh.edu/files/domains.txt
+# Following two lists should be used simultaneously: (readme https://github.com/notracking/hosts-blocklists/)
+#https://raw.github.com/notracking/hosts-blocklists/master/hostnames.txt
+#https://raw.github.com/notracking/hosts-blocklists/master/domains.txt
+# Combination of serveral host files on the internet (warning some facebook domains are also blocked but you can go to facebook.com). See https://github.com/mat1th/Dns-add-block for more information.
+#https://raw.githubusercontent.com/mat1th/Dns-add-block/master/hosts

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,196 +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.
-
-if [[ $# = 0 ]]; then
-    echo "::: Immediately blacklists one or more domains in the hosts file"
-    echo ":::"
-    echo "::: Usage: sudo pihole.sh -b domain1 [domain2 ...]"
-    echo ":::"
-    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"
-    exit 1
-fi
-
-#globals
-basename=pihole
-piholeDir=/etc/$basename
-adList=$piholeDir/gravity.list
-blacklist=$piholeDir/blacklist.txt
-reload=true
-addmode=true
-force=false
-versbose=true
-
-domList=()
-domToRemoveList=()
-
-piholeIPv6file=/etc/pihole/.useIPv6
-
-# 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%/*}
-
-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 $versbose; then
-	  echo -n "::: Adding $1 to blacklist file..."
-	  fi
-		echo "$1" >> $blacklist
-		modifyHost=true
-		echo " done!"
-	else
-	if $versbose; 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 $versbose; then
-  	echo "::: $1 is NOT blacklisted! No need to remove"
-  	fi
-  else
-    #Domain is in the blacklist file, add to a temporary array
-    if $versbose; 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 kill -HUP "$dnsmasqPid"
-	else
-		# service not running, start it up
-		sudo service dnsmasq start
-	fi
-	echo " done!"
-}
-
-###################################################
-
-for var in "$@"
-do
-  case "$var" in
-    "-nr"| "--noreload"  ) reload=false;;
-    "-d" | "--delmode"   ) addmode=false;;
-    "-f" | "--force"     ) force=true;;
-    "-q" | "--quiet"     ) versbose=false;;  			
-    *                    ) HandleOther "$var";;
-  esac
-done
-
-PopBlacklistFile
-
-if $modifyHost || $force; then
-	ModifyHostFile
-else
-  if $versbose; 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
-			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,13 +69,16 @@ 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
-		toilet -f small -F gay Pi-hole
+		echo " ___ _     _        _"
-		echo "        $(ifconfig eth0 | awk '/inet addr/ {print $2}' | cut -d':' -f2)"
+		echo "| _ (_)___| |_  ___| |___"
+		echo "|  _/ |___| ' \/ _ \ / -_)"
+		echo "|_| |_|   |_||_\___/_\___|"
+		echo ""
+		echo "        ${IPV4_ADDRESS}"
 		echo ""
 		uptime | cut -d' ' -f11-
 		#uptime -p	#Doesn't work on all versions of uptime
@@ -107,35 +100,33 @@ 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.sh -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
 		"-j" | "--json"  ) outputJSON;;
 		"-h" | "--help"  ) displayHelp;;

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

@@ -3,307 +3,405 @@
 # (c) 2015, 2016 by Jacob Salmela
 # Network-wide ad blocking via your Raspberry Pi
 # http://pi-hole.net
-# Generates pihole_debug.log in /var/log/ to be used for troubleshooting.
+# Generates pihole_debug.log to be used for troubleshooting.
 #
 # 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.
 
-# Nate Brandeburg
+set -o pipefail
-# nate@ubiquisoft.com
-# 3/24/2016
 
 ######## 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
-######## FIRST CHECK ########
+TIMEOUT=60
-# Must be root to debug
+# Header info and introduction
-if [[ $EUID -eq 0 ]]; then
+cat << EOM
-	echo "::: You are root... Beginning debug!"
+::: Beginning Pi-hole debug at $(date)!
-else
+:::
-	echo "::: Sudo will be used for debugging."
+::: This process collects information from your Pi-hole, and optionally uploads
-	# Check if sudo is actually installed
+::: it to a unique and random directory on tricorder.pi-hole.net.
-	if [[ $(dpkg-query -s sudo) ]]; then
+:::
-		export SUDO="sudo"
+::: NOTE: All log files auto-delete after 24 hours and ONLY the Pi-hole developers
-	else
+::: can access your data via the given token. We have taken these extra steps to
-		echo "::: Please install sudo or run this as root."
+::: secure your data and will work to further reduce any personal information gathered.
-		exit 1
+:::
-	fi
+::: Please read and note any issues, and follow any directions advised during this process.
-fi
+EOM
 
 # 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 compareWhitelist {
+log_write() {
-	if [ ! -f "$WHITELISTMATCHES" ]; then
+    echo "${1}" >> "${DEBUG_LOG}"
-		$SUDO touch $WHITELISTMATCHES
+}
-		$SUDO chmod 644 $WHITELISTMATCHES
+
-		$SUDO chown "$USER":root $WHITELISTMATCHES
+log_echo() {
+  case ${1} in
+    -n)
+      echo -n ":::       ${2}"
+      log_write "${2}"
+      ;;
+    -r)
+      echo ":::       ${2}"
+      log_write "${2}"
+      ;;
+    -l)
+      echo "${2}"
+      log_write "${2}"
+      ;;
+     *)
+      echo ":::  ${1}"
+      log_write "${1}"
+  esac
+}
+
+header_write() {
+  log_echo ""
+  log_echo "${1}"
+  log_write ""
+}
+
+file_parse() {
+    while read -r line; do
+		  if [ ! -z "${line}" ]; then
+			  [[ "${line}" =~ ^#.*$  || ! "${line}" ]] && continue
+				log_write "${line}"
+			fi
+		done < "${1}"
+		log_write ""
+}
+
+block_parse() {
+  log_write "${1}"
+}
+
+lsof_parse() {
+  local user
+  local process
+
+  user=$(echo ${1} | cut -f 3 -d ' ' | cut -c 2-)
+  process=$(echo ${1} | cut -f 2 -d ' ' | cut -c 2-)
+  [[ ${2} -eq ${process} ]] \
+  && echo ":::       Correctly configured." \
+  || log_echo ":::       Failure: Incorrectly configured daemon."
+
+  log_write "Found user ${user} with process ${process}"
+}
+
+
+version_check() {
+  header_write "Detecting Installed Package Versions:"
+
+  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
-		truncate -s 0 $WHITELISTMATCHES
+    log_echo "${1} not found!"
+    return 1
   fi
-
+  echo ":::"
-	echo "#######################################" >> $DEBUG_LOG
-	echo "######## Whitelist Comparison #########" >> $DEBUG_LOG
-	echo "#######################################" >> $DEBUG_LOG
-	while read -r line; do
-		TMP=$(grep -w ".* $line$" "$GRAVITYFILE")
-		if [ ! -z "$TMP" ]; then
-			echo "$TMP" >> $DEBUG_LOG
-			echo "$TMP"	>> $WHITELISTMATCHES
-		fi
-	done < "$WHITELISTFILE"
-	echo >> $DEBUG_LOG
 }
 
-function compareBlacklist {
+source_file() {
-	echo "#######################################" >> $DEBUG_LOG
+  local file_found=$(files_check "${1}") \
-	echo "######## Blacklist Comparison #########" >> $DEBUG_LOG
+   && (source "${1}" &> /dev/null && echo "${file_found} and was successfully sourced") \
-	echo "#######################################" >> $DEBUG_LOG
+   || log_echo -l "${file_found} and could not be sourced"
-	while read -r line; do
-		if [ ! -z "$line" ]; then
-			grep -w ".* $line$" "$GRAVITYFILE" >> $DEBUG_LOG
-		fi
-	done < "$BLACKLISTFILE"
-	echo >> $DEBUG_LOG
 }
 
-function testNslookup {
+distro_check() {
-	TESTURL="doubleclick.com"
+  local soft_fail
-	echo "#######################################" >> $DEBUG_LOG
+  header_write "Detecting installed OS Distribution"
-	echo "############ NSLookup Test ############" >> $DEBUG_LOG
+  soft_fail=0
-	echo "#######################################" >> $DEBUG_LOG
+	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
+      log_echo="No IPv6 Gateway Detected"
+    fi
+
+local IPv4_addr_list="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet") print $(i+1) }')" \
+	&& (block_parse "${IPv4_addr_list}" && echo ":::       IPv4 addresses located")\
+	|| log_echo "No IPv4 addresses found."
+
+	local IPv4_def_gateway=$(ip r | grep default | cut -d ' ' -f 3)
+	if [[ $? = 0 ]]; then
+		echo -n ":::        Pinging default IPv4 gateway: "
+		local IPv4_def_gateway_check="$(ping -q -w 3 -c 3 -n "${IPv4_def_gateway}"  -I "${IPv4_interface}" | tail -n3)" \
+		&& echo "Gateway responded." \
+		|| echo "Gateway did not respond."
+		block_parse "${IPv4_def_gateway_check}"
+
+		echo -n ":::        Pinging Internet via IPv4: "
+		local IPv4_inet_check="$(ping -q -w 5 -c 3 -n 8.8.8.8 -I "${IPv4_interface}" | tail -n3)" \
+		&& echo "Query responded." \
+		|| echo "Query did not respond."
+		block_parse "${IPv4_inet_check}"
+	fi
+
+  fi
+}
+
+port_check() {
+  local lsof_value
+
+  lsof_value=$(lsof -i ${1}:${2} -FcL | tr '\n' ' ') \
+  && lsof_parse "${lsof_value}" "${3}" \
+  || log_echo "Failure: IPv${1} Port not in use"
+}
+
+daemon_check() {
+  # Check for daemon ${1} on port ${2}
+	header_write "Daemon Process Information"
+
+	echo ":::     Checking ${2} port for ${1} listener."
+
+	if [[ ${IPV6_READY} ]]; then
+	  port_check 6 "${2}" "${1}"
+  fi
+	lsof_value=$(lsof -i 4:${2} -FcL | tr '\n' ' ') \
+    port_check 4 "${2}" "${1}"
+}
+
+testResolver() {
+	header_write "Resolver Functions Check"
+
 	# Find a blocked url that has not been whitelisted.
-	if [ -s "$WHITELISTMATCHES" ]; then
+	TESTURL="doubleclick.com"
+	if [ -s "${WHITELISTMATCHES}" ]; then
 		while read -r line; do
 			CUTURL=${line#*" "}
-			if [ "$CUTURL" != "Pi-Hole.IsWorking.OK" ]; then
+			if [ "${CUTURL}" != "Pi-Hole.IsWorking.OK" ]; then
 				while read -r line2; do
 					CUTURL2=${line2#*" "}
-					if [ "$CUTURL" != "$CUTURL2" ]; then
+					if [ "${CUTURL}" != "${CUTURL2}" ]; then
-						TESTURL="$CUTURL"
+						TESTURL="${CUTURL}"
 						break 2
 					fi
-				done < "$WHITELISTMATCHES"
+				done < "${WHITELISTMATCHES}"
 			fi
-		done < "$GRAVITYFILE"
+		done < "${GRAVITYFILE}"
 	fi
 
-	echo "NSLOOKUP of $TESTURL from PiHole:" >> $DEBUG_LOG
+	log_write "Resolution of ${TESTURL} from Pi-hole:"
-	nslookup "$TESTURL" >> $DEBUG_LOG
+	LOCALDIG=$(dig "${TESTURL}" @127.0.0.1)
-	echo >> $DEBUG_LOG
+	if [[ $? = 0 ]]; then
-	echo "NSLOOKUP of $TESTURL from 8.8.8.8:" >> $DEBUG_LOG
+		log_write "${LOCALDIG}"
-	nslookup "$TESTURL" 8.8.8.8 >> $DEBUG_LOG
+	else
-	echo >> $DEBUG_LOG
+		log_write "Failed to resolve ${TESTURL} on Pi-hole"
+	fi
+	log_write ""
+
+
+	log_write "Resolution of ${TESTURL} from 8.8.8.8:"
+	REMOTEDIG=$(dig "${TESTURL}" @8.8.8.8)
+	if [[ $? = 0 ]]; then
+		log_write "${REMOTEDIG}"
+	else
+		log_write "Failed to resolve ${TESTURL} on 8.8.8.8"
+	fi
+	log_write ""
+
+	log_write "Pi-hole dnsmasq specific records lookups"
+	log_write "Cache Size:"
+	dig +short chaos txt cachesize.bind >> ${DEBUG_LOG}
+	log_write "Upstream Servers:"
+	dig +short chaos txt servers.bind >> ${DEBUG_LOG}
+	log_write ""
 }
 
-function checkProcesses {
+checkProcesses() {
-	echo "#######################################" >> $DEBUG_LOG
+	header_write "Processes Check"
-	echo "########### Processes Check ###########" >> $DEBUG_LOG
+
-	echo "#######################################" >> $DEBUG_LOG
-	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
+	log_write ""
 }
 
+debugLighttpd() {
+  echo ":::     Checking for necessary lighttpd files."
+  files_check "${LIGHTTPDFILE}"
+  files_check "${LIGHTTPDERRFILE}"
+  echo ":::"
+}
+
+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 ###
 
-### Check Pi internet connections ###
+# Gather version of required packages / repositories
-# Log the IP addresses of this Pi
+version_check || echo "REQUIRED FILES MISSING"
-IPADDR=$($SUDO ifconfig | perl -nle 's/dr:(\S+)/print $1/e')
+# Check for newer setupVars storage file
-echo "::: Writing local IPs to debug log"
+source_file "/etc/pihole/setupVars.conf"
-echo "IP Addresses of this Pi:" >> $DEBUG_LOG
+# Gather information about the running distribution
-echo "$IPADDR" >> $DEBUG_LOG
+distro_check || echo "Distro Check soft fail"
-echo >> $DEBUG_LOG
+# Gather processor type
+processor_check || echo "Processor Check soft fail"
 
-# Check if we can connect to the local gateway
+ip_check
-GATEWAY_CHECK=$(ping -q -w 1 -c 1 "$(ip r | grep default | cut -d ' ' -f 3)" > /dev/null && echo ok || echo error)
-echo "Gateway check:" >> $DEBUG_LOG
-echo "$GATEWAY_CHECK" >> $DEBUG_LOG
-echo >> $DEBUG_LOG
 
-compareWhitelist
+daemon_check lighttpd http
-compareBlacklist
+daemon_check dnsmasq domain
-testNslookup
 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
-	#cat "$PIHOLECONFFILE" >> $DEBUG_LOG
-	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 lighttpd.conf to debug log..."
+header_write "Analyzing gravity.list"
-echo "#######################################" >> $DEBUG_LOG
-echo "############ lighttpd.conf ############" >> $DEBUG_LOG
-echo "#######################################" >> $DEBUG_LOG
-if [ -e "$LIGHTTPDFILE" ]
-then
-	#cat "$PIHOLECONFFILE" >> $DEBUG_LOG
-	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
-
-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
-
-# Write the hostname output to compare against entries in /etc/hosts, which is logged next
-echo "Hostname of this pihole is: " >> $DEBUG_LOG
-hostname >> $DEBUG_LOG
-
-echo "::: Writing hosts file to debug log..."
-echo "#######################################" >> $DEBUG_LOG
-echo "################ Hosts ################" >> $DEBUG_LOG
-echo "#######################################" >> $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
-
-### PiHole application specific logging ###
-echo "::: Writing whitelist to debug log..."
-echo "#######################################" >> $DEBUG_LOG
-echo "############## Whitelist ##############" >> $DEBUG_LOG
-echo "#######################################" >> $DEBUG_LOG
-if [ -e "$WHITELISTFILE" ]
-then
-	cat "$WHITELISTFILE" >> $DEBUG_LOG
-	echo >> $DEBUG_LOG
-else
-	echo "No whitelist.txt file found!" >> $DEBUG_LOG
-	printf ":::\tNo whitelist.txt file found!\n"
-fi
-
-echo "::: Writing blacklist to debug log..."
-echo "#######################################" >> $DEBUG_LOG
-echo "############## Blacklist ##############" >> $DEBUG_LOG
-echo "#######################################" >> $DEBUG_LOG
-if [ -e "$BLACKLISTFILE" ]
-then
-	cat "$BLACKLISTFILE" >> $DEBUG_LOG
-	echo >> $DEBUG_LOG
-else
-	echo "No blacklist.txt file found!" >> $DEBUG_LOG
-	printf ":::\tNo blacklist.txt file found!\n"
-fi
-
-echo "::: Writing adlists.list to debug log..."
-echo "#######################################" >> $DEBUG_LOG
-echo "############ adlists.list #############" >> $DEBUG_LOG
-echo "#######################################" >> $DEBUG_LOG
-if [ -e "$ADLISTSFILE" ]
-then
-	cat "$ADLISTSFILE" >> $DEBUG_LOG
-	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 "\nFinishing debug write from interrupt... Quitting!" ; exit 1; }' INT
+	trap '{ echo -e "\n::: Finishing debug write from interrupt... Quitting!" ; exit 1; }' INT
-	echo -e "::: Writing current pihole 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() {
+  local tricorder
 	echo "::: Finshed debugging!"
+	echo "::: The debug log can be uploaded to tricorder.pi-hole.net for sharing with developers only."
+	read -r -p "::: Would you like to upload the log? [y/N] " response
+	case ${response} in
+		[yY][eE][sS]|[yY])
+			tricorder=$(cat /var/log/pihole_debug.log | nc tricorder.pi-hole.net 9999)
+			;;
+		*)
+			echo "::: Log will NOT be uploaded to tricorder."
+			;;
+	esac
+
+	# Check if tricorder.pi-hole.net is reachable and provide token.
+	if [ -n "${tricorder}" ]; then
+		echo "::: Your debug token is : ${tricorder}"
+		echo "::: Please contact the Pi-hole team with your token for assistance."
+		echo "::: Thank you."
+	else
+		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
 
 ### Method calls for additional logging ###

advanced/Scripts/piholeLogFlush.sh

@@ -11,5 +11,5 @@
 # (at your option) any later version.
 
 echo -n "::: Flushing /var/log/pihole.log ..."
-truncate -s 0 /var/log/pihole.log
+echo " " > /var/log/pihole.log
 echo "... done!"

advanced/Scripts/setupLCD.sh

@@ -11,21 +11,6 @@
 # (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 [[ $(dpkg-query -s 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
@@ -44,12 +29,12 @@ getInitSys() {
 # https://github.com/adafruit/Adafruit-PiTFT-Helper/blob/master/adafruit-pitft-helper#L274-L285
 autoLoginPiToConsole() {
 	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
-      $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
 }
@@ -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,166 @@
+#!/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}"
+
+  git -C "${directory}" status --short &> /dev/null
+  return
+}
+
+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 retVal=0
+  # Pull the latest commits
+
+  # Stash all files not tracked for later retrieval
+  git -C "${directory}" stash --all --quiet &> /dev/null || ${retVal}=1
+  # Force a clean working directory for cloning
+  git -C "${directory}" clean --force -d &> /dev/null || ${retVal}=1
+  # Fetch latest changes and apply
+  git -C "${directory}" pull --quiet &> /dev/null || ${retVal}=1
+  return ${retVal}
+}
+
+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/updateDashboard.sh

@@ -1,69 +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
-# Updates the Pi-hole web interface
-#
-# 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.
-
-WEB_INTERFACE_GIT_URL="https://github.com/pi-hole/AdminLTE.git"
-WEB_INTERFACE_DIR="/var/www/html/admin"
-
-main() {
-    prerequisites
-    if ! is_repo; then
-        make_repo
-    fi
-    update_repo
-}
-
-prerequisites() {
-
-    # must be root to update
-    if [[ $EUID -ne 0 ]]; then
-        sudo bash "$0" "$@"
-        exit $?
-    fi
-
-    # web interface must already exist. this is a (lazy)
-    # check to make sure pihole is actually installed.
-    if [ ! -d "$WEB_INTERFACE_DIR" ]; then
-        echo "$WEB_INTERFACE_DIR not found. Exiting."
-        exit 1
-    fi
-
-    if ! type "git" > /dev/null; then
-        apt-get -y install git
-    fi
-}
-
-is_repo() {
-    # if the web interface directory does not have a .git folder
-    # it means its using the master.zip archive from the install
-    # script.
-    if [ ! -d "$WEB_INTERFACE_DIR/.git" ]; then
-        return 1
-    fi
-    return 0
-}
-
-# removes the web interface installed from the master.zip archive and
-# replaces it with the current master branch from github
-make_repo() {
-    # remove the non-repod interface and clone the interface
-    rm -rf $WEB_INTERFACE_DIR
-    git clone "$WEB_INTERFACE_GIT_URL" "$WEB_INTERFACE_DIR"
-}
-
-# pulls the latest master branch from github
-update_repo() {
-    # pull the latest commits
-    cd "$WEB_INTERFACE_DIR"
-    git pull
-}
-
-main

advanced/Scripts/version.sh

@@ -0,0 +1,102 @@
+#!/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
+# 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.
+
+# Flags:
+latest=false
+current=false
+
+DEFAULT="-1"
+
+normalOutput() {
+	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,257 @@
+#!/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 "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,210 +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.
-
-if [[ $# = 0 ]]; then
-    echo "::: Immediately whitelists one or more domains in the hosts file"
-    echo ":::"
-    echo "::: Usage: sudo pihole.sh -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"
-    exit 1
-fi
-
-#globals
-basename=pihole
-piholeDir=/etc/$basename
-adList=$piholeDir/gravity.list
-whitelist=$piholeDir/whitelist.txt
-reload=true
-addmode=true
-force=false
-versbose=true
-
-domList=()
-domToRemoveList=()
-
-piholeIPv6file=/etc/pihole/.useIPv6
-
-# 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%/*}
-
-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 $versbose; then
-		echo -n "::: Adding $1 to $whitelist..."
-	  fi
-	  echo "$1" >> $whitelist
-		modifyHost=true
-		if $versbose; then
-	  	echo " done!"
-	  fi
-	else
-		if $versbose; 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 $versbose; 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 $versbose; 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 [[ -n $piholeIPv6 ]];then
-	    	  echo -n ":::    Un-whitelisting $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 ":::    Un-whitelisting $rdom on IPv4"
-	      	echo "$rdom" | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' >>$adList
-	      	echo " done!"
-	      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 kill -HUP "$dnsmasqPid"
-	else
-		# service not running, start it up
-		sudo service dnsmasq start
-	fi
-	echo " done!"
-}
-
-###################################################
-
-for var in "$@"
-do
-  case "$var" in
-    "-nr"| "--noreload"  ) reload=false;;
-    "-d" | "--delmode"   ) addmode=false;;
-    "-f" | "--force"     ) force=true;;
-    "-q" | "--quiet"     ) versbose=false;;  			
-    *                    ) HandleOther "$var";;
-  esac
-done
-
-PopWhitelistFile
-
-if $modifyHost || $force; then
-	 ModifyHostFile
-else
-  if $versbose; then
-  echo ":::"
-	echo "::: No changes need to be made"
-	exit 1
-	fi
-fi
-
-if $reload; then
-	Reload
-fi

advanced/bash-completion/pihole

@@ -1,10 +1,9 @@
-_pihole() 
+_pihole() {
-{
 	local cur prev opts
 	COMPREPLY=()
 	cur="${COMP_WORDS[COMP_CWORD]}"
 	prev="${COMP_WORDS[COMP_CWORD-1]}"
-    opts="whitelist blacklist debug flush updateDashboard updateGravity setupLCD chronometer uninstall help"
+	opts="admin blacklist chronometer debug disable enable flush help logging query reconfigure restartdns setupLCD status tail uninstall updateGravity updatePihole version whitelist"
 
 	COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
 	return 0

advanced/index.html

@@ -1,4 +1,7 @@
 <html>
+<head>
+<script>window.close();</script>
+</head>
 <body>
 </body>
 </html>

advanced/lighttpd.conf.debian

@@ -12,6 +12,7 @@
 server.modules = (
 	"mod_access",
 	"mod_accesslog",
+	"mod_auth",
 	"mod_expire",
 	"mod_compress",
 	"mod_redirect",
@@ -46,13 +47,20 @@ include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
 # If the URL starts with /admin, it is the Web interface
 $HTTP["url"] =~ "^/admin/" {
 	# Create a response header for debugging using curl -I
-	setenv.add-response-header = ( "X-Pi-hole" => "The Pi-hole Web interface is working!" )
+    setenv.add-response-header = (
+        "X-Pi-hole" => "The Pi-hole Web interface is working!",
+        "X-Frame-Options" => "DENY"
+    )
 }
 
+# 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

@@ -0,0 +1,83 @@
+# 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
+# lighttpd config for Pi-hole
+#
+# 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.
+
+server.modules = (
+	"mod_access",
+	"mod_auth",
+	"mod_fastcgi",
+	"mod_accesslog",
+	"mod_expire",
+	"mod_compress",
+	"mod_redirect",
+	"mod_setenv",
+	"mod_rewrite"
+)
+
+server.document-root        = "/var/www/html"
+server.error-handler-404	= "pihole/index.html"
+server.upload-dirs          = ( "/var/cache/lighttpd/uploads" )
+server.errorlog             = "/var/log/lighttpd/error.log"
+server.pid-file             = "/var/run/lighttpd.pid"
+server.username             = "lighttpd"
+server.groupname            = "lighttpd"
+server.port                 = 80
+accesslog.filename			= "/var/log/lighttpd/access.log"
+accesslog.format			= "%{%s}t|%V|%r|%s|%b"
+
+
+index-file.names            = ( "index.php", "index.html", "index.lighttpd.html" )
+url.access-deny             = ( "~", ".inc" )
+static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
+
+compress.cache-dir          = "/var/cache/lighttpd/compress/"
+compress.filetype           = ( "application/javascript", "text/css", "text/html", "text/plain" )
+
+mimetype.assign   = ( ".png"  => "image/png",
+                      ".jpg"  => "image/jpeg",
+                      ".jpeg" => "image/jpeg",
+                      ".html" => "text/html",
+                      ".css" => "text/css; charset=utf-8",
+                      ".js" => "application/javascript",
+                      ".json" => "application/json",
+                      ".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
+#include_shell "/usr/share/lighttpd/create-mime.assign.pl"
+#include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
+
+fastcgi.server = ( ".php" =>
+                   ( "localhost" =>
+                     (
+                       "socket" => "/tmp/php-fastcgi.socket",
+                       "bin-path" => "/usr/bin/php-cgi"
+                     )
+                   )
+                 )
+
+# If the URL starts with /admin, it is the Web interface
+$HTTP["url"] =~ "^/admin/" {
+	# Create a response header for debugging using curl -I
+	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." )
+}
+
+# Add user chosen options held in external file
+include_shell "cat external.conf 2>/dev/null"

advanced/pihole.cron

@@ -8,19 +8,20 @@
 # 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.
+PATH="$PATH:/usr/local/bin/"
 
 # 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/gravity.sh
+59 1    * * 7   root    pihole updateGravity
 
-# Pi-hole: Update the Web interface shortly after gravity runs
+# Pi-hole: Update Pi-hole! Uncomment to enable auto update
-#          This should also update the version number if it is changed in the dashboard repo
+#30 2    * * 7   root    pihole updatePihole
-30 2    * * 7   root    /usr/local/bin/updateDashboard.sh
 
-# Pi-hole: Parse the log file before it is flushed and save the stats to a database
+# Pi-hole: Flush the log daily at 00:00 so it doesn't get out of control
-#          This will be used for a historical view of your Pi-hole's performance
-#50 23  * * *   root    /usr/local/bin/dailyLog.sh
-
-# Pi-hole: Flush the log daily at 11:58 so it doesn't get out of control
 #          Stats will be viewable in the Web interface thanks to the cron job above
-58 23   * * *   root    /usr/local/bin/piholeLogFlush.sh
+00 00   * * *   root    pihole flush

advanced/pihole.sudo

@@ -0,0 +1,11 @@
+# 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
+# Allows the WebUI to use Pi-hole commands
+#
+# 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.
+

automated install/uninstall.sh

@@ -11,13 +11,13 @@
 # (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
 	# If it isn't, exit because the unnstall cannot complete
-  if [[ $(dpkg-query -s sudo) ]];then
+	if [ -x "$(command -v sudo)" ]; then
 		export SUDO="sudo"
 	else
 		echo "::: Please install sudo or run this as root."
@@ -25,67 +25,96 @@ else
 	fi
 fi
 
-spinner()
+# Compatability
-{
+if [ -x "$(command -v rpm)" ]; then
+	# Fedora Family
+	if [ -x "$(command -v dnf)" ]; then
+		PKG_MANAGER="dnf"
+	else
+		PKG_MANAGER="yum"
+	fi
+	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
+	}
+	package_cleanup() {
+		${SUDO} ${PKG_MANAGER} -y autoremove
+	}
+elif [ -x "$(command -v apt-get)" ]; then
+	# Debian Family
+	PKG_MANAGER="apt-get"
+	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"
+	}
+	package_cleanup() {
+		${SUDO} ${PKG_MANAGER} -y autoremove
+		${SUDO} ${PKG_MANAGER} -y autoclean
+	}
+else
+	echo "OS distribution not supported"
+	exit
+fi
+
+spinner() {
 	local pid=$1
 	local delay=0.50
 	local spinstr='/-\|'
-    while [ "$(ps a | awk '{print $1}' | grep "$pid")" ]; do
+	while [ "$(ps a | awk '{print $1}' | grep "${pid}")" ]; do
 		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"
 	done
 	printf "    \b\b\b\b"
 }
 
-function removeAndPurge {
+removeAndPurge() {
 	# Purge dependencies
 	echo ":::"
-	# Nate 3/28/2016 - Removed `php5-cgi` and `php5` as they are removed with php5-common
+	for i in "${PIHOLE_DEPS[@]}"; do
-	dependencies=( dnsutils bc toilet figlet dnsmasq lighttpd php5-common git curl unzip wget )
+		package_check ${i} > /dev/null
-	for i in "${dependencies[@]}"; do
+		if [ $? -eq 0 ]; then
-		if [ "$(dpkg-query -W --showformat='${Status}\n' "$i" 2> /dev/null | grep -c "ok installed")" -eq 1 ]; 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
+				case ${yn} in
-					[Yy]* ) printf ":::\tRemoving %s..." "$i"; $SUDO apt-get -y remove --purge "$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
 
 	# Remove dependency config files
 	echo "::: Removing dnsmasq config files..."
-	$SUDO rm /etc/dnsmasq.conf /etc/dnsmasq.conf.orig /etc/dnsmasq.d/01-pihole.conf &> /dev/null
+	${SUDO} rm /etc/dnsmasq.conf /etc/dnsmasq.conf.orig /etc/dnsmasq.d/01-pihole.conf &> /dev/null
 
 	# Take care of any additional package cleaning
-	printf "::: Auto removing remaining dependencies..."
+	printf "::: Auto removing & cleaning remaining dependencies..."
-	$SUDO apt-get -y autoremove &> /dev/null & spinner $!; printf "done!\n";
+	package_cleanup &> /dev/null & spinner $!; printf "done!\n";
-	printf "::: Auto cleaning remaining dependencies..."
-	$SUDO apt-get -y autoclean &> /dev/null & spinner $!; printf "done!\n";
 
 	# Call removeNoPurge to remove PiHole specific files
 	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..."
-	$SUDO rm -rf /var/www/html/admin &> /dev/null
+	${SUDO} rm -rf /var/www/html/admin &> /dev/null
-	$SUDO rm -rf /var/www/html/pihole &> /dev/null
+	${SUDO} rm -rf /var/www/html/pihole &> /dev/null
-	$SUDO rm /var/www/html/index.lighttpd.orig &> /dev/null
+	${SUDO} rm /var/www/html/index.lighttpd.orig &> /dev/null
 
 	# If the web directory is empty after removing these files, then the parent html folder can be removed.
 	if [ -d "/var/www/html" ]; then
 		if [[ ! "$(ls -A /var/www/html)" ]]; then
-    			$SUDO rm -rf /var/www/html &> /dev/null
+    			${SUDO} rm -rf /var/www/html &> /dev/null
 		fi
 	fi
 
@@ -95,34 +124,42 @@ function removeNoPurge {
 	# preserved.
 	if [[ -f /etc/crontab.orig ]]; then
 		echo "::: Initial Pi-hole cron detected.  Restoring the default system cron..."
-		$SUDO mv /etc/crontab /etc/crontab.pihole
+		${SUDO} mv /etc/crontab /etc/crontab.pihole
-		$SUDO mv /etc/crontab.orig /etc/crontab
+		${SUDO} mv /etc/crontab.orig /etc/crontab
-		$SUDO service cron restart
+		${SUDO} service cron restart
 	fi
 
 	# Attempt to preserve backwards compatibility with older versions
 	if [[ -f /etc/cron.d/pihole ]];then
 		echo "::: Removing cron.d/pihole..."
-		$SUDO rm /etc/cron.d/pihole &> /dev/null
+		${SUDO} rm /etc/cron.d/pihole &> /dev/null
 	fi
 
 	echo "::: Removing config files and scripts..."
-	if [ ! "$(dpkg-query -W --showformat='${Status}\n' lighttpd 2> /dev/null | grep -c "ok installed")" -eq 1 ]; then
+	package_check lighttpd > /dev/null
-		$SUDO rm -rf /etc/lighttpd/ &> /dev/null
+	if [ $? -eq 1 ]; then
+		${SUDO} rm -rf /etc/lighttpd/ &> /dev/null
 	else
 		if [ -f /etc/lighttpd/lighttpd.conf.orig ]; then
-			$SUDO mv /etc/lighttpd/lighttpd.conf.orig /etc/lighttpd/lighttpd.conf
+			${SUDO} mv /etc/lighttpd/lighttpd.conf.orig /etc/lighttpd/lighttpd.conf
 		fi
 	fi
 
-	$SUDO rm /etc/dnsmasq.d/adList.conf &> /dev/null
+	${SUDO} rm /etc/dnsmasq.d/adList.conf &> /dev/null
-	$SUDO rm /etc/dnsmasq.d/01-pihole.conf &> /dev/null
+	${SUDO} rm /etc/dnsmasq.d/01-pihole.conf &> /dev/null
-	$SUDO rm -rf /var/log/*pihole* &> /dev/null
+	${SUDO} rm -rf /var/log/*pihole* &> /dev/null
-	$SUDO rm -rf /etc/pihole/ &> /dev/null
+	${SUDO} rm -rf /etc/pihole/ &> /dev/null
-	$SUDO rm -rf /etc/.pihole/ &> /dev/null
+	${SUDO} rm -rf /etc/.pihole/ &> /dev/null
-	$SUDO rm -rf /opt/pihole/ &> /dev/null
+	${SUDO} rm -rf /opt/pihole/ &> /dev/null
-	$SUDO rm /usr/local/bin/pihole &> /dev/null
+	${SUDO} rm /usr/local/bin/pihole &> /dev/null
-	$SUDO rm /etc/bash_completion.d/pihole
+	${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"
@@ -136,11 +173,9 @@ echo "::: Preparing to remove packages, be sure that each may be safely removed
 echo "::: (SAFE TO REMOVE ALL ON RASPBIAN)"
 while true; do
 	read -rp "::: Do you wish to purge PiHole's dependencies from your OS? (You will be prompted for each package) [y/n]: " yn
-	case $yn in
+	case ${yn} in
 		[Yy]* ) removeAndPurge; break;;
 	
 		[Nn]* ) removeNoPurge; break;;
 	esac
 done
-
-

autotest

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

gravity.sh

@@ -12,97 +12,78 @@
 
 # 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 [[ $(dpkg-query -s sudo) ]];then
-		export SUDO="sudo"
-	else
-		echo "::: Please install sudo or run this script as root."
-		exit 1
-	fi
-fi
 
-piholeIPfile=/tmp/piholeIP
+helpFunc() {
-piholeIPv6file=/etc/pihole/.useIPv6
+	cat << EOM
+::: Pull in domains from adlists
+:::
+::: Usage: pihole -g
+:::
+::: Options:
+:::  -f, --force			Force lists to be downloaded, even if they don't need updating.
+:::  -h, --help				Show this help dialog
+EOM
+	exit 0
+}
+
 
 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
 
-if [[ -f $piholeIPfile ]];then
+#Source the setupVars from install script for the IP
-    # 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
+setupVars=/etc/pihole/setupVars.conf
-    piholeIP=$(cat $piholeIPfile)
+if [[ -f ${setupVars} ]];then
-    rm $piholeIPfile
+	. /etc/pihole/setupVars.conf
 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
+	echo "::: WARNING: /etc/pihole/setupVars.conf missing. Possible installation failure."
-    IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
+	echo ":::          Please run 'pihole -r', and choose the 'reconfigure' option to reconfigure."
-    piholeIPCIDR=$(ip -o -f inet addr show dev "$IPv4dev" | awk '{print $4}' | awk 'END {print}')
+	exit 1
-    piholeIP=${piholeIPCIDR%/*}
 fi
 
-if [[ -f $piholeIPv6file ]];then
+#Remove the /* from the end of the IPv4addr.
-    # If the file exists, then the user previously chose to use IPv6 in the automated installer
+IPV4_ADDRESS=${IPV4_ADDRESS%/*}
-    piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
+IPV6_ADDRESS=${IPV6_ADDRESS}
-fi
 
 # Variables for various stages of downloading and formatting the list
-## Nate 3/26/2016 - Commented unused variables
 basename=pihole
-piholeDir=/etc/$basename
+piholeDir=/etc/${basename}
-adList=$piholeDir/gravity.list
+adList=${piholeDir}/gravity.list
-#blacklist=$piholeDir/blacklist.txt
+localList=${piholeDir}/local.list
-#whitelist=$piholeDir/whitelist.txt
-#latentWhitelist=$piholeDir/latentWhitelist.txt
 justDomainsExtension=domains
-matterandlight=$basename.0.matterandlight.txt
+matterAndLight=${basename}.0.matterandlight.txt
-supernova=$basename.1.supernova.txt
+supernova=${basename}.1.supernova.txt
-eventHorizon=$basename.2.eventHorizon.txt
+preEventHorizon=list.preEventHorizon
-accretionDisc=$basename.3.accretionDisc.txt
+eventHorizon=${basename}.2.supernova.txt
-#eyeOfTheNeedle=$basename.4.wormhole.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
 
-spinner() {
-    local pid=$1
-    local delay=0.50
-    local spinstr='/-|'
-    while [ "$(ps a | awk '{print $1}' | grep "$pid")" ]; do
-        local temp=${spinstr#?}
-        printf " [%c]  " "$spinstr"
-        local spinstr=$temp${spinstr%"$temp"}
-        sleep $delay
-        printf "\b\b\b\b\b\b"
-    done
-    printf "    \b\b\b\b"
-}
-
 ###########################
 # 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.
-	if [ -f $adListFile ]; then
+	if [ -f ${adListFile} ]; then
 		#custom file found, use this instead of default
 		echo -n "::: Custom adList file detected. Reading..."
 		sources=()
 		while read -r line; do
 			#Do not read commented out or blank lines
-			if [[ $line = \#* ]] || [[ ! $line ]]; then
+			if [[ ${line} = \#* ]] || [[ ! ${line} ]]; then
 				echo "" > /dev/null
 			else
-				sources+=($line)
+				sources+=(${line})
 			fi
-		done < $adListFile
+		done < ${adListFile}
 		echo " done!"
 	else
 		#no custom file found, use defaults!
@@ -110,48 +91,48 @@ function gravity_collapse() {
 		sources=()
 		while read -r line; do
 			#Do not read commented out or blank lines
-			if [[ $line = \#* ]] || [[ ! $line ]]; then
+			if [[ ${line} = \#* ]] || [[ ! ${line} ]]; then
 				echo "" > /dev/null
 			else
-				sources+=($line)
+				sources+=(${line})
 			fi
-		done < $adListDefault
+		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
+	success=$2
+	error=$3
+	if [ $success = true ]; then
+		# check if download was successful but list has not been modified
+		if [ "${error}" == "304" ]; then
+			echo ":::   No changes detected, transport skipped!"
 		# check if the patternbuffer is a non-zero length file
-	if [[ -s "$patternBuffer" ]];then
+		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.
-		cp "$patternBuffer" "$saveLocation"
+			mv "${patternBuffer}" "${saveLocation}"
-		echo " List updated, transport successful!"
+			echo ":::   List updated, transport successful!"
 		else
-		# curl didn't download any host files, probably because of the date check
+			# Empty file -> use previously downloaded list
-		echo " No changes detected, transport skipped!"
+			echo ":::   Received empty file, using cached one (list not updated!)"
+		fi
+	else
+		# check if cached list exists
+		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
@@ -159,42 +140,55 @@ function gravity_transport() {
 	# tmp file, so we don't have to store the (long!) lists in RAM
 	patternBuffer=$(mktemp)
 	heisenbergCompensator=""
-	if [[ -r $saveLocation ]]; then
+	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 $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]}
 		# 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
-        saveLocation=$piholeDir/list.$i.$domain.$justDomainsExtension
+		saveLocation=${piholeDir}/list.${i}.${domain}.${justDomainsExtension}
-        activeDomains[$i]=$saveLocation
+		activeDomains[$i]=${saveLocation}
 
 		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
+		case "${domain}" in
 			"adblock.mahakala.is")
-                agent='Mozilla/5.0 (X11; Linux x86_64; rv:30.0) Gecko/20100101 Firefox/30.0'
+			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/"
 		    ;;
 
@@ -205,117 +199,164 @@ function gravity_spinup() {
             # Default is a simple request
             *) cmd_ext=""
         esac
+        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 & spinner $!
+	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 & spinner $!
+	    numBlacklisted=$(wc -l < "${blacklistFile}")
-
-	numBlacklisted=$(wc -l < "/etc/pihole/blacklist.txt")
 	    plural=; [[ "$numBlacklisted" != "1" ]] && plural=s
-	echo " $numBlacklisted domain${plural} blacklisted!"
+	    echo -n "::: Blacklisting $numBlacklisted domain${plural}..."
+	    cat ${blacklistFile} >> ${piholeDir}/${eventHorizon}
+	    echo " done!"
+	else
+	    echo "::: Nothing to blacklist!"
+	fi
+
 }
 
-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 & spinner $!
+	${whitelistScript} -nr -q "${urls[@]}" > /dev/null
-	numWhitelisted=$(wc -l < "/etc/pihole/whitelist.txt")
+
+    # Check whitelist.txt exists.
+	if [[ -f "${whitelistFile}" ]]; then
+        # Remove anything in whitelist.txt from the Event Horizon
+        numWhitelisted=$(wc -l < "${whitelistFile}")
         plural=; [[ "$numWhitelisted" != "1" ]] && plural=s
-	echo " $numWhitelisted domain${plural} whitelisted!"
+        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  & spinner $!
+	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)
-	# 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
+	elif [ -x "$(command -v hostname)" ]; then
-	if [[ -n $piholeIPv6 ]];then
+		hostname=$(hostname -f)
-		# 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 "$piholeIP $hostname\n$piholeIPv6 $hostname\n$piholeIP pi.hole\n$piholeIPv6 pi.hole" > $piholeDir/$accretionDisc
-		cat $piholeDir/$eventHorizon | awk -v ipv4addr="$piholeIP" -v ipv6addr="$piholeIPv6" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> $piholeDir/$accretionDisc
 	else
-		# Otherwise, just create gravity.list as normal using IPv4
+		echo "::: Error: Unable to determine fully qualified domain name of host"
-		# 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)
+	fi
-		echo -e "$piholeIP $hostname\n$piholeIP pi.hole" > $piholeDir/$accretionDisc
+  # Check vars from setupVars.conf to see if we're using IPv4, IPv6, Or both.
-		cat $piholeDir/$eventHorizon | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' >> $piholeDir/$accretionDisc
+  if [[ -n "${IPV4_ADDRESS}" && -n "${IPV6_ADDRESS}" ]];then
+
+      echo -e "${IPV4_ADDRESS} ${hostname}\n${IPV6_ADDRESS} ${hostname}\n${IPV4_ADDRESS} pi.hole\n${IPV6_ADDRESS} pi.hole" > ${localList}
+      # Both IPv4 and IPv6
+      cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPV4_ADDRESS" -v ipv6addr="$IPV6_ADDRESS" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc}
+
+  elif [[ -n "${IPV4_ADDRESS}" && -z "${IPV6_ADDRESS}" ]];then
+
+      echo -e "${IPV4_ADDRESS} ${hostname}\n${IPV4_ADDRESS} pi.hole" > ${localList}
+      # 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
+	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
 	# It also helps with debugging so each stage of the script can be researched more in depth
 	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 & spinner $!
+	#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')
+	#Awk -F splits on given IFS, we grab the right hand side (chops trailing #coments and /'s to grab the domain only.
+	#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)
+	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
@@ -326,28 +367,43 @@ function gravity_reload() {
 	#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 {} \; & spinner $!
+	pihole restartdns
-
-	if [[ $dnsmasqPid ]]; then
-		# service already running - reload config
-		$SUDO kill -HUP "$dnsmasqPid" & spinner $!
-	else
-		# service not running, start it up
-		$SUDO service dnsmasq start & spinner $!
-	fi
 	echo " done!"
 }
 
-$SUDO cp /etc/.pihole/adlists.default /etc/pihole/adlists.default
+for var in "$@"; do
+	case "${var}" in
+		"-f" | "--force"     ) forceGrav=true;;
+		"-h" | "--help"      ) helpFunc;;
+		"-sd" | "--skip-download"    ) skipDownload=true;;
+	esac
+done
+
+if [[ "${forceGrav}" == true ]]; then
+	echo -n "::: Deleting exising list cache..."
+	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
+#cp /etc/.pihole/adlists.default /etc/pihole/adlists.default
 gravity_collapse
 gravity_spinup
+if [[ "${skipDownload}" == false ]]; then
     gravity_Schwarzchild
     gravity_advanced
-gravity_hostFormat
+else
-gravity_blackbody
+    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,87 +10,247 @@
 # 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
+if [[ ! $EUID -eq 0 ]];then
-	echo "::: You are root."
+  if [ -x "$(command -v sudo)" ];then
+    exec sudo bash "$0" "$@"
+    exit $?
   else
-	echo "::: Sudo will be used for this tool."
+    echo "::: sudo is needed to run pihole commands.  Please run this script as root or install sudo."
-  # Check if it is actually installed
-  # If it isn't, exit because the pihole cannot be invoked without privileges.
-  if [[ $(dpkg-query -s sudo) ]];then
-		export SUDO="sudo"
-  else
-    echo "::: Please install sudo or run this as root."
     exit 1
   fi
 fi
 
-function whitelistFunc {
+webpageFunc() {
+  /opt/pihole/webpage.sh "$@"
+  exit 0
+}
+
+whitelistFunc() {
+ "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
+  exit 0
+}
+
+blacklistFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
+  exit 0
+}
+
+debugFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/piholeDebug.sh
+  exit 0
+}
+
+flushFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/piholeLogFlush.sh
+  exit 0
+}
+
+updatePiholeFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/update.sh
+  exit 0
+}
+
+reconfigurePiholeFunc() {
+  /etc/.pihole/automated\ install/basic-install.sh --reconfigure
+  exit 0;
+}
+
+updateGravityFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/gravity.sh "$@"
+  exit 0
+}
+
+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
+}
+
+chronometerFunc() {
   shift
-	$SUDO /opt/pihole/whitelist.sh "$@"
+  "${PI_HOLE_SCRIPT_DIR}"/chronometer.sh "$@"
-	exit 1
+  exit 0
 }
 
-function blacklistFunc {
+
+uninstallFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/uninstall.sh
+  exit 0
+}
+
+versionFunc() {
   shift
-	$SUDO /opt/pihole/blacklist.sh "$@"
+  "${PI_HOLE_SCRIPT_DIR}"/version.sh "$@"
-	exit 1
+  exit 0
 }
 
-function debugFunc {
+restartDNS() {
-	$SUDO /opt/pihole/piholeDebug.sh
+  dnsmasqPid=$(pidof dnsmasq)
-	exit 1
+  if [[ ${dnsmasqPid} ]]; then
+    # service already running - reload config
+    if [ -x "$(command -v systemctl)" ]; then
+      systemctl restart dnsmasq
+    else
+      service dnsmasq restart
+    fi
+  else
+    # service not running, start it up
+    if [ -x "$(command -v systemctl)" ]; then
+      systemctl start dnsmasq
+    else
+      service dnsmasq start
+    fi
+  fi
 }
 
-function flushFunc {
+piholeEnable() {
-	$SUDO /opt/pihole/piholeLogFlush.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 updateDashboardFunc {
+piholeLogging() {
-	$SUDO /opt/pihole/updateDashboard.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 updateGravityFunc {
+piholeStatus() {
-	$SUDO /opt/pihole/gravity.sh
+  if [[ $(grep -i "^#addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf) ]] ; then
-	exit 1
+    #list is commented out
+    if [[ "${1}" == "web" ]] ; then
+      echo 0;
+    else
+      echo "::: Pi-hole blocking is Disabled";
+    fi
+  elif [[ $(grep -i "^addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf) ]] ; then
+    #list set
+    if [[ "${1}" == "web" ]] ; then
+      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 setupLCDFunction {
+tailFunc() {
-	$SUDO /opt/pihole/setupLCD.sh
+  echo "Press Ctrl-C to exit"
-	exit 1
+  tail -F /var/log/pihole.log
+  exit 0
 }
 
-function chronometerFunc {
+helpFunc() {
-	$SUDO /opt/pihole/chronometer.sh
+	cat << EOM
-	exit 1
+::: Control all PiHole specific functions!
-}
+:::
-
+::: Usage: pihole [options]
-
+:::		Add -h after -w (whitelist), -b (blacklist), -c (chronometer), or -a (admin)  for more information on usage
-function uninstallFunc {
+:::
-	$SUDO /opt/pihole/uninstall.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.sh [options]"
+:::  -r, reconfigure          Reconfigure or Repair Pi-hole
-    printf ":::\tAdd -h after -w (whitelist), -b (blacklist), or -c (chronometer)  for more information on usage\n"
+:::  -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 ":::  -u, updateDashboard		Update the web dashboard manually"
+:::  -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 ":::  uninstall				Uninstall Pi-Hole from your system!"
+:::  disable                  Disable Pi-Hole DNS Blocking
-    exit 1
+:::                           Blocking can also be disabled only temporarily, e.g.,
+:::                           pihole disable 5m - will disable blocking for 5 minutes
+:::  restartdns               Restart dnsmasq
+EOM
+  exit 0
 }
 
 if [[ $# = 0 ]]; then
@@ -98,16 +258,26 @@ if [[ $# = 0 ]]; then
 fi
 
 # Handle redirecting to specific functions based on arguments
-case "$1" in
+case "${1}" in
   "-w" | "whitelist"            ) whitelistFunc "$@";;
   "-b" | "blacklist"            ) blacklistFunc "$@";;
   "-d" | "debug"                ) debugFunc;;
   "-f" | "flush"                ) flushFunc;;
-"-u" | "updateDashboard"	) updateDashboardFunc;;
+  "-up" | "updatePihole"        ) updatePiholeFunc;;
-"-g" | "updateGravity"		) updateGravityFunc;;
+  "-r"  | "reconfigure"         ) reconfigurePiholeFunc;;
+  "-g" | "updateGravity"        ) updateGravityFunc "$@";;
   "-s" | "setupLCD"             ) setupLCDFunction;;
-"-c" | "chronometer"		) chronometerFunc;;
+  "-c" | "chronometer"          ) chronometerFunc "$@";;
   "-h" | "help"                 ) helpFunc;;
+  "-v" | "version"              ) versionFunc "$@";;
+  "-q" | "query"                ) queryFunc "$@";;
+  "-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