Merge pull request #874 from pi-hole/development

Next release 2.9.5

.codeclimate.yml

@@ -0,0 +1,3 @@
+engines:
+  shellcheck:
+    enabled: true

.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,42 @@
-##### 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?:**
+
+- [] 1 (very unfamiliar)
+- [] 2
+- [] 3
+- [] 4
+- [] 5
+- [] 6
+- [] 7
+- [] 8
+- [] 9
+- [] 10 (very familiar)
+
+---
+**[FEATURE REQUEST | QUESTION | OTHER]:**
+
+_{replace this section with your content or delete if not a FEATURE REQUEST/QUESTION/OTHER}_
+
+**[BUG | ISSUE] Expected Behaviour:**
 
 
-##### Actual Behaviour:
+**[BUG | ISSUE] Actual Behaviour:**
 
 
-##### Steps to reproduce this issue:
+**[BUG | ISSUE] Steps to reproduce:**
+
+-
+-
+-
+-
+
+**(Optional) Debug Log generated by `pihole -d`:**
+
+`http://termbin.com/<something>`
+
+_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,26 @@
-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:
+- [] 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?:**
 
-- 
+- [] 1 (very unfamiliar)
+- [] 2
+- [] 3
+- [] 4
+- [] 5
+- [] 6
+- [] 7
+- [] 8
+- [] 9
+- [] 10 (very familiar)
 
-- 
+---
+_{replace this line with your pull request content}_
 
-@pi-hole/gravity
+
+_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._

.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:
+      - gravity
+  
+  master:
+    approve_by_comment:
+      enabled: true
+    conditions:
+      branches:
+        - master
+    required: 3
+    teams:
+      - gravity

CONTRIBUTING.md

@@ -1,8 +1,37 @@
-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.
-* 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.
-* 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!)
-* 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..
+# Contributors Guide
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+- 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!)
+- Commit Unix line endings.
+- (Optional fun) keep to the theme of Star Trek/black holes/gravity.

README.md

@@ -1,113 +1,125 @@
-# Automated Install 
-##### Designed For Raspberry Pi A+, B, B+, 2, Zero, and 3B (with an Ethernet/Wi-Fi adapter) (Works on most Debian distributions!)
+[![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=3011939)](https://www.bountysource.com/trackers/3011939-pi-hole-pi-hole?utm_source=3011939&utm_medium=shield&utm_campaign=TRACKER_BADGE) [![Code Climate](https://codeclimate.com/github/pi-hole/pi-hole/badges/gpa.svg)](https://codeclimate.com/github/pi-hole/pi-hole)
 
-1. Install Raspbian 
+# Automated Install
 
-2. Run the command below (downloads [this script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) in case you want to read over it first!)
+Designed For Raspberry Pi A+, B, B+, 2, 3B, and Zero (with an Ethernet/Wi-Fi adapter)
+Works on most Debian and CentOS/RHEL based distributions!
 
-### ```curl -L https://install.pi-hole.net | bash```
+1.  Install Raspbian
+2.  Run the command below (downloads [this script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) in case you want to read over it first!)
 
-#### Alternative Semi-Automated install ####
-```
+## `curl -L https://install.pi-hole.net | bash`
+
+### Alternative Semi-Automated install
+
+```bash
 wget -O basic-install.sh https://install.pi-hole.net
 chmod +x basic-install.sh
 ./basic-install.sh
 ```
+
 If you wish to read over the script before running it, then after the `wget` command, do `nano basic-install.sh` to open a text viewer
 
-
-Once installed, [configure your router to have **DHCP clients use the Pi as their DNS server**](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**](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/).
 
 ## How To Install Pi-hole
 
-[![60-second install tutorial](http://i.imgur.com/lVyNWTC.png)](https://www.youtube.com/watch?v=TzFLJqUeirA)
+[![60-second install tutorial](http://i.imgur.com/5TEc3a6.png)](https://www.youtube.com/watch?v=TzFLJqUeirA)
+
+## How It Works
 
-## How Does It Work?
 **Watch the 60-second video below to get a quick overview**
 
-[![Pi-hole exlplained](http://i.imgur.com/qNybJDX.png)](https://youtu.be/L2iVKs0v0Tk)
+[![Pi-hole exlplained](http://i.imgur.com/pG1m937.png)](https://youtu.be/9Eti3xibiho)
 
 ## Pi-hole Is Free, But Powered By Your Donations
-Send a one-time donation or sign up for Optimal.com's service using our link below to provide us with a small portion of the montly fee.
-* ![Paypal](http://i.imgur.com/3muNfxu.png) : [Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
-* ![Flattr](http://i.imgur.com/ZFceFRu.png) : [Donate](https://flattr.com/submit/auto?user_id=jacobsalmela&url=https://github.com/pi-hole/pi-hole)
-* ![Bitcoin](http://i.imgur.com/FIlmOMG.png)  : 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
-* ![Optimal.com](http://i.imgur.com/d4EAYrw.png) : [Optimal.com](http://api.optimal.com/partner/v1.0/bmV0d29ya3xkbnN8OlJhc3BiZXJyeSBQaS1Ib2xl/subscribe?redirect=https%3A%2F%2Fpi-hole.net%2Fthank-you%2F) (we get a small comission)
 
+Send a one-time donation or sign up for Optimal.com's service using our link below to provide us with a small portion of the monthly fee.
+
+-   ![Paypal](http://i.imgur.com/3muNfxu.png) : [Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
+-   ![Flattr](http://i.imgur.com/ZFceFRu.png) : [Donate](https://flattr.com/submit/auto?user_id=jacobsalmela&url=https://github.com/pi-hole/pi-hole)
+-   ![Bitcoin](http://i.imgur.com/FIlmOMG.png) : 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
 
 ## Get Help Or Connect With Us On The Web
 
-- [@The_Pi_Hole](https://twitter.com/The_Pi_Hole)
-- [/r/pihole](https://www.reddit.com/r/pihole/)
-- [Pi-hole YouTube channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w)
-- [Wiki](https://github.com/pi-hole/pi-hole/wiki/Customization)
-- [FAQs](https://pi-hole.net/help/)
-- [![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_Pi_Hole](https://twitter.com/The_Pi_Hole)
+-   [/r/pihole](https://www.reddit.com/r/pihole/)
+-   [Pi-hole YouTube channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w)
+-   [Wiki](https://github.com/pi-hole/pi-hole/wiki/Customization)
+-   [FAQs](https://pi-hole.net/help/)
+-   [![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.
+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)).
+
+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)).
 
 ## 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:
+
+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` or `http://pi.hole/admin`
 
-![Pi-hole Advanced Stats Dashboard](http://i.imgur.com/CQlEnDy.png)
+![Pi-hole Advanced Stats Dashboard](http://i.imgur.com/gTq2GbS.png)
 
 ### Whitelist and blacklist
 
-Domains can be whitelisted and blacklisted using two pre-installed scripts. See [the wiki page](https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting) for more details
-![Whitelist editor in the Web interface](http://i.imgur.com/Anj1GzO.png)
+Domains can be whitelisted and blacklisted using two pre-installed scripts. See [the wiki page](https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting) for more details ![Whitelist editor in the Web interface](http://i.imgur.com/ogu2ewg.png)
 
 ## API
 
 A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON:
-```JSON
+
+```json
 {
-	"domains_being_blocked": "136708",
-	"dns_queries_today": "18108",
-	"ads_blocked_today": "14648",
-	"ads_percentage_today": "80.89"
+    "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`
+
+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)
+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/)
-- [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)
-- [Sky-Hole](http://dlaa.me/blog/post/skyhole)
-- [Pi-hole in the Cloud!](http://blog.codybunch.com/2015/07/28/Pi-Hole-in-the-cloud/)
-- [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)
+
+-   [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)
+-   [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)
+-   [Sky-Hole](http://dlaa.me/blog/post/skyhole)
+-   [Pi-hole in the Cloud!](http://blog.codybunch.com/2015/07/28/Pi-Hole-in-the-cloud/)
+-   [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)
 
 ## Coverage
-- [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)
-- [MacObserver Podcast 585](http://www.macobserver.com/tmo/podcast/macgeekgab-585)
-- [Medium: Block All Ads For $53](https://medium.com/@robleathern/block-ads-on-all-home-devices-for-53-18-a5f1ec139693#.gj1xpgr5d)
-- [MakeUseOf: Adblock Everywhere, The Pi-hole Way](http://www.makeuseof.com/tag/adblock-everywhere-raspberry-pi-hole-way/)
-- [Lifehacker: Turn Your Pi Into An Ad Blocker With A Single Command](http://lifehacker.com/turn-a-raspberry-pi-into-an-ad-blocker-with-a-single-co-1686093533)!
-- [Pi-hole on TekThing](https://youtu.be/8Co59HU2gY0?t=2m)
-- [Pi-hole on Security Now! Podcast](http://www.youtube.com/watch?v=p7-osq_y8i8&t=100m26s)
-- [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/)
+
+-   [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)
+-   [MacObserver Podcast 585](http://www.macobserver.com/tmo/podcast/macgeekgab-585)
+-   [Medium: Block All Ads For $53](https://medium.com/@robleathern/block-ads-on-all-home-devices-for-53-18-a5f1ec139693#.gj1xpgr5d)
+-   [MakeUseOf: Adblock Everywhere, The Pi-hole Way](http://www.makeuseof.com/tag/adblock-everywhere-raspberry-pi-hole-way/)
+-   [Lifehacker: Turn Your Pi Into An Ad Blocker With A Single Command](http://lifehacker.com/turn-a-raspberry-pi-into-an-ad-blocker-with-a-single-co-1686093533)!
+-   [Pi-hole on TekThing](https://youtu.be/8Co59HU2gY0?t=2m)
+-   [Pi-hole on Security Now! Podcast](http://www.youtube.com/watch?v=p7-osq_y8i8&t=100m26s)
+-   [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/)
 
 ## 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.
+
+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

@@ -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
@@ -43,11 +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,41 @@
 # 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                              #
+###############################################################################
+
+address=/pi.hole/@IPv4@
+address=/pi.hole/@IPv6@
+
+address=/@HOSTNAME@/@IPv4@
+address=/@HOSTNAME@/@IPv6@
+
 addn-hosts=/etc/pihole/gravity.list
 
-# The following two options make you a better netizen, since they
-# tell dnsmasq to filter out queries which the public DNS cannot
-# answer, and which load the servers (especially the root servers)
-# unnecessarily. If you have a dial-on-demand link they also stop
-# these requests from bringing up the link unnecessarily.
-
-# Never forward plain names (without a dot or domain part)
 domain-needed
-# Never forward addresses in the non-routed address spaces.
+
 bogus-priv
 
-# If you don't want dnsmasq to read /etc/resolv.conf or any other
-# file, getting its servers from this file instead (see below), then
-# uncomment this.
 no-resolv
 
-# Add other name servers here, with domain specs if they are for
-# non-public domains.
 server=@DNS1@
 server=@DNS2@
 
-# If you want dnsmasq to listen for DHCP and DNS requests only on
-# specified interfaces (and the loopback) give the name of the
-# interface (eg eth0) here.
 interface=@INT@
-# Or which to listen on by address (remember to include 127.0.0.1 if
-# you use this.)
-listen-address=127.0.0.1
 
-# Set the cachesize here.
 cache-size=10000
 
-# For debugging purposes, log each DNS query as it passes through
-# dnsmasq.
 log-queries
 log-facility=/var/log/pihole.log
 
-# Normally responses which come from /etc/hosts and the DHCP lease
-# file have Time-To-Live set as zero, which conventionally means
-# do not cache further. If you are happy to trade lower load on the
-# server for potentially stale date, you can set a time-to-live (in
-# seconds) here.
 local-ttl=300
 
-# This allows it to continue functioning without being blocked by syslog, and allows syslog to use dnsmasq for DNS queries without risking deadlock
 log-async

advanced/Scripts/blacklist.sh

@@ -1,237 +0,0 @@
-#!/usr/bin/env bash
-# Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
-# Blacklists domains
-#
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
-
-#rootcheck
-if [[ $EUID -eq 0 ]];then
-	echo "::: You are root."
-else
-	echo "::: sudo will be used."
-	# Check if it is actually installed
-	# If it isn't, exit because the install cannot complete
-	if [[ $(dpkg-query -s sudo) ]];then
-		export SUDO="sudo"
-	else
-		echo "::: Please install sudo or run this script as root."
-		exit 1
-	fi
-fi
-
-function helpFunc()
-{
-	echo "::: Immediately blacklists one or more domains in the hosts file"
-	echo ":::"
-	echo ":::"
-	echo "::: Usage: pihole -b domain1 [domain2 ...]"
-	echo "::: Options:"
-	echo ":::  -d, --delmode			Remove domains from the blacklist"
-	echo ":::  -nr, --noreload			Update blacklist without refreshing dnsmasq"
-	echo ":::  -f, --force				Force updating of the hosts files, even if there are no changes"
-	echo ":::  -q, --quiet				output is less verbose"
-	echo ":::  -h, --help				Show this help dialog"
-	echo ":::  -l, --list				Display your blacklisted domains"
-	exit 1
-}
-
-if [[ $# = 0 ]]; then
-	helpFunc
-fi
-
-#globals
-basename=pihole
-piholeDir=/etc/$basename
-adList=$piholeDir/gravity.list
-blacklist=$piholeDir/blacklist.txt
-reload=true
-addmode=true
-force=false
-verbose=true
-
-domList=()
-domToRemoveList=()
-
-piholeIPfile=/etc/pihole/piholeIP
-piholeIPv6file=/etc/pihole/.useIPv6
-
-if [[ -f $piholeIPfile ]];then
-    # If the file exists, it means it was exported from the installation script and we should use that value instead of detecting it in this script
-    piholeIP=$(cat $piholeIPfile)
-    #rm $piholeIPfile
-else
-    # Otherwise, the IP address can be taken directly from the machine, which will happen when the script is run by the user and not the installation script
-    IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
-    piholeIPCIDR=$(ip -o -f inet addr show dev "$IPv4dev" | awk '{print $4}' | awk 'END {print}')
-    piholeIP=${piholeIPCIDR%/*}
-fi
-
-modifyHost=false
-
-# After setting defaults, check if there's local overrides
-if [[ -r $piholeDir/pihole.conf ]];then
-    echo "::: Local calibration requested..."
-        . $piholeDir/pihole.conf
-fi
-
-
-if [[ -f $piholeIPv6file ]];then
-    # If the file exists, then the user previously chose to use IPv6 in the automated installer
-    piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
-fi
-
-function HandleOther(){
-  #check validity of domain
-	validDomain=$(echo "$1" | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/')
-	if [ -z "$validDomain" ]; then
-		echo "::: $1 is not a valid argument or domain name"
-	else
-	  domList=("${domList[@]}" $validDomain)
-	fi
-}
-
-function PopBlacklistFile(){
-	#check blacklist file exists, and if not, create it
-	if [[ ! -f $blacklist ]];then
-  	  touch $blacklist
-	fi
-	for dom in "${domList[@]}"; do
-	  if "$addmode"; then
-	  	AddDomain "$dom"
-	  else
-	    RemoveDomain "$dom"
-	  fi
-	done
-}
-
-function AddDomain(){
-#| sed 's/\./\\./g'
-	bool=false
-	grep -Ex -q "$1" $blacklist || bool=true
-	if $bool; then
-	  #domain not found in the blacklist file, add it!
-	  if $verbose; then
-	  echo -n "::: Adding $1 to blacklist file..."
-	  fi
-		echo "$1" >> $blacklist
-		modifyHost=true
-		echo " done!"
-	else
-	if $verbose; then
-		echo "::: $1 already exists in $blacklist! No need to add"
-		fi
-	fi
-}
-
-function RemoveDomain(){
-
-  bool=false
-  grep -Ex -q "$1" $blacklist || bool=true
-  if $bool; then
-  	#Domain is not in the blacklist file, no need to Remove
-  	if $verbose; then
-  	echo "::: $1 is NOT blacklisted! No need to remove"
-  	fi
-  else
-    #Domain is in the blacklist file, add to a temporary array
-    if $verbose; then
-    echo "::: Un-blacklisting $dom..."
-    fi
-    domToRemoveList=("${domToRemoveList[@]}" $1)
-    modifyHost=true
-  fi
-}
-
-function ModifyHostFile(){
-	 if $addmode; then
-	    #add domains to the hosts file
-	    if [[ -r $blacklist ]];then
-	      numberOf=$(cat $blacklist | sed '/^\s*$/d' | wc -l)
-        plural=; [[ "$numberOf" != "1" ]] && plural=s
-        echo ":::"
-        echo -n "::: Modifying HOSTS file to blacklist $numberOf domain${plural}..."
-	    	if [[ -n $piholeIPv6 ]];then
-				cat $blacklist | awk -v ipv4addr="$piholeIP" -v ipv6addr="$piholeIPv6" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> $adList
-	      	else
-				cat $blacklist | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' >>$adList
-	      	fi
-	  	fi
-	  else
-		echo ":::"
-	  	for dom in "${domToRemoveList[@]}"
-		do
-	      #we need to remove the domains from the blacklist file and the host file
-			echo "::: $dom"
-			echo -n ":::    removing from HOSTS file..."
-	      	echo "$dom" | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /[^.]'{}'(?!.)/;' $adList
-	      	echo " done!"
-	      	echo -n ":::    removing from blackist.txt..."
-	      	echo "$dom" | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /'{}'(?!.)/;' $blacklist
-	      	echo " done!"
-		done
-	fi
-}
-
-function Reload() {
-	# Reload hosts file
-	echo ":::"
-	echo -n "::: Refresh lists in dnsmasq..."
-
-	dnsmasqPid=$(pidof dnsmasq)
-
-	if [[ $dnsmasqPid ]]; then
-		# service already running - reload config
-		$SUDO killall -s HUP dnsmasq
-	else
-		# service not running, start it up
-		$SUDO service dnsmasq start
-	fi
-	echo " done!"
-}
-
-function DisplayBlist() {
-	verbose=false
-	echo -e " Displaying Gravity Affected Domains \n"
-	count=1
-	while IFS= read -r AD
-	do
-		echo "${count}: $AD"
-		count=$((count+1))
-	done < "$blacklist"
-}
-
-###################################################
-
-for var in "$@"
-do
-  case "$var" in
-    "-nr"| "--noreload"  ) reload=false;;
-    "-d" | "--delmode"   ) addmode=false;;
-    "-f" | "--force"     ) force=true;;
-    "-q" | "--quiet"     ) verbose=false;;
-    "-h" | "--help"	     ) helpFunc;;
-    "-l" | "--list"      ) DisplayBlist;;
-    *                    ) HandleOther "$var";;
-  esac
-done
-
-PopBlacklistFile
-
-if $modifyHost || $force; then
-	ModifyHostFile
-else
-  if $verbose; then
-		echo "::: No changes need to be made"
-	fi
-	exit 1
-fi
-
-if $reload; then
-	Reload
-fi

advanced/Scripts/chronometer.sh

@@ -17,11 +17,11 @@ gravity="/etc/pihole/gravity.list"
 
 today=$(date "+%b %e")
 
-function CalcBlockedDomains(){
+CalcBlockedDomains() {
 	CheckIPv6
-	if [ -e "$gravity" ]; then
+	if [ -e "${gravity}" ]; then
 		#Are we IPV6 or IPV4?
-		if [[ -n $piholeIPv6 ]];then
+		if [[ -n ${piholeIPv6} ]]; then
 			#We are IPV6
 			blockedDomainsTotal=$(wc -l /etc/pihole/gravity.list | awk '{print $1/2}')
 		else
@@ -33,43 +33,43 @@ function CalcBlockedDomains(){
 	fi
 }
 
-function CalcQueriesToday(){
-	if [ -e "$piLog" ];then
-		queriesToday=$(cat "$piLog" | grep "$today" | awk '/query/ {print $6}' | wc -l)
+CalcQueriesToday() {
+	if [ -e "${piLog}" ]; then
+		queriesToday=$(cat "${piLog}" | grep "${today}" | awk '/query/ {print $6}' | wc -l)
 	else
 		queriesToday="Err."
 	fi
 }
 
-function CalcblockedToday(){
-	if [ -e "$piLog" ] && [ -e "$gravity" ];then
-		blockedToday=$(cat $piLog | awk '/\/etc\/pihole\/gravity.list/ && !/address/ {print $6}' | wc -l)
+CalcblockedToday() {
+	if [ -e "${piLog}" ] && [ -e "${gravity}" ];then
+		blockedToday=$(cat ${piLog} | awk '/\/etc\/pihole\/gravity.list/ && !/address/ {print $6}' | wc -l)
 	else
 		blockedToday="Err."
 	fi
 }
 
-function CalcPercentBlockedToday(){
-	if [ "$queriesToday" != "Err." ] && [ "$blockedToday" != "Err." ]; then
-		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=$(sed 's/.\{2\}$//' <<< "$percentBlockedToday")
+CalcPercentBlockedToday() {
+	if [ "${queriesToday}" != "Err." ] && [ "${blockedToday}" != "Err." ]; then
+		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=$(sed 's/.\{2\}$//' <<< "${percentBlockedToday}")
 		else
 			percentBlockedToday=0
 		fi
 	fi
 }
 
-function CheckIPv6(){
+CheckIPv6() {
 	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) }')
+	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(){
+outputJSON() {
 	CalcQueriesToday
 	CalcblockedToday
 	CalcPercentBlockedToday
@@ -79,9 +79,8 @@ function outputJSON(){
 	printf '{"domains_being_blocked":"%s","dns_queries_today":"%s","ads_blocked_today":"%s","ads_percentage_today":"%s"}\n' "$blockedDomainsTotal" "$queriesToday" "$blockedToday" "$percentBlockedToday"
 }
 
-function normalChrono(){
-	for (( ; ; ))
-	do
+normalChrono() {
+	for (( ; ; )); do
 		clear
 		# Displays a colorful Pi-hole logo
 		echo " ___ _     _        _"
@@ -111,26 +110,27 @@ function normalChrono(){
 
 		CalcBlockedDomains
 
-		echo "Blocking:      $blockedDomainsTotal"
+		echo "Blocking:      ${blockedDomainsTotal}"
 		#below commented line does not add up to todaysQueryCount
 		#echo "Queries:       $todaysQueryCountV4 / $todaysQueryCountV6"
-		echo "Queries:       $queriesToday" #same total calculation as dashboard
-	  echo "Pi-holed:      $blockedToday ($percentBlockedToday%)"
+		echo "Queries:       ${queriesToday}" #same total calculation as dashboard
+	  echo "Pi-holed:      ${blockedToday} (${percentBlockedToday}%)"
 
 		sleep 5
 	done
 }
 
-function displayHelp(){
- 	echo "::: Displays stats about your piHole!"
-    echo ":::"
-    echo "::: Usage: sudo pihole -c [optional:-j]"
-    echo "::: Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds"
-    echo ":::"
-    echo "::: Options:"
-    echo ":::  -j, --json		output stats as JSON formatted string"
-    echo ":::  -h, --help		display this help text"
-
+displayHelp() {
+	cat << EOM
+::: Displays stats about your piHole!
+:::
+::: Usage: sudo pihole -c [optional:-j]
+::: Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds
+:::
+::: Options:
+:::  -j, --json		output stats as JSON formatted string
+:::  -h, --help		display this help text
+EOM
     exit 1
 }
 
@@ -138,11 +138,10 @@ if [[ $# = 0 ]]; then
 	normalChrono
 fi
 
-for var in "$@"
-do
-  case "$var" in
-    "-j" | "--json"  ) outputJSON;;
-    "-h" | "--help"  ) displayHelp;;
-    *                ) exit 1;;
-  esac
+for var in "$@"; do
+	case "$var" in
+		"-j" | "--json"  ) outputJSON;;
+		"-h" | "--help"  ) displayHelp;;
+		*                ) exit 1;;
+	esac
 done

advanced/Scripts/list.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
+# 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 1
+}
+
+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
+}
+
+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"
+
+	bool=true
+	#Is the domain in the list we want to add it to?
+	grep -Ex -q "$1" ${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"
+
+    bool=true
+    #Is it in the other list? Logic follows that if its whitelisted it should not be blacklisted and vice versa
+    grep -Ex -q "$1" ${list} > /dev/null 2>&1 || bool=false
+    if [[ "${bool}" == true ]]; then
+        # Remove it from the other one
+        echo "::: Removing $1 from $list..."
+        echo "$1" | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /'{}'(?!.)/;' ${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,336 +3,393 @@
 # (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
-# nate@ubiquisoft.com
-# 3/24/2016
+set -o pipefail
 
 ######## GLOBAL VARS ########
+VARSFILE="/etc/pihole/setupVars.conf"
 DEBUG_LOG="/var/log/pihole_debug.log"
 DNSMASQFILE="/etc/dnsmasq.conf"
-PIHOLECONFFILE="/etc/dnsmasq.d/01-pihole.conf"
+DNSMASQCONFFILE="/etc/dnsmasq.d/01-pihole.conf"
 LIGHTTPDFILE="/etc/lighttpd/lighttpd.conf"
 LIGHTTPDERRFILE="/var/log/lighttpd/error.log"
 GRAVITYFILE="/etc/pihole/gravity.list"
-HOSTSFILE="/etc/hosts"
 WHITELISTFILE="/etc/pihole/whitelist.txt"
 BLACKLISTFILE="/etc/pihole/blacklist.txt"
-ADLISTSFILE="/etc/pihole/adlists.list"
+ADLISTFILE="/etc/pihole/adlists.list"
 PIHOLELOG="/var/log/pihole.log"
 WHITELISTMATCHES="/tmp/whitelistmatches.list"
 
+IPV6_READY=false
 
-######## FIRST CHECK ########
-# Must be root to debug
-if [[ $EUID -eq 0 ]]; then
-	echo "::: You are root... Beginning debug!"
-else
-	echo "::: Sudo will be used for debugging."
-	# Check if sudo is actually installed
-	if [[ $(dpkg-query -s sudo) ]]; then
-		export SUDO="sudo"
-	else
-		echo "::: Please install sudo or run this as root."
-		exit 1
-	fi
-fi
+# Header info and introduction
+cat << EOM
+::: Beginning Pi-hole debug at $(date)!
+:::
+::: This process collects information from your Pi-hole, and optionally uploads
+::: it to a unique and random directory on tricorder.pi-hole.net.
+:::
+::: NOTE: All log files auto-delete after 24 hours and ONLY the Pi-hole developers
+::: can access your data via the given token. We have taken these extra steps to
+::: secure your data and will work to further reduce any personal information gathered.
+:::
+::: Please read and note any issues, and follow any directions advised during this process.
+EOM
 
 # Ensure the file exists, create if not, clear if exists.
-if [ ! -f "$DEBUG_LOG" ]; then
-	$SUDO touch $DEBUG_LOG
-	$SUDO chmod 644 $DEBUG_LOG
-	$SUDO chown "$USER":root $DEBUG_LOG
-else 
-	truncate -s 0 $DEBUG_LOG
-fi
+truncate --size=0 "${DEBUG_LOG}"
+chmod 644 ${DEBUG_LOG}
+chown "$USER":pihole ${DEBUG_LOG}
+
+source ${VARSFILE}
 
 ### Private functions exist here ###
-function versionCheck {
-	echo "#######################################" >> $DEBUG_LOG
-	echo "########## Versions Section ###########" >> $DEBUG_LOG
-	echo "#######################################" >> $DEBUG_LOG
-	
-	TMP=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
-	echo "Pi-hole Version: $TMP" >> $DEBUG_LOG
-	
-	TMP=$(cd /var/www/html/admin && git describe --tags --abbrev=0)
-	echo "WebUI Version: $TMP" >> $DEBUG_LOG
-	echo >> $DEBUG_LOG
+log_write() {
+    echo "${1}" >> "${DEBUG_LOG}"
 }
 
-function compareWhitelist {
-	if [ ! -f "$WHITELISTMATCHES" ]; then
-		$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 ":::"
+}
+
+source_file() {
+  local file_found=$(files_check "${1}") \
+   && (source "${1}" &> /dev/null && echo "${file_found} and was successfully sourced") \
+   || log_echo -l "${file_found} and could not be sourced"
+}
+
+distro_check() {
+  local soft_fail
+  header_write "Detecting installed OS Distribution"
+  soft_fail=0
+	local distro="$(cat /etc/*release)" && block_parse "${distro}" || (log_echo "Distribution details not found." && soft_fail=1)
+	return "${soft_fail}"
+}
+
+processor_check() {
+  header_write "Checking processor variety"
+  log_write $(uname -m) && return 0 || return 1
+}
+
+ipv6_check() {
+  # Check if system is IPv6 enabled, for use in other functions
+  if [[ $IPv6_address ]]; then
+    ls /proc/net/if_inet6 &>/dev/null && IPV6_READY=true
+    return 0
+  else
+    return 1
+  fi
+}
+
+
+ip_check() {
+	header_write "IP Address Information"
+	# Get the current interface for Internet traffic
+
+	# Check if IPv6 enabled
+	local IPv6_interface
+	local IPv4_interface
+	ipv6_check &&	IPv6_interface=${piholeInterface:-$(ip -6 r | grep default | cut -d ' ' -f 5)}
+	# If declared in setupVars.conf use it, otherwise defer to default
+	# http://stackoverflow.com/questions/2013547/assigning-default-values-to-shell-variables-with-a-single-command-in-bash
+  IPv4_interface=${piholeInterface:-$(ip r | grep default | cut -d ' ' -f 5)}
+
+
+  if [[ IPV6_READY ]]; then
+    local IPv6_addr_list="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet6") print $(i+1) }')" \
+	  && (log_write "${IPv6_addr_list}" && echo ":::       IPv6 addresses located") \
+	  || log_echo "No IPv6 addresses found."
+
+    local IPv6_def_gateway=$(ip -6 r | grep default | cut -d ' ' -f 3)
+    if [[ $? = 0 ]] && [[ -n ${IPv6_def_gateway} ]]; then
+      echo -n ":::        Pinging default IPv6 gateway: "
+      local IPv6_def_gateway_check="$(ping6 -q -W 3 -c 3 -n "${IPv6_def_gateway}" -I "${IPv6_interface}"| tail -n3)" \
+      && echo "Gateway Responded." \
+      || echo "Gateway did not respond."
+      block_parse "${IPv6_def_gateway_check}"
+
+      echo -n ":::        Pinging Internet via IPv6: "
+      local IPv6_inet_check=$(ping6 -q -W 3 -c 3 -n 2001:4860:4860::8888 -I "${IPv6_interface}"| tail -n3) \
+      && echo "Query responded." \
+      || echo "Query did not respond."
+      block_parse "${IPv6_inet_check}"
+    else
+      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
 
-	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
+  fi
 }
 
-function compareBlacklist {
-	echo "#######################################" >> $DEBUG_LOG
-	echo "######## Blacklist Comparison #########" >> $DEBUG_LOG
-	echo "#######################################" >> $DEBUG_LOG
-	while read -r line; do
-		if [ ! -z "$line" ]; then
-			grep -w ".* $line$" "$GRAVITYFILE" >> $DEBUG_LOG
-		fi
-	done < "$BLACKLISTFILE"
-	echo >> $DEBUG_LOG
+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"
 }
 
-function testNslookup {
-	TESTURL="doubleclick.com"
-	echo "#######################################" >> $DEBUG_LOG
-	echo "############ NSLookup Test ############" >> $DEBUG_LOG
-	echo "#######################################" >> $DEBUG_LOG
+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
-						TESTURL="$CUTURL"
+					if [ "${CUTURL}" != "${CUTURL2}" ]; then
+						TESTURL="${CUTURL}"
 						break 2
 					fi
-				done < "$WHITELISTMATCHES"
+				done < "${WHITELISTMATCHES}"
 			fi
-		done < "$GRAVITYFILE"
+		done < "${GRAVITYFILE}"
 	fi
 
-	echo "NSLOOKUP of $TESTURL from PiHole:" >> $DEBUG_LOG
-	nslookup "$TESTURL" >> $DEBUG_LOG
-	echo >> $DEBUG_LOG
-	echo "NSLOOKUP of $TESTURL from 8.8.8.8:" >> $DEBUG_LOG
-	nslookup "$TESTURL" 8.8.8.8 >> $DEBUG_LOG
-	echo >> $DEBUG_LOG
+	log_write "Resolution of ${TESTURL} from Pi-hole:"
+	LOCALDIG=$(dig "${TESTURL}" @127.0.0.1)
+	if [[ $? = 0 ]]; then
+		log_write "${LOCALDIG}"
+	else
+		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 {
-	echo "#######################################" >> $DEBUG_LOG
-	echo "########### Processes Check ###########" >> $DEBUG_LOG
-	echo "#######################################" >> $DEBUG_LOG
-	echo ":::"
-	echo "::: Logging status of lighttpd and dnsmasq..."
+checkProcesses() {
+	header_write "Processes Check"
+
+	echo ":::     Logging status of lighttpd and dnsmasq..."
 	PROCESSES=( lighttpd dnsmasq )
-	for i in "${PROCESSES[@]}"
-	do
-		echo "" >> $DEBUG_LOG
-		echo -n "$i" >> "$DEBUG_LOG"
-		echo " processes status:" >> $DEBUG_LOG
-		$SUDO systemctl -l status "$i" >> "$DEBUG_LOG"
+	for i in "${PROCESSES[@]}"; do
+		log_write ""
+		log_write "${i}"
+		log_write " processes status:"
+		systemctl -l status "${i}" >> "${DEBUG_LOG}"
 	done
+	log_write ""
 }
 
-function debugLighttpd {
-	echo "::: Writing lighttpd to debug log..."
-	echo "#######################################" >> $DEBUG_LOG
-	echo "############ lighttpd.conf ############" >> $DEBUG_LOG
-	echo "#######################################" >> $DEBUG_LOG
-	if [ -e "$LIGHTTPDFILE" ]
-	then
-		while read -r line; do
-			if [ ! -z "$line" ]; then
-				[[ "$line" =~ ^#.*$ ]] && continue
-				echo "$line" >> $DEBUG_LOG
-			fi
-		done < "$LIGHTTPDFILE"
-		echo >> $DEBUG_LOG
-	else
-		echo "No lighttpd.conf file found!" >> $DEBUG_LOG
-		printf ":::\tNo lighttpd.conf file found\n"
-	fi
-	
-	if [ -e "$LIGHTTPDERRFILE" ]
-	then
-		echo "#######################################" >> $DEBUG_LOG
-		echo "######### lighttpd error.log ##########" >> $DEBUG_LOG
-		echo "#######################################" >> $DEBUG_LOG
-		cat "$LIGHTTPDERRFILE" >> $DEBUG_LOG
-	else
-		echo "No lighttpd error.log file found!" >> $DEBUG_LOG
-		printf ":::\tNo lighttpd error.log file found\n"
-	fi
-	echo >> $DEBUG_LOG
+debugLighttpd() {
+  echo ":::     Checking for necessary lighttpd files."
+  files_check "${LIGHTTPDFILE}"
+  files_check "${LIGHTTPDERRFILE}"
+  echo ":::"
 }
 
 ### END FUNCTIONS ###
 
-### Check Pi internet connections ###
-# Log the IP addresses of this Pi
-IPADDR=$($SUDO ifconfig | perl -nle 's/dr:(\S+)/print $1/e')
-echo "::: Writing local IPs to debug log"
-echo "IP Addresses of this Pi:" >> $DEBUG_LOG
-echo "$IPADDR" >> $DEBUG_LOG
-echo >> $DEBUG_LOG
+# Gather version of required packages / repositories
+version_check || echo "REQUIRED FILES MISSING"
+# Check for newer setupVars storage file
+source_file "/etc/pihole/setupVars.conf"
+# Gather information about the running distribution
+distro_check || echo "Distro Check soft fail"
+# Gather processor type
+processor_check || echo "Processor Check soft fail"
 
-# Check if we can connect to the local gateway
-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
+ip_check
 
-versionCheck
-compareWhitelist
-compareBlacklist
-testNslookup
+daemon_check lighttpd http
+daemon_check dnsmasq domain
 checkProcesses
+testResolver
 debugLighttpd
 
-echo "::: Writing dnsmasq.conf to debug log..."
-echo "#######################################" >> $DEBUG_LOG
-echo "############### Dnsmasq ###############" >> $DEBUG_LOG
-echo "#######################################" >> $DEBUG_LOG
-if [ -e "$DNSMASQFILE" ]
-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
+files_check "${DNSMASQFILE}"
+files_check "${DNSMASQCONFFILE}"
+files_check "${WHITELISTFILE}"
+files_check "${BLACKLISTFILE}"
+files_check "${ADLISTFILE}"
 
-echo "::: Writing 01-pihole.conf to debug log..."
-echo "#######################################" >> $DEBUG_LOG
-echo "########### 01-pihole.conf ############" >> $DEBUG_LOG
-echo "#######################################" >> $DEBUG_LOG
-if [ -e "$PIHOLECONFFILE" ]
-then
-	while read -r line; do
-		if [ ! -z "$line" ]; then
-			[[ "$line" =~ ^#.*$ ]] && continue
-			echo "$line" >> $DEBUG_LOG
-        fi
-	done < "$PIHOLECONFFILE"
-	echo >> $DEBUG_LOG
-else
-	echo "No 01-pihole.conf file found!" >> $DEBUG_LOG
-	printf ":::\tNo 01-pihole.conf file found\n"
-fi
 
-echo "::: Writing size of gravity.list to debug log..."
-echo "#######################################" >> $DEBUG_LOG
-echo "############ gravity.list #############" >> $DEBUG_LOG
-echo "#######################################" >> $DEBUG_LOG
-if [ -e "$GRAVITYFILE" ]
-then
-	wc -l "$GRAVITYFILE" >> $DEBUG_LOG
-	echo >> $DEBUG_LOG
-else
-	echo "No gravity.list file found!" >> $DEBUG_LOG
-	printf ":::\tNo gravity.list file found\n"
-fi
-
-# 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
+header_write "Analyzing gravity.list"
 
+	gravity_length=$(wc -l "${GRAVITYFILE}") \
+	&& log_write "${GRAVITYFILE} is ${gravity_length} lines long." \
+	|| log_echo "Warning: No gravity.list file found!"
 
 # Continuously append the pihole.log file to the pihole_debug.log file
-function dumpPiHoleLog {
+dumpPiHoleLog() {
 	trap '{ echo -e "\n::: Finishing debug write from interrupt... Quitting!" ; exit 1; }' INT
-	echo -e "::: Writing current 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 "#######################################" >> $DEBUG_LOG
-	echo "############# pihole.log ##############" >> $DEBUG_LOG
-	echo "#######################################" >> $DEBUG_LOG
-	if [ -e "$PIHOLELOG" ]
-	then
+	echo "::: "
+	echo "::: --= User Action Required =--"
+	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.)"
+	header_write "pihole.log"
+	if [ -e "${PIHOLELOG}" ]; then
 		while true; do
-			tail -f "$PIHOLELOG" >> $DEBUG_LOG
-			echo >> $DEBUG_LOG
+			tail -f "${PIHOLELOG}" >> ${DEBUG_LOG}
+			log_write ""
 		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 {
-	echo "::: Finshed debugging!" 
-	echo "::: Debug log can be found at : /var/log/pihole_debug.log"
+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 to being assistance."
+		echo "::: Thank you."
+	fi
+		echo "::: 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,47 +11,32 @@
 # (at your option) any later version.
 
 ############ FUNCTIONS ###########
-# Run this script as root or under sudo
-echo ":::"
-if [[ $EUID -eq 0 ]];then
-	echo "::: You are root."
-else
-	echo "::: sudo will be used."
-  # Check if it is actually installed
-  # If it isn't, exit because the install cannot complete
-  if [[ $(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
 getInitSys() {
-  if command -v systemctl > /dev/null && systemctl | grep -q '\-\.mount'; then
-    SYSTEMD=1
-  elif [ -f /etc/init.d/cron ] && [ ! -h /etc/init.d/cron ]; then
-    SYSTEMD=0
-  else
-    echo "Unrecognised init system"
-    return 1
-  fi
+	if command -v systemctl > /dev/null && systemctl | grep -q '\-\.mount'; then
+		SYSTEMD=1
+	elif [ -f /etc/init.d/cron ] && [ ! -h /etc/init.d/cron ]; then
+		SYSTEMD=0
+	else
+		echo "Unrecognised init system"
+		return 1
+	fi
 }
 
 # Borrowed from adafruit-pitft-helper:
 # https://github.com/adafruit/Adafruit-PiTFT-Helper/blob/master/adafruit-pitft-helper#L274-L285
 autoLoginPiToConsole() {
-  if [ -e /etc/init.d/lightdm ]; then
-    if [ $SYSTEMD -eq 1 ]; then
-      $SUDO systemctl set-default multi-user.target
-      $SUDO ln -fs /etc/systemd/system/autologin@.service /etc/systemd/system/getty.target.wants/getty@tty1.service
-    else
-      $SUDO 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/"
-      fi
-  fi
+	if [ -e /etc/init.d/lightdm ]; then
+		if [ ${SYSTEMD} -eq 1 ]; then
+			systemctl set-default multi-user.target
+			ln -fs /etc/systemd/system/autologin@.service /etc/systemd/system/getty.target.wants/getty@tty1.service
+		else
+			update-rc.d lightdm disable 2
+			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
 }
 
 ######### SCRIPT ###########
@@ -66,23 +51,23 @@ echo /usr/local/bin/chronometer.sh >> /home/pi/.bashrc
 
 # Set up the LCD screen based on Adafruits instuctions:
 # https://learn.adafruit.com/adafruit-pitft-28-inch-resistive-touchscreen-display-raspberry-pi/easy-install
-curl -SLs https://apt.adafruit.com/add-pin | $SUDO bash
-$SUDO apt-get -y install raspberrypi-bootloader
-$SUDO apt-get -y install adafruit-pitft-helper
-$SUDO adafruit-pitft-helper -t 28r
+curl -SLs https://apt.adafruit.com/add-pin | bash
+apt-get -y install raspberrypi-bootloader
+apt-get -y install adafruit-pitft-helper
+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
-$SUDO curl -o /boot/cmdline.txt https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/cmdline.txt
+mv /boot/cmdline.txt /boot/cmdline.orig
+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
-$SUDO curl -o /etc/default/console-setup https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/console-setup
+mv /etc/default/console-setup /etc/default/console-setup.orig
+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,142 @@
+#!/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.
+
+# Variables
+
+webInterfaceGitUrl="https://github.com/pi-hole/AdminLTE.git"
+webInterfaceDir="/var/www/html/admin"
+piholeGitUrl="https://github.com/pi-hole/pi-hole.git"
+piholeFilesDir="/etc/.pihole"
+
+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"
+}
+
+getGitFiles() {
+	# Setup git repos for directory and repository passed
+	# as arguments 1 and 2
+	echo ":::"
+	echo "::: Checking for existing repository..."
+	if is_repo "${1}"; then
+		update_repo "${1}"
+	else
+		make_repo "${1}" "${2}"
+	fi
+}
+
+is_repo() {
+	# Use git to check if directory is currently under VCS
+	echo -n ":::    Checking $1 is a repo..."
+	cd "${1}" &> /dev/null || return 1
+	git status &> /dev/null && echo " OK!"; return 0 || echo " not found!"; return 1
+}
+
+make_repo() {
+	# Remove the non-repod interface and clone the interface
+	echo -n ":::    Cloning $2 into $1..."
+	rm -rf "${1}"
+	git clone -q --depth 1 "${2}" "${1}" > /dev/null & spinner $!
+	echo " done!"
+}
+
+update_repo() {
+# Pull the latest commits
+	echo -n ":::     Updating repo in $1..."
+	cd "${1}" || exit 1
+	git stash -q > /dev/null & spinner $!
+	git pull -q > /dev/null & spinner $!
+	echo " done!"
+}
+
+if [ ! -d "/etc/.pihole" ]; then #This is unlikely
+	echo "::: Critical Error: Pi-Hole repo missing from system!"
+	echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
+	exit 1;
+fi
+if [ ! -d "/var/www/html/admin" ]; then #This is unlikely
+	echo "::: Critical Error: Pi-Hole repo missing from system!"
+	echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
+	exit 1;
+fi
+
+echo "::: Checking for updates..."
+piholeVersion=$(pihole -v -p -c)
+piholeVersionLatest=$(pihole -v -p -l)
+
+webVersion=$(pihole -v -a -c)
+webVersionLatest=$(pihole -v -a -l)
+
+echo ":::"
+echo "::: Pi-hole version is $piholeVersion (Latest version is $piholeVersionLatest)"
+echo "::: Web Admin version is $webVersion (Latest version is $webVersionLatest)"
+echo ":::"
+
+# 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 [[ ${piholeVersion} == ${piholeVersionLatest} && ${webVersion} == ${webVersionLatest} ]]; then
+	echo "::: Everything is up to date!"
+	echo ""
+	exit 0
+
+elif [[ ${piholeVersion} == ${piholeVersionLatest} && ${webVersion} != ${webVersionLatest} ]]; then
+	echo "::: Pi-hole Web Admin files out of date"
+	getGitFiles ${webInterfaceDir} ${webInterfaceGitUrl}
+	echo ":::"
+	webVersion=$(pihole -v -a -c)
+	echo "::: Web Admin version is now at ${webVersion}"
+	echo "::: If you had made any changes in '/var/www/html/admin', they have been stashed using 'git stash'"
+	echo ""
+elif [[ ${piholeVersion} != ${piholeVersionLatest} && ${webVersion} == ${webVersionLatest} ]]; then
+	echo "::: Pi-hole core files out of date"
+	getGitFiles ${piholeFilesDir} ${piholeGitUrl}
+	/etc/.pihole/automated\ install/basic-install.sh --reconfigure --unattended
+	echo ":::"
+	piholeVersion=$(pihole -v -p -c)
+	echo "::: Pi-hole version is now at ${piholeVersion}"
+	echo "::: If you had made any changes in '/etc/.pihole', they have been stashed using 'git stash'"
+	echo ""
+elif [[ ${piholeVersion} != ${piholeVersionLatest} && ${webVersion} != ${webVersionLatest} ]]; then
+	echo "::: Updating Everything"
+	getGitFiles ${piholeFilesDir} ${piholeGitUrl}
+	/etc/.pihole/automated\ install/basic-install.sh --unattended
+	webVersion=$(pihole -v -a -c)
+	piholeVersion=$(pihole -v -p -c)
+	echo ":::"
+	echo "::: Pi-hole version is now at ${piholeVersion}"
+	echo "::: If you had made any changes in '/etc/.pihole', they have been stashed using 'git stash'"
+	echo ":::"
+	echo "::: Pi-hole version is now at ${piholeVersion}"
+	echo "::: If you had made any changes in '/etc/.pihole', they have been stashed using 'git stash'"
+	echo ""
+fi

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,100 @@
+#!/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
+
+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})"
+	echo "::: Web-Admin version is ${webVersion} (Latest version is ${webVersionLatest})"
+}
+
+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}
+	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)"
+	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}
+	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)"
+	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 1
+}
+
+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/whitelist.sh

@@ -1,251 +0,0 @@
-#!/usr/bin/env bash
-# Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
-# Whitelists domains
-#
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
-
-#rootcheck
-if [[ $EUID -eq 0 ]];then
-	echo "::: You are root."
-else
-	echo "::: sudo will be used."
-	# Check if it is actually installed
-	# If it isn't, exit because the install cannot complete
-	if [[ $(dpkg-query -s sudo) ]];then
-		export SUDO="sudo"
-	else
-		echo "::: Please install sudo or run this script as root."
-		exit 1
-	fi
-fi
-
-function helpFunc()
-{
-	echo "::: Immediately whitelists one or more domains in the hosts file"
-	echo ":::"
-	echo "::: Usage: pihole -w domain1 [domain2 ...]"
-	echo ":::"
-	echo "::: Options:"
-	echo ":::  -d, --delmode			Remove domains from the whitelist"
-	echo ":::  -nr, --noreload			Update Whitelist without refreshing dnsmasq"
-	echo ":::  -f, --force				Force updating of the hosts files, even if there are no changes"
-	echo ":::  -q, --quiet				output is less verbose"
-	echo ":::  -h, --help				Show this help dialog"
-	echo ":::  -l, --list				Display your whitelisted domains"
-	exit 1
-}
-
-if [[ $# = 0 ]]; then
-	helpFunc
-fi
-
-#globals
-basename=pihole
-piholeDir=/etc/$basename
-adList=$piholeDir/gravity.list
-whitelist=$piholeDir/whitelist.txt
-reload=true
-addmode=true
-force=false
-verbose=true
-
-domList=()
-domToRemoveList=()
-
-piholeIPfile=/etc/pihole/piholeIP
-piholeIPv6file=/etc/pihole/.useIPv6
-
-if [[ -f $piholeIPfile ]];then
-    # If the file exists, it means it was exported from the installation script and we should use that value instead of detecting it in this script
-    piholeIP=$(cat $piholeIPfile)
-    #rm $piholeIPfile
-else
-    # Otherwise, the IP address can be taken directly from the machine, which will happen when the script is run by the user and not the installation script
-    IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
-    piholeIPCIDR=$(ip -o -f inet addr show dev "$IPv4dev" | awk '{print $4}' | awk 'END {print}')
-    piholeIP=${piholeIPCIDR%/*}
-fi
-
-modifyHost=false
-
-# After setting defaults, check if there's local overrides
-if [[ -r $piholeDir/pihole.conf ]];then
-    echo "::: Local calibration requested..."
-        . $piholeDir/pihole.conf
-fi
-
-if [[ -f $piholeIPv6file ]];then
-    # If the file exists, then the user previously chose to use IPv6 in the automated installer
-    piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
-fi
-
-function HandleOther(){
-  #check validity of domain
-	validDomain=$(echo "$1" | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/')
-	if [ -z "$validDomain" ]; then
-		echo "::: $1 is not a valid argument or domain name"
-	else
-	  domList=("${domList[@]}" $validDomain)
-	fi
-}
-
-function PopWhitelistFile(){
-	#check whitelist file exists, and if not, create it
-	if [[ ! -f $whitelist ]];then
-  	  touch $whitelist
-	fi
-	for dom in "${domList[@]}"
-	do
-	  if $addmode; then
-	  	AddDomain "$dom"
-	  else
-	    RemoveDomain "$dom"
-	  fi
-	done
-}
-
-function AddDomain(){
-#| sed 's/\./\\./g'
-	bool=false
-
-	grep -Ex -q "$1" $whitelist || bool=true
-	if $bool; then
-	  #domain not found in the whitelist file, add it!
-	  if $verbose; then
-		echo -n "::: Adding $1 to $whitelist..."
-	  fi
-	  echo "$1" >> $whitelist
-		modifyHost=true
-		if $verbose; then
-	  	echo " done!"
-	  fi
-	else
-		if $verbose; then
-			echo "::: $1 already exists in $whitelist, no need to add!"
-		fi
-	fi
-}
-
-function RemoveDomain(){
-
-  bool=false
-  grep -Ex -q "$1" $whitelist || bool=true
-  if $bool; then
-  	#Domain is not in the whitelist file, no need to Remove
-  	if $verbose; then
-  	echo "::: $1 is NOT whitelisted! No need to remove"
-  	fi
-  else
-    #Domain is in the whitelist file, add to a temporary array and remove from whitelist file
-    #if $verbose; then
-    #echo "::: Un-whitelisting $dom..."
-    #fi
-    domToRemoveList=("${domToRemoveList[@]}" $1)
-    modifyHost=true
-  fi
-}
-
-function ModifyHostFile(){
-	 if $addmode; then
-	    #remove domains in  from hosts file
-	    if [[ -r $whitelist ]];then
-        # Remove whitelist entries
-				numberOf=$(cat $whitelist | sed '/^\s*$/d' | wc -l)
-        plural=; [[ "$numberOf" != "1" ]] && plural=s
-        echo ":::"
-        echo -n "::: Modifying HOSTS file to whitelist $numberOf domain${plural}..."
-        awk -F':' '{print $1}' $whitelist | while read -r line; do echo "$piholeIP $line"; done > /etc/pihole/whitelist.tmp
-        awk -F':' '{print $1}' $whitelist | while read -r line; do echo "$piholeIPv6 $line"; done >> /etc/pihole/whitelist.tmp
-        echo "l" >> /etc/pihole/whitelist.tmp
-        grep -F -x -v -f $piholeDir/whitelist.tmp $adList > $piholeDir/gravity.tmp
-        rm $adList
-        mv $piholeDir/gravity.tmp $adList
-        rm $piholeDir/whitelist.tmp
-        echo " done!"
-
-	  	fi
-	  else
-	    #we need to add the removed domains to the hosts file
-	    echo ":::"
-	    echo "::: Modifying HOSTS file to un-whitelist domains..."
-	    for rdom in "${domToRemoveList[@]}"
-	    do
-	    	if [[ -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 killall -s HUP dnsmasq
-	else
-		# service not running, start it up
-		$SUDO service dnsmasq start
-	fi
-	echo " done!"
-}
-
-function DisplayWlist() {
-	verbose=false
-	echo -e " Displaying Gravity Resistant Domains \n"
-	count=1
-	while IFS= read -r RD
-	do
-		echo "${count}: $RD"
-		count=$((count+1))
-	done < "$whitelist"
-}
-
-###################################################
-
-for var in "$@"
-do
-  case "$var" in
-    "-nr"| "--noreload"  ) reload=false;;
-    "-d" | "--delmode"   ) addmode=false;;
-    "-f" | "--force"     ) force=true;;
-    "-q" | "--quiet"     ) verbose=false;;
-    "-h" | "--help"      ) helpFunc;;
-    "-l" | "--list"      ) DisplayWlist;;
-    *                    ) HandleOther "$var";;
-  esac
-done
-
-PopWhitelistFile
-
-if $modifyHost || $force; then
-	 ModifyHostFile
-else
-  if $verbose; then
-	  echo ":::"
-		echo "::: No changes need to be made"
-	fi
-	exit 1
-fi
-
-if $reload; then
-	Reload
-fi

advanced/bash-completion/pihole

@@ -1,12 +1,11 @@
-_pihole() 
-{
-    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"
+_pihole() {
+	local cur prev opts
+	COMPREPLY=()
+	cur="${COMP_WORDS[COMP_CWORD]}"
+	prev="${COMP_WORDS[COMP_CWORD-1]}"
+	opts="blacklist chronometer debug flush help query reconfigure setupLCD uninstall updateGravity updatePihole version whitelist"
 
-    COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
-    return 0
+	COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+	return 0
 }
-complete -F _pihole pihole
+complete -F _pihole pihole

advanced/index.html

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

advanced/lighttpd.conf.debian

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

advanced/lighttpd.conf.fedora

@@ -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,19 @@
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 2 of the License, or
 # (at your option) any later version.
+# 
+# This file is under source-control of the Pi-hole installation and update
+# scripts, any changes made to this file will be overwritten when the softare
+# is updated or re-installed. Please make any changes to the appropriate crontab
+# or other cron file snippets.
 
 # Pi-hole: Update the ad sources once a week on Sunday at 01:59
 #          Download any updates from the adlists
 59 1    * * 7   root    /usr/local/bin/pihole updateGravity
 
-# Pi-hole: Update the Web interface shortly after gravity runs
-#          This should also update the version number if it is changed in the dashboard repo
-30 2    * * 7   root    /usr/local/bin/pihole updateDashboard
+# Pi-hole: Update Pi-hole! Uncomment to enable auto update
+#30 2    * * 7   root    /usr/local/bin/pihole updatePihole
 
-# Pi-hole: Parse the log file before it is flushed and save the stats to a database
-#          This will be used for a historical view of your Pi-hole's performance
-#50 23  * * *   root    /usr/local/bin/dailyLog.sh # note: this is outdated
-
-# Pi-hole: Flush the log daily at 11:58 so it doesn't get out of control
+# Pi-hole: Flush the log daily at 00:00 so it doesn't get out of control
 #          Stats will be viewable in the Web interface thanks to the cron job above
-58 23   * * *   root    /usr/local/bin/pihole flush
+00 00   * * *   root    /usr/local/bin/pihole flush

advanced/selinux/pihole.te

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

automated install/uninstall.sh

@@ -11,81 +11,110 @@
 # (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
+	# Check if it is actually installed
+	# If it isn't, exit because the unnstall cannot complete
+	if [ -x "$(command -v sudo)" ]; then
 		export SUDO="sudo"
-  else
-    echo "::: Please install sudo or run this as root."
-    exit 1
-  fi
+	else
+		echo "::: Please install sudo or run this as root."
+		exit 1
+	fi
 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"
+# 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
+		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"
 }
 
-function removeAndPurge {
+removeAndPurge() {
 	# Purge dependencies
-echo ":::"
-	# Nate 3/28/2016 - Removed `php5-cgi` and `php5` as they are removed with php5-common
-	dependencies=( dnsutils bc dnsmasq lighttpd php5-common git curl unzip wget )
-	for i in "${dependencies[@]}"; do
-		if [ "$(dpkg-query -W --showformat='${Status}\n' "$i" 2> /dev/null | grep -c "ok installed")" -eq 1 ]; then
+	echo ":::"
+	for i in "${PIHOLE_DEPS[@]}"; do
+		package_check ${i} > /dev/null
+		if [ $? -eq 0 ]; then
 			while true; do
-				read -rp "::: Do you wish to remove $i from your system? [y/n]: " yn
-				case $yn in
-					[Yy]* ) printf ":::\tRemoving %s..." "$i"; $SUDO apt-get -y remove --purge "$i" &> /dev/null & spinner $!; printf "done!\n"; break;;
-					[Nn]* ) printf ":::\tSkipping %s" "$i\n"; break;;
+				read -rp "::: Do you wish to remove ${i} from your system? [y/n]: " yn
+				case ${yn} in
+					[Yy]* ) printf ":::\tRemoving %s..." "${i}"; ${SUDO} ${PKG_REMOVE} "${i}" &> /dev/null & spinner $!; printf "done!\n"; break;;
+					[Nn]* ) printf ":::\tSkipping %s" "${i}\n"; 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..."
-	$SUDO apt-get -y autoremove &> /dev/null & spinner $!; printf "done!\n";
-	printf "::: Auto cleaning remaining dependencies..."
-	$SUDO apt-get -y autoclean &> /dev/null & spinner $!; printf "done!\n";
+	printf "::: Auto removing & cleaning remaining dependencies..."
+	package_cleanup &> /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/pihole &> /dev/null
-	$SUDO rm /var/www/html/index.lighttpd.orig &> /dev/null
+	${SUDO} rm -rf /var/www/html/admin &> /dev/null
+	${SUDO} rm -rf /var/www/html/pihole &> /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,35 +124,36 @@ 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.orig /etc/crontab
-		$SUDO service cron restart
+		${SUDO} mv /etc/crontab /etc/crontab.pihole
+		${SUDO} mv /etc/crontab.orig /etc/crontab
+		${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
-		$SUDO rm -rf /etc/lighttpd/ &> /dev/null
+	package_check ${i} > /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/01-pihole.conf &> /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 /opt/pihole/ &> /dev/null
-	$SUDO rm /usr/local/bin/pihole &> /dev/null
-	$SUDO rm /etc/bash_completion.d/pihole &> /dev/null
-	$SUDO rm /etc/sudoers.d/pihole &> /dev/null
+	${SUDO} rm /etc/dnsmasq.d/adList.conf &> /dev/null
+	${SUDO} rm /etc/dnsmasq.d/01-pihole.conf &> /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 /opt/pihole/ &> /dev/null
+	${SUDO} rm /usr/local/bin/pihole &> /dev/null
+	${SUDO} rm /etc/bash_completion.d/pihole &> /dev/null
+	${SUDO} rm /etc/sudoers.d/pihole &> /dev/null
 
 	echo ":::"
 	printf "::: Finished removing PiHole from your system. Sorry to see you go!\n"
@@ -137,11 +167,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
-
-

gravity.sh

@@ -13,83 +13,75 @@
 # 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
+helpFunc() {
+	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 1
+}
 
-piholeIPfile=/etc/pihole/piholeIP
-piholeIPv6file=/etc/pihole/.useIPv6
 
 adListFile=/etc/pihole/adlists.list
 adListDefault=/etc/pihole/adlists.default
-whitelistScript=/opt/pihole/whitelist.sh
-blacklistScript=/opt/pihole/blacklist.sh
+whitelistScript="pihole -w"
+whitelistFile=/etc/pihole/whitelist.txt
+blacklistFile=/etc/pihole/blacklist.txt
 
-if [[ -f $piholeIPfile ]];then
-    # If the file exists, it means it was exported from the installation script and we should use that value instead of detecting it in this script
-    piholeIP=$(cat $piholeIPfile)
-    #rm $piholeIPfile
+#Source the setupVars from install script for the IP
+setupVars=/etc/pihole/setupVars.conf
+if [[ -f ${setupVars} ]];then
+	. /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
-    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%/*}
+	echo "::: WARNING: /etc/pihole/setupVars.conf missing. Possible installation failure."
+	echo ":::          Please run 'pihole -r', and choose the 'reconfigure' option to reconfigure."
+	exit 1
 fi
 
-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
+#Remove the /* from the end of the IPv4addr.
+IPv4_address=${IPv4_address%/*}
 
 # Variables for various stages of downloading and formatting the list
-## Nate 3/26/2016 - Commented unused variables
 basename=pihole
-piholeDir=/etc/$basename
-adList=$piholeDir/gravity.list
-#blacklist=$piholeDir/blacklist.txt
-#whitelist=$piholeDir/whitelist.txt
-#latentWhitelist=$piholeDir/latentWhitelist.txt
+piholeDir=/etc/${basename}
+adList=${piholeDir}/gravity.list
 justDomainsExtension=domains
-matterandlight=$basename.0.matterandlight.txt
-supernova=$basename.1.supernova.txt
-eventHorizon=$basename.2.eventHorizon.txt
-accretionDisc=$basename.3.accretionDisc.txt
-#eyeOfTheNeedle=$basename.4.wormhole.txt
+matterAndLight=${basename}.0.matterandlight.txt
+supernova=${basename}.1.supernova.txt
+preEventHorizon=list.preEventHorizon
+eventHorizon=${basename}.2.supernova.txt
+accretionDisc=${basename}.3.accretionDisc.txt
 
-# After setting defaults, check if there's local overrides
-if [[ -r $piholeDir/pihole.conf ]];then
-    echo "::: Local calibration requested..."
-        . $piholeDir/pihole.conf
+skipDownload=false
+
+# Warn users still using pihole.conf that it no longer has any effect (I imagine about 2 people use it)
+if [[ -r ${piholeDir}/pihole.conf ]]; then
+	echo "::: pihole.conf file no longer supported. Over-rides in this file are ignored."
 fi
 
 ###########################
 # collapse - begin formation of pihole
-function gravity_collapse() {
+gravity_collapse() {
 	echo "::: Neutrino emissions detected..."
 	echo ":::"
 	#Decide if we're using a custom ad block list, or defaults.
-	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!
@@ -97,39 +89,25 @@ 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
 	# check if the patternbuffer is a non-zero length file
-	if [[ -s "$patternBuffer" ]];then
+	if [[ -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!"
 	else
 		# curl didn't download any host files, probably because of the date check
@@ -138,7 +116,7 @@ function gravity_patternCheck() {
 }
 
 # transport - curl the specified url with any needed command extentions
-function gravity_transport() {
+gravity_transport() {
 	url=$1
 	cmd_ext=$2
 	agent=$3
@@ -146,195 +124,230 @@ 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
+	curl -s -L ${cmd_ext} ${heisenbergCompensator} -A "${agent}" ${url} > ${patternBuffer}
 	# Check for list updates
-	gravity_patternCheck "$patternBuffer"
-	# Cleanup
-	rm -f "$patternBuffer"
+	gravity_patternCheck "${patternBuffer}"
 }
 
 # 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++))
-	do
-        url=${sources[$i]}
-        # Get just the domain from the URL
-        domain=$(echo "$url" | cut -d'/' -f3)
+	for ((i = 0; i < "${#sources[@]}"; i++)); do
+		url=${sources[$i]}
+		# Get just the domain from the URL
+		domain=$(echo "${url}" | cut -d'/' -f3)
 
-        # Save the file as list.#.domain
-        saveLocation=$piholeDir/list.$i.$domain.$justDomainsExtension
-        activeDomains[$i]=$saveLocation
+		# Save the file as list.#.domain
+		saveLocation=${piholeDir}/list.${i}.${domain}.${justDomainsExtension}
+		activeDomains[$i]=${saveLocation}
 
-        agent="Mozilla/10.0"
+		agent="Mozilla/10.0"
 
-        echo -n "::: Getting $domain list..."
+		# Use a case statement to download lists that need special cURL commands
+		# to complete properly and reset the user agent when required
+		case "${domain}" in
+			"adblock.mahakala.is")
+			agent='Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
+			cmd_ext="-e http://forum.xda-developers.com/"
+		    ;;
 
-        # Use a case statement to download lists that need special cURL commands
-        # to complete properly and reset the user agent when required
-        case "$domain" in
-            "adblock.mahakala.is")
-                agent='Mozilla/5.0 (X11; Linux x86_64; rv:30.0) Gecko/20100101 Firefox/30.0'
-                cmd_ext="-e http://forum.xda-developers.com/"
-            ;;
-
-            "pgl.yoyo.org")
-                cmd_ext="-d mimetype=plaintext -d hostformat=hosts"
-            ;;
+		    "pgl.yoyo.org")
+			cmd_ext="-d mimetype=plaintext -d hostformat=hosts"
+		    ;;
 
             # Default is a simple request
             *) cmd_ext=""
         esac
-        gravity_transport "$url" "$cmd_ext" "$agent"
+        if [[ "${skipDownload}" == false ]]; then
+            echo -n "::: Getting $domain list..."
+            gravity_transport "$url" "$cmd_ext" "$agent"
+        fi
 	done
 }
 
 # Schwarzchild - aggregate domains to one list and add blacklisted domains
-function gravity_Schwarzchild() {
+gravity_Schwarzchild() {
 	echo "::: "
 	# Find all active domains and compile them into one file and remove CRs
 	echo -n "::: Aggregating list of domains..."
-	truncate -s 0 $piholeDir/$matterandlight
-	for i in "${activeDomains[@]}"
-	do
-		cat "$i" | tr -d '\r' >> $piholeDir/$matterandlight
+	truncate -s 0 ${piholeDir}/${matterAndLight}
+	for i in "${activeDomains[@]}"; do
+		cat "${i}" | tr -d '\r' >> ${piholeDir}/${matterAndLight}
 	done
 	echo " done!"
 }
 
-function gravity_Blacklist(){
-	# Append blacklist entries if they exist
-	echo -n "::: Running blacklist script to update HOSTS file...."
-	$blacklistScript -f -nr -q > /dev/null
+gravity_Blacklist() {
+	# Append blacklist entries to eventHorizon if they exist
+	if [[ -f "${blacklistFile}" ]]; then
+	    numBlacklisted=$(wc -l < "${blacklistFile}")
+	    plural=; [[ "$numBlacklisted" != "1" ]] && plural=s
+	    echo -n "::: BlackListing $numBlacklisted domain${plural}..."
+	    cat ${blacklistFile} >> ${piholeDir}/${eventHorizon}
+	    echo " done!"
+	else
+	    echo "::: Nothing to blacklist!"
+	fi
 
-	numBlacklisted=$(wc -l < "/etc/pihole/blacklist.txt")
-	plural=; [[ "$numBlacklisted" != "1" ]] && plural=s
-	echo " $numBlacklisted domain${plural} blacklisted!"
 }
 
-function gravity_Whitelist() {
+gravity_Whitelist() {
+    #${piholeDir}/${eventHorizon})
 	echo ":::"
 	# Prevent our sources from being pulled into the hole
 	plural=; [[ "${sources[@]}" != "1" ]] && plural=s
-	echo -n "::: Adding ${#sources[@]} adlist source${plural} to the whitelist..."
+	echo -n "::: Adding adlist source${plural} to the whitelist..."
 
 	urls=()
-	for url in "${sources[@]}"
-	do
-        tmp=$(echo "$url" | awk -F '/' '{print $3}')
-        urls=("${urls[@]}" $tmp)
+	for url in "${sources[@]}"; do
+		tmp=$(echo "${url}" | awk -F '/' '{print $3}')
+		urls=("${urls[@]}" ${tmp})
 	done
 	echo " done!"
 
-	echo -n "::: Running whitelist script to update HOSTS file...."
-	$whitelistScript -f -nr -q "${urls[@]}" > /dev/null
-	numWhitelisted=$(wc -l < "/etc/pihole/whitelist.txt")
-	plural=; [[ "$numWhitelisted" != "1" ]] && plural=s
-	echo " $numWhitelisted domain${plural} whitelisted!"
+	# Ensure adlist domains are in whitelist.txt
+	${whitelistScript} -nr -q "${urls[@]}" > /dev/null
+
+    # 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 -n "::: Whitelisting $numWhitelisted domain${plural}..."
+        #print everything from preEventHorizon into eventHorizon EXCEPT domains in whitelist.txt
+        grep -F -x -v -f ${whitelistFile} ${piholeDir}/${preEventHorizon} > ${piholeDir}/${eventHorizon}
+        echo " done!"
+	else
+	    echo "::: Nothing to whitelist!"
+	fi
 }
 
-function gravity_unique() {
+gravity_unique() {
 	# Sort and remove duplicates
 	echo -n "::: Removing duplicate domains...."
-	sort -u  $piholeDir/$supernova > $piholeDir/$eventHorizon
+	sort -u  ${piholeDir}/${supernova} > ${piholeDir}/${preEventHorizon}
 	echo " done!"
-	numberOf=$(wc -l < $piholeDir/$eventHorizon)
+	numberOf=$(wc -l < ${piholeDir}/${preEventHorizon})
 	echo "::: $numberOf unique domains trapped in the event horizon."
 }
 
-function gravity_hostFormat() {
+gravity_hostFormat() {
 	# Format domain list as "192.168.x.x domain.com"
 	echo "::: Formatting domains into a HOSTS file..."
-	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
-	if [[ -n $piholeIPv6 ]];then
-		# Add hostname and dummy domain to the top of gravity.list to make ping result return a friendlier looking domain! Also allows for an easy way to access the Pi-hole admin console (pi.hole/admin)
-		echo -e "$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
-		# 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$piholeIP pi.hole" > $piholeDir/$accretionDisc
-		cat $piholeDir/$eventHorizon | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' >> $piholeDir/$accretionDisc
-	fi
+    # Check vars from setupVars.conf to see if we're using IPv4, IPv6, Or both.
+    if [[ -n "${IPv4_address}" && -n "${IPv6_address}" ]];then
+
+        # 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
+
+        # 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
+
+        # 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}
 }
 
 # blackbody - remove any remnant files from script processes
-function gravity_blackbody() {
+gravity_blackbody() {
 	# Loop through list files
-	for file in $piholeDir/*.$justDomainsExtension
-	do
+	for file in ${piholeDir}/*.${justDomainsExtension}; 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
+	#awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' ${piholeDir}/${matterAndLight} | sed -nr -e 's/\.{2,}/./g' -e '/\./p' >  ${piholeDir}/${supernova}
+	#Above line does not correctly grab domains where comment is on the same line (e.g 'addomain.com #comment')
+	#Add additional awk command to read all lines up to a '#', and then continue as we were
+	cat ${piholeDir}/${matterAndLight} | awk -F'#' '{print $1}' | awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' | sed -nr -e 's/\.{2,}/./g' -e '/\./p' >  ${piholeDir}/${supernova}
 	echo " done!"
 
-	numberOf=$(wc -l < $piholeDir/$supernova)
-	echo "::: $numberOf domains being pulled in by gravity..."
+	numberOf=$(wc -l < ${piholeDir}/${supernova})
+	echo "::: ${numberOf} domains being pulled in by gravity..."
 
 	gravity_unique
 }
 
-function gravity_reload() {
+gravity_reload() {
 	#Clear no longer needed files...
 	echo ":::"
 	echo -n "::: Cleaning up un-needed files..."
-	$SUDO rm $piholeDir/pihole.*.txt
+	rm ${piholeDir}/pihole.*.txt
 	echo " done!"
 
 	# Reload hosts file
 	echo ":::"
-	echo -n "::: Refresh lists in dnsmasq..."
-	
+	echo "::: Refresh lists in dnsmasq..."
+
 	#ensure /etc/dnsmasq.d/01-pihole.conf is pointing at the correct list!
 	#First escape forward slashes in the path:
 	adList=${adList//\//\\\/}
 	#Now replace the line in dnsmasq file
-	$SUDO sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf
-	dnsmasqPid=$(pidof dnsmasq)
+#	sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf
 
-    find "$piholeDir" -type f -exec $SUDO chmod 666 {} \;
-
-	if [[ $dnsmasqPid ]]; then
-		# service already running - reload config
-		$SUDO killall -s HUP dnsmasq
-	else
-		# service not running, start it up
-		$SUDO service dnsmasq start
-	fi
-	echo " done!"
+        pihole restartdns
 }
 
-$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
-gravity_Schwarzchild
-gravity_advanced
-gravity_hostFormat
-gravity_blackbody
+if [[ "${skipDownload}" == false ]]; then
+    gravity_Schwarzchild
+    gravity_advanced
+else
+    echo "::: Using cached Event Horizon list..."
+    numberOf=$(wc -l < ${piholeDir}/${preEventHorizon})
+	echo "::: $numberOf unique domains trapped in the event horizon."
+fi
 gravity_Whitelist
 gravity_Blacklist
+
+gravity_hostFormat
+gravity_blackbody
+
 gravity_reload
+pihole status

pihole

@@ -12,85 +12,173 @@
 
 # Must be root to use this tool
 if [[ ! $EUID -eq 0 ]];then
-	#echo "::: You are root."
-#else
-	#echo "::: Sudo will be used for this tool."
-  # Check if it is actually installed
-  # If it isn't, exit because the pihole cannot be invoked without privileges.
-  if [[ $(dpkg-query -s sudo) ]];then
-		export SUDO="sudo"
-  else
-    echo "::: Please install sudo or run this as root."
-    exit 1
-  fi
+	if [ -x "$(command -v sudo)" ];then
+		exec sudo bash "$0" "$@"
+		exit $?
+	else
+		echo "::: sudo is needed to run pihole commands.  Please run this script as root or install sudo."
+		exit 1
+	fi
 fi
 
-function whitelistFunc {
+whitelistFunc() {
+	/opt/pihole/list.sh "$@"
+	exit 0
+}
+
+blacklistFunc() {
+	/opt/pihole/list.sh "$@"
+	exit 0
+}
+
+debugFunc() {
+	/opt/pihole/piholeDebug.sh
+	exit 0
+}
+
+flushFunc() {
+	/opt/pihole/piholeLogFlush.sh
+	exit 0
+}
+
+
+updatePiholeFunc() {
+	/opt/pihole/update.sh
+	exit 0
+}
+
+reconfigurePiholeFunc() {
+	/etc/.pihole/automated\ install/basic-install.sh --reconfigure
+	exit 0;
+}
+
+updateGravityFunc() {
+	/opt/pihole/gravity.sh "$@"
+	exit 0
+}
+
+setupLCDFunction() {
+	/opt/pihole/setupLCD.sh
+	exit 0
+}
+
+queryFunc() {
+	domain=$2
+	for list in /etc/pihole/list.*; do
+		count=$(grep ${domain} $list | wc -l)
+		echo "::: ${list} (${count} results)"
+			if [[ ${count} > 0 ]]; then
+				grep ${domain} ${list}
+			fi
+		echo ""
+	done
+	exit 0
+}
+
+chronometerFunc() {
 	shift
-	$SUDO /opt/pihole/whitelist.sh "$@"
-	exit 1
+	/opt/pihole/chronometer.sh "$@"
+	exit 0
 }
 
-function blacklistFunc {
+
+uninstallFunc() {
+	/opt/pihole/uninstall.sh
+	exit 0
+}
+
+versionFunc() {
 	shift
-	$SUDO /opt/pihole/blacklist.sh "$@"
-	exit 1
+	/opt/pihole/version.sh "$@"
+	exit 0
 }
 
-function debugFunc {
-	$SUDO /opt/pihole/piholeDebug.sh
-	exit 1
+restartDNS() {
+  dnsmasqPid=$(pidof dnsmasq)
+  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 {
-	$SUDO /opt/pihole/piholeLogFlush.sh
-	exit 1
+piholeEnable() {
+  if [[ "${1}" == "0" ]] ; then
+    #Disable Pihole
+    sed -i 's/^addn-hosts/#addn-hosts/' /etc/dnsmasq.d/01-pihole.conf
+    echo "::: Blocking has been disabled!"
+  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 {
-	$SUDO /opt/pihole/updateDashboard.sh
-	exit 1
-}
-
-function updateGravityFunc {
-	$SUDO /opt/pihole/gravity.sh
-	exit 1
-}
-
-function setupLCDFunction {
-	$SUDO /opt/pihole/setupLCD.sh
-	exit 1
-}
-
-function chronometerFunc {
-	shift
-	$SUDO /opt/pihole/chronometer.sh "$@"
-	exit 1
+piholeStatus() {
+  if [[ $(cat /etc/dnsmasq.d/01-pihole.conf | grep "#addn-hosts=/") ]] ; then
+    #list is commented out
+    if [[ "${1}" == "web" ]] ; then
+      echo 0;
+    else
+      echo "::: Pi-hole blocking is Disabled";
+    fi
+  elif [[ $(cat /etc/dnsmasq.d/01-pihole.conf | grep "addn-hosts=/") ]] ; 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 uninstallFunc {
-	$SUDO /opt/pihole/uninstall.sh
-	exit 1
-}
-
-function helpFunc {
-	echo "::: Control all PiHole specific functions!"
-	echo ":::"
-	echo "::: Usage: pihole [options]"
-	echo ":::		Add -h after -w (whitelist), -b (blacklist), or -c (chronometer)  for more information on usage"
-	echo ":::"
-	echo "::: Options:"
-	echo ":::  -w, whitelist			Whitelist domains"
-	echo ":::  -b, blacklist			Blacklist domains"
-	echo ":::  -d, debug 				Start a debugging session if having trouble"
-	echo ":::  -f, flush 				Flush the pihole.log file"
-	echo ":::  -u, updateDashboard			Update the web dashboard manually"
-	echo ":::  -g, updateGravity			Update the list of ad-serving domains"
-	echo ":::  -s, setupLCD				Automatically configures the Pi to use the 2.8 LCD screen to display stats on it"
-	echo ":::  -c, chronometer			Calculates stats and displays to an LCD"
-	echo ":::  -h, help				Show this help dialog"
-	echo ":::  uninstall				Uninstall Pi-Hole from your system!"
+helpFunc() {
+	cat << EOM
+::: Control all PiHole specific functions!
+:::
+::: Usage: pihole [options]
+:::		Add -h after -w (whitelist), -b (blacklist), or -c (chronometer)  for more information on usage
+:::
+::: Options:
+:::  -w, whitelist            Whitelist domains
+:::  -b, blacklist            Blacklist domains
+:::  -d, debug                Start a debugging session if having trouble
+:::  -f, flush                Flush the pihole.log file
+:::  -up, updatePihole        Update Pi-hole
+:::  -g, updateGravity        Update the list of ad-serving domains
+:::  -s, setupLCD             Automatically configures the Pi to use the 2.8 LCD screen to display stats on it
+:::  -c, chronometer          Calculates stats and displays to an LCD
+:::  -h, help                 Show this help dialog
+:::  -v, version              Show current versions
+:::  -q, query                Query the adlists for a specific domain
+:::  uninstall                Uninstall Pi-Hole from your system :(!
+:::  status                   Is Pi-Hole Enabled or Disabled
+:::  enable                   Enable Pi-Hole DNS Blocking
+:::  disable                  Disable Pi-Hole DNS Blocking
+:::  restartdns               Restart dnsmasq
+EOM
 	exit 1
 }
 
@@ -99,16 +187,23 @@ if [[ $# = 0 ]]; then
 fi
 
 # Handle redirecting to specific functions based on arguments
-case "$1" in
-"-w" | "whitelist"			) whitelistFunc "$@";;
-"-b" | "blacklist"			) blacklistFunc "$@";;
-"-d" | "debug"				) debugFunc;;
-"-f" | "flush"				) flushFunc;;
-"-u" | "updateDashboard"	) updateDashboardFunc;;
-"-g" | "updateGravity"		) updateGravityFunc;;
-"-s" | "setupLCD"			) setupLCDFunction;;
-"-c" | "chronometer"		) chronometerFunc "$@";;
-"-h" | "help"				) helpFunc;;
-"uninstall"					) uninstallFunc;;
-*                    		) helpFunc;;
+case "${1}" in
+	"-w" | "whitelist"			) whitelistFunc "$@";;
+	"-b" | "blacklist"			) blacklistFunc "$@";;
+	"-d" | "debug"				) debugFunc;;
+	"-f" | "flush"				) flushFunc;;
+	"-up" | "updatePihole"      ) updatePiholeFunc;;
+	"-r"  | "reconfigure"       ) reconfigurePiholeFunc;;
+	"-g" | "updateGravity"		) updateGravityFunc "$@";;
+	"-s" | "setupLCD"			) setupLCDFunction;;
+	"-c" | "chronometer"		) chronometerFunc "$@";;
+	"-h" | "help"				) helpFunc;;
+	"-v" | "version"            ) versionFunc "$@";;
+	"-q" | "query"              ) queryFunc "$@";;
+	"uninstall"					) uninstallFunc;;
+	"enable"                      ) piholeEnable 1;;
+    "disable"                     ) piholeEnable 0;;
+    "status"                      ) piholeStatus "$2";;
+    "restartdns"                  ) restartDNS;;
+	*                    		) helpFunc;;
 esac