Merge pull request #4514 from pi-hole/development

Pi-hole core v5.8

.editorconfig

@@ -1,4 +1,4 @@
-# EditorConfig is awesome: http://EditorConfig.org
+# EditorConfig is awesome: https://editorconfig.org/
 
 # top-most EditorConfig file
 root = true
@@ -9,7 +9,7 @@ end_of_line = lf
 insert_final_newline = true
 indent_style = space
 indent_size = tab
-tab_width = 2
+tab_width = 4
 charset = utf-8
 trim_trailing_whitespace = true
 

.github/ISSUE_TEMPLATE.md

@@ -1,33 +0,0 @@
-**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 am reporting isn't a duplicate (see [FAQs](https://github.com/pi-hole/pi-hole/wiki/FAQs), [closed issues](https://github.com/pi-hole/pi-hole/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), and [open issues](https://github.com/pi-hole/pi-hole/issues)).
-
-**How familiar are you with the codebase?:**
-
-_{replace this text with a number from 1 to 10, with 1 being not familiar, and 10 being very familiar}_
-
----
-**[BUG REPORT | OTHER]:**
-
-Please [submit your feature request here](https://discourse.pi-hole.net/c/feature-requests), so it is votable by the community.  It's also easier for us to track.
-
-**[BUG | ISSUE] Expected Behaviour:**
-
-
-**[BUG | ISSUE] Actual Behaviour:**
-
-
-**[BUG | ISSUE] Steps to reproduce:**
-
--
--
--
--
-
-**(Optional) Debug token generated by `pihole -d`:**
-
-`<token>`
-
-_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._

.github/PULL_REQUEST_TEMPLATE.md

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

.github/dco.yml

@@ -0,0 +1,2 @@
+require:
+  members: false

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly
+    day: saturday
+    time: "10:00"
+  open-pull-requests-limit: 10
+  target-branch: developement

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,40 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches:
+      - master
+      - development
+  pull_request:
+    branches:
+      - master
+      - development
+  schedule:
+    - cron: '32 11 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    steps:
+    -
+      name: Checkout repository
+      uses: actions/checkout@v2
+    # Initializes the CodeQL tools for scanning.
+    -
+      name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: 'python'
+    -
+      name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+    -
+      name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/stale.yml

@@ -0,0 +1,24 @@
+name: Mark stale issues
+
+on:
+  schedule:
+  - cron: '30 * * * *'
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+
+    steps:
+    - uses: actions/stale@v4
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        debug-only: true
+        days-before-stale: 30
+        days-before-close: 5
+        stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Please comment or update this issue or it will be closed in 5 days.'
+        stale-issue-label: 'Submitter Attention Required'
+        exempt-issue-labels: 'pinned, Fixed in next release, Bug: Confirmed'
+        exempt-all-issue-assignees: true

.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Test Supported Distributions
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  smoke-test:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+    -
+      name: Checkout repository
+      uses: actions/checkout@v2
+    -
+      name: Run Smoke Tests
+      run: |
+        # Ensure scripts in repository are executable
+        IFS=$'\n';
+        for f in $(find . -name '*.sh'); do if [[ ! -x $f ]]; then echo "$f is not executable" && FAIL=1; fi ;done
+        unset IFS;
+        # If FAIL is 1 then we fail.
+        [[ $FAIL == 1 ]] && exit 1 || echo "Smoke Tests Passed"
+
+  distro-test:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    needs: smoke-test
+    strategy:
+      matrix:
+        distro: [debian_9, debian_10, debian_11, ubuntu_16, ubuntu_18, ubuntu_20, ubuntu_21, centos_7, centos_8, fedora_33, fedora_34]
+    env:
+      DISTRO: ${{matrix.distro}}
+    steps:
+    -
+      name: Checkout repository
+      uses: actions/checkout@v2
+    -
+      name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    -
+      name: Install dependencies
+      run: pip install -r test/requirements.txt
+    -
+      name: Test with tox
+      run: tox -c test/tox.${DISTRO}.ini

.gitignore

@@ -3,4 +3,10 @@
 *.swp
 __pycache__
 .cache
-.pullapprove.yml
+.pytest_cache
+.tox
+.eggs
+*.egg-info
+.idea/
+*.iml
+.vscode/

.idea/codeStyleSettings.xml

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

.pullapprove.yml

@@ -1,38 +0,0 @@
-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|:taco:)'
-  reject_regex: '^(Rejected|:-1:|Borg)'
-  author_approval:
-    auto: true
-
-
-groups:
-  development:
-    approve_by_comment:
-      enabled: true
-    conditions:
-      branches:
-        - development
-    required: 2
-    teams:
-      - approvers
-
-  master:
-    approve_by_comment:
-      enabled: true
-    conditions:
-      branches:
-        - master
-    required: 4
-    teams:
-      - approvers

.stickler.yml

@@ -0,0 +1,6 @@
+linters:
+  shellcheck:
+    shell: bash
+  phpcs:
+  flake8:
+    max-line-length: 120

.travis.yml

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

CONTRIBUTING.md

@@ -1,39 +1,7 @@
-_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
-
 # Contributors Guide
 
 Please read and understand the contribution guide before creating an issue or pull request.
 
-## Etiquette
+The guide can be found here: [https://docs.pi-hole.net/guides/github/contributing/](https://docs.pi-hole.net/guides/github/contributing/)
 
-- Our goal for Pi-hole is **stability before features**.  This means we focus on squashing critical bugs before adding new features.  Often, we can do both in tandem, but bugs will take priority over a new feature.
-- Pi-hole is open source and [powered by donations](https://pi-hole.net/donate/), and as such, we give our **free time** to build, maintain, and **provide user support** for this project.  It would be extremely unfair for us to suffer abuse or anger for our hard work, so please take a moment to consider that.
-- Please be considerate towards the developers and other users when raising issues or presenting pull requests.
-- Respect our decision(s), and do not be upset or abusive if your submission is not used.
 
-## Viability
-
-When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many people, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project.
-
-## Procedure
-
-**Before filing an issue:**
-
-- Attempt to replicate and **document** the problem, to ensure that it wasn't a coincidental incident.
-- Check to make sure your feature suggestion isn't already present within the project.
-- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
-- Check the pull requests tab to ensure that the feature isn't already in progress.
-
-**Before submitting a pull request:**
-
-- Check the codebase to ensure that your feature doesn't already exist.
-- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
-
-## Technical Requirements
-
-- Submit Pull Requests to the **development branch only**.
-- Before Submitting your Pull Request, merge `development` with your new branch and fix any conflicts. (Make sure you don't break anything in development!)
-- Please use the [Google Style Guide for Shell](https://google.github.io/styleguide/shell.xml) for your code submission styles. 
-- Commit Unix line endings.
-- Please use the Pi-hole brand: **Pi-hole** (Take a special look at the capitalized 'P' and a low 'h' with a hyphen)
-- (Optional fun) keep to the theme of Star Trek/black holes/gravity.

README.md

@@ -1,176 +1,164 @@
-<p align="center">
-<a href=https://www.bountysource.com/trackers/3011939-pi-hole-pi-hole?utm_source=3011939&utm_medium=shield&utm_campaign=TRACKER_BADGE><img src="https://www.bountysource.com/badge/tracker?tracker_id=3011939"></a>
-<a href="https://www.codacy.com/app/Pi-hole/pi-hole?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=pi-hole/pi-hole&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/c558a0f8d7124c99b02b84f0f5564238"/></a>
-<a href=https://travis-ci.org/pi-hole/pi-hole><img src="https://travis-ci.org/pi-hole/pi-hole.svg?branch=development"></a>
-</p>
+<!-- markdownlint-configure-file { "MD004": { "style": "consistent" } } -->
+<!-- markdownlint-disable MD033 -->
+#
 
 <p align="center">
-<a href=https://discourse.pi-hole.net><img src="https://assets.pi-hole.net/static/Vortex_with_text_and_TM.png" width=210></a>
+    <a href="https://pi-hole.net/">
+        <img src="https://pi-hole.github.io/graphics/Vortex/Vortex_with_Wordmark.svg" width="150" height="260" alt="Pi-hole">
+    </a>
+    <br>
+    <strong>Network-wide ad blocking via your own Linux hardware</strong>
 </p>
+<!-- markdownlint-enable MD033 -->
 
-## The multi-platform, network-wide ad blocker
+The Pi-hole® is a [DNS sinkhole](https://en.wikipedia.org/wiki/DNS_Sinkhole) that protects your devices from unwanted content without installing any client-side software.
 
-Block ads for **all** your devices _without_ the need to install client-side software.  The Pi-hole™ blocks ads at the DNS-level, so all your devices are protected.
+- **Easy-to-install**: our versatile installer walks you through the process and takes less than ten minutes
+- **Resolute**: content is blocked in _non-browser locations_, such as ad-laden mobile apps and smart TVs
+- **Responsive**: seamlessly speeds up the feel of everyday browsing by caching DNS queries
+- **Lightweight**: runs smoothly with [minimal hardware and software requirements](https://docs.pi-hole.net/main/prerequisites/)
+- **Robust**: a command line interface that is quality assured for interoperability
+- **Insightful**: a beautiful responsive Web Interface dashboard to view and control your Pi-hole
+- **Versatile**: can optionally function as a [DHCP server](https://discourse.pi-hole.net/t/how-do-i-use-pi-holes-built-in-dhcp-server-and-why-would-i-want-to/3026), ensuring *all* your devices are protected automatically
+- **Scalable**: [capable of handling hundreds of millions of queries](https://pi-hole.net/2017/05/24/how-much-traffic-can-pi-hole-handle/) when installed on server-grade hardware
+- **Modern**: blocks ads over both IPv4 and IPv6
+- **Free**: open source software that helps ensure _you_ are the sole person in control of your privacy
 
-- Web Browsers
-- Cell Phones
-- Smart TV's
-- Internet-connected home automation
-- Anything that communicates with the Internet
+-----
 
-<p align="center">
-<a href=http://www.digitalocean.com/?refcode=344d234950e1><img src="https://assets.pi-hole.net/static/DOHostingSlug.png"></a>
-</p>
+## One-Step Automated Install
 
-## Your Support Still Matters
-
-Digital Ocean helps with our infrastructure, but our developers are all volunteers so *your donations help keep us innovating*. Sending a donation using our links below helps us offset a portion of our monthly costs.
-
--   ![Paypal](https://assets.pi-hole.net/static/paypal.png) [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
--   ![Bitcoin](https://assets.pi-hole.net/static/Bitcoin.png) Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
-
-### One-Step Automated Install
-1.  Install a [supported operating system](https://discourse.pi-hole.net/t/hardware-software-requirements/273/1)
-2.  Run the command below (it downloads [this script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) in case you want to read over it first!)
+Those who want to get started quickly and conveniently may install Pi-hole using the following command:
 
 ### `curl -sSL https://install.pi-hole.net | bash`
 
-#### Alternative Semi-Automated Install Methods
-_If you wish to read over the script before running it, run `nano basic-install.sh` to open the file in a text viewer._
+## Alternative Install Methods
 
-##### Clone our repository and run the automated installer from your device.
+Piping to `bash` is [controversial](https://pi-hole.net/2016/07/25/curling-and-piping-to-bash), as it prevents you from [reading code that is about to run](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) on your system. Therefore, we provide these alternative installation methods which allow code review before installation:
 
-```
+### Method 1: Clone our repository and run
+
+```bash
 git clone --depth 1 https://github.com/pi-hole/pi-hole.git Pi-hole
-cd Pi-hole/automated\ install/
-bash basic-install.sh
+cd "Pi-hole/automated install/"
+sudo bash basic-install.sh
 ```
 
-##### Or
+### Method 2: Manually download the installer and run
 
 ```bash
 wget -O basic-install.sh https://install.pi-hole.net
-bash basic-install.sh
+sudo bash basic-install.sh
 ```
+### Method 3: Using Docker to deploy Pi-hole
+Please refer to the [Pi-hole docker repo](https://github.com/pi-hole/docker-pi-hole) to use the Official Docker Images.
 
-Once installed, [configure your router to have **DHCP clients use the Pi as their DNS server**](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245) and then any device that connects to your network will have ads blocked without any further configuration. Alternatively, you can manually set each device to use Pi-hole™ as their DNS server.
+## [Post-install: Make your network take advantage of Pi-hole](https://docs.pi-hole.net/main/post-install/)
 
-## What is Pi-hole™ and how do I install it?
-<p align="center">
-<a href=https://www.youtube.com/watch?v=vKWjx1AQYgs><img src="https://assets.pi-hole.net/static/video-explainer.png"></a>
-</p>
+Once the installer has been run, you will need to [configure your router to have **DHCP clients use Pi-hole as their DNS server**](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245) which ensures that all devices connecting to your network will have content blocked without any further intervention.
 
+If your router does not support setting the DNS server, you can [use Pi-hole's built-in DHCP server](https://discourse.pi-hole.net/t/how-do-i-use-pi-holes-built-in-dhcp-server-and-why-would-i-want-to/3026); be sure to disable DHCP on your router first (if it has that feature available).
 
-## Get Help Or Connect With Us On The Web
+As a last resort, you can manually set each device to use Pi-hole as their DNS server.
 
--   [Users Forum](https://discourse.pi-hole.net/)
--   [FAQs](https://discourse.pi-hole.net/c/faqs)
--   [Wiki](https://github.com/pi-hole/pi-hole/wiki)
--   ![Twitter](https://assets.pi-hole.net/static/twitter.png) [Tweet @The_Pi_Hole](https://twitter.com/The_Pi_Hole)
--   ![Reddit](https://assets.pi-hole.net/static/reddit.png) [Reddit /r/pihole](https://www.reddit.com/r/pihole/)
--   ![YouTube](https://assets.pi-hole.net/static/youtube.png)  [Pi-hole channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w)
--   [![Join the chat at https://gitter.im/pi-hole/pi-hole](https://badges.gitter.im/pi-hole/pi-hole.svg)](https://gitter.im/pi-hole/pi-hole?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+-----
 
-## Technical Details
+## Pi-hole is free but powered by your support
 
-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.
+There are many reoccurring costs involved with maintaining free, open source, and privacy-respecting software; expenses which [our volunteer developers](https://github.com/orgs/pi-hole/people) pitch in to cover out-of-pocket. This is just one example of how strongly we feel about our software and the importance of keeping it maintained.
 
-### Gravity
+Make no mistake: **your support is absolutely vital to help keep us innovating!**
 
-The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/gravity.sh) does most of the magic. The script pulls in ad domains from many sources and compiles them into a single list of [over 1.6 million entries](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0) (if you decide to use the [mahakala list](https://github.com/pi-hole/pi-hole/commit/963eacfe0537a7abddf30441c754c67ca1e40965)). This script is controlled by the `pihole` command. Please run `pihole -h` to see what commands can be run via `pihole`.
+### [Donations](https://pi-hole.net/donate)
 
+Donating using our Sponsor Button is **extremely helpful** in offsetting a portion of our monthly expenses:
 
+### Alternative support
 
-#### Other Operating Systems
+If you'd rather not donate (_which is okay!_), there are other ways you can help support us:
 
-The automated install is only for a clean install of a Debian family or Fedora based system, such as the Raspberry Pi. However, this script will work for most UNIX-like systems, some with some slight **modifications** that we can help you work through. If you can install `dnsmasq` and a web server, it should work OK. If there are other platforms you'd like supported, let us know.
+- [GitHub Sponsors](https://github.com/sponsors/pi-hole/)
+- [Patreon](https://patreon.com/pihole)
+- [Hetzner Cloud](https://hetzner.cloud/?ref=7aceisRX3AzA) _affiliate link_
+- [Digital Ocean](https://www.digitalocean.com/?refcode=344d234950e1) _affiliate link_
+- [Stickermule](https://www.stickermule.com/unlock?ref_id=9127301701&utm_medium=link&utm_source=invite) _earn a $10 credit after your first purchase_
+- [Amazon US](http://www.amazon.com/exec/obidos/redirect-home/pihole09-20) _affiliate link_
+- Spreading the word about our software and how you have benefited from it
 
-### Web Interface
+### Contributing via GitHub
 
-The [Web interface](https://github.com/pi-hole/AdminLTE#pi-hole-admin-dashboard) will be installed automatically so you can view stats and change settings. You can find it at:
+We welcome _everyone_ to contribute to issue reports, suggest new features, and create pull requests.
 
-`http://192.168.1.x/admin/index.php` or `http://pi.hole/admin`
+If you have something to add - anything from a typo through to a whole new feature, we're happy to check it out! Just make sure to fill out our template when submitting your request; the questions it asks will help the volunteers quickly understand what you're aiming to achieve.
 
-![Pi-hole Advanced Stats Dashboard](https://assets.pi-hole.net/static/dashboard212.png)
+You'll find that the [install script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) and the [debug script](https://github.com/pi-hole/pi-hole/blob/master/advanced/Scripts/piholeDebug.sh) have an abundance of comments, which will help you better understand how Pi-hole works. They're also a valuable resource to those who want to learn how to write scripts or code a program! We encourage anyone who likes to tinker to read through it and submit a pull request for us to review.
 
-### Whitelist and blacklist
+-----
 
-Domains can be whitelisted and blacklisted using either the web interface or the command line. See [the wiki page](https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting) for more details
-<p align="center">
-<a href=https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting><img src="https://assets.pi-hole.net/static/whitelist212.png"></a>
-</p>
+## Getting in touch with us
 
-### Settings
+While we are primarily reachable on our [Discourse User Forum](https://discourse.pi-hole.net/), we can also be found on various social media outlets.
 
-The settings page lets you control and configure your Pi-hole™.  You can do things like:
+**Please be sure to check the FAQs** before starting a new discussion, as we do not have the spare time to reply to every request for assistance.
 
-- enable Pi-hole's built-in DHCP server
-- exclude domains from the graphs
-- configure upstream DNS servers
-- and more!
+- [Frequently Asked Questions](https://discourse.pi-hole.net/c/faqs)
+- [Feature Requests](https://discourse.pi-hole.net/c/feature-requests?order=votes)
+- [Reddit](https://www.reddit.com/r/pihole/)
+- [Twitter](https://twitter.com/The_Pi_hole)
 
-![Settings page](https://assets.pi-hole.net/static/settings212.png)
+-----
 
-#### Built-in DHCP Server
+## Breakdown of Features
 
-Pi-hole™ ships with a built-in DHCP server.  This allows you to let your network devices use Pi-hole™ as their DNS server if your router does not let you adjust the DHCP options.
-<p align="center">
-<a href=hhttps://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245><img src="https://assets.pi-hole.net/static/piholedhcpserver.png"></a>
-</p>
+### [Faster-than-light Engine](https://github.com/pi-hole/ftl)
 
-## API
+[FTLDNS](https://github.com/pi-hole/ftl) is a lightweight, purpose-built daemon used to provide statistics needed for the Web Interface, and its API can be easily integrated into your own projects. As the name implies, FTLDNS does this all *very quickly*!
 
-A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON:
+Some of the statistics you can integrate include:
 
-``` json
-{
-    "domains_being_blocked": "136708",
-    "dns_queries_today": "18108",
-    "ads_blocked_today": "14648",
-    "ads_percentage_today": "80.89"
-}
-```
+- Total number of domains being blocked
+- Total number of DNS queries today
+- Total number of ads blocked today
+- Percentage of ads blocked
+- Unique domains
+- Queries forwarded (to your chosen upstream DNS server)
+- Queries cached
+- Unique clients
 
-The same output can be achieved on the CLI by running `chronometer.sh -j`
+Access the API via [`telnet`](https://github.com/pi-hole/FTL), the Web (`admin/api.php`) and Command Line (`pihole -c -j`). You can find out [more details over here](https://discourse.pi-hole.net/t/pi-hole-api/1863).
 
-## Real-time Statistics
+### The Command Line Interface
 
-You can view [real-time stats](https://discourse.pi-hole.net/t/how-do-i-view-my-pi-holes-stats-over-ssh-or-on-an-lcd-using-chronometer/240) 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)
+The [pihole](https://docs.pi-hole.net/core/pihole-command/) command has all the functionality necessary to fully administer the Pi-hole, without the need of the Web Interface. It's fast, user-friendly, and auditable by anyone with an understanding of `bash`.
 
-## Pi-hole™ Projects
+Some notable features include:
 
--   [An ad blocking Magic Mirror](https://zonksec.com/blog/magic-mirror-dns-filtering/#dnssoftware)
--   [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://thetimmy.silvernight.org/pages/endisbutton/)
--   [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 Visualiser](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)
--   [Let your blink1 device blink when Pi-hole filters ads](https://gist.github.com/elpatron68/ec0b4c582e5abf604885ac1e068d233f)
--   [Pi-hole Prometheus exporter](https://github.com/nlamirault/pihole_exporter): a [Prometheus](https://prometheus.io/) exporter for Pi-hole
--   [Pi-hole Droid - open source Android client](https://github.com/friimaind/pi-hole-droid)
--   [Windows DNS Swapper](https://github.com/roots84/DNS-Swapper), see [#1400](https://github.com/pi-hole/pi-hole/issues/1400)
+- [Whitelisting, Blacklisting, and Regex](https://docs.pi-hole.net/core/pihole-command/#whitelisting-blacklisting-and-regex)
+- [Debugging utility](https://docs.pi-hole.net/core/pihole-command/#debugger)
+- [Viewing the live log file](https://docs.pi-hole.net/core/pihole-command/#tail)
+- [Updating Ad Lists](https://docs.pi-hole.net/core/pihole-command/#gravity)
+- [Querying Ad Lists for blocked domains](https://docs.pi-hole.net/core/pihole-command/#query)
+- [Enabling and Disabling Pi-hole](https://docs.pi-hole.net/core/pihole-command/#enable-disable)
+- ... and *many* more!
 
-## Coverage
+You can read our [Core Feature Breakdown](https://docs.pi-hole.net/core/pihole-command/#pi-hole-core) for more information.
 
--   [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/)
--   [Build an Ad-Blocker for less than 10$ with Orange-Pi](http://www.devacron.com/orangepi-zero-as-an-ad-block-server-with-pi-hole/)
+### The Web Interface Dashboard
+
+This [optional dashboard](https://github.com/pi-hole/AdminLTE) allows you to view stats, change settings, and configure your Pi-hole. It's the power of the Command Line Interface, with none of the learning curve!
+
+Some notable features include:
+
+- Mobile-friendly interface
+- Password protection
+- Detailed graphs and doughnut charts
+- Top lists of domains and clients
+- A filterable and sortable query log
+- Long Term Statistics to view data over user-defined time ranges
+- The ability to easily manage and configure Pi-hole features
+- ... and all the main features of the Command Line Interface!
+
+There are several ways to [access the dashboard](https://discourse.pi-hole.net/t/how-do-i-access-pi-holes-dashboard-admin-interface/3168):
+
+1. `http://pi.hole/admin/` (when using Pi-hole as your DNS server)
+2. `http://<IP_ADDPRESS_OF_YOUR_PI_HOLE>/admin/`

adlists.default

@@ -1,23 +0,0 @@
-# The below list amalgamates several lists we used previously.
-# See `https://github.com/StevenBlack/hosts` for details
-##StevenBlack's list
-https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts
-
-##MalwareDomains
-https://mirror1.malwaredomains.com/files/justdomains
-
-##Cameleon
-http://sysctl.org/cameleon/hosts
-
-##Zeustracker
-https://zeustracker.abuse.ch/blocklist.php?download=domainblocklist
-
-##Disconnect.me Tracking
-https://s3.amazonaws.com/lists.disconnect.me/simple_tracking.txt
-
-##Disconnect.me Ads
-https://s3.amazonaws.com/lists.disconnect.me/simple_ad.txt
-
-##Hosts-file.net
-https://hosts-file.net/ad_servers.txt
-

advanced/01-pihole.conf

@@ -1,13 +1,11 @@
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
-# dnsmasq config for Pi-hole
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
 #
-# 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.
+# Dnsmasq config for Pi-hole's FTLDNS
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
 
 ###############################################################################
 #      FILE AUTOMATICALLY POPULATED BY PI-HOLE INSTALL/UPDATE PROCEDURE.      #
@@ -16,13 +14,12 @@
 #        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                              #
+#        ANY OTHER CHANGES SHOULD BE MADE IN A SEPARATE CONFIG FILE           #
+#                    WITHIN /etc/dnsmasq.d/yourname.conf                      #
 ###############################################################################
 
-addn-hosts=/etc/pihole/gravity.list
 addn-hosts=/etc/pihole/local.list
-addn-hosts=/etc/pihole/black.list
+addn-hosts=/etc/pihole/custom.list
 
 domain-needed
 
@@ -37,11 +34,9 @@ server=@DNS2@
 
 interface=@INT@
 
-cache-size=10000
+cache-size=@CACHE_SIZE@
 
 log-queries
 log-facility=/var/log/pihole.log
 
-local-ttl=300
-
 log-async

advanced/06-rfc6761.conf

@@ -0,0 +1,42 @@
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2021 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# RFC 6761 config file for Pi-hole
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+###############################################################################
+#      FILE AUTOMATICALLY POPULATED BY PI-HOLE INSTALL/UPDATE PROCEDURE.      #
+# ANY CHANGES MADE TO THIS FILE AFTER INSTALL WILL BE LOST ON THE NEXT UPDATE #
+#                                                                             #
+#             CHANGES SHOULD BE MADE IN A SEPARATE CONFIG FILE                #
+#                    WITHIN /etc/dnsmasq.d/yourname.conf                      #
+###############################################################################
+
+# RFC 6761: Caching DNS servers SHOULD recognize
+#     test, localhost, invalid
+# names as special and SHOULD NOT attempt to look up NS records for them, or
+# otherwise query authoritative DNS servers in an attempt to resolve these
+# names.
+server=/test/
+server=/localhost/
+server=/invalid/
+
+# The same RFC requests something similar for
+#     10.in-addr.arpa.      21.172.in-addr.arpa.  27.172.in-addr.arpa.
+#     16.172.in-addr.arpa.  22.172.in-addr.arpa.  28.172.in-addr.arpa.
+#     17.172.in-addr.arpa.  23.172.in-addr.arpa.  29.172.in-addr.arpa.
+#     18.172.in-addr.arpa.  24.172.in-addr.arpa.  30.172.in-addr.arpa.
+#     19.172.in-addr.arpa.  25.172.in-addr.arpa.  31.172.in-addr.arpa.
+#     20.172.in-addr.arpa.  26.172.in-addr.arpa.  168.192.in-addr.arpa.
+# Pi-hole implements this via the dnsmasq option "bogus-priv" (see
+# 01-pihole.conf) because this also covers IPv6.
+
+# OpenWRT furthermore blocks    bind, local, onion    domains
+# see https://git.openwrt.org/?p=openwrt/openwrt.git;a=blob_plain;f=package/network/services/dnsmasq/files/rfc6761.conf;hb=HEAD
+# and https://www.iana.org/assignments/special-use-domain-names/special-use-domain-names.xhtml
+# We do not include the ".local" rule ourselves, see https://github.com/pi-hole/pi-hole/pull/4282#discussion_r689112972
+server=/bind/
+server=/onion/

advanced/Scripts/COL_TABLE

@@ -0,0 +1,49 @@
+# Determine if terminal is capable of showing colors
+if [[ -t 1 ]] && [[ $(tput colors) -ge 8 ]]; then
+  # Bold and underline may not show up on all clients
+  # If something MUST be emphasized, use both
+  COL_BOLD=''
+  COL_ULINE=''
+
+  COL_NC=''
+  COL_GRAY=''
+  COL_RED=''
+  COL_GREEN=''
+  COL_YELLOW=''
+  COL_BLUE=''
+  COL_PURPLE=''
+  COL_CYAN=''
+else
+  # Provide empty variables for `set -u`
+  COL_BOLD=""
+  COL_ULINE=""
+
+  COL_NC=""
+  COL_GRAY=""
+  COL_RED=""
+  COL_GREEN=""
+  COL_YELLOW=""
+  COL_BLUE=""
+  COL_PURPLE=""
+  COL_CYAN=""
+fi
+
+# Deprecated variables
+COL_WHITE="${COL_BOLD}"
+COL_BLACK="${COL_NC}"
+COL_LIGHT_BLUE="${COL_BLUE}"
+COL_LIGHT_GREEN="${COL_GREEN}"
+COL_LIGHT_CYAN="${COL_CYAN}"
+COL_LIGHT_RED="${COL_RED}"
+COL_URG_RED="${COL_RED}${COL_BOLD}${COL_ULINE}"
+COL_LIGHT_PURPLE="${COL_PURPLE}"
+COL_BROWN="${COL_YELLOW}"
+COL_LIGHT_GRAY="${COL_GRAY}"
+COL_DARK_GRAY="${COL_GRAY}"
+
+TICK="[${COL_GREEN}✓${COL_NC}]"
+CROSS="[${COL_RED}✗${COL_NC}]"
+INFO="[i]"
+QST="[?]"
+DONE="${COL_GREEN} done!${COL_NC}"
+OVER="\\r"

advanced/Scripts/chronometer.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+# shellcheck disable=SC1090,SC1091
 # Pi-hole: A black hole for Internet advertisements
 # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
 # Network-wide ad blocking via your own hardware.
@@ -7,429 +8,568 @@
 #
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
+LC_ALL=C
+LC_NUMERIC=C
 
 # Retrieve stats from FTL engine
 pihole-FTL() {
-  ftl_port=$(cat /var/run/pihole-FTL.port 2> /dev/null)
-  if [[ -n "$ftl_port" ]]; then
-    # Open connection to FTL
-    exec 3<>"/dev/tcp/localhost/$ftl_port"
+    local ftl_port LINE
+    ftl_port=$(cat /run/pihole-FTL.port 2> /dev/null)
+    if [[ -n "$ftl_port" ]]; then
+        # Open connection to FTL
+        exec 3<>"/dev/tcp/127.0.0.1/$ftl_port"
 
-    # Test if connection is open
-    if { "true" >&3; } 2> /dev/null; then
-      # Send command to FTL
-      echo -e ">$1" >&3
+        # Test if connection is open
+        if { "true" >&3; } 2> /dev/null; then
+            # Send command to FTL and ask to quit when finished
+            echo -e ">$1 >quit" >&3
 
-      # Read input
-      read -r -t 1 LINE <&3
-      until [[ ! $? ]] || [[ "$LINE" == *"EOM"* ]]; do
-         echo "$LINE" >&1
-         read -r -t 1 LINE <&3
-      done
+            # Read input until we received an empty string and the connection is
+            # closed
+            read -r -t 1 LINE <&3
+            until [[ -z "${LINE}" ]] && [[ ! -t 3 ]]; do
+                echo "$LINE" >&1
+                read -r -t 1 LINE <&3
+            done
 
-      # Close connection
-      exec 3>&-
-      exec 3<&-
-   fi
-  else
-    echo -e "${COL_LIGHT_RED}FTL offline${COL_NC}"
-  fi
+            # Close connection
+            exec 3>&-
+            exec 3<&-
+        fi
+    else
+        echo "0"
+    fi
 }
 
-# Print spaces to align right-side content
+# Print spaces to align right-side additional text
 printFunc() {
-  txt_len="${#2}"
-  
-  # Reduce string length when using colour code
-  [ "${2:0:1}" == "" ] && txt_len=$((txt_len-7))
-  
-  if [[ "$3" == "last" ]]; then
-    # Prevent final line from printing trailing newline
-    scr_size=( $(stty size 2>/dev/null || echo 24 80) )
-    scr_width="${scr_size[1]}"
-    
-    title_len="${#1}"
-    spc_num=$(( (scr_width - title_len) - txt_len ))
-    [[ "$spc_num" -lt 0 ]] && spc_num="0"
-    spc=$(printf "%${spc_num}s")
-    
-    printf "%s%s$spc" "$1" "$2"
-  else
-    # Determine number of spaces for padding
-    spc_num=$(( 20 - txt_len ))
-    [[ "$spc_num" -lt 0 ]] && spc_num="0"
-    spc=$(printf "%${spc_num}s")
+    local text_last
 
-    # Print string (Max 20 characters, prevents overflow)
-    printf "%s%s$spc" "$1" "${2:0:20}"
-  fi
+    title="$1"
+    title_len="${#title}"
+
+    text_main="$2"
+    text_main_nocol="$text_main"
+    if [[ "${text_main:0:1}" == "" ]]; then
+        text_main_nocol=$(sed 's/\[[0-9;]\{1,5\}m//g' <<< "$text_main")
+    fi
+    text_main_len="${#text_main_nocol}"
+
+    text_addn="$3"
+    if [[ "$text_addn" == "last" ]]; then
+        text_addn=""
+        text_last="true"
+    fi
+
+    # If there is additional text, define max length of text_main
+    if [[ -n "$text_addn" ]]; then
+        case "$scr_cols" in
+            [0-9]|1[0-9]|2[0-9]|3[0-9]|4[0-4]) text_main_max_len="9";;
+            4[5-9]) text_main_max_len="14";;
+            *) text_main_max_len="19";;
+        esac
+    fi
+
+    [[ -z "$text_addn" ]] && text_main_max_len="$(( scr_cols - title_len ))"
+
+    # Remove excess characters from main text
+    if [[ "$text_main_len" -gt "$text_main_max_len" ]]; then
+        # Trim text without colors
+        text_main_trim="${text_main_nocol:0:$text_main_max_len}"
+        # Replace with trimmed text
+        text_main="${text_main/$text_main_nocol/$text_main_trim}"
+    fi
+
+    # Determine amount of spaces for each line
+    if [[ -n "$text_last" ]]; then
+        # Move cursor to end of screen
+        spc_num=$(( scr_cols - ( title_len + text_main_len ) ))
+    else
+        spc_num=$(( text_main_max_len - text_main_len ))
+    fi
+
+    [[ "$spc_num" -le 0 ]] && spc_num="0"
+    spc=$(printf "%${spc_num}s")
+    #spc="${spc// /.}" # Debug: Visualize spaces
+
+    printf "%s%s$spc" "$title" "$text_main"
+
+    if [[ -n "$text_addn" ]]; then
+        printf "%s(%s)%s\\n" "$COL_NC$COL_DARK_GRAY" "$text_addn" "$COL_NC"
+    else
+        # Do not print trailing newline on final line
+        [[ -z "$text_last" ]] && printf "%s\\n" "$COL_NC"
+    fi
 }
 
 # Perform on first Chrono run (not for JSON formatted string)
 get_init_stats() {
-  LC_NUMERIC=C
-  calcFunc(){ awk "BEGIN {print $*}"; }
+    calcFunc(){ awk "BEGIN {print $*}" 2> /dev/null; }
 
-  # Convert bytes to human-readable format
-  hrBytes() {
-    awk '{
-      num=$1;
-      if(num==0) {
-        print "0 B"
-      } else {
-        xxx=(num<0?-num:num)
-        sss=(num<0?-1:1)
-        split("B KB MB GB TB PB",type)
-        for(i=5;yyy < 1;i--) {
-          yyy=xxx / (2^(10*i))
-        }
-        printf "%.0f " type[i+2], yyy*sss
-      }
-    }' <<< "$1";
-  }
+    # Convert bytes to human-readable format
+    hrBytes() {
+        awk '{
+            num=$1;
+            if(num==0) {
+                print "0 B"
+            } else {
+                xxx=(num<0?-num:num)
+                sss=(num<0?-1:1)
+                split("B KB MB GB TB PB",type)
+                for(i=5;yyy < 1;i--) {
+                    yyy=xxx / (2^(10*i))
+                }
+            printf "%.0f " type[i+2], yyy*sss
+            }
+        }' <<< "$1";
+    }
 
-  # Convert seconds to human-readable format
-  hrSecs() { 
-    day=$(( $1/60/60/24 )); hrs=$(( $1/3600%24 )); mins=$(( ($1%3600)/60 )); secs=$(( $1%60 ))
-    [[ "$day" -ge "2" ]] && plu="s"
-    [[ "$day" -ge "1" ]] && days="$day day${plu}, " || days=""
-    printf "%s%02d:%02d:%02d\n" "$days" "$hrs" "$mins" "$secs"
-  }
+    # Convert seconds to human-readable format
+    hrSecs() {
+        day=$(( $1/60/60/24 )); hrs=$(( $1/3600%24 ))
+        mins=$(( ($1%3600)/60 )); secs=$(( $1%60 ))
+        [[ "$day" -ge "2" ]] && plu="s"
+        [[ "$day" -ge "1" ]] && days="$day day${plu}, " || days=""
+        printf "%s%02d:%02d:%02d\\n" "$days" "$hrs" "$mins" "$secs"
+    }
 
-  # Set Colour Codes
-  coltable="/opt/pihole/COL_TABLE"
-  if [[ -f "${coltable}" ]]; then
-    source ${coltable}
-  else
-    COL_NC=''
-    COL_DARK_GRAY=''
-    COL_LIGHT_GREEN=''
-    COL_LIGHT_BLUE=''
-    COL_LIGHT_RED=''
-    COL_YELLOW=''
-    COL_LIGHT_RED=''
-    COL_URG_RED=''
-  fi
+    # Set Color Codes
+    coltable="/opt/pihole/COL_TABLE"
+    if [[ -f "${coltable}" ]]; then
+        source ${coltable}
+    else
+        COL_NC=""
+        COL_DARK_GRAY=""
+        COL_LIGHT_GREEN=""
+        COL_LIGHT_BLUE=""
+        COL_LIGHT_RED=""
+        COL_YELLOW=""
+        COL_LIGHT_RED=""
+        COL_URG_RED=""
+    fi
 
-  # Get RPi model number, or OS distro info
-  if command -v vcgencmd &> /dev/null; then
-    sys_rev=$(awk '/Revision/ {print $3}' < /proc/cpuinfo)
-    case "$sys_rev" in
-      000[2-6]) sys_model=" 1, Model B";; # 256MB
-      000[7-9]) sys_model=" 1, Model A" ;; # 256MB
-      000d|000e|000f) sys_model=" 1, Model B";; # 512MB
-      0010|0013) sys_model=" 1, Model B+";; # 512MB
-      0012|0015) sys_model=" 1, Model A+";; # 256MB
-      a0104[0-1]|a21041|a22042) sys_model=" 2, Model B";; # 1GB
-      900021) sys_model=" 1, Model A+";; # 512MB
-      900032) sys_model=" 1, Model B+";; # 512MB
-      90009[2-3]|920093) sys_model=" Zero";; # 512MB
-      9000c1) sys_model=" Zero W";; # 512MB
-      a02082|a[2-3]2082) sys_model=" 3, Model B";; # 1GB
-      *) sys_model="" ;;
-    esac
-    sys_type="Raspberry Pi$sys_model"
-  else
-    source "/etc/os-release"
-    CODENAME=$(sed 's/[()]//g' <<< "${VERSION/* /}")
-    sys_type="${NAME/ */} ${CODENAME^} $VERSION_ID"
-  fi
+    # Get RPi throttle state (RPi 3B only) & model number, or OS distro info
+    if command -v vcgencmd &> /dev/null; then
+        local sys_throttle_raw
+        local sys_rev_raw
 
-  # Get core count
-  sys_cores=$(grep -c "^processor" /proc/cpuinfo)
-  [[ "$sys_cores" -ne 1 ]] && sys_cores_plu="cores" || sys_cores_plu="core"
+        sys_throttle_raw=$(vgt=$(sudo vcgencmd get_throttled); echo "${vgt##*x}")
 
-  # Test existence of clock speed file for ARM CPU
-  if [[ -f "/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq" ]]; then
-    scaling_freq_file="/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq"
-  fi
+        # Active Throttle Notice: https://bit.ly/2gnunOo
+        if [[ "$sys_throttle_raw" != "0" ]]; then
+            case "$sys_throttle_raw" in
+                *0001) thr_type="${COL_YELLOW}Under Voltage";;
+                *0002) thr_type="${COL_LIGHT_BLUE}Arm Freq Cap";;
+                *0003) thr_type="${COL_YELLOW}UV${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_BLUE}AFC";;
+                *0004) thr_type="${COL_LIGHT_RED}Throttled";;
+                *0005) thr_type="${COL_YELLOW}UV${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_RED}TT";;
+                *0006) thr_type="${COL_LIGHT_BLUE}AFC${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_RED}TT";;
+                *0007) thr_type="${COL_YELLOW}UV${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_BLUE}AFC${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_RED}TT";;
+            esac
+        [[ -n "$thr_type" ]] && sys_throttle="$thr_type${COL_DARK_GRAY}"
+        fi
 
-  # Test existence of temperature file
-  if [[ -f "/sys/class/thermal/thermal_zone0/temp" ]]; then
-    temp_file="/sys/class/thermal/thermal_zone0/temp"
-  elif [[ -f "/sys/class/hwmon/hwmon0/temp1_input" ]]; then 
-    temp_file="/sys/class/hwmon/hwmon0/temp1_input"
-  else
-    temp_file=""
-  fi
+        sys_rev_raw=$(awk '/Revision/ {print $3}' < /proc/cpuinfo)
+        case "$sys_rev_raw" in
+            000[2-6]) sys_model=" 1, Model B";; # 256MB
+            000[7-9]) sys_model=" 1, Model A";; # 256MB
+            000d|000e|000f) sys_model=" 1, Model B";; # 512MB
+            0010|0013) sys_model=" 1, Model B+";; # 512MB
+            0012|0015) sys_model=" 1, Model A+";; # 256MB
+            a0104[0-1]|a21041|a22042) sys_model=" 2, Model B";; # 1GB
+            900021) sys_model=" 1, Model A+";; # 512MB
+            900032) sys_model=" 1, Model B+";; # 512MB
+            90009[2-3]|920093) sys_model=" Zero";; # 512MB
+            9000c1) sys_model=" Zero W";; # 512MB
+            a02082|a[2-3]2082) sys_model=" 3, Model B";; # 1GB
+            a020d3) sys_model=" 3, Model B+";; # 1GB
+            *) sys_model="";;
+        esac
+        sys_type="Raspberry Pi$sys_model"
+    else
+        source "/etc/os-release"
+        CODENAME=$(sed 's/[()]//g' <<< "${VERSION/* /}")
+        sys_type="${NAME/ */} ${CODENAME^} $VERSION_ID"
+    fi
 
-  # Test existence of setupVars config
-  if [[ -f "/etc/pihole/setupVars.conf" ]]; then
-    setupVars="/etc/pihole/setupVars.conf"
-  fi
+    # Get core count
+    sys_cores=$(grep -c "^processor" /proc/cpuinfo)
+
+    # Test existence of clock speed file for ARM CPU
+    if [[ -f "/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq" ]]; then
+        scaling_freq_file="/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq"
+    fi
+
+    # Test existence of temperature file
+    if [[ -f "/sys/class/thermal/thermal_zone0/temp" ]]; then
+        temp_file="/sys/class/thermal/thermal_zone0/temp"
+    elif [[ -f "/sys/class/hwmon/hwmon0/temp1_input" ]]; then
+        temp_file="/sys/class/hwmon/hwmon0/temp1_input"
+    else
+        temp_file=""
+    fi
+
+    # Test existence of setupVars config
+    if [[ -f "/etc/pihole/setupVars.conf" ]]; then
+        setupVars="/etc/pihole/setupVars.conf"
+    fi
 }
 
 get_sys_stats() {
-  local ph_ver_raw
-  local cpu_raw
-  local ram_raw
-  local disk_raw
+    local ph_ver_raw
+    local cpu_raw
+    local ram_raw
+    local disk_raw
 
-  # Update every 12 refreshes (Def: every 60s)
-  count=$((count+1))
-  if [[ "$count" == "1" ]] || (( "$count" % 12 == 0 )); then
-    [[ -n "$setupVars" ]] && source "$setupVars"
-    
-    
-    ph_ver_raw=($(pihole -v -c 2> /dev/null | sed -n 's/^.* v/v/p'))
-    if [[ -n "${ph_ver_raw[0]}" ]]; then
-      ph_core_ver="${ph_ver_raw[0]}"
-      ph_lte_ver="${ph_ver_raw[1]}"
-      ph_ftl_ver="${ph_ver_raw[2]}"
-    else
-      ph_core_ver="${COL_LIGHT_RED}API unavailable${COL_NC}"
+    # Update every 12 refreshes (Def: every 60s)
+    count=$((count+1))
+    if [[ "$count" == "1" ]] || (( "$count" % 12 == 0 )); then
+        # Do not source setupVars if file does not exist
+        [[ -n "$setupVars" ]] && source "$setupVars"
+
+        mapfile -t ph_ver_raw < <(pihole -v -c 2> /dev/null | sed -n 's/^.* v/v/p')
+        if [[ -n "${ph_ver_raw[0]}" ]]; then
+            ph_core_ver="${ph_ver_raw[0]}"
+            if [[ ${#ph_ver_raw[@]} -eq 2 ]]; then
+                # AdminLTE not installed
+                ph_lte_ver="(not installed)"
+                ph_ftl_ver="${ph_ver_raw[1]}"
+            else
+                ph_lte_ver="${ph_ver_raw[1]}"
+                ph_ftl_ver="${ph_ver_raw[2]}"
+            fi
+        else
+            ph_core_ver="-1"
+        fi
+
+        sys_name=$(hostname)
+
+        [[ -n "$TEMPERATUREUNIT" ]] && temp_unit="${TEMPERATUREUNIT^^}" || temp_unit="C"
+
+        # Get storage stats for partition mounted on /
+        read -r -a disk_raw <<< "$(df -B1 / 2> /dev/null | awk 'END{ print $3,$2,$5 }')"
+        disk_used="${disk_raw[0]}"
+        disk_total="${disk_raw[1]}"
+        disk_perc="${disk_raw[2]}"
+
+        net_gateway=$(ip route | grep default | cut -d ' ' -f 3 | head -n 1)
+
+        # Get DHCP stats, if feature is enabled
+        if [[ "$DHCP_ACTIVE" == "true" ]]; then
+            ph_dhcp_max=$(( ${DHCP_END##*.} - ${DHCP_START##*.} + 1 ))
+        fi
+
+        # Get DNS server count
+        dns_count="0"
+        [[ -n "${PIHOLE_DNS_1}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_2}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_3}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_4}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_5}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_6}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_7}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_8}" ]] && dns_count=$((dns_count+1))
+        [[ -n "${PIHOLE_DNS_9}" ]] && dns_count="$dns_count+"
     fi
-    
-    sys_name=$(hostname)
-    
-    [[ -n "$TEMPERATUREUNIT" ]] && temp_unit="$TEMPERATUREUNIT" || temp_unit="c"
-    
-    # Get storage stats for partition mounted on /
-    disk_raw=($(df -B1 / 2> /dev/null | awk 'END{ print $3,$2,$5 }'))
-    disk_used="${disk_raw[0]}"
-    disk_total="${disk_raw[1]}"
-    disk_perc="${disk_raw[2]}"
-    
-    net_gateway=$(route -n | awk '$4 == "UG" {print $2;exit}')
-    
-    # Get DHCP stats, if feature is enabled
+
+    # Get screen size
+    read -r -a scr_size <<< "$(stty size 2>/dev/null || echo 24 80)"
+    scr_lines="${scr_size[0]}"
+    scr_cols="${scr_size[1]}"
+
+    # Determine Chronometer size behavior
+    if [[ "$scr_cols" -ge 58 ]]; then
+        chrono_width="large"
+    elif [[ "$scr_cols" -gt 40 ]]; then
+        chrono_width="medium"
+    else
+        chrono_width="small"
+    fi
+
+    # Determine max length of divider string
+    scr_line_len=$(( scr_cols - 2 ))
+    [[ "$scr_line_len" -ge 58 ]] && scr_line_len="58"
+    scr_line_str=$(printf "%${scr_line_len}s")
+    scr_line_str="${scr_line_str// /—}"
+
+    sys_uptime=$(hrSecs "$(cut -d. -f1 /proc/uptime)")
+    sys_loadavg=$(cut -d " " -f1,2,3 /proc/loadavg)
+
+    # Get CPU usage, only counting processes over 1% as active
+    # shellcheck disable=SC2009
+    cpu_raw=$(ps -eo pcpu,rss --no-headers | grep -E -v "    0")
+    cpu_tasks=$(wc -l <<< "$cpu_raw")
+    cpu_taskact=$(sed -r "/(^ 0.)/d" <<< "$cpu_raw" | wc -l)
+    cpu_perc=$(awk '{sum+=$1} END {printf "%.0f\n", sum/'"$sys_cores"'}' <<< "$cpu_raw")
+
+    # Get CPU clock speed
+    if [[ -n "$scaling_freq_file" ]]; then
+        cpu_mhz=$(( $(< /sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq) / 1000 ))
+    else
+        cpu_mhz=$(lscpu | awk -F ":" '/MHz/ {print $2;exit}')
+        cpu_mhz=$(printf "%.0f" "${cpu_mhz//[[:space:]]/}")
+    fi
+
+    # Determine whether to display CPU clock speed as MHz or GHz
+    if [[ -n "$cpu_mhz" ]]; then
+        [[ "$cpu_mhz" -le "999" ]] && cpu_freq="$cpu_mhz MHz" || cpu_freq="$(printf "%.1f" $(calcFunc "$cpu_mhz"/1000)) GHz"
+        [[ "${cpu_freq}" == *".0"* ]] && cpu_freq="${cpu_freq/.0/}"
+    fi
+
+    # Determine color for temperature
+    if [[ -n "$temp_file" ]]; then
+        if [[ "$temp_unit" == "C" ]]; then
+            cpu_temp=$(printf "%.0fc\\n" "$(calcFunc "$(< $temp_file) / 1000")")
+
+            case "${cpu_temp::-1}" in
+                -*|[0-9]|[1-3][0-9]) cpu_col="$COL_LIGHT_BLUE";;
+                4[0-9]) cpu_col="";;
+                5[0-9]) cpu_col="$COL_YELLOW";;
+                6[0-9]) cpu_col="$COL_LIGHT_RED";;
+                *) cpu_col="$COL_URG_RED";;
+            esac
+
+            # $COL_NC$COL_DARK_GRAY is needed for $COL_URG_RED
+            cpu_temp_str=" @ $cpu_col$cpu_temp$COL_NC$COL_DARK_GRAY"
+
+        elif [[ "$temp_unit" == "F" ]]; then
+            cpu_temp=$(printf "%.0ff\\n" "$(calcFunc "($(< $temp_file) / 1000) * 9 / 5 + 32")")
+
+            case "${cpu_temp::-1}" in
+                -*|[0-9]|[0-9][0-9]) cpu_col="$COL_LIGHT_BLUE";;
+                1[0-1][0-9]) cpu_col="";;
+                1[2-3][0-9]) cpu_col="$COL_YELLOW";;
+                1[4-5][0-9]) cpu_col="$COL_LIGHT_RED";;
+                *) cpu_col="$COL_URG_RED";;
+            esac
+
+            cpu_temp_str=" @ $cpu_col$cpu_temp$COL_NC$COL_DARK_GRAY"
+
+        else
+            cpu_temp_str=$(printf " @ %.0fk\\n" "$(calcFunc "($(< $temp_file) / 1000) + 273.15")")
+        fi
+    else
+        cpu_temp_str=""
+    fi
+
+    read -r -a ram_raw <<< "$(awk '/MemTotal:/{total=$2} /MemFree:/{free=$2} /Buffers:/{buffers=$2} /^Cached:/{cached=$2} END {printf "%.0f %.0f %.0f", (total-free-buffers-cached)*100/total, (total-free-buffers-cached)*1024, total*1024}' /proc/meminfo)"
+    ram_perc="${ram_raw[0]}"
+    ram_used="${ram_raw[1]}"
+    ram_total="${ram_raw[2]}"
+
+    if [[ "$(pihole status web 2> /dev/null)" == "1" ]]; then
+        ph_status="${COL_LIGHT_GREEN}Active"
+    else
+        ph_status="${COL_LIGHT_RED}Offline"
+    fi
+
     if [[ "$DHCP_ACTIVE" == "true" ]]; then
-      ph_dhcp_eip="${DHCP_END##*.}"
-      ph_dhcp_max=$(( ${DHCP_END##*.} - ${DHCP_START##*.} + 1 ))
+        local ph_dhcp_range
+
+        ph_dhcp_range=$(seq -s "|" -f "${DHCP_START%.*}.%g" "${DHCP_START##*.}" "${DHCP_END##*.}")
+
+        # Count dynamic leases from available range, and not static leases
+        ph_dhcp_num=$(grep -cE "$ph_dhcp_range" "/etc/pihole/dhcp.leases")
+        ph_dhcp_percent=$(( ph_dhcp_num * 100 / ph_dhcp_max ))
     fi
-    
-    # Get alt DNS server, or print total count of alt DNS servers
-    if [[ -z "${PIHOLE_DNS_3}" ]]; then
-      ph_alts="${PIHOLE_DNS_2}"
-    else
-      dns_count="0"
-      [[ -n "${PIHOLE_DNS_2}" ]] && dns_count=$((dns_count+1))
-      [[ -n "${PIHOLE_DNS_3}" ]] && dns_count=$((dns_count+1))
-      [[ -n "${PIHOLE_DNS_4}" ]] && dns_count=$((dns_count+1))
-      [[ -n "${PIHOLE_DNS_5}" ]] && dns_count=$((dns_count+1))
-      [[ -n "${PIHOLE_DNS_6}" ]] && dns_count=$((dns_count+1))
-      [[ -n "${PIHOLE_DNS_7}" ]] && dns_count=$((dns_count+1))
-      [[ -n "${PIHOLE_DNS_8}" ]] && dns_count=$((dns_count+1))
-      [[ -n "${PIHOLE_DNS_9}" ]] && dns_count="$dns_count+"
-      ph_alts="${dns_count} others"
-    fi
-  fi
-  
-  sys_uptime=$(hrSecs "$(cut -d. -f1 /proc/uptime)")
-  sys_loadavg=$(cut -d " " -f1,2,3 /proc/loadavg)
-  
-  # Get CPU usage, only counting processes over 1% CPU as active
-  cpu_raw=$(ps -eo pcpu,rss --no-headers | grep -E -v "    0")
-  cpu_tasks=$(wc -l <<< "$cpu_raw")
-  cpu_taskact=$(sed -r "/(^ 0.)/d" <<< "$cpu_raw" | wc -l)
-  cpu_perc=$(awk '{sum+=$1} END {printf "%.0f\n", sum/'"$sys_cores"'}' <<< "$cpu_raw")
-  
-  # Get CPU clock speed
-  if [[ -n "$scaling_freq_file" ]]; then
-    cpu_mhz=$(( $(< /sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq) / 1000 ))
-  else
-    cpu_mhz=$(lscpu | awk -F "[ .]+" '/MHz/ {print $4;exit}')
-  fi
-  
-  # Determine correct string format for CPU clock speed
-  if [[ -n "$cpu_mhz" ]]; then
-    [[ "$cpu_mhz" -le "999" ]] && cpu_freq="$cpu_mhz MHz" || cpu_freq="$(calcFunc "$cpu_mhz"/1000) Ghz"
-    [[ -n "$cpu_freq" ]] && cpu_freq_str=" @ $cpu_freq" || cpu_freq_str=""
-  fi
-  
-  # Determine colour for temperature
-  if [[ -n "$temp_file" ]]; then
-    if [[ "$temp_unit" == "C" ]]; then
-      cpu_temp=$(printf "%'.0fc\n" "$(calcFunc "$(< $temp_file) / 1000")")
-      
-      case "${cpu_temp::-1}" in
-        -*|[0-9]|[1-3][0-9]) cpu_col="$COL_LIGHT_BLUE";;
-        4[0-9]) cpu_col="";;
-        5[0-9]) cpu_col="$COL_YELLOW";;
-        6[0-9]) cpu_col="$COL_LIGHT_RED";;
-        *) cpu_col="$COL_URG_RED";;
-      esac
-      
-      # $COL_NC$COL_DARK_GRAY is needed for $COL_URG_RED
-      cpu_temp_str=", $cpu_col$cpu_temp$COL_NC$COL_DARK_GRAY"
-      
-    elif [[ "$temp_unit" == "F" ]]; then
-      cpu_temp=$(printf "%'.0ff\n" "$(calcFunc "($(< $temp_file) / 1000) * 9 / 5 + 32")")
-      
-      case "${cpu_temp::-1}" in
-        -*|[0-9]|[0-9][0-9]) cpu_col="$COL_LIGHT_BLUE";;
-        1[0-1][0-9]) cpu_col="";;
-        1[2-3][0-9]) cpu_col="$COL_YELLOW";;
-        1[4-5][0-9]) cpu_col="$COL_LIGHT_RED";;
-        *) cpu_col="$COL_URG_RED";;
-      esac
-      
-      cpu_temp_str=", $cpu_col$cpu_temp$COL_NC$COL_DARK_GRAY"
-      
-    else
-      cpu_temp_str=$(printf ", %'.0fk\n" "$(calcFunc "($(< $temp_file) / 1000) + 273.15")")
-    fi
-  else
-    cpu_temp_str=""
-  fi
-  
-  ram_raw=($(awk '/MemTotal:/{total=$2} /MemFree:/{free=$2} /Buffers:/{buffers=$2} /^Cached:/{cached=$2} END {printf "%.0f %.0f %.0f", (total-free-buffers-cached)*100/total, (total-free-buffers-cached)*1024, total*1024}' /proc/meminfo))
-  ram_perc="${ram_raw[0]}"
-  ram_used="${ram_raw[1]}"
-  ram_total="${ram_raw[2]}"
-  
-  if [[ "$(pihole status web 2> /dev/null)" == "1" ]]; then
-    ph_status="${COL_LIGHT_GREEN}Active"
-  else
-    ph_status="${COL_LIGHT_RED}Inactive"
-  fi
-  
-  if [[ "$DHCP_ACTIVE" == "true" ]]; then
-    ph_dhcp_num=$(wc -l 2> /dev/null < "/etc/pihole/dhcp.leases")
-  fi
 }
 
 get_ftl_stats() {
-  local stats_raw
-  
-  stats_raw=($(pihole-FTL "stats"))
-  domains_being_blocked_raw="${stats_raw[1]}"
-  dns_queries_today_raw="${stats_raw[3]}"
-  ads_blocked_today_raw="${stats_raw[5]}"
-  ads_percentage_today_raw="${stats_raw[7]}"
+    local stats_raw
 
-  # Only retrieve these stats when not called from jsonFunc
-  if [[ -z "$1" ]]; then
-    local recent_blocked_raw
-    local top_ad_raw
-    local top_domain_raw
-    local top_client_raw
-  
-    domains_being_blocked=$(printf "%'.0f\n" "${domains_being_blocked_raw}")
-    dns_queries_today=$(printf "%'.0f\n" "${dns_queries_today_raw}")
-    ads_blocked_today=$(printf "%'.0f\n" "${ads_blocked_today_raw}")
-    ads_percentage_today=$(printf "%'.0f\n" "${ads_percentage_today_raw}")
-    
-    recent_blocked_raw=$(pihole-FTL recentBlocked)
-    top_ad_raw=($(pihole-FTL "top-ads (1)"))
-    top_domain_raw=($(pihole-FTL "top-domains (1)"))
-    top_client_raw=($(pihole-FTL "top-clients (1)"))
-    
-    # Limit strings to 40 characters to prevent overflow
-    recent_blocked="${recent_blocked_raw:0:40}"
-    top_ad="${top_ad_raw[2]:0:40}"
-    top_domain="${top_domain_raw[2]:0:40}"
-    [[ "${top_client_raw[3]}" ]] && top_client="${top_client_raw[3]:0:40}" || top_client="${top_client_raw[2]:0:40}"
-  fi
+    mapfile -t stats_raw < <(pihole-FTL "stats")
+    domains_being_blocked_raw="${stats_raw[0]#* }"
+    dns_queries_today_raw="${stats_raw[1]#* }"
+    ads_blocked_today_raw="${stats_raw[2]#* }"
+    ads_percentage_today_raw="${stats_raw[3]#* }"
+    queries_forwarded_raw="${stats_raw[5]#* }"
+    queries_cached_raw="${stats_raw[6]#* }"
+
+    # Only retrieve these stats when not called from jsonFunc
+    if [[ -z "$1" ]]; then
+        local top_ad_raw
+        local top_domain_raw
+        local top_client_raw
+
+        domains_being_blocked=$(printf "%.0f\\n" "${domains_being_blocked_raw}" 2> /dev/null)
+        dns_queries_today=$(printf "%.0f\\n" "${dns_queries_today_raw}")
+        ads_blocked_today=$(printf "%.0f\\n" "${ads_blocked_today_raw}")
+        ads_percentage_today=$(printf "%'.0f\\n" "${ads_percentage_today_raw}")
+        queries_cached_percentage=$(printf "%.0f\\n" "$(calcFunc "$queries_cached_raw * 100 / ( $queries_forwarded_raw + $queries_cached_raw )")")
+        recent_blocked=$(pihole-FTL recentBlocked)
+        read -r -a top_ad_raw <<< "$(pihole-FTL "top-ads (1)")"
+        read -r -a top_domain_raw <<< "$(pihole-FTL "top-domains (1)")"
+        read -r -a top_client_raw <<< "$(pihole-FTL "top-clients (1)")"
+
+        top_ad="${top_ad_raw[2]}"
+        top_domain="${top_domain_raw[2]}"
+        if [[ "${top_client_raw[3]}" ]]; then
+            top_client="${top_client_raw[3]}"
+        else
+            top_client="${top_client_raw[2]}"
+        fi
+    fi
+}
+
+get_strings() {
+    # Expand or contract strings depending on screen size
+    if [[ "$chrono_width" == "large" ]]; then
+        phc_str="        ${COL_DARK_GRAY}Core"
+        lte_str="        ${COL_DARK_GRAY}Web"
+        ftl_str="        ${COL_DARK_GRAY}FTL"
+        api_str="${COL_LIGHT_RED}API Offline"
+
+        host_info="$sys_type"
+        sys_info="$sys_throttle"
+        sys_info2="Active: $cpu_taskact of $cpu_tasks tasks"
+        used_str="Used: "
+        leased_str="Leased: "
+        domains_being_blocked=$(printf "%'.0f" "$domains_being_blocked")
+        ads_blocked_today=$(printf "%'.0f" "$ads_blocked_today")
+        dns_queries_today=$(printf "%'.0f" "$dns_queries_today")
+        ph_info="Blocking: $domains_being_blocked sites"
+        total_str="Total: "
+    else
+        phc_str=" ${COL_DARK_GRAY}Core"
+        lte_str=" ${COL_DARK_GRAY}Web"
+        ftl_str=" ${COL_DARK_GRAY}FTL"
+        api_str="${COL_LIGHT_RED}API Down"
+        ph_info="$domains_being_blocked blocked"
+    fi
+
+    [[ "$sys_cores" -ne 1 ]] && sys_cores_txt="${sys_cores}x "
+    cpu_info="$sys_cores_txt$cpu_freq$cpu_temp_str"
+    ram_info="$used_str$(hrBytes "$ram_used") of $(hrBytes "$ram_total")"
+    disk_info="$used_str$(hrBytes "$disk_used") of $(hrBytes "$disk_total")"
+
+    lan_info="Gateway: $net_gateway"
+    dhcp_info="$leased_str$ph_dhcp_num of $ph_dhcp_max"
+
+    ads_info="$total_str$ads_blocked_today of $dns_queries_today"
+    dns_info="$dns_count DNS servers"
+
+    [[ "$recent_blocked" == "0" ]] && recent_blocked="${COL_LIGHT_RED}FTL offline${COL_NC}"
 }
 
 chronoFunc() {
-  get_init_stats
-  
-  for (( ; ; )); do
-    get_sys_stats
-    get_ftl_stats
-    
-    # Do not print LTE/FTL strings if API is unavailable
-    ph_core_str="        ${COL_DARK_GRAY}Pi-hole: $ph_core_ver${COL_NC}"
-    if [[ -n "$ph_lte_ver" ]]; then
-      ph_lte_str="      ${COL_DARK_GRAY}AdminLTE: $ph_lte_ver${COL_NC}"
-      ph_ftl_str="           ${COL_DARK_GRAY}FTL: $ph_ftl_ver${COL_NC}"
-    fi
-    
-    clear
-    
-  	echo -e "|¯¯¯(¯)__|¯|_  ___|¯|___$ph_core_str
-| ¯_/¯|__| ' \/ _ \ / -_)$ph_lte_str
-|_| |_|  |_||_\___/_\___|$ph_ftl_str
- ${COL_DARK_GRAY}——————————————————————————————————————————————————————————${COL_NC}"
+    local extra_arg="$1"
+    local extra_value="$2"
 
-    printFunc "  Hostname: " "$sys_name"
-    [ -n "$sys_type" ] && printf "%s(%s)%s\n"  "$COL_DARK_GRAY" "$sys_type" "$COL_NC" || printf "\n"
-    
-    printf "%s\n" "    Uptime: $sys_uptime"
-    
-    printFunc " Task Load: " "$sys_loadavg"
-    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Active: $cpu_taskact of $cpu_tasks tasks" "$COL_NC"
-    
-    printFunc " CPU usage: " "$cpu_perc%"
-    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "$sys_cores $sys_cores_plu$cpu_freq_str$cpu_temp_str" "$COL_NC"
-    
-    printFunc " RAM usage: " "$ram_perc%"
-    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Used: $(hrBytes "$ram_used") of $(hrBytes "$ram_total")" "$COL_NC"
-    
-    printFunc " HDD usage: " "$disk_perc"
-    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Used: $(hrBytes "$disk_used") of $(hrBytes "$disk_total")" "$COL_NC"
-    
-    printFunc "  LAN addr: " "${IPV4_ADDRESS/\/*/}"
-    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Gateway: $net_gateway" "$COL_NC"
-    
-    if [[ "$DHCP_ACTIVE" == "true" ]]; then
-      printFunc "      DHCP: " "$DHCP_START to $ph_dhcp_eip"
-      printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Leased: $ph_dhcp_num of $ph_dhcp_max" "$COL_NC"
-    fi
-    
-    printFunc "   Pi-hole: " "$ph_status"
-    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Blocking: $domains_being_blocked sites" "$COL_NC"
-    
-    printFunc " Ads Today: " "$ads_percentage_today%"
-    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "$ads_blocked_today of $dns_queries_today queries" "$COL_NC"
-    
-    printFunc "   Fwd DNS: " "$PIHOLE_DNS_1"
-    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Alt DNS: $ph_alts" "$COL_NC"
-    
-    echo -e " ${COL_DARK_GRAY}——————————————————————————————————————————————————————————${COL_NC}"
-    echo " Recently blocked: $recent_blocked"
-    echo "   Top Advertiser: $top_ad"
-    echo "       Top Domain: $top_domain"
-    printFunc "       Top Client: " "$top_client" "last"
-    
-    if [[ "$1" == "exit" ]]; then
-      exit 0
-    else
-      if [[ -n "$1" ]]; then
-        sleep "${1}"
-      else
-        sleep 5
-      fi
-    fi
-    
-  done
+    get_init_stats
+
+    for (( ; ; )); do
+        get_sys_stats
+        get_ftl_stats
+        get_strings
+
+        # Strip excess development version numbers
+        if [[ "$ph_core_ver" != "-1" ]]; then
+            phc_ver_str="$phc_str: ${ph_core_ver%-*}${COL_NC}"
+            lte_ver_str="$lte_str: ${ph_lte_ver%-*}${COL_NC}"
+            ftl_ver_str="$ftl_str: ${ph_ftl_ver%-*}${COL_NC}"
+        else
+            phc_ver_str="$phc_str: $api_str${COL_NC}"
+        fi
+
+        # Get refresh number
+        if [[ "${extra_arg}" = "refresh" ]]; then
+            num="${extra_value}"
+            num_str="Refresh set for every $num seconds"
+        else
+            num_str=""
+        fi
+
+        clear
+
+        # Remove exit message heading on third refresh
+        if [[ "$count" -le 2 ]] && [[ "${extra_arg}" != "exit" ]]; then
+            echo -e " ${COL_LIGHT_GREEN}Pi-hole Chronometer${COL_NC}
+            $num_str
+            ${COL_LIGHT_RED}Press Ctrl-C to exit${COL_NC}
+            ${COL_DARK_GRAY}$scr_line_str${COL_NC}"
+        else
+            echo -e "|¯¯¯(¯)_|¯|_  ___|¯|___$phc_ver_str\\n| ¯_/¯|_| ' \\/ _ \\ / -_)$lte_ver_str\\n|_| |_| |_||_\\___/_\\___|$ftl_ver_str\\n ${COL_DARK_GRAY}$scr_line_str${COL_NC}"
+        fi
+
+        printFunc "  Hostname: " "$sys_name" "$host_info"
+        printFunc "    Uptime: " "$sys_uptime" "$sys_info"
+        printFunc " Task Load: " "$sys_loadavg" "$sys_info2"
+        printFunc " CPU usage: " "$cpu_perc%" "$cpu_info"
+        printFunc " RAM usage: " "$ram_perc%" "$ram_info"
+        printFunc " HDD usage: " "$disk_perc" "$disk_info"
+
+        if [[ "$DHCP_ACTIVE" == "true" ]]; then
+            printFunc "DHCP usage: " "$ph_dhcp_percent%" "$dhcp_info"
+        fi
+
+        printFunc "   Pi-hole: " "$ph_status" "$ph_info"
+        printFunc " Ads Today: " "$ads_percentage_today%" "$ads_info"
+        printFunc "Local Qrys: " "$queries_cached_percentage%" "$dns_info"
+
+        printFunc "   Blocked: " "$recent_blocked"
+        printFunc "Top Advert: " "$top_ad"
+
+        # Provide more stats on screens with more lines
+        if [[ "$scr_lines" -eq 17 ]]; then
+            if [[ "$DHCP_ACTIVE" == "true" ]]; then
+                printFunc "Top Domain: " "$top_domain" "last"
+            else
+                print_client="true"
+            fi
+        else
+            print_client="true"
+        fi
+
+        if [[ -n "$print_client" ]]; then
+            printFunc "Top Domain: " "$top_domain"
+            printFunc "Top Client: " "$top_client" "last"
+        fi
+
+        # Handle exit/refresh options
+        if [[ "${extra_arg}" == "exit" ]]; then
+            exit 0
+        else
+            if [[ "${extra_arg}" == "refresh" ]]; then
+                sleep "$num"
+            else
+                sleep 5
+            fi
+        fi
+
+    done
 }
 
 jsonFunc() {
-  get_ftl_stats "json"
-  echo "{\"domains_being_blocked\":${domains_being_blocked_raw},\"dns_queries_today\":${dns_queries_today_raw},\"ads_blocked_today\":${ads_blocked_today_raw},\"ads_percentage_today\":${ads_percentage_today_raw}}"
+    get_ftl_stats "json"
+    echo "{\"domains_being_blocked\":${domains_being_blocked_raw},\"dns_queries_today\":${dns_queries_today_raw},\"ads_blocked_today\":${ads_blocked_today_raw},\"ads_percentage_today\":${ads_percentage_today_raw}}"
 }
 
 helpFunc() {
     if [[ "$1" == "?" ]]; then
-      echo "Unknown option. Please view 'pihole -c --help' for more information"
+        echo "Unknown option. Please view 'pihole -c --help' for more information"
     else
-      echo "Usage: pihole -c [options]
+        echo "Usage: pihole -c [options]
 Example: 'pihole -c -j'
 Calculates stats and displays to an LCD
-    
+
 Options:
   -j, --json          Output stats as JSON formatted string
   -r, --refresh       Set update frequency (in seconds)
-  -e, --exit          Output stats and exit witout refreshing
+  -e, --exit          Output stats and exit without refreshing
   -h, --help          Display this help text"
   fi
-  
+
   exit 0
 }
 
 if [[ $# = 0 ]]; then
-  chronoFunc
+    chronoFunc
 fi
 
-for var in "$@"; do
-  case "$var" in
+case "$1" in
     "-j" | "--json"    ) jsonFunc;;
     "-h" | "--help"    ) helpFunc;;
-    "-r" | "--refresh" ) chronoFunc "$2";;
-    "-e" | "--exit"    ) chronoFunc "exit";;
+    "-r" | "--refresh" ) chronoFunc refresh "$2";;
+    "-e" | "--exit"    ) chronoFunc exit;;
     *                  ) helpFunc "?";;
-  esac
-done
+esac

advanced/Scripts/database_migration/gravity-db.sh

@@ -0,0 +1,131 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC1090
+
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2019 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# Updates gravity.db database
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+readonly scriptPath="/etc/.pihole/advanced/Scripts/database_migration/gravity"
+
+upgrade_gravityDB(){
+	local database piholeDir auditFile version
+	database="${1}"
+	piholeDir="${2}"
+	auditFile="${piholeDir}/auditlog.list"
+
+	# Get database version
+	version="$(sqlite3 "${database}" "SELECT \"value\" FROM \"info\" WHERE \"property\" = 'version';")"
+
+	if [[ "$version" == "1" ]]; then
+		# This migration script upgrades the gravity.db file by
+		# adding the domain_audit table
+		echo -e "  ${INFO} Upgrading gravity database from version 1 to 2"
+		sqlite3 "${database}" < "${scriptPath}/1_to_2.sql"
+		version=2
+
+		# Store audit domains in database table
+		if [ -e "${auditFile}" ]; then
+			echo -e "  ${INFO} Migrating content of ${auditFile} into new database"
+			# database_table_from_file is defined in gravity.sh
+			database_table_from_file "domain_audit" "${auditFile}"
+		fi
+	fi
+	if [[ "$version" == "2" ]]; then
+		# This migration script upgrades the gravity.db file by
+		# renaming the regex table to regex_blacklist, and
+		# creating a new regex_whitelist table + corresponding linking table and views
+		echo -e "  ${INFO} Upgrading gravity database from version 2 to 3"
+		sqlite3 "${database}" < "${scriptPath}/2_to_3.sql"
+		version=3
+	fi
+	if [[ "$version" == "3" ]]; then
+		# This migration script unifies the formally separated domain
+		# lists into a single table with a UNIQUE domain constraint
+		echo -e "  ${INFO} Upgrading gravity database from version 3 to 4"
+		sqlite3 "${database}" < "${scriptPath}/3_to_4.sql"
+		version=4
+	fi
+	if [[ "$version" == "4" ]]; then
+		# This migration script upgrades the gravity and list views
+		# implementing necessary changes for per-client blocking
+		echo -e "  ${INFO} Upgrading gravity database from version 4 to 5"
+		sqlite3 "${database}" < "${scriptPath}/4_to_5.sql"
+		version=5
+	fi
+	if [[ "$version" == "5" ]]; then
+		# This migration script upgrades the adlist view
+		# to return an ID used in gravity.sh
+		echo -e "  ${INFO} Upgrading gravity database from version 5 to 6"
+		sqlite3 "${database}" < "${scriptPath}/5_to_6.sql"
+		version=6
+	fi
+	if [[ "$version" == "6" ]]; then
+		# This migration script adds a special group with ID 0
+		# which is automatically associated to all clients not
+		# having their own group assignments
+		echo -e "  ${INFO} Upgrading gravity database from version 6 to 7"
+		sqlite3 "${database}" < "${scriptPath}/6_to_7.sql"
+		version=7
+	fi
+	if [[ "$version" == "7" ]]; then
+		# This migration script recreated the group table
+		# to ensure uniqueness on the group name
+		# We also add date_added and date_modified columns
+		echo -e "  ${INFO} Upgrading gravity database from version 7 to 8"
+		sqlite3 "${database}" < "${scriptPath}/7_to_8.sql"
+		version=8
+	fi
+	if [[ "$version" == "8" ]]; then
+		# This migration fixes some issues that were introduced
+		# in the previous migration script.
+		echo -e "  ${INFO} Upgrading gravity database from version 8 to 9"
+		sqlite3 "${database}" < "${scriptPath}/8_to_9.sql"
+		version=9
+	fi
+	if [[ "$version" == "9" ]]; then
+		# This migration drops unused tables and creates triggers to remove
+		# obsolete groups assignments when the linked items are deleted
+		echo -e "  ${INFO} Upgrading gravity database from version 9 to 10"
+		sqlite3 "${database}" < "${scriptPath}/9_to_10.sql"
+		version=10
+	fi
+	if [[ "$version" == "10" ]]; then
+		# This adds timestamp and an optional comment field to the client table
+		# These fields are only temporary and will be replaces by the columns
+		# defined in gravity.db.sql during gravity swapping. We add them here
+		# to keep the copying process generic (needs the same columns in both the
+		# source and the destination databases).
+		echo -e "  ${INFO} Upgrading gravity database from version 10 to 11"
+		sqlite3 "${database}" < "${scriptPath}/10_to_11.sql"
+		version=11
+	fi
+	if [[ "$version" == "11" ]]; then
+		# Rename group 0 from "Unassociated" to "Default"
+		echo -e "  ${INFO} Upgrading gravity database from version 11 to 12"
+		sqlite3 "${database}" < "${scriptPath}/11_to_12.sql"
+		version=12
+	fi
+	if [[ "$version" == "12" ]]; then
+		# Add column date_updated to adlist table
+		echo -e "  ${INFO} Upgrading gravity database from version 12 to 13"
+		sqlite3 "${database}" < "${scriptPath}/12_to_13.sql"
+		version=13
+	fi
+	if [[ "$version" == "13" ]]; then
+		# Add columns number and status to adlist table
+		echo -e "  ${INFO} Upgrading gravity database from version 13 to 14"
+		sqlite3 "${database}" < "${scriptPath}/13_to_14.sql"
+		version=14
+	fi
+	if [[ "$version" == "14" ]]; then
+		# Changes the vw_adlist created in 5_to_6
+		echo -e "  ${INFO} Upgrading gravity database from version 14 to 15"
+		sqlite3 "${database}" < "${scriptPath}/14_to_15.sql"
+		version=15
+	fi
+}

advanced/Scripts/database_migration/gravity/10_to_11.sql

@@ -0,0 +1,16 @@
+.timeout 30000
+
+BEGIN TRANSACTION;
+
+ALTER TABLE client ADD COLUMN date_added INTEGER;
+ALTER TABLE client ADD COLUMN date_modified INTEGER;
+ALTER TABLE client ADD COLUMN comment TEXT;
+
+CREATE TRIGGER tr_client_update AFTER UPDATE ON client
+    BEGIN
+      UPDATE client SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE id = NEW.id;
+    END;
+
+UPDATE info SET value = 11 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/11_to_12.sql

@@ -0,0 +1,19 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+UPDATE "group" SET name = 'Default' WHERE id = 0;
+UPDATE "group" SET description = 'The default group' WHERE id = 0;
+
+DROP TRIGGER IF EXISTS tr_group_zero;
+
+CREATE TRIGGER tr_group_zero AFTER DELETE ON "group"
+    BEGIN
+      INSERT OR IGNORE INTO "group" (id,enabled,name,description) VALUES (0,1,'Default','The default group');
+    END;
+
+UPDATE info SET value = 12 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/12_to_13.sql

@@ -0,0 +1,18 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+ALTER TABLE adlist ADD COLUMN date_updated INTEGER;
+
+DROP TRIGGER tr_adlist_update;
+
+CREATE TRIGGER tr_adlist_update AFTER UPDATE OF address,enabled,comment ON adlist
+    BEGIN
+      UPDATE adlist SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE id = NEW.id;
+    END;
+
+UPDATE info SET value = 13 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/13_to_14.sql

@@ -0,0 +1,13 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+ALTER TABLE adlist ADD COLUMN number INTEGER NOT NULL DEFAULT 0;
+ALTER TABLE adlist ADD COLUMN invalid_domains INTEGER NOT NULL DEFAULT 0;
+ALTER TABLE adlist ADD COLUMN status INTEGER NOT NULL DEFAULT 0;
+
+UPDATE info SET value = 14 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/14_to_15.sql

@@ -0,0 +1,15 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+DROP VIEW vw_adlist;
+
+CREATE VIEW vw_adlist AS SELECT DISTINCT address, id
+    FROM adlist
+    WHERE enabled = 1
+    ORDER BY id;
+
+UPDATE info SET value = 15 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/1_to_2.sql

@@ -0,0 +1,14 @@
+.timeout 30000
+
+BEGIN TRANSACTION;
+
+CREATE TABLE domain_audit
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	domain TEXT UNIQUE NOT NULL,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int))
+);
+
+UPDATE info SET value = 2 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/2_to_3.sql

@@ -0,0 +1,65 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+ALTER TABLE regex RENAME TO regex_blacklist;
+
+CREATE TABLE regex_blacklist_by_group
+(
+	regex_blacklist_id INTEGER NOT NULL REFERENCES regex_blacklist (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (regex_blacklist_id, group_id)
+);
+
+INSERT INTO regex_blacklist_by_group SELECT * FROM regex_by_group;
+DROP TABLE regex_by_group;
+DROP VIEW vw_regex;
+DROP TRIGGER tr_regex_update;
+
+CREATE VIEW vw_regex_blacklist AS SELECT DISTINCT domain
+    FROM regex_blacklist
+    LEFT JOIN regex_blacklist_by_group ON regex_blacklist_by_group.regex_blacklist_id = regex_blacklist.id
+    LEFT JOIN "group" ON "group".id = regex_blacklist_by_group.group_id
+    WHERE regex_blacklist.enabled = 1 AND (regex_blacklist_by_group.group_id IS NULL OR "group".enabled = 1)
+    ORDER BY regex_blacklist.id;
+
+CREATE TRIGGER tr_regex_blacklist_update AFTER UPDATE ON regex_blacklist
+    BEGIN
+      UPDATE regex_blacklist SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE domain = NEW.domain;
+    END;
+
+CREATE TABLE regex_whitelist
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	domain TEXT UNIQUE NOT NULL,
+	enabled BOOLEAN NOT NULL DEFAULT 1,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	comment TEXT
+);
+
+CREATE TABLE regex_whitelist_by_group
+(
+	regex_whitelist_id INTEGER NOT NULL REFERENCES regex_whitelist (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (regex_whitelist_id, group_id)
+);
+
+CREATE VIEW vw_regex_whitelist AS SELECT DISTINCT domain
+    FROM regex_whitelist
+    LEFT JOIN regex_whitelist_by_group ON regex_whitelist_by_group.regex_whitelist_id = regex_whitelist.id
+    LEFT JOIN "group" ON "group".id = regex_whitelist_by_group.group_id
+    WHERE regex_whitelist.enabled = 1 AND (regex_whitelist_by_group.group_id IS NULL OR "group".enabled = 1)
+    ORDER BY regex_whitelist.id;
+
+CREATE TRIGGER tr_regex_whitelist_update AFTER UPDATE ON regex_whitelist
+    BEGIN
+      UPDATE regex_whitelist SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE domain = NEW.domain;
+    END;
+
+
+UPDATE info SET value = 3 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/3_to_4.sql

@@ -0,0 +1,96 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+CREATE TABLE domainlist
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	type INTEGER NOT NULL DEFAULT 0,
+	domain TEXT UNIQUE NOT NULL,
+	enabled BOOLEAN NOT NULL DEFAULT 1,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	comment TEXT
+);
+
+ALTER TABLE whitelist ADD COLUMN type INTEGER;
+UPDATE whitelist SET type = 0;
+INSERT INTO domainlist (type,domain,enabled,date_added,date_modified,comment)
+    SELECT type,domain,enabled,date_added,date_modified,comment FROM whitelist;
+
+ALTER TABLE blacklist ADD COLUMN type INTEGER;
+UPDATE blacklist SET type = 1;
+INSERT INTO domainlist (type,domain,enabled,date_added,date_modified,comment)
+    SELECT type,domain,enabled,date_added,date_modified,comment FROM blacklist;
+
+ALTER TABLE regex_whitelist ADD COLUMN type INTEGER;
+UPDATE regex_whitelist SET type = 2;
+INSERT INTO domainlist (type,domain,enabled,date_added,date_modified,comment)
+    SELECT type,domain,enabled,date_added,date_modified,comment FROM regex_whitelist;
+
+ALTER TABLE regex_blacklist ADD COLUMN type INTEGER;
+UPDATE regex_blacklist SET type = 3;
+INSERT INTO domainlist (type,domain,enabled,date_added,date_modified,comment)
+    SELECT type,domain,enabled,date_added,date_modified,comment FROM regex_blacklist;
+
+DROP TABLE whitelist_by_group;
+DROP TABLE blacklist_by_group;
+DROP TABLE regex_whitelist_by_group;
+DROP TABLE regex_blacklist_by_group;
+CREATE TABLE domainlist_by_group
+(
+	domainlist_id INTEGER NOT NULL REFERENCES domainlist (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (domainlist_id, group_id)
+);
+
+DROP TRIGGER tr_whitelist_update;
+DROP TRIGGER tr_blacklist_update;
+DROP TRIGGER tr_regex_whitelist_update;
+DROP TRIGGER tr_regex_blacklist_update;
+CREATE TRIGGER tr_domainlist_update AFTER UPDATE ON domainlist
+    BEGIN
+      UPDATE domainlist SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE domain = NEW.domain;
+    END;
+
+DROP VIEW vw_whitelist;
+CREATE VIEW vw_whitelist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 0
+    ORDER BY domainlist.id;
+
+DROP VIEW vw_blacklist;
+CREATE VIEW vw_blacklist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 1
+    ORDER BY domainlist.id;
+
+DROP VIEW vw_regex_whitelist;
+CREATE VIEW vw_regex_whitelist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 2
+    ORDER BY domainlist.id;
+
+DROP VIEW vw_regex_blacklist;
+CREATE VIEW vw_regex_blacklist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 3
+    ORDER BY domainlist.id;
+
+UPDATE info SET value = 4 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/4_to_5.sql

@@ -0,0 +1,38 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+DROP TABLE gravity;
+CREATE TABLE gravity
+(
+	domain TEXT NOT NULL,
+	adlist_id INTEGER NOT NULL REFERENCES adlist (id),
+	PRIMARY KEY(domain, adlist_id)
+);
+
+DROP VIEW vw_gravity;
+CREATE VIEW vw_gravity AS SELECT domain, adlist_by_group.group_id AS group_id
+    FROM gravity
+    LEFT JOIN adlist_by_group ON adlist_by_group.adlist_id = gravity.adlist_id
+    LEFT JOIN adlist ON adlist.id = gravity.adlist_id
+    LEFT JOIN "group" ON "group".id = adlist_by_group.group_id
+    WHERE adlist.enabled = 1 AND (adlist_by_group.group_id IS NULL OR "group".enabled = 1);
+
+CREATE TABLE client
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	ip TEXT NOL NULL UNIQUE
+);
+
+CREATE TABLE client_by_group
+(
+	client_id INTEGER NOT NULL REFERENCES client (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (client_id, group_id)
+);
+
+UPDATE info SET value = 5 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/5_to_6.sql

@@ -0,0 +1,18 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+DROP VIEW vw_adlist;
+CREATE VIEW vw_adlist AS SELECT DISTINCT address, adlist.id AS id
+    FROM adlist
+    LEFT JOIN adlist_by_group ON adlist_by_group.adlist_id = adlist.id
+    LEFT JOIN "group" ON "group".id = adlist_by_group.group_id
+    WHERE adlist.enabled = 1 AND (adlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    ORDER BY adlist.id;
+
+UPDATE info SET value = 6 WHERE property = 'version';
+
+COMMIT;
+

advanced/Scripts/database_migration/gravity/6_to_7.sql

@@ -0,0 +1,35 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+INSERT OR REPLACE INTO "group" (id,enabled,name) VALUES (0,1,'Unassociated');
+
+INSERT INTO domainlist_by_group (domainlist_id, group_id) SELECT id, 0 FROM domainlist;
+INSERT INTO client_by_group (client_id, group_id) SELECT id, 0 FROM client;
+INSERT INTO adlist_by_group (adlist_id, group_id) SELECT id, 0 FROM adlist;
+
+CREATE TRIGGER tr_domainlist_add AFTER INSERT ON domainlist
+    BEGIN
+      INSERT INTO domainlist_by_group (domainlist_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_client_add AFTER INSERT ON client
+    BEGIN
+      INSERT INTO client_by_group (client_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_adlist_add AFTER INSERT ON adlist
+    BEGIN
+      INSERT INTO adlist_by_group (adlist_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_group_zero AFTER DELETE ON "group"
+    BEGIN
+      INSERT OR REPLACE INTO "group" (id,enabled,name) VALUES (0,1,'Unassociated');
+    END;
+
+UPDATE info SET value = 7 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/7_to_8.sql

@@ -0,0 +1,35 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+ALTER TABLE "group" RENAME TO "group__";
+
+CREATE TABLE "group"
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	enabled BOOLEAN NOT NULL DEFAULT 1,
+	name TEXT UNIQUE NOT NULL,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	description TEXT
+);
+
+CREATE TRIGGER tr_group_update AFTER UPDATE ON "group"
+    BEGIN
+      UPDATE "group" SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE id = NEW.id;
+    END;
+
+INSERT OR IGNORE INTO "group" (id,enabled,name,description) SELECT id,enabled,name,description FROM "group__";
+
+DROP TABLE "group__";
+
+CREATE TRIGGER tr_group_zero AFTER DELETE ON "group"
+    BEGIN
+      INSERT OR IGNORE INTO "group" (id,enabled,name) VALUES (0,1,'Unassociated');
+    END;
+
+UPDATE info SET value = 8 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/8_to_9.sql

@@ -0,0 +1,27 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+DROP TRIGGER IF EXISTS tr_group_update;
+DROP TRIGGER IF EXISTS tr_group_zero;
+
+PRAGMA legacy_alter_table=ON;
+ALTER TABLE "group" RENAME TO "group__";
+PRAGMA legacy_alter_table=OFF;
+ALTER TABLE "group__" RENAME TO "group";
+
+CREATE TRIGGER tr_group_update AFTER UPDATE ON "group"
+    BEGIN
+      UPDATE "group" SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE id = NEW.id;
+    END;
+
+CREATE TRIGGER tr_group_zero AFTER DELETE ON "group"
+    BEGIN
+      INSERT OR IGNORE INTO "group" (id,enabled,name) VALUES (0,1,'Unassociated');
+    END;
+
+UPDATE info SET value = 9 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/database_migration/gravity/9_to_10.sql

@@ -0,0 +1,29 @@
+.timeout 30000
+
+PRAGMA FOREIGN_KEYS=OFF;
+
+BEGIN TRANSACTION;
+
+DROP TABLE IF EXISTS whitelist;
+DROP TABLE IF EXISTS blacklist;
+DROP TABLE IF EXISTS regex_whitelist;
+DROP TABLE IF EXISTS regex_blacklist;
+
+CREATE TRIGGER tr_domainlist_delete AFTER DELETE ON domainlist
+    BEGIN
+      DELETE FROM domainlist_by_group WHERE domainlist_id = OLD.id;
+    END;
+
+CREATE TRIGGER tr_adlist_delete AFTER DELETE ON adlist
+    BEGIN
+      DELETE FROM adlist_by_group WHERE adlist_id = OLD.id;
+    END;
+
+CREATE TRIGGER tr_client_delete AFTER DELETE ON client
+    BEGIN
+      DELETE FROM client_by_group WHERE client_id = OLD.id;
+    END;
+
+UPDATE info SET value = 10 WHERE property = 'version';
+
+COMMIT;

advanced/Scripts/list.sh

@@ -1,4 +1,6 @@
 #!/usr/bin/env bash
+# shellcheck disable=SC1090
+
 # Pi-hole: A black hole for Internet advertisements
 # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
 # Network-wide ad blocking via your own hardware.
@@ -9,217 +11,291 @@
 # Please see LICENSE file for your rights under this license.
 
 # Globals
-basename=pihole
-piholeDir=/etc/${basename}
-whitelist=${piholeDir}/whitelist.txt
-blacklist=${piholeDir}/blacklist.txt
-readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
-reload=false
+piholeDir="/etc/pihole"
+GRAVITYDB="${piholeDir}/gravity.db"
+# Source pihole-FTL from install script
+pihole_FTL="${piholeDir}/pihole-FTL.conf"
+if [[ -f "${pihole_FTL}" ]]; then
+    source "${pihole_FTL}"
+fi
+
+# Set this only after sourcing pihole-FTL.conf as the gravity database path may
+# have changed
+gravityDBfile="${GRAVITYDB}"
+
+noReloadRequested=false
 addmode=true
 verbose=true
+wildcard=false
+web=false
 
 domList=()
-domToRemoveList=()
 
-listMain=""
-listAlt=""
+typeId=""
+comment=""
+declare -i domaincount
+domaincount=0
+reload=false
+
+colfile="/opt/pihole/COL_TABLE"
+source ${colfile}
+
+# IDs are hard-wired to domain interpretation in the gravity database scheme
+# Clients (including FTL) will read them through the corresponding views
+readonly whitelist="0"
+readonly blacklist="1"
+readonly regex_whitelist="2"
+readonly regex_blacklist="3"
+
+GetListnameFromTypeId() {
+    if [[ "$1" == "${whitelist}" ]]; then
+        echo "whitelist"
+    elif  [[ "$1" == "${blacklist}" ]]; then
+        echo "blacklist"
+    elif  [[ "$1" == "${regex_whitelist}" ]]; then
+        echo "regex whitelist"
+    elif  [[ "$1" == "${regex_blacklist}" ]]; then
+        echo "regex blacklist"
+    fi
+}
+
+GetListParamFromTypeId() {
+    if [[ "${typeId}" == "${whitelist}" ]]; then
+        echo "w"
+    elif  [[ "${typeId}" == "${blacklist}" ]]; then
+        echo "b"
+    elif  [[ "${typeId}" == "${regex_whitelist}" && "${wildcard}" == true ]]; then
+        echo "-white-wild"
+    elif  [[ "${typeId}" == "${regex_whitelist}" ]]; then
+        echo "-white-regex"
+    elif  [[ "${typeId}" == "${regex_blacklist}" && "${wildcard}" == true ]]; then
+        echo "-wild"
+    elif  [[ "${typeId}" == "${regex_blacklist}" ]]; then
+        echo "-regex"
+    fi
+}
 
 helpFunc() {
-  if [[ "${listMain}" == "${whitelist}" ]]; then
-    param="w"
-    type="white"
-  elif [[ "${listMain}" == "${wildcardlist}" ]]; then
-    param="wild"
-    type="wildcard black"
-  else
-    param="b"
-    type="black"
-  fi
+    local listname param
+
+    listname="$(GetListnameFromTypeId "${typeId}")"
+    param="$(GetListParamFromTypeId)"
 
     echo "Usage: pihole -${param} [options] <domain> <domain2 ...>
 Example: 'pihole -${param} site.com', or 'pihole -${param} site1.com site2.com'
-${type^}list one or more domains
+${listname^} one or more domains
 
 Options:
-  -d, --delmode       Remove domain(s) from the ${type}list
-  -nr, --noreload     Update ${type}list without refreshing dnsmasq
+  -d, --delmode       Remove domain(s) from the ${listname}
+  -nr, --noreload     Update ${listname} without reloading the DNS server
   -q, --quiet         Make output less verbose
   -h, --help          Show this help dialog
-  -l, --list          Display all your ${type}listed domains"
+  -l, --list          Display all your ${listname}listed domains
+  --nuke              Removes all entries in a list
+  --comment \"text\"    Add a comment to the domain. If adding multiple domains the same comment will be used for all"
 
   exit 0
 }
 
-EscapeRegexp() {
-  # This way we may safely insert an arbitrary
-  # string in our regular expressions
-  # Also remove leading "." if present
-  echo $* | sed 's/^\.*//' | sed "s/[]\.|$(){}?+*^]/\\\\&/g" | sed "s/\\//\\\\\//g"
-}
+ValidateDomain() {
+    # Convert to lowercase
+    domain="${1,,}"
 
-HandleOther() {
-  # First, convert everything to lowercase
-  domain=$(sed -e "y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/" <<< "$1")
-
-  # Check validity of domain
-  validDomain=$(echo "${domain}" | perl -lne 'print if /(?!.*[^a-z0-9-\.].*)^((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9-]+\.)*[a-z]{2,63}/')
-  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}"
-      if [[ "${listMain}" == "${whitelist}" || "${listMain}" == "${blacklist}" ]]; then
-        RemoveDomain "${dom}" "${wildcardlist}"
-      fi
-    else
-      RemoveDomain "${dom}" "${listMain}"
+    # Check validity of domain (don't check for regex entries)
+    if [[ "${#domain}" -le 253 ]]; then
+        if [[ ( "${typeId}" == "${regex_blacklist}" || "${typeId}" == "${regex_whitelist}" ) && "${wildcard}" == false ]]; then
+            validDomain="${domain}"
+        else
+            validDomain=$(grep -P "^((-|_)*[a-z\\d]((-|_)*[a-z\\d])*(-|_)*)(\\.(-|_)*([a-z\\d]((-|_)*[a-z\\d])*))*$" <<< "${domain}") # Valid chars check
+            validDomain=$(grep -P "^[^\\.]{1,63}(\\.[^\\.]{1,63})*$" <<< "${validDomain}") # Length of each label
+        fi
     fi
-  done
+
+    if [[ -n "${validDomain}" ]]; then
+        domList=("${domList[@]}" "${validDomain}")
+    else
+        echo -e "  ${CROSS} ${domain} is not a valid argument or domain name!"
+    fi
+
+    domaincount=$((domaincount+1))
+}
+
+ProcessDomainList() {
+    for dom in "${domList[@]}"; do
+        # Format domain into regex filter if requested
+        if [[ "${wildcard}" == true ]]; then
+            dom="(\\.|^)${dom//\./\\.}$"
+        fi
+
+        # 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}"
+        else
+            RemoveDomain "${dom}"
+        fi
+    done
 }
 
 AddDomain() {
-  list="$2"
-  domain=$(EscapeRegexp "$1")
+    local domain num requestedListname existingTypeId existingListname
+    domain="$1"
 
-  if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
-    bool=true
     # Is the domain in the list we want to add it to?
-    grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
+    num="$(sqlite3 "${gravityDBfile}" "SELECT COUNT(*) FROM domainlist WHERE domain = '${domain}';")"
+    requestedListname="$(GetListnameFromTypeId "${typeId}")"
 
-    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
+    if [[ "${num}" -ne 0 ]]; then
+        existingTypeId="$(sqlite3 "${gravityDBfile}" "SELECT type FROM domainlist WHERE domain = '${domain}';")"
+        if [[ "${existingTypeId}" == "${typeId}" ]]; then
+            if [[ "${verbose}" == true ]]; then
+                echo -e "  ${INFO} ${1} already exists in ${requestedListname}, no need to add!"
+            fi
+        else
+            existingListname="$(GetListnameFromTypeId "${existingTypeId}")"
+            sqlite3 "${gravityDBfile}" "UPDATE domainlist SET type = ${typeId} WHERE domain='${domain}';"
+            if [[ "${verbose}" == true ]]; then
+                echo -e "  ${INFO} ${1} already exists in ${existingListname}, it has been moved to ${requestedListname}!"
+            fi
+        fi
+        return
     fi
-  elif [[ "${list}" == "${wildcardlist}" ]]; then
-    source "${piholeDir}/setupVars.conf"
-    # Remove the /* from the end of the IPv4addr.
-    IPV4_ADDRESS=${IPV4_ADDRESS%/*}
-    IPV6_ADDRESS=${IPV6_ADDRESS}
 
-    bool=true
-    # Is the domain in the list?
-    grep -e "address=\/${domain}\/" "${wildcardlist}" > /dev/null 2>&1 || bool=false
-
-    if [[ "${bool}" == false ]]; then
-      if [[ "${verbose}" == true ]]; then
-      echo "::: Adding $1 to wildcard blacklist..."
-      fi
-      reload=true
-      echo "address=/$1/${IPV4_ADDRESS}" >> "${wildcardlist}"
-      if [[ "${#IPV6_ADDRESS}" > 0 ]]; then
-        echo "address=/$1/${IPV6_ADDRESS}" >> "${wildcardlist}"
-      fi
-    else
-      if [[ "${verbose}" == true ]]; then
-        echo "::: ${1} already exists in wildcard blacklist, no need to add!"
-      fi
+    # Domain not found in the table, add it!
+    if [[ "${verbose}" == true ]]; then
+        echo -e "  ${INFO} Adding ${domain} to the ${requestedListname}..."
+    fi
+    reload=true
+    # Insert only the domain here. The enabled and date_added fields will be filled
+    # with their default values (enabled = true, date_added = current timestamp)
+    if [[ -z "${comment}" ]]; then
+        sqlite3 "${gravityDBfile}" "INSERT INTO domainlist (domain,type) VALUES ('${domain}',${typeId});"
+    else
+        # also add comment when variable has been set through the "--comment" option
+        sqlite3 "${gravityDBfile}" "INSERT INTO domainlist (domain,type,comment) VALUES ('${domain}',${typeId},'${comment}');"
     fi
-  fi
 }
 
 RemoveDomain() {
-    list="$2"
-    domain=$(EscapeRegexp "$1")
+    local domain num requestedListname
+    domain="$1"
 
-    if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
-      bool=true
-      # Is it in the list? Logic follows that if its whitelisted it should not be blacklisted and vice versa
-      grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
-      if [[ "${bool}" == true ]]; then
-        # Remove it from the other one
-        echo "::: Removing $1 from $list..."
-        # /I flag: search case-insensitive
-        sed -i "/${domain}/Id" "${list}"
-        reload=true
-      else
+    # Is the domain in the list we want to remove it from?
+    num="$(sqlite3 "${gravityDBfile}" "SELECT COUNT(*) FROM domainlist WHERE domain = '${domain}' AND type = ${typeId};")"
+
+    requestedListname="$(GetListnameFromTypeId "${typeId}")"
+
+    if [[ "${num}" -eq 0 ]]; then
         if [[ "${verbose}" == true ]]; then
-          echo "::: ${1} does not exist in ${list}, no need to remove!"
+            echo -e "  ${INFO} ${domain} does not exist in ${requestedListname}, no need to remove!"
         fi
-      fi
-    elif [[ "${list}" == "${wildcardlist}" ]]; then
-      bool=true
-      # Is it in the list?
-      grep -e "address=\/${domain}\/" "${wildcardlist}" > /dev/null 2>&1 || bool=false
-      if [[ "${bool}" == true ]]; then
-        # Remove it from the other one
-        echo "::: Removing $1 from $list..."
-        # /I flag: search case-insensitive
-        sed -i "/address=\/${domain}/Id" "${list}"
-        reload=true
-      else
-        if [[ "${verbose}" == true ]]; then
-          echo "::: ${1} does not exist in ${list}, no need to remove!"
-        fi
-      fi
+        return
     fi
-}
 
-Reload() {
-  # Reload hosts file
-  pihole -g -sd
+    # Domain found in the table, remove it!
+    if [[ "${verbose}" == true ]]; then
+        echo -e "  ${INFO} Removing ${domain} from the ${requestedListname}..."
+    fi
+    reload=true
+    # Remove it from the current list
+    sqlite3 "${gravityDBfile}" "DELETE FROM domainlist WHERE domain = '${domain}' AND type = ${typeId};"
 }
 
 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;
+    local count num_pipes domain enabled status nicedate requestedListname
+
+    requestedListname="$(GetListnameFromTypeId "${typeId}")"
+    data="$(sqlite3 "${gravityDBfile}" "SELECT domain,enabled,date_modified FROM domainlist WHERE type = ${typeId};" 2> /dev/null)"
+
+    if [[ -z $data ]]; then
+        echo -e "Not showing empty list"
+    else
+        echo -e "Displaying ${requestedListname}:"
+        count=1
+        while IFS= read -r line
+        do
+            # Count number of pipes seen in this line
+            # This is necessary because we can only detect the pipe separating the fields
+            # from the end backwards as the domain (which is the first field) may contain
+            # pipe symbols as they are perfectly valid regex filter control characters
+            num_pipes="$(grep -c "^" <<< "$(grep -o "|" <<< "${line}")")"
+
+            # Extract domain and enabled status based on the obtained number of pipe characters
+            domain="$(cut -d'|' -f"-$((num_pipes-1))" <<< "${line}")"
+            enabled="$(cut -d'|' -f"$((num_pipes))" <<< "${line}")"
+            datemod="$(cut -d'|' -f"$((num_pipes+1))" <<< "${line}")"
+
+            # Translate boolean status into human readable string
+            if [[ "${enabled}" -eq 1 ]]; then
+                status="enabled"
+            else
+                status="disabled"
+            fi
+
+            # Get nice representation of numerical date stored in database
+            nicedate=$(date --rfc-2822 -d "@${datemod}")
+
+            echo "  ${count}: ${domain} (${status}, last modified ${nicedate})"
+            count=$((count+1))
+        done <<< "${data}"
+    fi
+    exit 0;
 }
 
-for var in "$@"; do
-  case "${var}" in
-    "-w" | "whitelist"   ) listMain="${whitelist}"; listAlt="${blacklist}";;
-    "-b" | "blacklist"   ) listMain="${blacklist}"; listAlt="${whitelist}";;
-    "-wild" | "wildcard" ) listMain="${wildcardlist}";;
-    "-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
+NukeList() {
+    count=$(sqlite3 "${gravityDBfile}" "SELECT COUNT(1) FROM domainlist WHERE type = ${typeId};")
+    listname="$(GetListnameFromTypeId "${typeId}")"
+    if [ "$count" -gt 0 ];then
+        sqlite3 "${gravityDBfile}" "DELETE FROM domainlist WHERE type = ${typeId};"
+        echo "  ${TICK} Removed ${count} domain(s) from the ${listname}"
+    else
+        echo "  ${INFO} ${listname} already empty. Nothing to do!"
+    fi
+    exit 0;
+}
+
+GetComment() {
+    comment="$1"
+    if [[ "${comment}" =~ [^a-zA-Z0-9_\#:/\.,\ -] ]]; then
+        echo "  ${CROSS} Found invalid characters in domain comment!"
+        exit
+    fi
+}
+
+while (( "$#" )); do
+    case "${1}" in
+        "-w" | "whitelist"   ) typeId=0;;
+        "-b" | "blacklist"   ) typeId=1;;
+        "--white-regex" | "white-regex" ) typeId=2;;
+        "--white-wild" | "white-wild" ) typeId=2; wildcard=true;;
+        "--wild" | "wildcard" ) typeId=3; wildcard=true;;
+        "--regex" | "regex"   ) typeId=3;;
+        "-nr"| "--noreload"  ) noReloadRequested=true;;
+        "-d" | "--delmode"   ) addmode=false;;
+        "-q" | "--quiet"     ) verbose=false;;
+        "-h" | "--help"      ) helpFunc;;
+        "-l" | "--list"      ) Displaylist;;
+        "--nuke"             ) NukeList;;
+        "--web"              ) web=true;;
+        "--comment"          ) GetComment "${2}"; shift;;
+        *                    ) ValidateDomain "${1}";;
+    esac
+    shift
 done
 
 shift
 
-if [[ $# = 0 ]]; then
-  helpFunc
+if [[ ${domaincount} == 0 ]]; then
+    helpFunc
 fi
 
-PoplistFile
+ProcessDomainList
 
-if ${reload}; then
-  Reload
+# Used on web interface
+if $web; then
+    echo "DONE"
+fi
+
+if [[ ${reload} == true && ${noReloadRequested} == false ]]; then
+    pihole restartdns reload-lists
 fi

advanced/Scripts/pihole-reenable.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2020 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+#
+#
+# The pihole disable command has the option to set a specified time before
+# blocking is automatically re-enabled.
+#
+# Present script is responsible for the sleep & re-enable part of the job and
+# is automatically terminated if it is still running when pihole is enabled by
+# other means.
+#
+# This ensures that pihole ends up in the correct state after a sequence of
+# commands suchs as: `pihole disable 30s; pihole enable; pihole disable`
+
+readonly PI_HOLE_BIN_DIR="/usr/local/bin"
+
+sleep "${1}"
+"${PI_HOLE_BIN_DIR}"/pihole enable

advanced/Scripts/piholeARPTable.sh

@@ -0,0 +1,66 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC1090
+
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2019 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# ARP table interaction
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+coltable="/opt/pihole/COL_TABLE"
+if [[ -f ${coltable} ]]; then
+    source ${coltable}
+fi
+
+# Determine database location
+# Obtain DBFILE=... setting from pihole-FTL.db
+# Constructed to return nothing when
+# a) the setting is not present in the config file, or
+# b) the setting is commented out (e.g. "#DBFILE=...")
+FTLconf="/etc/pihole/pihole-FTL.conf"
+if [ -e "$FTLconf" ]; then
+    DBFILE="$(sed -n -e 's/^\s*DBFILE\s*=\s*//p' ${FTLconf})"
+fi
+# Test for empty string. Use standard path in this case.
+if [ -z "$DBFILE" ]; then
+    DBFILE="/etc/pihole/pihole-FTL.db"
+fi
+
+
+flushARP(){
+    local output
+    if [[ "${args[1]}" != "quiet" ]]; then
+        echo -ne "  ${INFO} Flushing network table ..."
+    fi
+
+    # Truncate network_addresses table in pihole-FTL.db
+    # This needs to be done before we can truncate the network table due to
+    # foreign key constraints
+    if ! output=$(sqlite3 "${DBFILE}" "DELETE FROM network_addresses" 2>&1); then
+        echo -e "${OVER}  ${CROSS} Failed to truncate network_addresses table"
+        echo "  Database location: ${DBFILE}"
+        echo "  Output: ${output}"
+        return 1
+    fi
+
+    # Truncate network table in pihole-FTL.db
+    if ! output=$(sqlite3 "${DBFILE}" "DELETE FROM network" 2>&1); then
+        echo -e "${OVER}  ${CROSS} Failed to truncate network table"
+        echo "  Database location: ${DBFILE}"
+        echo "  Output: ${output}"
+        return 1
+    fi
+
+    if [[ "${args[1]}" != "quiet" ]]; then
+        echo -e "${OVER}  ${TICK} Flushed network table"
+    fi
+}
+
+args=("$@")
+
+case "${args[0]}" in
+    "arpflush"            ) flushARP;;
+esac

advanced/Scripts/piholeCheckout.sh

@@ -3,204 +3,202 @@
 # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
 # Network-wide ad blocking via your own hardware.
 #
-# Switch Pi-hole subsystems to a different Github branch
+# Switch Pi-hole subsystems to a different GitHub branch.
 #
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
 readonly PI_HOLE_FILES_DIR="/etc/.pihole"
-PH_TEST="true" source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
+PH_TEST="true"
+source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
 
 # webInterfaceGitUrl set in basic-install.sh
 # webInterfaceDir set in basic-install.sh
 # piholeGitURL set in basic-install.sh
 # is_repo() sourced from basic-install.sh
 # setupVars set in basic-install.sh
+# check_download_exists sourced from basic-install.sh
+# fully_fetch_repo sourced from basic-install.sh
+# get_available_branches sourced from basic-install.sh
+# fetch_checkout_pull_branch sourced from basic-install.sh
+# checkout_pull_branch sourced from basic-install.sh
 
 source "${setupVars}"
-update="false"
-
-# Colour codes
-red="\e[1;31m"
-def="\e[0m"
-
-fully_fetch_repo() {
-  # Add upstream branches to shallow clone
-  local directory="${1}"
-
-  cd "${directory}" || return 1
-  if is_repo "${directory}"; then
-    git remote set-branches origin '*' || return 1
-    git fetch --quiet || return 1
-  else
-    return 1
-  fi
-  return 0
-}
-
-get_available_branches() {
-  # Return available branches
-  local directory="${1}"
-
-  cd "${directory}" || return 1
-  # Get reachable remote branches
-  git remote show origin | grep 'tracked' | sed 's/tracked//;s/ //g'
-  return
-}
-
-
-fetch_checkout_pull_branch() {
-  # Check out specified branch
-  local directory="${1}"
-  local branch="${2}"
-
-  # Set the reference for the requested branch, fetch, check it put and pull it
-  cd "${directory}"
-  git remote set-branches origin "${branch}" || return 1
-  git stash --all --quiet &> /dev/null || true
-  git clean --force -d || true
-  git fetch --quiet || return 1
-  checkout_pull_branch "${directory}" "${branch}" || return 1
-}
-
-checkout_pull_branch() {
-  # Check out specified branch
-  local directory="${1}"
-  local branch="${2}"
-  local oldbranch
-
-  cd "${directory}" || return 1
-
-  oldbranch="$(git symbolic-ref HEAD)"
-
-  git checkout "${branch}" || return 1
-
-  if [ "$(git diff "${oldbranch}" | grep -c "^")" -gt "0" ]; then
-    update="true"
-  fi
-
-  git pull || return 1
-  return 0
-}
 
 warning1() {
-  echo "  Please note that changing branches severely alters your Pi-hole subsystems"
-  echo "  Features that work on the master branch, may not on a development branch"
-  echo -e "  ${red}This feature is NOT supported unless a Pi-hole developer explicitly asks!${def}"
-  read -r -p "  Have you read and understood this? [y/N] " response
-  case ${response} in
-  [yY][eE][sS]|[yY])
-    echo "::: Continuing with branch change."
-    return 0
-    ;;
-  *)
-    echo "::: Branch change has been cancelled."
-    return 1
-    ;;
-  esac
+    echo "  Please note that changing branches severely alters your Pi-hole subsystems"
+    echo "  Features that work on the master branch, may not on a development branch"
+    echo -e "  ${COL_LIGHT_RED}This feature is NOT supported unless a Pi-hole developer explicitly asks!${COL_NC}"
+    read -r -p "  Have you read and understood this? [y/N] " response
+    case "${response}" in
+        [yY][eE][sS]|[yY])
+            echo ""
+            return 0
+            ;;
+        *)
+            echo -e "\\n  ${INFO} Branch change has been canceled"
+            return 1
+            ;;
+    esac
 }
 
 checkout() {
-  local corebranches
-  local webbranches
+    local corebranches
+    local webbranches
 
-  # Avoid globbing
-  set -f
+    # Check if FTL is installed - do this early on as FTL is a hard dependency for Pi-hole
+    local funcOutput
+    funcOutput=$(get_binary_name) #Store output of get_binary_name here
+    local binary
+    binary="pihole-FTL${funcOutput##*pihole-FTL}" #binary name will be the last line of the output of get_binary_name (it always begins with pihole-FTL)
 
-  #This is unlikely
-  if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
-    echo "::: Critical Error: Core Pi-hole repo is missing from system!"
-    echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
-    exit 1;
-  fi
-  if [[ ${INSTALL_WEB} == "true" ]]; then
-    if ! is_repo "${webInterfaceDir}" ; then
-      echo "::: Critical Error: Web Admin repo is missing from system!"
-      echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
-      exit 1;
-    fi
-  fi
+    # Avoid globbing
+    set -f
 
-  if [[ -z "${1}" ]]; then
-    echo "::: No option detected. Please use 'pihole checkout <master|dev>'."
-    echo "::: Or enter the repository and branch you would like to check out:"
-    echo "::: 'pihole checkout <web|core> <branchname>'"
-    exit 1
-  fi
+    # This is unlikely
+    if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
+        echo -e "  ${COL_LIGHT_RED}Error: Core Pi-hole repo is missing from system!"
+        echo -e "  Please re-run install script from https://github.com/pi-hole/pi-hole${COL_NC}"
+        exit 1;
+    fi
+    if [[ "${INSTALL_WEB_INTERFACE}" == "true" ]]; then
+        if ! is_repo "${webInterfaceDir}" ; then
+            echo -e "  ${COL_LIGHT_RED}Error: Web Admin repo is missing from system!"
+            echo -e "  Please re-run install script from https://github.com/pi-hole/pi-hole${COL_NC}"
+            exit 1;
+        fi
+    fi
 
-  if ! warning1 ; then
-    exit 1
-  fi
+    if [[ -z "${1}" ]]; then
+        echo -e "  ${COL_LIGHT_RED}Invalid option${COL_NC}"
+        echo -e "  Try 'pihole checkout --help' for more information."
+        exit 1
+    fi
 
-  if [[ "${1}" == "dev" ]] ; then
-    # Shortcut to check out development branches
-    echo "::: Shortcut \"dev\" detected - checking out development / devel branches ..."
-    echo "::: Pi-hole core"
-    fetch_checkout_pull_branch "${PI_HOLE_FILES_DIR}" "development" || { echo "Unable to pull Core developement branch"; exit 1; }
-    if [[ ${INSTALL_WEB} == "true" ]]; then
-      echo "::: Web interface"
-      fetch_checkout_pull_branch "${webInterfaceDir}" "devel" || { echo "Unable to pull Web development branch"; exit 1; }
+    if ! warning1 ; then
+        exit 1
     fi
-    echo "::: done!"
-  elif [[ "${1}" == "master" ]] ; then
-    # Shortcut to check out master branches
-    echo "::: Shortcut \"master\" detected - checking out master branches ..."
-    echo "::: Pi-hole core"
-    fetch_checkout_pull_branch "${PI_HOLE_FILES_DIR}" "master" || { echo "Unable to pull Core master branch"; exit 1; }
-    if [[ ${INSTALL_WEB} == "true" ]]; then
-      echo "::: Web interface"
-      fetch_checkout_pull_branch "${webInterfaceDir}" "master" || { echo "Unable to pull web master branch"; exit 1; }
-    fi
-    echo "::: done!"
-  elif [[ "${1}" == "core" ]] ; then
-    echo -n "::: Fetching remote branches for Pi-hole core from ${piholeGitUrl} ... "
-    if ! fully_fetch_repo "${PI_HOLE_FILES_DIR}" ; then
-      echo "::: Fetching all branches for Pi-hole core repo failed!"
-      exit 1
-    fi
-    corebranches=($(get_available_branches "${PI_HOLE_FILES_DIR}"))
-    echo " done!"
-    echo "::: ${#corebranches[@]} branches available"
-    echo ":::"
-    # Have to user chosing the branch he wants
-    if ! (for e in "${corebranches[@]}"; do [[ "$e" == "${2}" ]] && exit 0; done); then
-      echo "::: Requested branch \"${2}\" is not available!"
-      echo "::: Available branches for core are:"
-      for e in "${corebranches[@]}"; do echo ":::   $e"; done
-      exit 1
-    fi
-    checkout_pull_branch "${PI_HOLE_FILES_DIR}" "${2}"
-  elif [[ "${1}" == "web" && "${INSTALL_WEB}" == "true" ]] ; then
-    echo -n "::: Fetching remote branches for the web interface from ${webInterfaceGitUrl} ... "
-    if ! fully_fetch_repo "${webInterfaceDir}" ; then
-      echo "::: Fetching all branches for Pi-hole web interface repo failed!"
-      exit 1
-    fi
-    webbranches=($(get_available_branches "${webInterfaceDir}"))
-    echo " done!"
-    echo "::: ${#webbranches[@]} branches available"
-    echo ":::"
-    # Have to user chosing the branch he wants
-    if ! (for e in "${webbranches[@]}"; do [[ "$e" == "${2}" ]] && exit 0; done); then
-      echo "::: Requested branch \"${2}\" is not available!"
-      echo "::: Available branches for web are:"
-      for e in "${webbranches[@]}"; do echo ":::   $e"; done
-      exit 1
-    fi
-    checkout_pull_branch "${webInterfaceDir}" "${2}"
-  else
-    echo "::: Requested option \"${1}\" is not available!"
-    exit 1
-  fi
 
-  # Force updating everything
-  if [[ ! "${1}" == "web" && "${update}" == "true" ]]; then
-    echo "::: Running installer to upgrade your installation"
-    if "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh" --unattended; then
-      exit 0
+    if [[ "${1}" == "dev" ]] ; then
+        # Shortcut to check out development branches
+        echo -e "  ${INFO} Shortcut \"dev\" detected - checking out development / devel branches..."
+        echo ""
+        echo -e "  ${INFO} Pi-hole Core"
+        fetch_checkout_pull_branch "${PI_HOLE_FILES_DIR}" "development" || { echo "  ${CROSS} Unable to pull Core development branch"; exit 1; }
+        if [[ "${INSTALL_WEB_INTERFACE}" == "true" ]]; then
+            echo ""
+            echo -e "  ${INFO} Web interface"
+            fetch_checkout_pull_branch "${webInterfaceDir}" "devel" || { echo "  ${CROSS} Unable to pull Web development branch"; exit 1; }
+        fi
+        #echo -e "  ${TICK} Pi-hole Core"
+
+        local path
+        path="development/${binary}"
+        echo "development" > /etc/pihole/ftlbranch
+        chmod 644 /etc/pihole/ftlbranch
+    elif [[ "${1}" == "master" ]] ; then
+        # Shortcut to check out master branches
+        echo -e "  ${INFO} Shortcut \"master\" detected - checking out master branches..."
+        echo -e "  ${INFO} Pi-hole core"
+        fetch_checkout_pull_branch "${PI_HOLE_FILES_DIR}" "master" || { echo "  ${CROSS} Unable to pull Core master branch"; exit 1; }
+        if [[ ${INSTALL_WEB_INTERFACE} == "true" ]]; then
+            echo -e "  ${INFO} Web interface"
+            fetch_checkout_pull_branch "${webInterfaceDir}" "master" || { echo "  ${CROSS} Unable to pull Web master branch"; exit 1; }
+        fi
+        #echo -e "  ${TICK} Web Interface"
+        local path
+        path="master/${binary}"
+        echo "master" > /etc/pihole/ftlbranch
+        chmod 644 /etc/pihole/ftlbranch
+    elif [[ "${1}" == "core" ]] ; then
+        str="Fetching branches from ${piholeGitUrl}"
+        echo -ne "  ${INFO} $str"
+        if ! fully_fetch_repo "${PI_HOLE_FILES_DIR}" ; then
+            echo -e "${OVER}  ${CROSS} $str"
+            exit 1
+        fi
+        corebranches=($(get_available_branches "${PI_HOLE_FILES_DIR}"))
+
+        if [[ "${corebranches[*]}" == *"master"* ]]; then
+            echo -e "${OVER}  ${TICK} $str"
+            echo -e "  ${INFO} ${#corebranches[@]} branches available for Pi-hole Core"
+        else
+            # Print STDERR output from get_available_branches
+            echo -e "${OVER}  ${CROSS} $str\\n\\n${corebranches[*]}"
+            exit 1
+        fi
+
+        echo ""
+        # Have the user choose the branch they want
+        if ! (for e in "${corebranches[@]}"; do [[ "$e" == "${2}" ]] && exit 0; done); then
+            echo -e "  ${INFO} Requested branch \"${2}\" is not available"
+            echo -e "  ${INFO} Available branches for Core are:"
+            for e in "${corebranches[@]}"; do echo "      - $e"; done
+            exit 1
+        fi
+        checkout_pull_branch "${PI_HOLE_FILES_DIR}" "${2}"
+    elif [[ "${1}" == "web" ]] && [[ "${INSTALL_WEB_INTERFACE}" == "true" ]] ; then
+        str="Fetching branches from ${webInterfaceGitUrl}"
+        echo -ne "  ${INFO} $str"
+        if ! fully_fetch_repo "${webInterfaceDir}" ; then
+            echo -e "${OVER}  ${CROSS} $str"
+            exit 1
+        fi
+        webbranches=($(get_available_branches "${webInterfaceDir}"))
+
+        if [[ "${webbranches[*]}" == *"master"* ]]; then
+            echo -e "${OVER}  ${TICK} $str"
+            echo -e "  ${INFO} ${#webbranches[@]} branches available for Web Admin"
+        else
+            # Print STDERR output from get_available_branches
+            echo -e "${OVER}  ${CROSS} $str\\n\\n${webbranches[*]}"
+            exit 1
+        fi
+
+        echo ""
+        # Have the user choose the branch they want
+        if ! (for e in "${webbranches[@]}"; do [[ "$e" == "${2}" ]] && exit 0; done); then
+            echo -e "  ${INFO} Requested branch \"${2}\" is not available"
+            echo -e "  ${INFO} Available branches for Web Admin are:"
+            for e in "${webbranches[@]}"; do echo "      - $e"; done
+            exit 1
+        fi
+        checkout_pull_branch "${webInterfaceDir}" "${2}"
+    elif [[ "${1}" == "ftl" ]] ; then
+        local path
+        local oldbranch
+        path="${2}/${binary}"
+        oldbranch="$(pihole-FTL -b)"
+
+        if check_download_exists "$path"; then
+            echo "  ${TICK} Branch ${2} exists"
+            echo "${2}" > /etc/pihole/ftlbranch
+            chmod 644 /etc/pihole/ftlbranch
+            echo -e "  ${INFO} Switching to branch: \"${2}\" from \"${oldbranch}\""
+            FTLinstall "${binary}"
+            restart_service pihole-FTL
+            enable_service pihole-FTL
+        else
+            echo "  ${CROSS} Requested branch \"${2}\" is not available"
+            ftlbranches=( $(git ls-remote https://github.com/pi-hole/ftl | grep 'heads' | sed 's/refs\/heads\///;s/ //g' | awk '{print $2}') )
+            echo -e "  ${INFO} Available branches for FTL are:"
+            for e in "${ftlbranches[@]}"; do echo "      - $e"; done
+            exit 1
+        fi
+
     else
-      echo "Unable to complete update, contact Pi-hole"
-      exit 1
+        echo -e "  ${INFO} Requested option \"${1}\" is not available"
+        exit 1
+    fi
+
+    # Force updating everything
+    if [[  ! "${1}" == "web" && ! "${1}" == "ftl" ]]; then
+        echo -e "  ${INFO} Running installer to upgrade your installation"
+        if "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh" --unattended; then
+            exit 0
+        else
+            echo -e "  ${COL_LIGHT_RED} Error: Unable to complete update, please contact support${COL_NC}"
+            exit 1
+        fi
     fi
-  fi
 }

advanced/Scripts/piholeLogFlush.sh

@@ -8,38 +8,68 @@
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
-if [[ "$@" != *"quiet"* ]]; then
-  echo -n "::: Flushing /var/log/pihole.log ..."
+colfile="/opt/pihole/COL_TABLE"
+source ${colfile}
+
+# In case we're running at the same time as a system logrotate, use a
+# separate logrotate state file to prevent stepping on each other's
+# toes.
+STATEFILE="/var/lib/logrotate/pihole"
+
+# Determine database location
+# Obtain DBFILE=... setting from pihole-FTL.db
+# Constructed to return nothing when
+# a) the setting is not present in the config file, or
+# b) the setting is commented out (e.g. "#DBFILE=...")
+FTLconf="/etc/pihole/pihole-FTL.conf"
+if [ -e "$FTLconf" ]; then
+    DBFILE="$(sed -n -e 's/^\s*DBFILE\s*=\s*//p' ${FTLconf})"
 fi
-if [[ "$@" == *"once"* ]]; then
-  # Nightly logrotation
-  if command -v /usr/sbin/logrotate >/dev/null; then
-    # Logrotate once
-    /usr/sbin/logrotate --force /etc/pihole/logrotate
-  else
-    # Copy pihole.log over to pihole.log.1
-    # and empty out pihole.log
-    # Note that moving the file is not an option, as
-    # dnsmasq would happily continue writing into the
-    # moved file (it will have the same file handler)
-    cp /var/log/pihole.log /var/log/pihole.log.1
-    echo " " > /var/log/pihole.log
-  fi
-else
-  # Manual flushing
-  if command -v /usr/sbin/logrotate >/dev/null; then
-    # Logrotate twice to move all data out of sight of FTL
-    /usr/sbin/logrotate --force /etc/pihole/logrotate; sleep 3
-    /usr/sbin/logrotate --force /etc/pihole/logrotate
-  else
-    # Flush both pihole.log and pihole.log.1 (if existing)
-    echo " " > /var/log/pihole.log
-    if [ -f /var/log/pihole.log.1 ]; then
-      echo " " > /var/log/pihole.log.1
-    fi
-  fi
+# Test for empty string. Use standard path in this case.
+if [ -z "$DBFILE" ]; then
+    DBFILE="/etc/pihole/pihole-FTL.db"
 fi
 
 if [[ "$@" != *"quiet"* ]]; then
-  echo "... done!"
+    echo -ne "  ${INFO} Flushing /var/log/pihole.log ..."
+fi
+if [[ "$@" == *"once"* ]]; then
+    # Nightly logrotation
+    if command -v /usr/sbin/logrotate >/dev/null; then
+        # Logrotate once
+        /usr/sbin/logrotate --force --state "${STATEFILE}" /etc/pihole/logrotate
+    else
+        # Copy pihole.log over to pihole.log.1
+        # and empty out pihole.log
+        # Note that moving the file is not an option, as
+        # dnsmasq would happily continue writing into the
+        # moved file (it will have the same file handler)
+        cp -p /var/log/pihole.log /var/log/pihole.log.1
+        echo " " > /var/log/pihole.log
+        chmod 644 /var/log/pihole.log
+    fi
+else
+    # Manual flushing
+    if command -v /usr/sbin/logrotate >/dev/null; then
+        # Logrotate twice to move all data out of sight of FTL
+        /usr/sbin/logrotate --force --state "${STATEFILE}" /etc/pihole/logrotate; sleep 3
+        /usr/sbin/logrotate --force --state "${STATEFILE}" /etc/pihole/logrotate
+    else
+        # Flush both pihole.log and pihole.log.1 (if existing)
+        echo " " > /var/log/pihole.log
+        if [ -f /var/log/pihole.log.1 ]; then
+            echo " " > /var/log/pihole.log.1
+            chmod 644 /var/log/pihole.log.1
+        fi
+    fi
+    # Delete most recent 24 hours from FTL's database, leave even older data intact (don't wipe out all history)
+    deleted=$(sqlite3 "${DBFILE}" "DELETE FROM queries WHERE timestamp >= strftime('%s','now')-86400; select changes() from queries limit 1")
+
+    # Restart pihole-FTL to force reloading history
+    sudo pihole restartdns
+fi
+
+if [[ "$@" != *"quiet"* ]]; then
+    echo -e "${OVER}  ${TICK} Flushed /var/log/pihole.log"
+    echo -e "  ${TICK} Deleted ${deleted} queries from database"
 fi

advanced/Scripts/query.sh

@@ -0,0 +1,264 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC1090
+
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2018 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# Query Domain Lists
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+# Globals
+piholeDir="/etc/pihole"
+GRAVITYDB="${piholeDir}/gravity.db"
+options="$*"
+all=""
+exact=""
+blockpage=""
+matchType="match"
+# Source pihole-FTL from install script
+pihole_FTL="${piholeDir}/pihole-FTL.conf"
+if [[ -f "${pihole_FTL}" ]]; then
+    source "${pihole_FTL}"
+fi
+
+# Set this only after sourcing pihole-FTL.conf as the gravity database path may
+# have changed
+gravityDBfile="${GRAVITYDB}"
+
+colfile="/opt/pihole/COL_TABLE"
+source "${colfile}"
+
+# Scan an array of files for matching strings
+scanList(){
+    # Escape full stops
+    local domain="${1}" esc_domain="${1//./\\.}" lists="${2}" type="${3:-}"
+
+    # Prevent grep from printing file path
+    cd "$piholeDir" || exit 1
+
+    # Prevent grep -i matching slowly: https://bit.ly/2xFXtUX
+    export LC_CTYPE=C
+
+    # /dev/null forces filename to be printed when only one list has been generated
+    case "${type}" in
+        "exact" ) grep -i -E -l "(^|(?<!#)\\s)${esc_domain}($|\\s|#)" ${lists} /dev/null 2>/dev/null;;
+        # Iterate through each regexp and check whether it matches the domainQuery
+        # If it does, print the matching regexp and continue looping
+        # Input 1 - regexps | Input 2 - domainQuery
+        "regex" )
+            for list in ${lists}; do
+                if [[ "${domain}" =~ ${list} ]]; then
+                    printf "%b\n" "${list}";
+                fi
+            done;;
+        *       ) grep -i "${esc_domain}" ${lists} /dev/null 2>/dev/null;;
+    esac
+}
+
+if [[ "${options}" == "-h" ]] || [[ "${options}" == "--help" ]]; then
+    echo "Usage: pihole -q [option] <domain>
+Example: 'pihole -q -exact domain.com'
+Query the adlists for a specified domain
+
+Options:
+  -exact              Search the block lists for exact domain matches
+  -all                Return all query matches within a block list
+  -h, --help          Show this help dialog"
+  exit 0
+fi
+
+# Handle valid options
+if [[ "${options}" == *"-bp"* ]]; then
+    exact="exact"; blockpage=true
+else
+    [[ "${options}" == *"-all"* ]] && all=true
+    if [[ "${options}" == *"-exact"* ]]; then
+        exact="exact"; matchType="exact ${matchType}"
+    fi
+fi
+
+# Strip valid options, leaving only the domain and invalid options
+# This allows users to place the options before or after the domain
+options=$(sed -E 's/ ?-(bp|adlists?|all|exact) ?//g' <<< "${options}")
+
+# Handle remaining options
+# If $options contain non ASCII characters, convert to punycode
+case "${options}" in
+    ""             ) str="No domain specified";;
+    *" "*          ) str="Unknown query option specified";;
+    *[![:ascii:]]* ) domainQuery=$(idn2 "${options}");;
+    *              ) domainQuery="${options}";;
+esac
+
+if [[ -n "${str:-}" ]]; then
+    echo -e "${str}${COL_NC}\\nTry 'pihole -q --help' for more information."
+    exit 1
+fi
+
+scanDatabaseTable() {
+    local domain table type querystr result extra
+    domain="$(printf "%q" "${1}")"
+    table="${2}"
+    type="${3:-}"
+
+    # As underscores are legitimate parts of domains, we escape them when using the LIKE operator.
+    # Underscores are SQLite wildcards matching exactly one character. We obviously want to suppress this
+    # behavior. The "ESCAPE '\'" clause specifies that an underscore preceded by an '\' should be matched
+    # as a literal underscore character. We pretreat the $domain variable accordingly to escape underscores.
+    if [[ "${table}" == "gravity" ]]; then
+        case "${exact}" in
+            "exact" ) querystr="SELECT gravity.domain,adlist.address,adlist.enabled FROM gravity LEFT JOIN adlist ON adlist.id = gravity.adlist_id WHERE domain = '${domain}'";;
+            *       ) querystr="SELECT gravity.domain,adlist.address,adlist.enabled FROM gravity LEFT JOIN adlist ON adlist.id = gravity.adlist_id WHERE domain LIKE '%${domain//_/\\_}%' ESCAPE '\\'";;
+        esac
+    else
+        case "${exact}" in
+            "exact" ) querystr="SELECT domain,enabled FROM domainlist WHERE type = '${type}' AND domain = '${domain}'";;
+            *       ) querystr="SELECT domain,enabled FROM domainlist WHERE type = '${type}' AND domain LIKE '%${domain//_/\\_}%' ESCAPE '\\'";;
+        esac
+    fi
+
+    # Send prepared query to gravity database
+    result="$(sqlite3 "${gravityDBfile}" "${querystr}")" 2> /dev/null
+    if [[ -z "${result}" ]]; then
+        # Return early when there are no matches in this table
+        return
+    fi
+
+    if [[ "${table}" == "gravity" ]]; then
+        echo "${result}"
+        return
+    fi
+
+    # Mark domain as having been white-/blacklist matched (global variable)
+    wbMatch=true
+
+    # Print table name
+    if [[ -z "${blockpage}" ]]; then
+        echo " ${matchType^} found in ${COL_BOLD}exact ${table}${COL_NC}"
+    fi
+
+    # Loop over results and print them
+    mapfile -t results <<< "${result}"
+    for result in "${results[@]}"; do
+        if [[ -n "${blockpage}" ]]; then
+            echo "π ${result}"
+            exit 0
+        fi
+        domain="${result/|*}"
+        if [[ "${result#*|}" == "0" ]]; then
+            extra=" (disabled)"
+        else
+            extra=""
+        fi
+        echo "   ${domain}${extra}"
+    done
+}
+
+scanRegexDatabaseTable() {
+    local domain list
+    domain="${1}"
+    list="${2}"
+    type="${3:-}"
+
+    # Query all regex from the corresponding database tables
+    mapfile -t regexList < <(sqlite3 "${gravityDBfile}" "SELECT domain FROM domainlist WHERE type = ${type}" 2> /dev/null)
+
+    # If we have regexps to process
+    if [[ "${#regexList[@]}" -ne 0 ]]; then
+        # Split regexps over a new line
+        str_regexList=$(printf '%s\n' "${regexList[@]}")
+        # Check domain against regexps
+        mapfile -t regexMatches < <(scanList "${domain}" "${str_regexList}" "regex")
+        # If there were regex matches
+        if [[  "${#regexMatches[@]}" -ne 0 ]]; then
+            # Split matching regexps over a new line
+            str_regexMatches=$(printf '%s\n' "${regexMatches[@]}")
+            # Form a "matched" message
+            str_message="${matchType^} found in ${COL_BOLD}regex ${list}${COL_NC}"
+            # Form a "results" message
+            str_result="${COL_BOLD}${str_regexMatches}${COL_NC}"
+            # If we are displaying more than just the source of the block
+            if [[ -z "${blockpage}" ]]; then
+                # Set the wildcard match flag
+                wcMatch=true
+                # Echo the "matched" message, indented by one space
+                echo " ${str_message}"
+                # Echo the "results" message, each line indented by three spaces
+                # shellcheck disable=SC2001
+                echo "${str_result}" | sed 's/^/   /'
+            else
+                echo "π .wildcard"
+                exit 0
+            fi
+        fi
+    fi
+}
+
+# Scan Whitelist and Blacklist
+scanDatabaseTable "${domainQuery}" "whitelist" "0"
+scanDatabaseTable "${domainQuery}" "blacklist" "1"
+
+# Scan Regex table
+scanRegexDatabaseTable "${domainQuery}" "whitelist" "2"
+scanRegexDatabaseTable "${domainQuery}" "blacklist" "3"
+
+# Query block lists
+mapfile -t results <<< "$(scanDatabaseTable "${domainQuery}" "gravity")"
+
+# Handle notices
+if [[ -z "${wbMatch:-}" ]] && [[ -z "${wcMatch:-}" ]] && [[ -z "${results[*]}" ]]; then
+    echo -e "  ${INFO} No ${exact/t/t }results found for ${COL_BOLD}${domainQuery}${COL_NC} within the block lists"
+    exit 0
+elif [[ -z "${results[*]}" ]]; then
+    # Result found in WL/BL/Wildcards
+    exit 0
+elif [[ -z "${all}" ]] && [[ "${#results[*]}" -ge 100 ]]; then
+    echo -e "  ${INFO} Over 100 ${exact/t/t }results found for ${COL_BOLD}${domainQuery}${COL_NC}
+        This can be overridden using the -all option"
+    exit 0
+fi
+
+# Print "Exact matches for" title
+if [[ -n "${exact}" ]] && [[ -z "${blockpage}" ]]; then
+    plural=""; [[ "${#results[*]}" -gt 1 ]] && plural="es"
+    echo " ${matchType^}${plural} for ${COL_BOLD}${domainQuery}${COL_NC} found in:"
+fi
+
+for result in "${results[@]}"; do
+    match="${result/|*/}"
+    extra="${result#*|}"
+    adlistAddress="${extra/|*/}"
+    extra="${extra#*|}"
+    if [[ "${extra}" == "0" ]]; then
+        extra="(disabled)"
+    else
+        extra=""
+    fi
+
+    if [[ -n "${blockpage}" ]]; then
+        echo "0 ${adlistAddress}"
+    elif [[ -n "${exact}" ]]; then
+        echo "  - ${adlistAddress} ${extra}"
+    else
+        if [[ ! "${adlistAddress}" == "${adlistAddress_prev:-}" ]]; then
+            count=""
+            echo " ${matchType^} found in ${COL_BOLD}${adlistAddress}${COL_NC}:"
+            adlistAddress_prev="${adlistAddress}"
+        fi
+        : $((count++))
+
+        # Print matching domain if $max_count has not been reached
+        [[ -z "${all}" ]] && max_count="50"
+        if [[ -z "${all}" ]] && [[ "${count}" -ge "${max_count}" ]]; then
+            [[ "${count}" -gt "${max_count}" ]] && continue
+            echo "   ${COL_GRAY}Over ${count} results found, skipping rest of file${COL_NC}"
+        else
+            echo "   ${match} ${extra}"
+        fi
+    fi
+done
+
+exit 0

advanced/Scripts/setupLCD.sh

@@ -15,28 +15,28 @@
 # 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 "Unrecognized 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
-			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
+    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 ###########
@@ -70,5 +70,5 @@ setupcon
 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
+# https://unix.stackexchange.com/questions/170063/start-a-process-on-a-different-tty
 #setsid sh -c 'exec /usr/local/bin/chronometer.sh <> /dev/tty1 >&0 2>&1'

advanced/Scripts/update.sh

@@ -10,216 +10,224 @@
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
-
-
 # Variables
-
 readonly ADMIN_INTERFACE_GIT_URL="https://github.com/pi-hole/AdminLTE.git"
 readonly ADMIN_INTERFACE_DIR="/var/www/html/admin"
 readonly PI_HOLE_GIT_URL="https://github.com/pi-hole/pi-hole.git"
 readonly PI_HOLE_FILES_DIR="/etc/.pihole"
 
+# shellcheck disable=SC2034
 PH_TEST=true
-source ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh
+
+# when --check-only is passed to this script, it will not perform the actual update
+CHECK_ONLY=false
+
+# shellcheck disable=SC1090
+source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
+# shellcheck disable=SC1091
+source "/opt/pihole/COL_TABLE"
 
 # is_repo() sourced from basic-install.sh
 # make_repo() sourced from basic-install.sh
 # update_repo() source from basic-install.sh
 # getGitFiles() sourced from basic-install.sh
+# FTLcheckUpdate() sourced from basic-install.sh
 
 GitCheckUpdateAvail() {
-  local directory="${1}"
-  curdir=$PWD
-  cd "${directory}"
+    local directory
+    local curBranch
+    directory="${1}"
+    curdir=$PWD
+    cd "${directory}" || return
 
-  # Fetch latest changes in this repo
-  git fetch --quiet origin
+    # Fetch latest changes in this repo
+    git fetch --tags --quiet origin
 
-  # @ alone is a shortcut for HEAD. Older versions of git
-  # need @{0}
-  LOCAL="$(git rev-parse @{0})"
+    # Check current branch. If it is master, then check for the latest available tag instead of latest commit.
+    curBranch=$(git rev-parse --abbrev-ref HEAD)
+    if [[ "${curBranch}" == "master" ]]; then
+        # get the latest local tag
+        LOCAL=$(git describe --abbrev=0 --tags master)
+        # get the latest tag from remote
+        REMOTE=$(git describe --abbrev=0 --tags origin/master)
 
-  # The suffix @{upstream} to a branchname
-  # (short form <branchname>@{u}) refers
-  # to the branch that the branch specified
-  # by branchname is set to build on top of#
-  # (configured with branch.<name>.remote and
-  # branch.<name>.merge). A missing branchname
-  # defaults to the current one.
-  REMOTE="$(git rev-parse @{upstream})"
+    else
+        # @ alone is a shortcut for HEAD. Older versions of git
+        # need @{0}
+        LOCAL="$(git rev-parse "@{0}")"
 
-  if [[ ${#LOCAL} == 0 ]]; then
-    echo "::: Error: Local revision could not be obtained, ask Pi-hole support."
-    echo "::: Additional debugging output:"
-    git status
-    exit
-  fi
-  if [[ ${#REMOTE} == 0 ]]; then
-    echo "::: Error: Remote revision could not be obtained, ask Pi-hole support."
-    echo "::: Additional debugging output:"
-    git status
-    exit
-  fi
+        # The suffix @{upstream} to a branchname
+        # (short form <branchname>@{u}) refers
+        # to the branch that the branch specified
+        # by branchname is set to build on top of#
+        # (configured with branch.<name>.remote and
+        # branch.<name>.merge). A missing branchname
+        # defaults to the current one.
+        REMOTE="$(git rev-parse "@{upstream}")"
+    fi
 
-  # Change back to original directory
-  cd "${curdir}"
 
-  if [[ "${LOCAL}" != "${REMOTE}" ]]; then
-    # Local branch is behind remote branch -> Update
-    return 0
-  else
-    # Local branch is up-to-date or in a situation
-    # where this updater cannot be used (like on a
-    # branch that exists only locally)
-    return 1
-  fi
-}
+    if [[ "${#LOCAL}" == 0 ]]; then
+        echo -e "\\n  ${COL_LIGHT_RED}Error: Local revision could not be obtained, please contact Pi-hole Support"
+        echo -e "  Additional debugging output:${COL_NC}"
+        git status
+        exit
+    fi
+    if [[ "${#REMOTE}" == 0 ]]; then
+        echo -e "\\n  ${COL_LIGHT_RED}Error: Remote revision could not be obtained, please contact Pi-hole Support"
+        echo -e "  Additional debugging output:${COL_NC}"
+        git status
+        exit
+    fi
 
-FTLcheckUpdate() {
+    # Change back to original directory
+    cd "${curdir}" || exit
 
-	local FTLversion=$(/usr/bin/pihole-FTL tag)
-	local FTLlatesttag=$(curl -sI https://github.com/pi-hole/FTL/releases/latest | grep 'Location' | awk -F '/' '{print $NF}' | tr -d '\r\n')
-
-	if [[ "${FTLversion}" != "${FTLlatesttag}" ]]; then
-		return 0
-	else
-		return 1
-	fi
+    if [[ "${LOCAL}" != "${REMOTE}" ]]; then
+        # Local branch is behind remote branch -> Update
+        return 0
+    else
+        # Local branch is up-to-date or in a situation
+        # where this updater cannot be used (like on a
+        # branch that exists only locally)
+        return 1
+    fi
 }
 
 main() {
-  local pihole_version_current
-  local web_version_current
-  source "${setupVars}"
+    local basicError="\\n  ${COL_LIGHT_RED}Unable to complete update, please contact Pi-hole Support${COL_NC}"
+    local core_update
+    local web_update
+    local FTL_update
 
-  #This is unlikely
-  if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
-    echo "::: Critical Error: Core Pi-hole repo is missing from system!"
-    echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
-    exit 1;
-  fi
-
-  echo "::: Checking for updates..."
-
-  if GitCheckUpdateAvail "${PI_HOLE_FILES_DIR}" ; then
-    core_update=true
-    echo "::: Pi-hole Core:   update available"
-  else
     core_update=false
-    echo "::: Pi-hole Core:   up to date"
-  fi
-
-  if FTLcheckUpdate ; then
-    FTL_update=true
-    echo "::: FTL:            update available"
-  else
+    web_update=false
     FTL_update=false
-    echo "::: FTL:            up to date"
-  fi
 
-  # Logic: Don't update FTL when there is a core update available
-  # since the core update will run the installer which will itself
-  # re-install (i.e. update) FTL
-  if ${FTL_update} && ! ${core_update}; then
-    echo ":::"
-    echo "::: FTL out of date"
-    FTLdetect
-    echo ":::"
-  fi
+    # shellcheck disable=1090,2154
+    source "${setupVars}"
 
-  if [[ ${INSTALL_WEB} == true ]]; then
-    if ! is_repo "${ADMIN_INTERFACE_DIR}" ; then
-      echo "::: Critical Error: Web Admin repo is missing from system!"
-      echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
-      exit 1;
+    # Install packages used by this installation script (necessary if users have removed e.g. git from their systems)
+    package_manager_detect
+    install_dependent_packages "${INSTALLER_DEPS[@]}"
+
+    # This is unlikely
+    if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
+        echo -e "\\n  ${COL_LIGHT_RED}Error: Core Pi-hole repo is missing from system!"
+        echo -e "  Please re-run install script from https://pi-hole.net${COL_NC}"
+        exit 1;
     fi
 
-    if GitCheckUpdateAvail "${ADMIN_INTERFACE_DIR}" ; then
-      web_update=true
-      echo "::: Web Interface:  update available"
+    echo -e "  ${INFO} Checking for updates..."
+
+    if GitCheckUpdateAvail "${PI_HOLE_FILES_DIR}" ; then
+        core_update=true
+        echo -e "  ${INFO} Pi-hole Core:\\t${COL_YELLOW}update available${COL_NC}"
     else
-      web_update=false
-      echo "::: Web Interface:  up to date"
+        core_update=false
+        echo -e "  ${INFO} Pi-hole Core:\\t${COL_LIGHT_GREEN}up to date${COL_NC}"
     fi
 
-    # Logic
-    # 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 [[ "${INSTALL_WEB_INTERFACE}" == true ]]; then
+        if ! is_repo "${ADMIN_INTERFACE_DIR}" ; then
+            echo -e "\\n  ${COL_LIGHT_RED}Error: Web Admin repo is missing from system!"
+            echo -e "  Please re-run install script from https://pi-hole.net${COL_NC}"
+            exit 1;
+        fi
 
-    if ! ${core_update} && ! ${web_update} ; then
-      if ! ${FTL_update} ; then
-        echo ":::"
-        echo "::: Everything is up to date!"
+        if GitCheckUpdateAvail "${ADMIN_INTERFACE_DIR}" ; then
+            web_update=true
+            echo -e "  ${INFO} Web Interface:\\t${COL_YELLOW}update available${COL_NC}"
+        else
+            web_update=false
+            echo -e "  ${INFO} Web Interface:\\t${COL_LIGHT_GREEN}up to date${COL_NC}"
+        fi
+    fi
+
+    local funcOutput
+    funcOutput=$(get_binary_name) #Store output of get_binary_name here
+    local binary
+    binary="pihole-FTL${funcOutput##*pihole-FTL}" #binary name will be the last line of the output of get_binary_name (it always begins with pihole-FTL)
+
+    if FTLcheckUpdate "${binary}" > /dev/null; then
+        FTL_update=true
+        echo -e "  ${INFO} FTL:\\t\\t${COL_YELLOW}update available${COL_NC}"
+    else
+        case $? in
+            1)
+                echo -e "  ${INFO} FTL:\\t\\t${COL_LIGHT_GREEN}up to date${COL_NC}"
+                ;;
+            2)
+                echo -e "  ${INFO} FTL:\\t\\t${COL_LIGHT_RED}Branch is not available.${COL_NC}\\n\\t\\t\\tUse ${COL_LIGHT_GREEN}pihole checkout ftl [branchname]${COL_NC} to switch to a valid branch."
+                ;;
+            *)
+                echo -e "  ${INFO} FTL:\\t\\t${COL_LIGHT_RED}Something has gone wrong, contact support${COL_NC}"
+        esac
+        FTL_update=false
+    fi
+
+    # Determine FTL branch
+    local ftlBranch
+    if [[ -f "/etc/pihole/ftlbranch" ]]; then
+        ftlBranch=$(</etc/pihole/ftlbranch)
+    else
+        ftlBranch="master"
+    fi
+
+    if [[ ! "${ftlBranch}" == "master" && ! "${ftlBranch}" == "development" ]]; then
+        # Notify user that they are on a custom branch which might mean they they are lost
+        # behind if a branch was merged to development and got abandoned
+        printf "  %b %bWarning:%b You are using FTL from a custom branch (%s) and might be missing future releases.\\n" "${INFO}" "${COL_LIGHT_RED}" "${COL_NC}" "${ftlBranch}"
+    fi
+
+    if [[ "${core_update}" == false && "${web_update}" == false && "${FTL_update}" == false ]]; then
+        echo ""
+        echo -e "  ${TICK} Everything is up to date!"
         exit 0
-      fi
-
-    elif ! ${core_update} && ${web_update} ; then
-      echo ":::"
-      echo "::: Pi-hole Web Admin files out of date"
-      getGitFiles "${ADMIN_INTERFACE_DIR}" "${ADMIN_INTERFACE_GIT_URL}"
-
-    elif ${core_update} && ! ${web_update} ; then
-      echo ":::"
-      echo "::: Pi-hole core files out of date"
-      getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
-      ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
-
-    elif ${core_update} && ${web_update} ; then
-      echo ":::"
-      echo "::: Updating Pi-hole core and web admin files"
-      getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
-      ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
-    else
-      echo "*** Update script has malfunctioned, fallthrough reached. Please contact support"
-      exit 1
     fi
-  else # Web Admin not installed, so only verify if core is up to date
-    if ! ${core_update}; then
-      if ! ${FTL_update} ; then
-        echo ":::"
-        echo "::: Everything is up to date!"
+
+    if [[ "${CHECK_ONLY}" == true ]]; then
+        echo ""
         exit 0
-      fi
-    else
-      echo ":::"
-      echo "::: Pi-hole core files out of date"
-      getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
-      ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
     fi
-  fi
 
-  if [[ "${web_update}" == true ]]; then
-    web_version_current="$(/usr/local/bin/pihole version --admin --current)"
-    echo ":::"
-    echo "::: Web Admin version is now at ${web_version_current/* v/v}}"
-    echo "::: If you had made any changes in '/var/www/html/admin/', they have been stashed using 'git stash'"
-  fi
+    if [[ "${core_update}" == true ]]; then
+        echo ""
+        echo -e "  ${INFO} Pi-hole core files out of date, updating local repo."
+        getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
+        echo -e "  ${INFO} If you had made any changes in '/etc/.pihole/', they have been stashed using 'git stash'"
+    fi
 
-  if [[ "${core_update}" == true ]]; then
-    pihole_version_current="$(/usr/local/bin/pihole version --pihole --current)"
-    echo ":::"
-    echo "::: Pi-hole version is now at ${pihole_version_current/* v/v}}"
-    echo "::: If you had made any changes in '/etc/.pihole/', they have been stashed using 'git stash'"
-  fi
+    if [[ "${web_update}" == true ]]; then
+        echo ""
+        echo -e "  ${INFO} Pi-hole Web Admin files out of date, updating local repo."
+        getGitFiles "${ADMIN_INTERFACE_DIR}" "${ADMIN_INTERFACE_GIT_URL}"
+        echo -e "  ${INFO} If you had made any changes in '/var/www/html/admin/', they have been stashed using 'git stash'"
+    fi
 
-  if [[ ${FTL_update} == true ]]; then
-    FTL_version_current="$(/usr/local/bin/pihole version --ftl --current)"
-    echo ":::"
-    echo "::: FTL version is now at ${FTL_version_current/* v/v}}"
-    start_service pihole-FTL
-    enable_service pihole-FTL
-  fi
+    if [[ "${FTL_update}" == true ]]; then
+        echo ""
+        echo -e "  ${INFO} FTL out of date, it will be updated by the installer."
+    fi
 
+    if [[ "${FTL_update}" == true || "${core_update}" == true ]]; then
+        ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || \
+            echo -e "${basicError}" && exit 1
+    fi
 
-  echo ""
-  exit 0
+    if [[ "${FTL_update}" == true || "${core_update}" == true || "${web_update}" == true ]]; then
+        # Force an update of the updatechecker
+        /opt/pihole/updatecheck.sh
+        /opt/pihole/updatecheck.sh x remote
+        echo -e "  ${INFO} Local version file information updated."
+    fi
 
+    echo ""
+    exit 0
 }
 
+if [[ "$1" == "--check-only" ]]; then
+    CHECK_ONLY=true
+fi
+
 main

advanced/Scripts/updatecheck.sh

@@ -0,0 +1,94 @@
+#!/usr/bin/env bash
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# Checks for local or remote versions and branches
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+# Credit: https://stackoverflow.com/a/46324904
+function json_extract() {
+    local key=$1
+    local json=$2
+
+    local string_regex='"([^"\]|\\.)*"'
+    local number_regex='-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?'
+    local value_regex="${string_regex}|${number_regex}|true|false|null"
+    local pair_regex="\"${key}\"[[:space:]]*:[[:space:]]*(${value_regex})"
+
+    if [[ ${json} =~ ${pair_regex} ]]; then
+        echo $(sed 's/^"\|"$//g' <<< "${BASH_REMATCH[1]}")
+    else
+        return 1
+    fi
+}
+
+function get_local_branch() {
+    # Return active branch
+    cd "${1}" 2> /dev/null || return 1
+    git rev-parse --abbrev-ref HEAD || return 1
+}
+
+function get_local_version() {
+    # Return active branch
+    cd "${1}" 2> /dev/null || return 1
+    git describe --long --dirty --tags 2> /dev/null || return 1
+}
+
+# Source the setupvars config file
+# shellcheck disable=SC1091
+. /etc/pihole/setupVars.conf
+
+if [[ "$2" == "remote" ]]; then
+
+    if [[ "$3" == "reboot" ]]; then
+        sleep 30
+    fi
+
+    GITHUB_VERSION_FILE="/etc/pihole/GitHubVersions"
+
+    GITHUB_CORE_VERSION="$(json_extract tag_name "$(curl -s 'https://api.github.com/repos/pi-hole/pi-hole/releases/latest' 2> /dev/null)")"
+    echo -n "${GITHUB_CORE_VERSION}" > "${GITHUB_VERSION_FILE}"
+    chmod 644 "${GITHUB_VERSION_FILE}"
+
+    if [[ "${INSTALL_WEB_INTERFACE}" == true ]]; then
+        GITHUB_WEB_VERSION="$(json_extract tag_name "$(curl -s 'https://api.github.com/repos/pi-hole/AdminLTE/releases/latest' 2> /dev/null)")"
+        echo -n " ${GITHUB_WEB_VERSION}" >> "${GITHUB_VERSION_FILE}"
+    fi
+
+    GITHUB_FTL_VERSION="$(json_extract tag_name "$(curl -s 'https://api.github.com/repos/pi-hole/FTL/releases/latest' 2> /dev/null)")"
+    echo -n " ${GITHUB_FTL_VERSION}" >> "${GITHUB_VERSION_FILE}"
+
+else
+
+    LOCAL_BRANCH_FILE="/etc/pihole/localbranches"
+
+    CORE_BRANCH="$(get_local_branch /etc/.pihole)"
+    echo -n "${CORE_BRANCH}" > "${LOCAL_BRANCH_FILE}"
+    chmod 644 "${LOCAL_BRANCH_FILE}"
+
+    if [[ "${INSTALL_WEB_INTERFACE}" == true ]]; then
+        WEB_BRANCH="$(get_local_branch /var/www/html/admin)"
+        echo -n " ${WEB_BRANCH}" >> "${LOCAL_BRANCH_FILE}"
+    fi
+
+    FTL_BRANCH="$(pihole-FTL branch)"
+    echo -n " ${FTL_BRANCH}" >> "${LOCAL_BRANCH_FILE}"
+
+    LOCAL_VERSION_FILE="/etc/pihole/localversions"
+
+    CORE_VERSION="$(get_local_version /etc/.pihole)"
+    echo -n "${CORE_VERSION}" > "${LOCAL_VERSION_FILE}"
+    chmod 644 "${LOCAL_VERSION_FILE}"
+
+    if [[ "${INSTALL_WEB_INTERFACE}" == true ]]; then
+        WEB_VERSION="$(get_local_version /var/www/html/admin)"
+        echo -n " ${WEB_VERSION}" >> "${LOCAL_VERSION_FILE}"
+    fi
+
+    FTL_VERSION="$(pihole-FTL version)"
+    echo -n " ${FTL_VERSION}" >> "${LOCAL_VERSION_FILE}"
+
+fi

advanced/Scripts/version.sh

@@ -13,136 +13,192 @@ DEFAULT="-1"
 COREGITDIR="/etc/.pihole/"
 WEBGITDIR="/var/www/html/admin/"
 
+# Source the setupvars config file
+# shellcheck disable=SC1091
+source /etc/pihole/setupVars.conf
+
 getLocalVersion() {
-  # FTL requires a different method
-  if [[ "$1" == "FTL" ]]; then
-    pihole-FTL version
+    # FTL requires a different method
+    if [[ "$1" == "FTL" ]]; then
+        pihole-FTL version
+        return 0
+    fi
+
+    # Get the tagged version of the local repository
+    local directory="${1}"
+    local version
+
+    cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
+    version=$(git describe --tags --always || echo "$DEFAULT")
+    if [[ "${version}" =~ ^v ]]; then
+        echo "${version}"
+    elif [[ "${version}" == "${DEFAULT}" ]]; then
+        echo "ERROR"
+        return 1
+    else
+        echo "Untagged"
+    fi
     return 0
-  fi
-
-  # Get the tagged version of the local repository
-  local directory="${1}"
-  local version
-
-  cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
-  version=$(git describe --tags --always || echo "$DEFAULT")
-  if [[ "${version}" =~ ^v ]]; then
-    echo "${version}"
-  elif [[ "${version}" == "${DEFAULT}" ]]; then
-    echo "ERROR"
-    return 1
-  else
-    echo "Untagged"
-  fi
-  return 0
 }
 
 getLocalHash() {
-  # Local FTL hash does not exist on filesystem
-  if [[ "$1" == "FTL" ]]; then
-    echo "N/A"
-    return 0
-  fi
-  
-  # Get the short hash of the local repository
-  local directory="${1}"
-  local hash
+    # Local FTL hash does not exist on filesystem
+    if [[ "$1" == "FTL" ]]; then
+        echo "N/A"
+        return 0
+    fi
 
-  cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
-  hash=$(git rev-parse --short HEAD || echo "$DEFAULT")
-  if [[ "${hash}" == "${DEFAULT}" ]]; then
-    echo "ERROR"
-    return 1
-  else
-    echo "${hash}"
-  fi
-  return 0
+    # Get the short hash of the local repository
+    local directory="${1}"
+    local hash
+
+    cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
+    hash=$(git rev-parse --short HEAD || echo "$DEFAULT")
+    if [[ "${hash}" == "${DEFAULT}" ]]; then
+        echo "ERROR"
+        return 1
+    else
+        echo "${hash}"
+    fi
+    return 0
 }
 
 getRemoteHash(){
-  # Remote FTL hash is not applicable
-  if [[ "$1" == "FTL" ]]; then
-    echo "N/A"
+    # Remote FTL hash is not applicable
+    if [[ "$1" == "FTL" ]]; then
+        echo "N/A"
+        return 0
+    fi
+
+    local daemon="${1}"
+    local branch="${2}"
+
+    hash=$(git ls-remote --heads "https://github.com/pi-hole/${daemon}" | \
+        awk -v bra="$branch" '$0~bra {print substr($0,0,8);exit}')
+    if [[ -n "$hash" ]]; then
+        echo "$hash"
+    else
+        echo "ERROR"
+        return 1
+    fi
     return 0
-  fi
-
-  local daemon="${1}"
-  local branch="${2}"
-
-  hash=$(git ls-remote --heads "https://github.com/pi-hole/${daemon}" | \
-         awk -v bra="$branch" '$0~bra {print substr($0,0,8);exit}')
-  if [[ -n "$hash" ]]; then
-    echo "$hash"
-  else
-    echo "ERROR"
-    return 1
-  fi
-  return 0
 }
 
 getRemoteVersion(){
-  # Get the version from the remote origin
-  local daemon="${1}"
-  local version
+    # Get the version from the remote origin
+    local daemon="${1}"
+    local version
+    local cachedVersions
+    local arrCache
+    cachedVersions="/etc/pihole/GitHubVersions"
 
-  version=$(curl --silent --fail "https://api.github.com/repos/pi-hole/${daemon}/releases/latest" | \
-            awk -F: '$1 ~/tag_name/ { print $2 }' | \
-            tr -cd '[[:alnum:]]._-')
-  if [[ "${version}" =~ ^v ]]; then
-    echo "${version}"
-  else
-    echo "ERROR"
-    return 1
-  fi
-  return 0
+    #If the above file exists, then we can read from that. Prevents overuse of GitHub API
+    if [[ -f "$cachedVersions" ]]; then
+        IFS=' ' read -r -a arrCache < "$cachedVersions"
+
+        case $daemon in
+            "pi-hole"   )  echo "${arrCache[0]}";;
+            "AdminLTE"  )  [[ "${INSTALL_WEB_INTERFACE}" == true ]] && echo "${arrCache[1]}";;
+            "FTL"       )  [[ "${INSTALL_WEB_INTERFACE}" == true ]] && echo "${arrCache[2]}" || echo "${arrCache[1]}";;
+        esac
+
+        return 0
+    fi
+
+    version=$(curl --silent --fail "https://api.github.com/repos/pi-hole/${daemon}/releases/latest" | \
+        awk -F: '$1 ~/tag_name/ { print $2 }' | \
+        tr -cd '[[:alnum:]]._-')
+    if [[ "${version}" =~ ^v ]]; then
+        echo "${version}"
+    else
+        echo "ERROR"
+        return 1
+    fi
+    return 0
+}
+
+getLocalBranch(){
+    # Get the checked out branch of the local directory
+    local directory="${1}"
+    local branch
+
+    # Local FTL btranch is stored in /etc/pihole/ftlbranch
+    if [[ "$1" == "FTL" ]]; then
+        branch="$(pihole-FTL branch)"
+    else
+        cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
+        branch=$(git rev-parse --abbrev-ref HEAD || echo "$DEFAULT")
+    fi
+    if [[ ! "${branch}" =~ ^v ]]; then
+        if [[ "${branch}" == "master" ]]; then
+            echo ""
+        elif [[ "${branch}" == "HEAD" ]]; then
+            echo "in detached HEAD state at "
+        else
+            echo "${branch} "
+        fi
+    else
+        # Branch started in "v"
+        echo "release "
+    fi
+    return 0
 }
 
 versionOutput() {
-  [[ "$1" == "pi-hole" ]] && GITDIR=$COREGITDIR
-  [[ "$1" == "AdminLTE" ]] && GITDIR=$WEBGITDIR
-  [[ "$1" == "FTL" ]] && GITDIR="FTL"
-  
-  [[ "$2" == "-c" ]] || [[ "$2" == "--current" ]] || [[ -z "$2" ]] && current=$(getLocalVersion $GITDIR)
-  [[ "$2" == "-l" ]] || [[ "$2" == "--latest" ]] || [[ -z "$2" ]] && latest=$(getRemoteVersion "$1")
-  if [[ "$2" == "-h" ]] || [[ "$2" == "--hash" ]]; then
-    [[ "$3" == "-c" ]] || [[ "$3" == "--current" ]] || [[ -z "$3" ]] && curHash=$(getLocalHash "$GITDIR")
-    [[ "$3" == "-l" ]] || [[ "$3" == "--latest" ]] || [[ -z "$3" ]] && latHash=$(getRemoteHash "$1" "$(cd "$GITDIR" 2> /dev/null && git rev-parse --abbrev-ref HEAD)")
-  fi
+    if [[ "$1" == "AdminLTE" && "${INSTALL_WEB_INTERFACE}" != true ]]; then
+        echo "  WebAdmin not installed"
+        return 1
+    fi
 
-  if [[ -n "$current" ]] && [[ -n "$latest" ]]; then
-    output="${1^} version is $current (Latest: $latest)"
-  elif [[ -n "$current" ]] && [[ -z "$latest" ]]; then
-    output="Current ${1^} version is $current"
-  elif [[ -z "$current" ]] && [[ -n "$latest" ]]; then
-    output="Latest ${1^} version is $latest"
-  elif [[ "$curHash" == "N/A" ]] || [[ "$latHash" == "N/A" ]]; then
-    output="${1^} hash is not applicable"
-  elif [[ -n "$curHash" ]] && [[ -n "$latHash" ]]; then
-    output="${1^} hash is $curHash (Latest: $latHash)"
-  elif [[ -n "$curHash" ]] && [[ -z "$latHash" ]]; then
-    output="Current ${1^} hash is $curHash"
-  elif [[ -z "$curHash" ]] && [[ -n "$latHash" ]]; then
-    output="Latest ${1^} hash is $latHash"
-  else
-    errorOutput
-  fi
+    [[ "$1" == "pi-hole" ]] && GITDIR=$COREGITDIR
+    [[ "$1" == "AdminLTE" ]] && GITDIR=$WEBGITDIR
+    [[ "$1" == "FTL" ]] && GITDIR="FTL"
 
-  [[ -n "$output" ]] && echo "  $output"
+    [[ "$2" == "-c" ]] || [[ "$2" == "--current" ]] || [[ -z "$2" ]] && current=$(getLocalVersion $GITDIR) && branch=$(getLocalBranch $GITDIR)
+    [[ "$2" == "-l" ]] || [[ "$2" == "--latest" ]] || [[ -z "$2" ]] && latest=$(getRemoteVersion "$1")
+    if [[ "$2" == "-h" ]] || [[ "$2" == "--hash" ]]; then
+        [[ "$3" == "-c" ]] || [[ "$3" == "--current" ]] || [[ -z "$3" ]] && curHash=$(getLocalHash "$GITDIR") && branch=$(getLocalBranch $GITDIR)
+        [[ "$3" == "-l" ]] || [[ "$3" == "--latest" ]] || [[ -z "$3" ]] && latHash=$(getRemoteHash "$1" "$(cd "$GITDIR" 2> /dev/null && git rev-parse --abbrev-ref HEAD)")
+    fi
+    if [[ -n "$current" ]] && [[ -n "$latest" ]]; then
+        output="${1^} version is $branch$current (Latest: $latest)"
+    elif [[ -n "$current" ]] && [[ -z "$latest" ]]; then
+        output="Current ${1^} version is $branch$current"
+    elif [[ -z "$current" ]] && [[ -n "$latest" ]]; then
+        output="Latest ${1^} version is $latest"
+    elif [[ "$curHash" == "N/A" ]] || [[ "$latHash" == "N/A" ]]; then
+        output="${1^} hash is not applicable"
+    elif [[ -n "$curHash" ]] && [[ -n "$latHash" ]]; then
+        output="${1^} hash is $curHash (Latest: $latHash)"
+    elif [[ -n "$curHash" ]] && [[ -z "$latHash" ]]; then
+        output="Current ${1^} hash is $curHash"
+    elif [[ -z "$curHash" ]] && [[ -n "$latHash" ]]; then
+        output="Latest ${1^} hash is $latHash"
+    else
+        errorOutput
+        return 1
+    fi
+
+    [[ -n "$output" ]] && echo "  $output"
 }
 
 errorOutput() {
-  echo "  Invalid Option! Try 'pihole -v --help' for more information."
-  exit 1
+    echo "  Invalid Option! Try 'pihole -v --help' for more information."
+    exit 1
 }
-  
+
 defaultOutput() {
-  versionOutput "pi-hole" "$@"
-  versionOutput "AdminLTE" "$@"
-  versionOutput "FTL" "$@"
+    versionOutput "pi-hole" "$@"
+
+    if [[ "${INSTALL_WEB_INTERFACE}" == true ]]; then
+        versionOutput "AdminLTE" "$@"
+    fi
+
+    versionOutput "FTL" "$@"
 }
 
 helpFunc() {
-  echo "Usage: pihole -v [repo | option] [option]
+    echo "Usage: pihole -v [repo | option] [option]
 Example: 'pihole -v -p -l'
 Show Pi-hole, Admin Console & FTL versions
 
@@ -150,19 +206,19 @@ Repositories:
   -p, --pihole         Only retrieve info regarding Pi-hole repository
   -a, --admin          Only retrieve info regarding AdminLTE repository
   -f, --ftl            Only retrieve info regarding FTL repository
-  
+
 Options:
   -c, --current        Return the current version
   -l, --latest         Return the latest version
-  --hash               Return the Github hash from your local repositories
+  --hash               Return the GitHub hash from your local repositories
   -h, --help           Show this help dialog"
   exit 0
 }
 
 case "${1}" in
-  "-p" | "--pihole"    ) shift; versionOutput "pi-hole" "$@";;
-  "-a" | "--admin"     ) shift; versionOutput "AdminLTE" "$@";;
-  "-f" | "--ftl"       ) shift; versionOutput "FTL" "$@";;
-  "-h" | "--help"      ) helpFunc;;
-  *                    ) defaultOutput "$@";;
+    "-p" | "--pihole"    ) shift; versionOutput "pi-hole" "$@";;
+    "-a" | "--admin"     ) shift; versionOutput "AdminLTE" "$@";;
+    "-f" | "--ftl"       ) shift; versionOutput "FTL" "$@";;
+    "-h" | "--help"      ) helpFunc;;
+    *                    ) defaultOutput "$@";;
 esac

advanced/Templates/gravity.db.sql

@@ -0,0 +1,191 @@
+PRAGMA foreign_keys=OFF;
+BEGIN TRANSACTION;
+
+CREATE TABLE "group"
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	enabled BOOLEAN NOT NULL DEFAULT 1,
+	name TEXT UNIQUE NOT NULL,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	description TEXT
+);
+INSERT INTO "group" (id,enabled,name,description) VALUES (0,1,'Default','The default group');
+
+CREATE TABLE domainlist
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	type INTEGER NOT NULL DEFAULT 0,
+	domain TEXT NOT NULL,
+	enabled BOOLEAN NOT NULL DEFAULT 1,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	comment TEXT,
+	UNIQUE(domain, type)
+);
+
+CREATE TABLE adlist
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	address TEXT UNIQUE NOT NULL,
+	enabled BOOLEAN NOT NULL DEFAULT 1,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	comment TEXT,
+	date_updated INTEGER,
+	number INTEGER NOT NULL DEFAULT 0,
+	invalid_domains INTEGER NOT NULL DEFAULT 0,
+	status INTEGER NOT NULL DEFAULT 0
+);
+
+CREATE TABLE adlist_by_group
+(
+	adlist_id INTEGER NOT NULL REFERENCES adlist (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (adlist_id, group_id)
+);
+
+CREATE TABLE gravity
+(
+	domain TEXT NOT NULL,
+	adlist_id INTEGER NOT NULL REFERENCES adlist (id)
+);
+
+CREATE TABLE info
+(
+	property TEXT PRIMARY KEY,
+	value TEXT NOT NULL
+);
+
+INSERT INTO "info" VALUES('version','15');
+
+CREATE TABLE domain_audit
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	domain TEXT UNIQUE NOT NULL,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int))
+);
+
+CREATE TABLE domainlist_by_group
+(
+	domainlist_id INTEGER NOT NULL REFERENCES domainlist (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (domainlist_id, group_id)
+);
+
+CREATE TABLE client
+(
+	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	ip TEXT NOT NULL UNIQUE,
+	date_added INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	date_modified INTEGER NOT NULL DEFAULT (cast(strftime('%s', 'now') as int)),
+	comment TEXT
+);
+
+CREATE TABLE client_by_group
+(
+	client_id INTEGER NOT NULL REFERENCES client (id),
+	group_id INTEGER NOT NULL REFERENCES "group" (id),
+	PRIMARY KEY (client_id, group_id)
+);
+
+CREATE TRIGGER tr_adlist_update AFTER UPDATE OF address,enabled,comment ON adlist
+    BEGIN
+      UPDATE adlist SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE id = NEW.id;
+    END;
+
+CREATE TRIGGER tr_client_update AFTER UPDATE ON client
+    BEGIN
+      UPDATE client SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE ip = NEW.ip;
+    END;
+
+CREATE TRIGGER tr_domainlist_update AFTER UPDATE ON domainlist
+    BEGIN
+      UPDATE domainlist SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE domain = NEW.domain;
+    END;
+
+CREATE VIEW vw_whitelist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 0
+    ORDER BY domainlist.id;
+
+CREATE VIEW vw_blacklist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 1
+    ORDER BY domainlist.id;
+
+CREATE VIEW vw_regex_whitelist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 2
+    ORDER BY domainlist.id;
+
+CREATE VIEW vw_regex_blacklist AS SELECT domain, domainlist.id AS id, domainlist_by_group.group_id AS group_id
+    FROM domainlist
+    LEFT JOIN domainlist_by_group ON domainlist_by_group.domainlist_id = domainlist.id
+    LEFT JOIN "group" ON "group".id = domainlist_by_group.group_id
+    WHERE domainlist.enabled = 1 AND (domainlist_by_group.group_id IS NULL OR "group".enabled = 1)
+    AND domainlist.type = 3
+    ORDER BY domainlist.id;
+
+CREATE VIEW vw_gravity AS SELECT domain, adlist_by_group.group_id AS group_id
+    FROM gravity
+    LEFT JOIN adlist_by_group ON adlist_by_group.adlist_id = gravity.adlist_id
+    LEFT JOIN adlist ON adlist.id = gravity.adlist_id
+    LEFT JOIN "group" ON "group".id = adlist_by_group.group_id
+    WHERE adlist.enabled = 1 AND (adlist_by_group.group_id IS NULL OR "group".enabled = 1);
+
+CREATE VIEW vw_adlist AS SELECT DISTINCT address, id
+    FROM adlist
+    WHERE enabled = 1
+    ORDER BY id;
+
+CREATE TRIGGER tr_domainlist_add AFTER INSERT ON domainlist
+    BEGIN
+      INSERT INTO domainlist_by_group (domainlist_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_client_add AFTER INSERT ON client
+    BEGIN
+      INSERT INTO client_by_group (client_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_adlist_add AFTER INSERT ON adlist
+    BEGIN
+      INSERT INTO adlist_by_group (adlist_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_group_update AFTER UPDATE ON "group"
+    BEGIN
+      UPDATE "group" SET date_modified = (cast(strftime('%s', 'now') as int)) WHERE id = NEW.id;
+    END;
+
+CREATE TRIGGER tr_group_zero AFTER DELETE ON "group"
+    BEGIN
+      INSERT OR IGNORE INTO "group" (id,enabled,name) VALUES (0,1,'Default');
+    END;
+
+CREATE TRIGGER tr_domainlist_delete AFTER DELETE ON domainlist
+    BEGIN
+      DELETE FROM domainlist_by_group WHERE domainlist_id = OLD.id;
+    END;
+
+CREATE TRIGGER tr_adlist_delete AFTER DELETE ON adlist
+    BEGIN
+      DELETE FROM adlist_by_group WHERE adlist_id = OLD.id;
+    END;
+
+CREATE TRIGGER tr_client_delete AFTER DELETE ON client
+    BEGIN
+      DELETE FROM client_by_group WHERE client_id = OLD.id;
+    END;
+
+COMMIT;

advanced/Templates/gravity_copy.sql

@@ -0,0 +1,42 @@
+.timeout 30000
+
+ATTACH DATABASE '/etc/pihole/gravity.db' AS OLD;
+
+BEGIN TRANSACTION;
+
+DROP TRIGGER tr_domainlist_add;
+DROP TRIGGER tr_client_add;
+DROP TRIGGER tr_adlist_add;
+
+INSERT OR REPLACE INTO "group" SELECT * FROM OLD."group";
+INSERT OR REPLACE INTO domain_audit SELECT * FROM OLD.domain_audit;
+
+INSERT OR REPLACE INTO domainlist SELECT * FROM OLD.domainlist;
+INSERT OR REPLACE INTO domainlist_by_group SELECT * FROM OLD.domainlist_by_group;
+
+INSERT OR REPLACE INTO adlist SELECT * FROM OLD.adlist;
+INSERT OR REPLACE INTO adlist_by_group SELECT * FROM OLD.adlist_by_group;
+
+INSERT OR REPLACE INTO info SELECT * FROM OLD.info;
+
+INSERT OR REPLACE INTO client SELECT * FROM OLD.client;
+INSERT OR REPLACE INTO client_by_group SELECT * FROM OLD.client_by_group;
+
+
+CREATE TRIGGER tr_domainlist_add AFTER INSERT ON domainlist
+    BEGIN
+      INSERT INTO domainlist_by_group (domainlist_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_client_add AFTER INSERT ON client
+    BEGIN
+      INSERT INTO client_by_group (client_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+CREATE TRIGGER tr_adlist_add AFTER INSERT ON adlist
+    BEGIN
+      INSERT INTO adlist_by_group (adlist_id, group_id) VALUES (NEW.id, 0);
+    END;
+
+
+COMMIT;

advanced/Templates/pihole-FTL.conf

@@ -0,0 +1,2 @@
+#; Pi-hole FTL config file
+#; Comments should start with #; to avoid issues with PHP and bash reading this file

advanced/Templates/pihole-FTL.service

@@ -0,0 +1,102 @@
+#!/usr/bin/env sh
+### BEGIN INIT INFO
+# Provides:          pihole-FTL
+# Required-Start:    $remote_fs $syslog $network
+# Required-Stop:     $remote_fs $syslog $network
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: pihole-FTL daemon
+# Description:       Enable service provided by pihole-FTL daemon
+### END INIT INFO
+
+is_running() {
+  pgrep -xo "pihole-FTL" > /dev/null
+}
+
+
+# Start the service
+start() {
+  if is_running; then
+    echo "pihole-FTL is already running"
+  else
+    # Touch files to ensure they exist (create if non-existing, preserve if existing)
+    mkdir -pm 0755 /run/pihole
+    touch /run/pihole-FTL.pid /run/pihole-FTL.port /var/log/pihole-FTL.log /var/log/pihole.log /etc/pihole/dhcp.leases
+    # Ensure that permissions are set so that pihole-FTL can edit all necessary files
+    chown pihole:pihole /run/pihole-FTL.pid /run/pihole-FTL.port /var/log/pihole-FTL.log /var/log/pihole.log /etc/pihole/dhcp.leases /run/pihole /etc/pihole
+    chmod 0644 /run/pihole-FTL.pid /run/pihole-FTL.port /var/log/pihole-FTL.log /var/log/pihole.log /etc/pihole/dhcp.leases
+    # Ensure that permissions are set so that pihole-FTL can edit the files. We ignore errors as the file may not (yet) exist
+    chmod -f 0644 /etc/pihole/macvendor.db
+    # Chown database files to the user FTL runs as. We ignore errors as the files may not (yet) exist
+    chown -f pihole:pihole /etc/pihole/pihole-FTL.db /etc/pihole/gravity.db /etc/pihole/macvendor.db
+    # Chown database file permissions so that the pihole group (web interface) can edit the file. We ignore errors as the files may not (yet) exist
+    chmod -f 0664 /etc/pihole/pihole-FTL.db
+    if setcap CAP_NET_BIND_SERVICE,CAP_NET_RAW,CAP_NET_ADMIN,CAP_SYS_NICE,CAP_IPC_LOCK,CAP_CHOWN+eip "/usr/bin/pihole-FTL"; then
+      su -s /bin/sh -c "/usr/bin/pihole-FTL" pihole
+    else
+      echo "Warning: Starting pihole-FTL as root because setting capabilities is not supported on this system"
+      /usr/bin/pihole-FTL
+    fi
+    echo
+  fi
+}
+
+# Stop the service
+stop() {
+  if is_running; then
+    pkill -xo "pihole-FTL"
+    for i in 1 2 3 4 5; do
+      if ! is_running; then
+        break
+      fi
+
+      printf "."
+      sleep 1
+    done
+    echo
+
+    if is_running; then
+      echo "Not stopped; may still be shutting down or shutdown may have failed, killing now"
+      pkill -xo -9 "pihole-FTL"
+      exit 1
+    else
+      echo "Stopped"
+    fi
+  else
+    echo "Not running"
+  fi
+  # Cleanup
+  rm -f /run/pihole/FTL.sock /dev/shm/FTL-*
+  echo
+}
+
+# Indicate the service status
+status() {
+  if is_running; then
+    echo "[ ok ] pihole-FTL is running"
+    exit 0
+  else
+    echo "[    ] pihole-FTL is not running"
+    exit 1
+  fi
+}
+
+
+### main logic ###
+case "$1" in
+  stop)
+        stop
+        ;;
+  status)
+        status
+        ;;
+  start|restart|reload|condrestart)
+        stop
+        start
+        ;;
+  *)
+        echo "Usage: $0 {start|stop|restart|reload|status}"
+        exit 1
+esac
+
+exit 0

advanced/Templates/pihole.cron

@@ -0,0 +1,36 @@
+# Pi-hole: A black hole for Internet advertisements
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
+# Updates ad sources every week
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+#
+#
+#
+# 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 software
+# 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 a random time in the
+#          early morning. Download any updates from the adlists
+#          Squash output to log, then splat the log to stdout on error to allow for
+#          standard crontab job error handling.
+59 1    * * 7   root    PATH="$PATH:/usr/sbin:/usr/local/bin/" pihole updateGravity >/var/log/pihole_updateGravity.log || cat /var/log/pihole_updateGravity.log
+
+# Pi-hole: Flush the log daily at 00:00
+#          The flush script will use logrotate if available
+#          parameter "once": logrotate only once (default is twice)
+#          parameter "quiet": don't print messages
+00 00   * * *   root    PATH="$PATH:/usr/sbin:/usr/local/bin/" pihole flush once quiet
+
+@reboot root /usr/sbin/logrotate --state /var/lib/logrotate/pihole /etc/pihole/logrotate
+
+# Pi-hole: Grab local version and branch every 10 minutes
+*/10 *  * * *   root    PATH="$PATH:/usr/sbin:/usr/local/bin/" pihole updatechecker local
+
+# Pi-hole: Grab remote version every 24 hours
+59 17  * * *   root    PATH="$PATH:/usr/sbin:/usr/local/bin/" pihole updatechecker remote
+@reboot root    PATH="$PATH:/usr/sbin:/usr/local/bin/" pihole updatechecker remote reboot

advanced/bash-completion/pihole

@@ -1,11 +1,79 @@
 _pihole() {
-	local cur prev opts
+	local cur prev opts opts_admin opts_checkout opts_chronometer opts_debug opts_interface  opts_logging opts_privacy opts_query opts_update opts_version
 	COMPREPLY=()
 	cur="${COMP_WORDS[COMP_CWORD]}"
 	prev="${COMP_WORDS[COMP_CWORD-1]}"
-	opts="admin blacklist chronometer debug disable enable flush help logging query reconfigure restartdns setupLCD status tail uninstall updateGravity updatePihole version whitelist checkout"
+	prev2="${COMP_WORDS[COMP_CWORD-2]}"
 
-	COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+	case "${prev}" in
+		"pihole")
+			opts="admin blacklist checkout chronometer debug disable enable flush help logging query reconfigure regex restartdns status tail uninstall updateGravity updatePihole version wildcard whitelist arpflush"
+			COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+		;;
+		"whitelist"|"blacklist"|"wildcard"|"regex")
+			opts_lists="\--delmode \--noreload \--quiet \--list \--nuke"
+			COMPREPLY=( $(compgen -W "${opts_lists}" -- ${cur}) )
+		;;
+		"admin")
+			opts_admin="celsius email fahrenheit interface kelvin password privacylevel"
+			COMPREPLY=( $(compgen -W "${opts_admin}" -- ${cur}) )
+		;;
+		"checkout")
+			opts_checkout="core ftl web master dev"
+			COMPREPLY=( $(compgen -W "${opts_checkout}" -- ${cur}) )
+		;;
+		"chronometer")
+			opts_chronometer="\--exit \--json \--refresh"
+			COMPREPLY=( $(compgen -W "${opts_chronometer}" -- ${cur}) )
+		;;
+		"debug")
+			opts_debug="-a"
+			COMPREPLY=( $(compgen -W "${opts_debug}" -- ${cur}) )
+		;;
+		"logging")
+			opts_logging="on off 'off noflush'"
+			COMPREPLY=( $(compgen -W "${opts_logging}" -- ${cur}) )
+		;;
+		"query")
+			opts_query="-adlist -all -exact"
+			COMPREPLY=( $(compgen -W "${opts_query}" -- ${cur}) )
+		;;
+		"updatePihole"|"-up")
+			opts_update="--check-only"
+			COMPREPLY=( $(compgen -W "${opts_update}" -- ${cur}) )
+		;;
+		"version")
+			opts_version="\--admin \--current \--ftl \--hash \--latest \--pihole"
+			COMPREPLY=( $(compgen -W "${opts_version}" -- ${cur}) )
+		;;
+		"interface")
+			if ( [[ "$prev2" == "admin" ]] || [[ "$prev2" == "-a" ]] ); then
+				opts_interface="$(cat /proc/net/dev | cut -d: -s -f1)"
+				COMPREPLY=( $(compgen -W "${opts_interface}" -- ${cur}) )
+			else
+				return 1
+			fi
+		;;
+		"privacylevel")
+			if ( [[ "$prev2" == "admin" ]] || [[ "$prev2" == "-a" ]] ); then
+				opts_privacy="0 1 2 3"
+				COMPREPLY=( $(compgen -W "${opts_privacy}" -- ${cur}) )
+			else
+				return 1
+			fi
+		;;
+		"core"|"admin"|"ftl")
+			if [[ "$prev2" == "checkout" ]]; then
+				opts_checkout="master dev"
+				COMPREPLY=( $(compgen -W "${opts_checkout}" -- ${cur}) )
+			else
+				return 1
+			fi
+		;;
+		*)
+		return 1
+		;;
+	esac
 	return 0
 }
 complete -F _pihole pihole

advanced/blockingpage.css

@@ -1,136 +1,455 @@
-/* CSS Reset */
-html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video { margin: 0; padding: 0; border: 0; font-size: 100%; font: inherit; vertical-align: baseline; }
-article, aside, details, figcaption, figure, footer, header, hgroup, menu, nav, section { display: block; }
-body { line-height: 1; }
-ol, ul { list-style: none; }
-blockquote, q { quotes: none; }
-blockquote:before, blockquote:after, q:before, q:after { content: ''; content: none; }
-table { border-collapse: collapse; border-spacing: 0; }
-html { height: 100%; overflow-x: hidden; }
+/* Pi-hole: A black hole for Internet advertisements
+*  (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+*  Network-wide ad blocking via your own hardware.
+*
+*  This file is copyright under the latest version of the EUPL.
+*  Please see LICENSE file for your rights under this license. */
 
-/* General Style */
-a	{ color: rgba(0,60,120,0.95); text-decoration: none; } /* 1E3C5A */
-a:hover { color: rgba(210,120,0,0.95); transition-duration: .2s; } /* 255, 128, 0 */
-divs a		{ border-bottom: 1px dashed rgba(30,60,90,0.3); }
-b	{ font-weight: bold; }
-i	{ font-style: italic; }
+/* Text Customisation Options ======> */
+.title::before { content: "Website Blocked"; }
+.altBtn::before { content: "Why am I here?"; }
+.linkPH::before { content: "About Pi-hole"; }
+.linkEmail::before { content: "Contact Admin"; }
 
-footer, pre, td { font-family: monospace; padding-left: 15px; }
-/*body, header { background: #E1E1E1; }*/
+#bpOutput.add::before { content: "Info"; }
+#bpOutput.add::after { content: "The domain is being whitelisted..."; }
+#bpOutput.error::before, .unhandled::before { content: "Error"; }
+#bpOutput.unhandled::after { content: "An unhandled exception occurred. This may happen when your browser is unable to load jQuery, or when the webserver is denying access to the Pi-hole API."; }
+#bpOutput.success::before { content: "Success"; }
+#bpOutput.success::after { content: "Website has been whitelisted! You may need to flush your DNS cache"; }
+
+.recentwl::before { content: "This site has been whitelisted. Please flush your DNS cache and/or restart your browser."; }
+.unknown::before { content: "This website is not found in any of Pi-hole's blacklists. The reason you have arrived here is unknown."; }
+.cname::before { content: "This site is an alias for "; } /* <a href="http://cname.com">cname.com</a> */
+.cname::after { content: ", which may be blocked by Pi-hole."; }
+
+.blacklist::before { content: "Manually Blacklisted"; }
+.wildcard::before { content: "Manually Blacklisted by Wildcard"; }
+.noblock::before { content: "Not found on any Blacklist"; }
+
+#bpBlock::before { content: "Access to the following website has been denied:"; }
+#bpFlag::before { content: "This is primarily due to being flagged as:"; }
+
+#bpHelpTxt::before { content: "If you have an ongoing use for this website, please "; }
+#bpHelpTxt a::before, #bpHelpTxt span::before { content: "ask the administrator"; }
+#bpHelpTxt::after{ content: " of the Pi-hole on this network to have it whitelisted"; }
+
+#bpBack::before { content: "Back to safety"; }
+#bpInfo::before { content: "Technical Info"; }
+#bpFoundIn::before { content: "This site is found in "; }
+#bpFoundIn span::after { content: " of "; }
+#bpFoundIn::after { content: " lists:"; }
+#bpWhitelist::before { content: "Whitelist"; }
+
+footer span::before { content: "Page generated on "; }
+
+/* Hide whitelisting form entirely */
+/* #bpWLButtons { display: none; } */
+
+/* Text Customisation Options <=============================== */
+
+/* http://necolas.github.io/normalize.css ======> */
+html { font-family: sans-serif; line-height: 1.15; -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100%; }
+body { margin: 0; }
+article, aside, footer, header, nav, section { display: block; }
+h1 { font-size: 2em; margin: 0.67em 0; }
+figcaption, figure, main { display: block; }
+figure { margin: 1em 40px; }
+hr { box-sizing: content-box; height: 0; overflow: visible; }
+pre { font-family: monospace, monospace; font-size: 1em; }
+a { background-color: transparent; -webkit-text-decoration-skip: objects; }
+a:active, a:hover { outline-width: 0; }
+abbr[title] { border-bottom: none; text-decoration: underline; text-decoration: underline dotted; }
+b, strong { font-weight: inherit; }
+b, strong { font-weight: bolder; }
+code, kbd, samp { font-family: monospace, monospace; font-size: 1em; }
+dfn { font-style: italic; }
+mark { background-color: #ff0; color: #000; }
+small { font-size: 80%; }
+sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; }
+sub { bottom: -0.25em; }
+sup { top: -0.5em; }
+audio, video { display: inline-block; }
+audio:not([controls]) { display: none; height: 0; }
+img { border-style: none; }
+svg:not(:root) { overflow: hidden; }
+button, input, optgroup, select, textarea { font-family: sans-serif; font-size: 100%; line-height: 1.15; margin: 0; }
+button, input { overflow: visible; }
+button, select { text-transform: none; }
+button, html [type="button"], [type="reset"], [type="submit"] { -webkit-appearance: button; }
+button::-moz-focus-inner, [type="button"]::-moz-focus-inner, [type="reset"]::-moz-focus-inner, [type="submit"]::-moz-focus-inner { border-style: none; padding: 0; }
+button:-moz-focusring, [type="button"]:-moz-focusring, [type="reset"]:-moz-focusring, [type="submit"]:-moz-focusring { outline: 1px dotted ButtonText; }
+fieldset { border: 1px solid #c0c0c0; margin: 0 2px; padding: 0.35em 0.625em 0.75em; }
+legend { box-sizing: border-box; color: inherit; display: table; max-width: 100%; padding: 0; white-space: normal; }
+progress { display: inline-block; vertical-align: baseline; }
+textarea { overflow: auto; }
+[type="checkbox"], [type="radio"] { box-sizing: border-box; padding: 0; }
+[type="number"]::-webkit-inner-spin-button, [type="number"]::-webkit-outer-spin-button { height: auto; }
+[type="search"] { -webkit-appearance: textfield; outline-offset: -2px; }
+[type="search"]::-webkit-search-cancel-button, [type="search"]::-webkit-search-decoration { -webkit-appearance: none; }
+::-webkit-file-upload-button { -webkit-appearance: button; font: inherit; }
+details, menu { display: block; }
+summary { display: list-item; }
+canvas { display: inline-block; }
+template { display: none; }
+[hidden] { display: none; }
+/* Normalize.css <=============================== */
+
+html { font-size: 62.5%; }
+
+a { color: #3c8dbc; text-decoration: none; }
+a:hover { color: #72afda; text-decoration: underline; }
+b { color: rgb(68, 68, 68); }
+p { margin: 0; }
+
+label, .buttons a {
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  user-select: none;
+}
+
+label, .buttons *:not([disabled]) { cursor: pointer; }
+
+/* Touch device dark tap highlight */
+header h1 a, label, .buttons * { -webkit-tap-highlight-color: transparent; }
+
+/* Webkit Focus Glow */
+textarea, input, button { outline: none; }
+
+@font-face {
+  font-family: "Source Sans Pro";
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: local("Source Sans Pro Regular"), local("SourceSansPro-Regular"),
+       url("/admin/style/vendor/SourceSansPro/source-sans-pro-v13-latin-regular.woff2") format("woff2"),
+       url("/admin/style/vendor/SourceSansPro/source-sans-pro-v13-latin-regular.woff") format("woff");
+}
+
+@font-face {
+  font-family: "Source Sans Pro";
+  font-style: normal;
+  font-weight: 700;
+  font-display: swap;
+  src: local("Source Sans Pro Bold"), local("SourceSansPro-Bold"),
+       url("/admin/style/vendor/SourceSansPro/source-sans-pro-v13-latin-700.woff2") format("woff2"),
+       url("/admin/style/vendor/SourceSansPro/source-sans-pro-v13-latin-700.woff") format("woff");
+}
 
 body {
-	background-image: -webkit-linear-gradient(top, rgba(240,240,240,0.95), rgba(190,190,190,0.95));
-	background-image: linear-gradient(to bottom, rgba(240,240,240,0.95), rgba(190,190,190,0.95));
-	background-attachment: fixed;
-	color: rgba(64,64,64,0.95);
-	font: 14px, sans-serif;
-	line-height: 1em;
+  background: #dbdbdb url("/admin/img/boxed-bg.jpg") repeat fixed;
+  color: #333;
+  font: 1.4rem "Source Sans Pro", "Helvetica Neue", Helvetica, Arial, sans-serif;
+  line-height: 2.2rem;
+}
+
+/* User is greeted with a splash page when browsing to Pi-hole IP address */
+#splashpage {
+  background: #222;
+  color: rgba(255, 255, 255, 0.7);
+  text-align: center;
+  width: 100%;
+  height: 100%;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}
+
+#splashpage img { margin: 5px; width: 256px; }
+#splashpage b { color: inherit; }
+
+#bpWrapper {
+  margin: 0 auto;
+  max-width: 1250px;
+  box-shadow: 0 0 8px rgba(0, 0, 0, 0.5);
 }
 
 header {
-	min-width: 320px;
-	width: 100%;
-	text-shadow: 0 1px rgba(255,255,255,0.6);
-	display: table;
-	table-layout: fixed;
-	border: 1px solid rgba(0,0,0,0.25);
-	border-top-color: rgba(255,255,255,0.85);
-	border-style: solid none;
-	background-image: -webkit-linear-gradient(top, rgba(240,240,240,0.95), rgba(220,220,220,0.95));
-	background-image: linear-gradient(to bottom, rgba(240,240,240,0.95), rgba(220,220,220,0.95));
-	box-shadow:  0 0 1px 1px rgba(0,0,0,0.04);
+  background: #3c8dbc;
+  display: table;
+  position: relative;
+  width: 100%;
 }
 
-header h1, header div {
-	display: table-cell;
-	color: inherit;
-	font-weight: bold;
-	vertical-align: middle;
-	white-space: nowrap;
-	overflow: hidden;
-	box-sizing: border-box;
+header h1, header h1 a, header .spc, header #bpAlt label {
+  display: table-cell;
+  color: #fff;
+  white-space: nowrap;
+  vertical-align: middle;
+  height: 50px; /* Must match #bpAbout top value */
 }
 
-header h1 {
-	font-size: 22px;
-	font-weight: bold;
-	width: 100%;
-	padding: 8px 0;
-	text-indent: 32px;
-	background: url("http://pi.hole/admin/img/logo.svg") left no-repeat;
-	background-size: 30px 22px;
+h1 a {
+  background-color: rgba(0, 0, 0, 0.1);
+  font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+  font-size: 2rem;
+  font-weight: 400;
+  min-width: 230px;
+  text-align: center;
 }
 
-header h1 a, h1 a:hover { color: inherit; }
-header .alt { width: 85px; font-size: 0.8em; padding-right: 4px; text-align: right; line-height: 1.25em; }
-.active { color: green; }
-.inactive { color: red; }
+h1 a:hover, header #bpAlt:hover { background-color: rgba(0, 0, 0, 0.12); color: inherit; text-decoration: none; }
+
+header .spc { width: 100%; }
+
+header #bpAlt label {
+  background: url("/admin/img/logo.svg") no-repeat center left 15px;
+  background-size: 15px 23px;
+  padding: 0 15px;
+  text-indent: 30px;
+}
+
+[type="checkbox"][id$="Toggle"] { display: none; }
+[type="checkbox"][id$="Toggle"]:checked ~ #bpAbout,
+[type="checkbox"][id$="Toggle"]:checked ~ #bpMoreInfo {
+  display: block;
+}
+
+html, body {
+    height: 100%;
+}
+
+#pihole_card {
+    width: 400px;
+    height: auto;
+    max-width: 400px;
+}
+
+    #pihole_card p, #pihole_card a {
+        font-size: 13pt;
+        text-align: center;
+    }
+
+#pihole_logo_splash {
+    height: auto;
+    width: 100%;
+}
+
+/* Click anywhere else on screen to hide #bpAbout */
+#bpAboutToggle:checked {
+  display: block;
+  height: 300px; /* VH Fallback */
+  height: 100vh;
+  left: 0;
+  top: 0;
+  opacity: 0;
+  position: absolute;
+  width: 100%;
+}
+
+#bpAbout {
+  background: #3c8dbc;
+  border-bottom-left-radius: 5px;
+  border: 1px solid #fff;
+  border-right-width: 0;
+  box-shadow: -1px 1px 1px rgba(0, 0, 0, 0.12);
+  box-sizing: border-box;
+  display: none;
+  font-size: 1.7rem;
+  top: 50px;
+  position: absolute;
+  right: 0;
+  width: 280px;
+  z-index: 1;
+}
+
+.aboutPH {
+  box-sizing: border-box;
+  color: rgba(255, 255, 255, 0.8);
+  display: block;
+  padding: 10px;
+  width: 100%;
+  text-align: center;
+}
+
+.aboutImg {
+  background: url("/admin/img/logo.svg") no-repeat center;
+  background-size: 90px 90px;
+  height: 90px;
+  margin: 0 auto;
+  padding: 2px;
+  width: 90px;
+}
+
+.aboutPH p { margin: 10px 0; }
+.aboutPH small { display: block; font-size: 1.2rem; }
+
+.aboutLink {
+  background: #fff;
+  border-top: 1px solid #ddd;
+  display: table;
+  font-size: 1.4rem;
+  text-align: center;
+  width: 100%;
+}
+
+.aboutLink a {
+  display: table-cell;
+  padding: 14px;
+  min-width: 50%;
+}
 
 main {
-	display: block;
-	width: 80%;
-	padding: 10px;
-	font-size: 1em;
-	background-color: rgba(255,255,255,0.85);
-	margin: 8px auto;
-	box-sizing: border-box;
-	border: 1px solid rgba(0,0,0,0.25);
-	box-shadow:  4px 4px rgba(0,0,0,0.1);
-	line-height: 1.2em;
-	border-radius: 8px;
+  background: #ecf0f5;
+  font-size: 1.65rem;
+  padding: 10px;
 }
 
-h2 { /* Rgba is shared with .transparent th */
-	font: 1.15em sans-serif;
-	background-color: rgba(255,0,0,0.4);
-	text-shadow: none;
-	line-height: 1.1em;
-	padding-bottom: 1px;
-	margin-top: 8px;
-	margin-bottom: 4px;
-	background: -webkit-linear-gradient(left, rgba(0,0,0,0.25), transparent 80%) no-repeat;
-	background: linear-gradient(to right, rgba(0,0,0,0.25), transparent 80%) no-repeat;
-	background-size: 100% 1px;
-	background-position: 0 17px;
+#bpOutput {
+  background: #00c0ef;
+  border-radius: 3px;
+  border: 1px solid rgba(0, 0, 0, 0.1);
+  color: #fff;
+  font-size: 1.4rem;
+  margin-bottom: 10px;
+  margin-top: 5px;
+  padding: 15px;
 }
 
-h2:first-child { margin-top: 0; }
-h2 ~ *:not(h2) { margin-left: 4px; }
-li { padding: 2px 0; }
-li::before { content: "\00BB\00a0"; }
-li a { position: relative; top: 1px; } /* Center bullet-point arrows */
-
-/* Button Style */
-.buttons a, button, input, .transparent th a { /* Swapped rgba is shared with input[type='url'] */
-	display: inline-block;
-	color: rgba(32,32,32,0.9);
-	font-weight: bold;
-	text-align: center;
-	cursor: pointer;
-	text-shadow: 0 1px rgba(255,255,255,0.2);
-	line-height: 0.86em;
-	font-size: 1em;
-	padding: 4px 8px;
-	background: #FAFAFA;
-	background-image: -webkit-linear-gradient(top, rgba(255,255,255,0.05), rgba(0,0,0,0.05));
-	background-image: linear-gradient(to bottom, rgba(255,255,255,0.05), rgba(0,0,0,0.05));
-	border: 1px solid rgba(0,0,0,0.25);
-	border-radius: 4px;
-	box-shadow: 0 1px 0 rgba(0,0,0,0.04);
+#bpOutput::before {
+  background: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='7' height='14' viewBox='0 0 7 14'%3E%3Cpath fill='%23fff' d='M6 11a1.371 1.371 0 011 1v1a1.371 1.371 0 01-1 1H1a1.371 1.371 0 01-1-1v-1a1.371 1.371 0 011-1h1V8H1a1.371 1.371 0 01-1-1V6a1.371 1.371 0 011-1h3a1.371 1.371 0 011 1v5h1zM3.5 0A1.5 1.5 0 112 1.5 1.5 1.5 0 013.5 0z'/%3E%3C/svg%3E") no-repeat center left;
+  display: block;
+  font-size: 1.8rem;
+  text-indent: 15px;
 }
 
-.buttons { white-space: nowrap; width: 100%; display: table; }
-.buttons33 { white-space: nowrap; width: 33.333%; display: table; text-align: center; margin-left: 33.333% }
-.mini a { width: 50%; }
-a.safe { background-color: rgba(0,220,0,0.5); }
-button.safe { background-color: rgba(0,220,0,0.5); }
-a.warn { background-color: rgba(220,0,0,0.5); }
+#bpOutput.hidden { display: none; }
+#bpOutput.success { background: #00a65a; }
+#bpOutput.error { background: #dd4b39; }
 
-.blocked a, .mini a { display: table-cell; }
-.blocked a.safe50 { width: 50%; background-color: rgba(0,220,0,0.5); }
-.blocked a.safe33 { width: 33.333%; background-color: rgba(0,220,0,0.5); }
+.blockMsg, .flagMsg {
+  font: 700 1.8rem Consolas, Courier, monospace;
+  padding: 5px 10px 10px;
+  text-indent: 15px;
+}
 
-/* Types of text */
-.msg { white-space: pre; overflow: auto; -webkit-overflow-scrolling: touch; display: block; line-height: 1.2em; font-weight: bold; font-size: 1.15em; margin: 4px 8px 8px 8px; white-space: pre-line; }
+#bpHelpTxt { padding-bottom: 10px; }
 
-footer { font-size: 0.8em; text-align: center; width: 87%; margin: 4px auto; }
+.buttons {
+  border-spacing: 5px 0;
+  display: table;
+  width: 100%;
+}
+
+.buttons * {
+  -moz-appearance: none;
+  -webkit-appearance: none;
+  border-radius: 3px;
+  border: 1px solid rgba(0, 0, 0, 0.1);
+  box-sizing: content-box;
+  display: table-cell;
+  font-size: 1.65rem;
+  margin-right: 5px;
+  min-height: 20px;
+  padding: 6px 12px;
+  position: relative;
+  text-align: center;
+  vertical-align: top;
+  white-space: nowrap;
+  width: auto;
+}
+
+.buttons a:hover { text-decoration: none; }
+
+/* Button hover dark overlay */
+.buttons *:not(input):not([disabled]):hover {
+  background-image: linear-gradient(to bottom, rgba(0, 0, 0, 0.1), rgba(0, 0, 0, 0.1));
+  color: #fff;
+}
+
+/* Button active shadow inset */
+.buttons *:not([disabled]):not(input):active {
+  box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125);
+}
+
+/* Input border color */
+.buttons *:not([disabled]):hover, .buttons input:focus {
+  border-color: rgba(0, 0, 0, 0.25);
+}
+
+#bpButtons *  { width: 50%; color: #fff; }
+#bpBack       { background-color: #00a65a; }
+#bpInfo       { background-color: #3c8dbc; }
+#bpWhitelist  { background-color: #dd4b39; }
+
+#blockpage .buttons [type="password"][disabled] { color: rgba(0, 0, 0, 1); }
+#blockpage .buttons [disabled] { color: rgba(0, 0, 0, 0.55); background-color: #e3e3e3; }
+#blockpage .buttons [type="password"]:-ms-input-placeholder { color: rgba(51, 51, 51, 0.8); }
+
+input[type="password"] { font-size: 1.5rem; }
+
+@-webkit-keyframes slidein { from { max-height: 0; opacity: 0; } to { max-height: 300px; opacity: 1; } }
+
+@keyframes slidein { from { max-height: 0; opacity: 0; } to { max-height: 300px; opacity: 1; } }
+#bpMoreToggle:checked ~ #bpMoreInfo { display: block; margin-top: 8px; -webkit-animation: slidein 0.05s linear; animation: slidein 0.05s linear; }
+#bpMoreInfo { display: none; margin-top: 10px; }
+
+#bpQueryOutput {
+  font-size: 1.2rem;
+  line-height: 1.65rem;
+  margin: 5px 0 0;
+  overflow: auto;
+  padding: 0 5px;
+  -webkit-overflow-scrolling: touch;
+}
+
+#bpQueryOutput span { margin-right: 4px; }
+
+#bpWLButtons { width: auto; margin-top: 10px; }
+#bpWLButtons * { display: inline-block; }
+#bpWLDomain { display: none; }
+#bpWLPassword { width: 160px; }
+#bpWhitelist { color: #fff; }
+
+footer {
+  background: #fff;
+  border-top: 1px solid #d2d6de;
+  color: #444;
+  font: 1.2rem Consolas, Courier, monospace;
+  padding: 8px;
+}
+
+/* Responsive Content */
+@media only screen and (max-width: 500px) {
+  h1 a {
+        font-size: 1.8rem;
+        min-width: 170px;
+    }
+
+    footer span::before {
+        content: "Generated ";
+    }
+
+    footer span {
+        display: block;
+    }
+}
+
+@media only screen and (min-width: 1251px) {
+  #bpWrapper, footer {
+        border-radius: 0 0 5px 5px;
+    }
+
+    #bpAbout {
+        border-right-width: 1px;
+    }
+}
+
+@media only screen and (max-width: 400px) {
+    #pihole_card {
+        width: 100%;
+        height: auto;
+    }
+
+        #pihole_card p, #pihole_card a {
+            font-size: 100%;
+        }
+}
+
+@media only screen and (max-width: 256px) {
+    #pihole_logo_splash {
+        width: 90% !important;
+        height: auto;
+    }
+}

advanced/dnsmasq.conf.original

@@ -46,7 +46,7 @@
 #resolv-file=
 
 # By  default,  dnsmasq  will  send queries to any of the upstream
-# servers it knows about and tries to favour servers to are  known
+# servers it knows about and tries to favor servers to are  known
 # to  be  up.  Uncommenting this forces dnsmasq to try each query
 # with  each  server  strictly  in  the  order  they   appear   in
 # /etc/resolv.conf
@@ -189,7 +189,7 @@
 # add names to the DNS for the IPv6 address of SLAAC-configured dual-stack
 # hosts. Use the DHCPv4 lease to derive the name, network segment and
 # MAC address and assume that the host will also have an
-# IPv6 address calculated using the SLAAC alogrithm.
+# IPv6 address calculated using the SLAAC algorithm.
 #dhcp-range=1234::, ra-names
 
 # Do Router Advertisements, BUT NOT DHCP for this subnet.
@@ -210,7 +210,7 @@
 #dhcp-range=1234::, ra-stateless, ra-names
 
 # Do router advertisements for all subnets where we're doing DHCPv6
-# Unless overriden by ra-stateless, ra-names, et al, the router
+# Unless overridden by ra-stateless, ra-names, et al, the router
 # advertisements will have the M and O bits set, so that the clients
 # get addresses and configuration from DHCPv6, and the A bit reset, so the
 # clients don't use SLAAC addresses.
@@ -281,7 +281,7 @@
 # Give a fixed IPv6 address and name to client with
 # DUID 00:01:00:01:16:d2:83:fc:92:d4:19:e2:d8:b2
 # Note the MAC addresses CANNOT be used to identify DHCPv6 clients.
-# Note also the they [] around the IPv6 address are obilgatory.
+# Note also the they [] around the IPv6 address are obligatory.
 #dhcp-host=id:00:01:00:01:16:d2:83:fc:92:d4:19:e2:d8:b2, fred, [1234::5]
 
 # Ignore any clients which are not specified in dhcp-host lines
@@ -404,14 +404,14 @@
 #dhcp-option=vendor:MSFT,2,1i
 
 # Send the Encapsulated-vendor-class ID needed by some configurations of
-# Etherboot to allow is to recognise the DHCP server.
+# Etherboot to allow is to recognize the DHCP server.
 #dhcp-option=vendor:Etherboot,60,"Etherboot"
 
 # Send options to PXELinux. Note that we need to send the options even
 # though they don't appear in the parameter request list, so we need
 # to use dhcp-option-force here.
 # See http://syslinux.zytor.com/pxe.php#special for details.
-# Magic number - needed before anything else is recognised
+# Magic number - needed before anything else is recognized
 #dhcp-option-force=208,f1:00:74:7e
 # Configuration file name
 #dhcp-option-force=209,configs/common

advanced/index.js

@@ -1 +0,0 @@
-var x = "Pi-hole: A black hole for Internet advertisements."

advanced/index.php

@@ -1,224 +1,395 @@
 <?php
-/* Detailed Pi-hole Block Page: Show "Website Blocked" if user browses to site, but not to image/file requests based on the work of WaLLy3K for DietPi & Pi-Hole */
+/* Pi-hole: A black hole for Internet advertisements
+*  (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+*  Network-wide ad blocking via your own hardware.
+*
+*  This file is copyright under the latest version of the EUPL.
+*  Please see LICENSE file for your rights under this license. */
 
-function validIP($address){
-	if (preg_match('/[.:0]/', $address) && !preg_match('/[1-9a-f]/', $address)) {
-		// Test if address contains either `:` or `0` but not 1-9 or a-f
-		return false;
-	}
-	return !filter_var($address, FILTER_VALIDATE_IP) === false;
-}
+// Sanitize SERVER_NAME output
+$serverName = htmlspecialchars($_SERVER["SERVER_NAME"]);
+// Remove external ipv6 brackets if any
+$serverName = preg_replace('/^\[(.*)\]$/', '${1}', $serverName);
 
-$uri = escapeshellcmd($_SERVER['REQUEST_URI']);
-$serverName = escapeshellcmd($_SERVER['SERVER_NAME']);
+if (!is_file("/etc/pihole/setupVars.conf"))
+  die("[ERROR] File not found: <code>/etc/pihole/setupVars.conf</code>");
 
-// If the server name is 'pi.hole', it's likely a user trying to get to the admin panel.
-// Let's be nice and redirect them.
-if ($serverName === 'pi.hole')
-{
-    header('HTTP/1.1 301 Moved Permanently');
-    header("Location: /admin/");
-}
-
-// Retrieve server URI extension (EG: jpg, exe, php)
-ini_set('pcre.recursion_limit',100);
-$uriExt = pathinfo($uri, PATHINFO_EXTENSION);
-
-// Define which URL extensions get rendered as "Website Blocked"
-$webExt = array('asp', 'htm', 'html', 'php', 'rss', 'xml');
-
-// Get IPv4 and IPv6 addresses from setupVars.conf (if available)
+// Get values from setupVars.conf
 $setupVars = parse_ini_file("/etc/pihole/setupVars.conf");
-$ipv4 = isset($setupVars["IPV4_ADDRESS"]) ? explode("/", $setupVars["IPV4_ADDRESS"])[0] : $_SERVER['SERVER_ADDR'];
-$ipv6 = isset($setupVars["IPV6_ADDRESS"]) ? explode("/", $setupVars["IPV6_ADDRESS"])[0] : $_SERVER['SERVER_ADDR'];
+$svPasswd = !empty($setupVars["WEBPASSWORD"]);
+$svEmail = (!empty($setupVars["ADMIN_EMAIL"]) && filter_var($setupVars["ADMIN_EMAIL"], FILTER_VALIDATE_EMAIL)) ? $setupVars["ADMIN_EMAIL"] : "";
+unset($setupVars);
 
-$AUTHORIZED_HOSTNAMES = array(
-	$ipv4,
-	$ipv6,
-	str_replace(array("[","]"), array("",""), $_SERVER["SERVER_ADDR"]),
-	"pi.hole",
-	"localhost");
-// Allow user set virtual hostnames
-$virtual_host = getenv('VIRTUAL_HOST');
-if (!empty($virtual_host))
-	array_push($AUTHORIZED_HOSTNAMES, $virtual_host);
+// Set landing page location, found within /var/www/html/
+$landPage = "../landing.php";
 
-// Immediately quit since we didn't block this page (the IP address or pi.hole is explicitly requested)
-if(validIP($serverName) || in_array($serverName,$AUTHORIZED_HOSTNAMES))
-{
-	http_response_code(404);
-	die();
+// Define array for hostnames to be accepted as self address for splash page
+$authorizedHosts = [ "localhost" ];
+if (!empty($_SERVER["FQDN"])) {
+    // If setenv.add-environment = ("fqdn" => "true") is configured in lighttpd,
+    // append $serverName to $authorizedHosts
+    array_push($authorizedHosts, $serverName);
+} else if (!empty($_SERVER["VIRTUAL_HOST"])) {
+    // Append virtual hostname to $authorizedHosts
+    array_push($authorizedHosts, $_SERVER["VIRTUAL_HOST"]);
 }
 
-if(in_array($uriExt, $webExt) || empty($uriExt))
-{
-	// Requested resource has an extension listed in $webExt
-	// or no extension (index access to some folder incl. the root dir)
-	$showPage = true;
-}
-else
-{
-	// Something else
-	$showPage = false;
+// Set which extension types render as Block Page (Including "" for index.ext)
+$validExtTypes = array("asp", "htm", "html", "php", "rss", "xml", "");
+
+// Get extension of current URL
+$currentUrlExt = pathinfo($_SERVER["REQUEST_URI"], PATHINFO_EXTENSION);
+
+// Set mobile friendly viewport
+$viewPort = '<meta name="viewport" content="width=device-width, initial-scale=1">';
+
+// Set response header
+function setHeader($type = "x") {
+    header("X-Pi-hole: A black hole for Internet advertisements.");
+    if (isset($type) && $type === "js") header("Content-Type: application/javascript");
 }
 
-// Handle incoming URI types
-if (!$showPage)
-{
-?>
-<html>
-<head>
-<script>window.close();</script></head>
-<body>
-<img src="data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7">
-</body>
-</html>
-<?php
-	die();
+// Determine block page type
+if ($serverName === "pi.hole"
+    || (!empty($_SERVER["VIRTUAL_HOST"]) && $serverName === $_SERVER["VIRTUAL_HOST"])) {
+    // Redirect to Web Interface
+    exit(header("Location: /admin"));
+} elseif (filter_var($serverName, FILTER_VALIDATE_IP) || in_array($serverName, $authorizedHosts)) {
+    // When directly browsing via IP or authorized hostname
+    // Render splash/landing page based off presence of $landPage file
+    // Unset variables so as to not be included in $landPage or $splashPage
+    unset($svPasswd, $svEmail, $authorizedHosts, $validExtTypes, $currentUrlExt);
+    // If $landPage file is present
+    if (is_file(getcwd()."/$landPage")) {
+        unset($serverName, $viewPort); // unset extra variables not to be included in $landpage
+        include $landPage;
+        exit();
+    }
+    // If $landPage file was not present, Set Splash Page output
+    $splashPage = <<<EOT
+    <!doctype html>
+    <html lang='en'>
+        <head>
+            <meta charset='utf-8'>
+            $viewPort
+            <title>● $serverName</title>
+            <link rel='stylesheet' href='/pihole/blockingpage.css'>
+            <link rel='shortcut icon' href='/admin/img/favicons/favicon.ico' type='image/x-icon'>
+        </head>
+        <body id='splashpage'>
+            <div id="pihole_card">
+              <img src='/admin/img/logo.svg' alt='Pi-hole logo' id="pihole_logo_splash" />
+              <p>Pi-<strong>hole</strong>: Your black hole for Internet advertisements</p>
+              <a href='/admin'>Did you mean to go to the admin panel?</a>
+            </div>
+        </body>
+    </html>
+EOT;
+    exit($splashPage);
+} elseif ($currentUrlExt === "js") {
+    // Serve Pi-hole JavaScript for blocked domains requesting JS
+    exit(setHeader("js").'var x = "Pi-hole: A black hole for Internet advertisements."');
+} elseif (strpos($_SERVER["REQUEST_URI"], "?") !== FALSE && isset($_SERVER["HTTP_REFERER"])) {
+    // Serve blank image upon receiving REQUEST_URI w/ query string & HTTP_REFERRER
+    // e.g: An iframe of a blocked domain
+    exit(setHeader().'<!doctype html>
+    <html lang="en">
+        <head>
+            <meta charset="utf-8"><script>window.close();</script>
+        </head>
+        <body>
+            <img src="data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=">
+        </body>
+    </html>');
+} elseif (!in_array($currentUrlExt, $validExtTypes) || substr_count($_SERVER["REQUEST_URI"], "?")) {
+    // Serve SVG upon receiving non $validExtTypes URL extension or query string
+    // e.g: Not an iframe of a blocked domain, such as when browsing to a file/query directly
+    // QoL addition: Allow the SVG to be clicked on in order to quickly show the full Block Page
+    $blockImg = '<a href="/">
+    <svg xmlns="http://www.w3.org/2000/svg" width="110" height="16">
+      <circle cx="8" cy="8" r="7" fill="none" stroke="rgba(152,2,2,.5)" stroke-width="2"/>
+      <path fill="rgba(152,2,2,.5)" d="M11.526 3.04l1.414 1.415-8.485 8.485-1.414-1.414z"/>
+      <text x="19.3" y="12" opacity=".3" style="font:11px Arial">
+        Blocked by Pi-hole
+      </text>
+    </svg>
+    </a>';
+    exit(setHeader()."<!doctype html>
+    <html lang='en'>
+        <head>
+            <meta charset='utf-8'>
+            $viewPort
+        </head>
+        <body>$blockImg</body>
+    </html>");
 }
 
-// Get Pi-hole version
-$piHoleVersion = exec('cd /etc/.pihole/ && git describe --tags --abbrev=0');
+/* Start processing Block Page from here */
 
-// Don't show the URI if it is the root directory
-if($uri == "/")
-{
-	$uri = "";
+// Define admin email address text based off $svEmail presence
+$bpAskAdmin = !empty($svEmail) ? '<a href="mailto:'.$svEmail.'?subject=Site Blocked: '.$serverName.'"></a>' : "<span/>";
+
+// Get possible non-standard location of FTL's database
+$FTLsettings = parse_ini_file("/etc/pihole/pihole-FTL.conf");
+if (isset($FTLsettings["GRAVITYDB"])) {
+    $gravityDBFile = $FTLsettings["GRAVITYDB"];
+} else {
+    $gravityDBFile = "/etc/pihole/gravity.db";
 }
 
-?>
-<!DOCTYPE html>
-<html>
-<head>
-	<meta charset='UTF-8'/>
-	<title>Website Blocked</title>
-	<link rel='stylesheet' href='http://pi.hole/pihole/blockingpage.css'/>
-	<link rel='shortcut icon' href='http://pi.hole/admin/img/favicon.png' type='image/png'/>
-	<meta name='viewport' content='width=device-width,initial-scale=1.0,maximum-scale=1.0, user-scalable=no'/>
-	<meta name='robots' content='noindex,nofollow'/>
-</head>
-<body id="body">
-<header>
-	<h1><a href='/'>Website Blocked</a></h1>
-</header>
-<main>
-	<div>Access to the following site has been blocked:<br/>
-	<span class='pre msg'><?php echo $serverName.$uri; ?></span></div>
-	<div>If you have an ongoing use for this website, please ask the owner of the Pi-hole in your network to have it whitelisted.</div>
-	<input id="domain" type="hidden" value="<?php echo $serverName; ?>">
-	<input id="quiet" type="hidden" value="yes">
-	<button id="btnSearch" class="buttons blocked" type="button" style="visibility: hidden;"></button>
-	This page is blocked because it is explicitly contained within the following block list(s):
-	<pre id="output" style="width: 100%; height: 100%;" hidden="true"></pre><br/>
-	<div class='buttons blocked'>
-		<a class='safe33' href='javascript:history.back()'>Go back</a>
-		<a class='safe33' id="whitelisting">Whitelist this page</a>
-		<a class='safe33' href='javascript:window.close()'>Close window</a>
-	</div>
-		<div style="width: 98%; text-align: center; padding: 10px;" hidden="true" id="whitelistingform">
-			<p>Note that whitelisting domains which are blocked using the wildcard method won't work.</p>
-			<p>Password required!</p><br/>
-		<form>
-			<input name="list" type="hidden" value="white"><br/>
-			Domain:<br/>
-			<input name="domain" value="<?php echo $serverName ?>" disabled><br/><br/>
-			Password:<br/>
-			<input type="password" id="pw" name="pw"><br/><br/>
-			<button class="buttons33 safe" id="btnAdd" type="button">Whitelist</button>
-		</form><br/>
-		<pre id="whitelistingoutput" style="width: 100%; height: 100%; padding: 5px;" hidden="true"></pre><br/>
-		</div>
-</main>
-<footer>Generated <?php echo date('D g:i A, M d'); ?> by Pi-hole <?php echo $piHoleVersion; ?></footer>
-<script src="http://pi.hole/admin/scripts/vendor/jquery.min.js"></script>
-<script>
-// Create event for when the output is appended to
-(function($) {
-    var origAppend = $.fn.append;
+// Connect to gravity.db
+try {
+    $db = new SQLite3($gravityDBFile, SQLITE3_OPEN_READONLY);
+} catch (Exception $exception) {
+    die("[ERROR]: Failed to connect to gravity.db");
+}
 
-    $.fn.append = function () {
-        return origAppend.apply(this, arguments).trigger("append");
-    };
-})(jQuery);
-</script>
-<script src="http://pi.hole/admin/scripts/pi-hole/js/queryads.js"></script>
-<script>
-function inIframe () {
+// Get all adlist addresses
+$adlistResults = $db->query("SELECT address FROM vw_adlist");
+$adlistsUrls = array();
+while ($row = $adlistResults->fetchArray()) {
+    array_push($adlistsUrls, $row[0]);
+}
+
+if (empty($adlistsUrls))
+    die("[ERROR]: There are no adlists enabled");
+
+// Get total number of blocklists (Including Whitelist, Blacklist & Wildcard lists)
+$adlistsCount = count($adlistsUrls) + 3;
+
+// Set query timeout
+ini_set("default_socket_timeout", 3);
+
+// Logic for querying blocklists
+function queryAds($serverName) {
+    // Determine the time it takes while querying adlists
+    $preQueryTime = microtime(true)-$_SERVER["REQUEST_TIME_FLOAT"];
+    $queryAdsURL = sprintf(
+        "http://127.0.0.1:%s/admin/scripts/pi-hole/php/queryads.php?domain=%s&bp",
+        $_SERVER["SERVER_PORT"],
+        $serverName
+    );
+    $queryAds = file($queryAdsURL, FILE_IGNORE_NEW_LINES);
+    $queryAds = array_values(array_filter(preg_replace("/data:\s+/", "", $queryAds)));
+    $queryTime = sprintf("%.0f", (microtime(true)-$_SERVER["REQUEST_TIME_FLOAT"]) - $preQueryTime);
+
+    // Exception Handling
     try {
-        return window.self !== window.top;
-    } catch (e) {
-        return true;
+        // Define Exceptions
+        if (strpos($queryAds[0], "No exact results") !== FALSE) {
+            // Return "none" into $queryAds array
+            return array("0" => "none");
+        } else if ($queryTime >= ini_get("default_socket_timeout")) {
+            // Connection Timeout
+            throw new Exception ("Connection timeout (".ini_get("default_socket_timeout")."s)");
+        } elseif (!strpos($queryAds[0], ".") !== false) {
+            // Unknown $queryAds output
+            throw new Exception ("Unhandled error message (<code>$queryAds[0]</code>)");
+        }
+        return $queryAds;
+    } catch (Exception $e) {
+        // Return exception as array
+        return array("0" => "error", "1" => $e->getMessage());
     }
 }
 
-// Try to detect if page is loaded within iframe
-if(inIframe())
-{
-    // Within iframe
-    // hide content of page
-    $('#body').hide();
-    // remove background
-    document.body.style.backgroundImage = "none";
-}
-else
-{
-    // Query adlists
-    $( "#btnSearch" ).click();
+// Get results of queryads.php exact search
+$queryAds = queryAds($serverName);
+
+// Pass error through to Block Page
+if ($queryAds[0] === "error")
+    die("[ERROR]: Unable to parse results from <i>queryads.php</i>: <code>".$queryAds[1]."</code>");
+
+// Count total number of matching blocklists
+$featuredTotal = count($queryAds);
+
+// Place results into key => value array
+$queryResults = null;
+foreach ($queryAds as $str) {
+    $value = explode(" ", $str);
+    @$queryResults[$value[0]] .= "$value[1]";
 }
 
-$( "#whitelisting" ).on( "click", function(){ $( "#whitelistingform" ).removeAttr( "hidden" ); });
+// Determine if domain has been blacklisted, whitelisted, wildcarded or CNAME blocked
+if (strpos($queryAds[0], "blacklist") !== FALSE) {
+    $notableFlagClass = "blacklist";
+    $adlistsUrls = array("π" => substr($queryAds[0], 2));
+} elseif (strpos($queryAds[0], "whitelist") !== FALSE) {
+    $notableFlagClass = "noblock";
+    $adlistsUrls = array("π" => substr($queryAds[0], 2));
+    $wlInfo = "recentwl";
+} elseif (strpos($queryAds[0], "wildcard") !== FALSE) {
+    $notableFlagClass = "wildcard";
+    $adlistsUrls = array("π" => substr($queryAds[0], 2));
+} elseif ($queryAds[0] === "none") {
+    $featuredTotal = "0";
+    $notableFlagClass = "noblock";
 
-// Remove whitelist functionality if the domain was blocked because of a wildcard
-$( "#output" ).bind("append", function(){
-	if($( "#output" ).contents()[0].data.indexOf("Wildcard blocking") !== -1)
-	{
-		$( "#whitelisting" ).hide();
-		$( "#whitelistingform" ).hide();
-	}
-});
-
-function add() {
-	var domain = $("#domain");
-	var pw = $("#pw");
-	if(domain.val().length === 0){
-		return;
-	}
-
-	$.ajax({
-		url: "/admin/scripts/pi-hole/php/add.php",
-		method: "post",
-		data: {"domain":domain.val(), "list":"white", "pw":pw.val()},
-		success: function(response) {
-			$( "#whitelistingoutput" ).removeAttr( "hidden" );
-			if(response.indexOf("Pi-hole blocking") !== -1)
-			{
-				// Reload page after 5 seconds
-				setTimeout(function(){window.location.reload(1);}, 5000);
-				$( "#whitelistingoutput" ).html("---> Success <---<br/>You may have to flush your DNS cache");
-			}
-			else
-			{
-				$( "#whitelistingoutput" ).html("---> "+response+" <---");
-			}
-
-		},
-		error: function(jqXHR, exception) {
-			$( "#whitelistingoutput" ).removeAttr( "hidden" );
-			$( "#whitelistingoutput" ).html("---> Unknown Error <---");
-		}
-	});
+    // QoL addition: Determine appropriate info message if CNAME exists
+    // Suggests to the user that $serverName has a CNAME (alias) that may be blocked
+    $dnsRecord = dns_get_record("$serverName")[0];
+    if (array_key_exists("target", $dnsRecord)) {
+        $wlInfo = $dnsRecord['target'];
+    } else {
+        $wlInfo = "unknown";
+    }
 }
-// Handle enter button for adding domains
-$(document).keypress(function(e) {
-    if(e.which === 13 && $("#pw").is(":focus")) {
+
+// Set #bpOutput notification
+$wlOutputClass = (isset($wlInfo) && $wlInfo === "recentwl") ? $wlInfo : "hidden";
+$wlOutput = (isset($wlInfo) && $wlInfo !== "recentwl") ? "<a href='http://$wlInfo'>$wlInfo</a>" : "";
+
+// Get Pi-hole Core version
+$phVersion = exec("cd /etc/.pihole/ && git describe --long --tags");
+
+// Print $execTime on development branches
+// Testing for - is marginally faster than "git rev-parse --abbrev-ref HEAD"
+if (explode("-", $phVersion)[1] != "0")
+  $execTime = microtime(true)-$_SERVER["REQUEST_TIME_FLOAT"];
+
+// Please Note: Text is added via CSS to allow an admin to provide a localized
+// language without the need to edit this file
+
+setHeader();
+?>
+<!doctype html>
+<!-- Pi-hole: A black hole for Internet advertisements
+*  (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+*  Network-wide ad blocking via your own hardware.
+*
+*  This file is copyright under the latest version of the EUPL. -->
+<html>
+<head>
+  <meta charset="utf-8">
+  <?=$viewPort ?>
+  <meta name="robots" content="noindex,nofollow">
+  <meta http-equiv="x-dns-prefetch-control" content="off">
+  <link rel="stylesheet" href="pihole/blockingpage.css">
+  <link rel="shortcut icon" href="admin/img/favicons/favicon.ico" type="image/x-icon">
+  <title>● <?=$serverName ?></title>
+  <script src="admin/scripts/vendor/jquery.min.js"></script>
+  <script>
+    window.onload = function () {
+      <?php
+      // Remove href fallback from "Back to safety" button
+      if ($featuredTotal > 0) {
+        echo '$("#bpBack").removeAttr("href");';
+
+        // Enable whitelisting if JS is available
+        echo '$("#bpWhitelist").prop("disabled", false);';
+
+        // Enable password input if necessary
+        if (!empty($svPasswd)) {
+          echo '$("#bpWLPassword").attr("placeholder", "Password");';
+          echo '$("#bpWLPassword").prop("disabled", false);';
+        }
+        // Otherwise hide the input
+        else {
+          echo '$("#bpWLPassword").hide();';
+        }
+      }
+      ?>
+    }
+  </script>
+</head>
+<body id="blockpage"><div id="bpWrapper">
+<header>
+  <h1 id="bpTitle">
+    <a class="title" href="/"><?php //Website Blocked ?></a>
+  </h1>
+  <div class="spc"></div>
+
+  <input id="bpAboutToggle" type="checkbox">
+  <div id="bpAbout">
+    <div class="aboutPH">
+      <div class="aboutImg"></div>
+      <p>Open Source Ad Blocker
+        <small>Designed for Raspberry Pi</small>
+      </p>
+    </div>
+    <div class="aboutLink">
+      <a class="linkPH" href="https://docs.pi-hole.net/"><?php //About PH ?></a>
+      <?php if (!empty($svEmail)) echo '<a class="linkEmail" href="mailto:'.$svEmail.'"></a>'; ?>
+    </div>
+  </div>
+
+  <div id="bpAlt">
+    <label class="altBtn" for="bpAboutToggle"><?php //Why am I here? ?></label>
+  </div>
+</header>
+
+<main>
+  <div id="bpOutput" class="<?=$wlOutputClass ?>"><?=$wlOutput ?></div>
+  <div id="bpBlock">
+    <p class="blockMsg"><?=$serverName ?></p>
+  </div>
+  <?php if(isset($notableFlagClass)) { ?>
+    <div id="bpFlag">
+        <p class="flagMsg <?=$notableFlagClass ?>"></p>
+    </div>
+  <?php } ?>
+  <div id="bpHelpTxt"><?=$bpAskAdmin ?></div>
+  <div id="bpButtons" class="buttons">
+    <a id="bpBack" onclick="javascript:history.back()" href="about:home"></a>
+    <?php if ($featuredTotal > 0) echo '<label id="bpInfo" for="bpMoreToggle"></label>'; ?>
+  </div>
+  <input id="bpMoreToggle" type="checkbox">
+  <div id="bpMoreInfo">
+    <span id="bpFoundIn"><span><?=$featuredTotal ?></span><?=$adlistsCount ?></span>
+    <pre id='bpQueryOutput'><?php if ($featuredTotal > 0) foreach ($queryResults as $num => $value) { echo "<span>[$num]:</span>$adlistsUrls[$num]\n"; } ?></pre>
+
+    <form id="bpWLButtons" class="buttons">
+      <input id="bpWLDomain" type="text" value="<?=$serverName ?>" disabled>
+      <input id="bpWLPassword" type="password" placeholder="JavaScript disabled" disabled>
+      <button id="bpWhitelist" type="button" disabled></button>
+    </form>
+  </div>
+</main>
+
+<footer><span><?=date("l g:i A, F dS"); ?>.</span> Pi-hole <?=$phVersion ?> (<?=gethostname()."/".$_SERVER["SERVER_ADDR"]; if (isset($execTime)) printf("/%.2fs", $execTime); ?>)</footer>
+</div>
+
+<script>
+  function add() {
+    $("#bpOutput").removeClass("hidden error exception");
+    $("#bpOutput").addClass("add");
+    var domain = "<?=$serverName ?>";
+    var pw = $("#bpWLPassword");
+    if(domain.length === 0) {
+      return;
+    }
+    $.ajax({
+      url: "/admin/scripts/pi-hole/php/add.php",
+      method: "post",
+      data: {"domain":domain, "list":"white", "pw":pw.val()},
+      success: function(response) {
+        if(response.indexOf("Pi-hole blocking") !== -1) {
+          setTimeout(function(){window.location.reload(1);}, 10000);
+          $("#bpOutput").removeClass("add");
+          $("#bpOutput").addClass("success");
+          $("#bpOutput").html("");
+        } else {
+          $("#bpOutput").removeClass("add");
+          $("#bpOutput").addClass("error");
+          $("#bpOutput").html(""+response+"");
+        }
+      },
+      error: function(jqXHR, exception) {
+        $("#bpOutput").removeClass("add");
+        $("#bpOutput").addClass("exception");
+        $("#bpOutput").html("");
+      }
+    });
+  }
+  <?php if ($featuredTotal > 0) { ?>
+    $(document).keypress(function(e) {
+        if(e.which === 13 && $("#bpWLPassword").is(":focus")) {
+            add();
+        }
+    });
+    $("#bpWhitelist").on("click", function() {
         add();
-    }
-});
-
-// Handle buttons
-$("#btnAdd").on("click", function() {
-    add();
-});
+    });
+  <?php } ?>
 </script>
-</body>
-</html>
+</body></html>

advanced/lighttpd.conf.debian

@@ -2,80 +2,95 @@
 # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
 # Network-wide ad blocking via your own hardware.
 #
-# lighttpd config for Pi-hole
+# Lighttpd config for Pi-hole
 #
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
-
-
 ###############################################################################
 #     FILE AUTOMATICALLY OVERWRITTEN BY PI-HOLE INSTALL/UPDATE PROCEDURE.     #
 # ANY CHANGES MADE TO THIS FILE AFTER INSTALL WILL BE LOST ON THE NEXT UPDATE #
 #                                                                             #
-#              CHANGES SHOULD BE MADE IN A SEPERATE CONFIG FILE:              #
+#              CHANGES SHOULD BE MADE IN A SEPARATE CONFIG FILE:              #
 #                         /etc/lighttpd/external.conf                         #
 ###############################################################################
 
 server.modules = (
-	"mod_access",
-	"mod_accesslog",
-	"mod_auth",
-	"mod_expire",
-	"mod_compress",
-	"mod_redirect",
-	"mod_setenv",
-	"mod_rewrite"
+    "mod_access",
+    "mod_accesslog",
+    "mod_auth",
+    "mod_expire",
+    "mod_redirect",
+    "mod_setenv",
+    "mod_rewrite"
 )
 
 server.document-root        = "/var/www/html"
-server.error-handler-404    = "pihole/index.php"
+server.error-handler-404    = "/pihole/index.php"
 server.upload-dirs          = ( "/var/cache/lighttpd/uploads" )
 server.errorlog             = "/var/log/lighttpd/error.log"
-server.pid-file             = "/var/run/lighttpd.pid"
+server.pid-file             = "/run/lighttpd.pid"
 server.username             = "www-data"
 server.groupname            = "www-data"
 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" )
+url.access-deny             = ( "~", ".inc", ".md", ".yml", ".ini" )
 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 = (
+    ".ico"   => "image/x-icon",
+    ".jpeg"  => "image/jpeg",
+    ".jpg"   => "image/jpeg",
+    ".png"   => "image/png",
+    ".svg"   => "image/svg+xml",
+    ".css"   => "text/css; charset=utf-8",
+    ".html"  => "text/html; charset=utf-8",
+    ".js"    => "text/javascript; charset=utf-8",
+    ".json"  => "application/json; charset=utf-8",
+    ".map"   => "application/json; charset=utf-8",
+    ".txt"   => "text/plain; charset=utf-8",
+    ".eot"   => "application/vnd.ms-fontobject",
+    ".otf"   => "font/otf",
+    ".ttc"   => "font/collection",
+    ".ttf"   => "font/ttf",
+    ".woff"  => "font/woff",
+    ".woff2" => "font/woff2"
+)
+
+# Add user chosen options held in external file
+# This uses include_shell instead of an include wildcard for compatibility
+include_shell "cat external.conf 2>/dev/null"
 
 # 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"
+
+# Prevent Lighttpd from enabling Let's Encrypt SSL for every blocked domain
+#include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
+include_shell "find /etc/lighttpd/conf-enabled -name '*.conf' -a ! -name 'letsencrypt.conf' -printf 'include \"%p\"\n' 2>/dev/null"
 
 # If the URL starts with /admin, it is the Web interface
 $HTTP["url"] =~ "^/admin/" {
-	# Create a response header for debugging using curl -I
+    # Create a response header for debugging using curl -I
     setenv.add-response-header = (
         "X-Pi-hole" => "The Pi-hole Web interface is working!",
         "X-Frame-Options" => "DENY"
     )
 }
 
-# Rewite js requests, must be out of $HTTP block due to bug #2526
-url.rewrite = ( "^(?!/admin/).*\.js$"  => "pihole/index.js"   )
-
-# If the URL does not start with /admin, then it is a query for an ad domain
-$HTTP["url"] =~ "^(?!/admin)/.*" {
-    # Create a response header for debugging using curl -I
-    setenv.add-response-header = ( "X-Pi-hole" => "A black hole for Internet advertisements." )
+# Block . files from being served, such as .git, .github, .gitignore
+$HTTP["url"] =~ "^/admin/\.(.*)" {
+    url.access-deny = ("")
 }
 
-# Entering just "pi.hole" into a browser redirects to "pi.hole/admin/"
-$HTTP["host"] == "pi.hole" {
-    $HTTP["url"] == "/" {
-        url.redirect = ( "" => "/admin/" )
+# allow teleporter and API qr code iframe on settings page
+$HTTP["url"] =~ "/(teleporter|api_token)\.php$" {
+    $HTTP["referer"] =~ "/admin/settings\.php" {
+        setenv.add-response-header = ( "X-Frame-Options" => "SAMEORIGIN" )
     }
 }
 
-# Add user chosen options held in external file
-include_shell "cat external.conf 2>/dev/null"
+# Default expire header
+expire.url = ( "" => "access plus 0 seconds" )

advanced/lighttpd.conf.fedora

@@ -2,97 +2,103 @@
 # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
 # Network-wide ad blocking via your own hardware.
 #
-# lighttpd config for Pi-hole
+# Lighttpd config for Pi-hole
 #
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
-
-
 ###############################################################################
 #     FILE AUTOMATICALLY OVERWRITTEN BY PI-HOLE INSTALL/UPDATE PROCEDURE.     #
 # ANY CHANGES MADE TO THIS FILE AFTER INSTALL WILL BE LOST ON THE NEXT UPDATE #
 #                                                                             #
-#              CHANGES SHOULD BE MADE IN A SEPERATE CONFIG FILE:              #
+#              CHANGES SHOULD BE MADE IN A SEPARATE CONFIG FILE:              #
 #                         /etc/lighttpd/external.conf                         #
 ###############################################################################
 
 server.modules = (
-	"mod_access",
-	"mod_auth",
-	"mod_fastcgi",
-	"mod_accesslog",
-	"mod_expire",
-	"mod_compress",
-	"mod_redirect",
-	"mod_setenv",
-	"mod_rewrite"
+    "mod_access",
+    "mod_auth",
+    "mod_expire",
+    "mod_fastcgi",
+    "mod_accesslog",
+    "mod_redirect",
+    "mod_setenv",
+    "mod_rewrite"
 )
 
 server.document-root        = "/var/www/html"
-server.error-handler-404    = "pihole/index.php"
+server.error-handler-404    = "/pihole/index.php"
 server.upload-dirs          = ( "/var/cache/lighttpd/uploads" )
 server.errorlog             = "/var/log/lighttpd/error.log"
-server.pid-file             = "/var/run/lighttpd.pid"
+server.pid-file             = "/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" )
+url.access-deny             = ( "~", ".inc", ".md", ".yml", ".ini" )
 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 = (
+    ".ico"   => "image/x-icon",
+    ".jpeg"  => "image/jpeg",
+    ".jpg"   => "image/jpeg",
+    ".png"   => "image/png",
+    ".svg"   => "image/svg+xml",
+    ".css"   => "text/css; charset=utf-8",
+    ".html"  => "text/html; charset=utf-8",
+    ".js"    => "text/javascript; charset=utf-8",
+    ".json"  => "application/json; charset=utf-8",
+    ".map"   => "application/json; charset=utf-8",
+    ".txt"   => "text/plain; charset=utf-8",
+    ".eot"   => "application/vnd.ms-fontobject",
+    ".otf"   => "font/otf",
+    ".ttc"   => "font/collection",
+    ".ttf"   => "font/ttf",
+    ".woff"  => "font/woff",
+    ".woff2" => "font/woff2"
+)
 
-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" )
+# Add user chosen options held in external file
+# This uses include_shell instead of an include wildcard for compatibility
+include_shell "cat external.conf 2>/dev/null"
 
 # 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"
-                     )
-                   )
-                 )
+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!" )
+    # Create a response header for debugging using curl -I
+    setenv.add-response-header = (
+        "X-Pi-hole" => "The Pi-hole Web interface is working!",
+        "X-Frame-Options" => "DENY"
+    )
 }
 
-# Rewite js requests, must be out of $HTTP block due to bug #2526
-url.rewrite = ( "^(?!/admin/).*\.js$"  => "pihole/index.js"   )
-
-# If the URL does not start with /admin, then it is a query for an ad domain
-$HTTP["url"] =~ "^(?!/admin)/.*" {
-	# Create a response header for debugging using curl -I
-	setenv.add-response-header = ( "X-Pi-hole" => "A black hole for Internet advertisements." )
+# Block . files from being served, such as .git, .github, .gitignore
+$HTTP["url"] =~ "^/admin/\.(.*)" {
+    url.access-deny = ("")
 }
 
-# Entering just "pi.hole" into a browser redirects to "pi.hole/admin/"
-$HTTP["host"] == "pi.hole" {
-    $HTTP["url"] == "/" {
-        url.redirect = ( "" => "/admin/" )
+# allow teleporter and API qr code iframe on settings page
+$HTTP["url"] =~ "/(teleporter|api_token)\.php$" {
+    $HTTP["referer"] =~ "/admin/settings\.php" {
+        setenv.add-response-header = ( "X-Frame-Options" => "SAMEORIGIN" )
     }
 }
 
-# Add user chosen options held in external file
-include_shell "cat external.conf 2>/dev/null"
+# Default expire header
+expire.url = ( "" => "access plus 0 seconds" )

advanced/pihole-FTL.service

@@ -1,80 +0,0 @@
-#!/bin/bash
-### BEGIN INIT INFO
-# Provides:          pihole-FTL
-# Required-Start:    $remote_fs $syslog
-# Required-Stop:     $remote_fs $syslog
-# Default-Start:     2 3 4 5
-# Default-Stop:      0 1 6
-# Short-Description: pihole-FTL daemon
-# Description:       Enable service provided by pihole-FTL daemon
-### END INIT INFO
-
-FTLUSER=pihole
-PIDFILE=/var/run/pihole-FTL.pid
-
-get_pid() {
-    pidof "pihole-FTL"
-}
-
-is_running() {
-    ps "$(get_pid)" > /dev/null 2>&1
-}
-
-# Start the service
-start() {
-  if is_running; then
-    echo "pihole-FTL is already running"
-  else
-    touch /var/log/pihole-FTL.log /run/pihole-FTL.pid /run/pihole-FTL.port
-    chown pihole:pihole /var/log/pihole-FTL.log /run/pihole-FTL.pid /run/pihole-FTL.port /etc/pihole
-    chmod 0644 /var/log/pihole-FTL.log /run/pihole-FTL.pid /run/pihole-FTL.port
-    su -s /bin/sh -c "/usr/bin/pihole-FTL" "$FTLUSER"
-    echo
-  fi
-}
-
-# Stop the service
-stop() {
-  if is_running; then
-    kill "$(get_pid)"
-    for i in {1..5}; do
-      if ! is_running; then
-        break
-      fi
-
-      echo -n "."
-      sleep 1
-    done
-    echo
-
-    if is_running; then
-      echo "Not stopped; may still be shutting down or shutdown may have failed, killing now"
-      kill -9 "$(get_pid)"
-      exit 1
-    else
-      echo "Stopped"
-    fi
-  else
-    echo "Not running"
-  fi
-  echo
-}
-
-### main logic ###
-case "$1" in
-  stop)
-        stop
-        ;;
-  status)
-        status pihole-FTL
-        ;;
-  start|restart|reload|condrestart)
-        stop
-        start
-        ;;
-  *)
-        echo $"Usage: $0 {start|stop|restart|reload|status}"
-        exit 1
-esac
-
-exit 0

advanced/pihole.cron

@@ -1,30 +0,0 @@
-# Pi-hole: A black hole for Internet advertisements
-# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your own hardware.
-#
-# Updates ad sources every week
-#
-# This file is copyright under the latest version of the EUPL.
-# Please see LICENSE file for your rights under this license.
-#
-#
-#
-# 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    PATH="$PATH:/usr/local/bin/" pihole updateGravity
-
-# Pi-hole: Update Pi-hole! Uncomment to enable auto update
-#30 2    * * 7   root    PATH="$PATH:/usr/local/bin/" pihole updatePihole
-
-# Pi-hole: Flush the log daily at 00:00
-#          The flush script will use logrotate if available
-#          parameter "once": logrotate only once (default is twice)
-#          parameter "quiet": don't print messages
-00 00   * * *   root    PATH="$PATH:/usr/local/bin/" pihole flush once quiet
-
-@reboot root /usr/sbin/logrotate /etc/pihole/logrotate

automated install/uninstall.sh

@@ -8,174 +8,217 @@
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
+source "/opt/pihole/COL_TABLE"
 
+while true; do
+    read -rp "  ${QST} Are you sure you would like to remove ${COL_WHITE}Pi-hole${COL_NC}? [y/N] " yn
+    case ${yn} in
+        [Yy]* ) break;;
+        [Nn]* ) echo -e "${OVER}  ${COL_LIGHT_GREEN}Uninstall has been canceled${COL_NC}"; exit 0;;
+        * ) echo -e "${OVER}  ${COL_LIGHT_GREEN}Uninstall has been canceled${COL_NC}"; exit 0;;
+    esac
+done
 
 # Must be root to uninstall
+str="Root user check"
 if [[ ${EUID} -eq 0 ]]; then
-	echo "::: You are root."
+    echo -e "  ${TICK} ${str}"
 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 [ -x "$(command -v sudo)" ]; then
-		export SUDO="sudo"
-	else
-		echo "::: Please install sudo or run this as root."
-		exit 1
-	fi
+    # Check if sudo is actually installed
+    # If it isn't, exit because the uninstall can not complete
+    if [ -x "$(command -v sudo)" ]; then
+        export SUDO="sudo"
+    else
+        echo -e "  ${CROSS} ${str}
+            Script called with non-root privileges
+            The Pi-hole requires elevated privileges to uninstall"
+        exit 1
+    fi
 fi
 
-# 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
+readonly PI_HOLE_FILES_DIR="/etc/.pihole"
+PH_TEST="true"
+source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
+# setupVars set in basic-install.sh
+source "${setupVars}"
+
+# package_manager_detect() sourced from basic-install.sh
+package_manager_detect
+
+# Install packages used by the Pi-hole
+DEPS=("${INSTALLER_DEPS[@]}" "${PIHOLE_DEPS[@]}")
+if [[ "${INSTALL_WEB_SERVER}" == true ]]; then
+    # Install the Web dependencies
+    DEPS+=("${PIHOLE_WEB_DEPS[@]}")
 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"
-}
+# Compatibility
+if [ -x "$(command -v apt-get)" ]; then
+    # Debian Family
+    PKG_REMOVE=("${PKG_MANAGER}" -y remove --purge)
+    package_check() {
+        dpkg-query -W -f='${Status}' "$1" 2>/dev/null | grep -c "ok installed"
+    }
+elif [ -x "$(command -v rpm)" ]; then
+    # Fedora Family
+    PKG_REMOVE=("${PKG_MANAGER}" remove -y)
+    package_check() {
+        rpm -qa | grep "^$1-" > /dev/null
+    }
+else
+    echo -e "  ${CROSS} OS distribution not supported"
+    exit 1
+fi
 
 removeAndPurge() {
-	# Purge dependencies
-	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} ${PKG_REMOVE} "${i}" &> /dev/null & spinner $!; printf "done!\n"; break;;
-					[Nn]* ) printf ":::\tSkipping %s\n" "${i}"; break;;
-					* ) printf "::: You must answer yes or no!\n";;
-				esac
-			done
-		else
-			printf ":::\tPackage %s not installed... Not removing.\n" "${i}"
-		fi
-	done
+    # Purge dependencies
+    echo ""
+    for i in "${DEPS[@]}"; do
+        if package_check "${i}" > /dev/null; then
+            while true; do
+                read -rp "  ${QST} Do you wish to remove ${COL_WHITE}${i}${COL_NC} from your system? [Y/N] " yn
+                case ${yn} in
+                    [Yy]* )
+                        echo -ne "  ${INFO} Removing ${i}...";
+                        ${SUDO} "${PKG_REMOVE[@]}" "${i}" &> /dev/null;
+                        echo -e "${OVER}  ${INFO} Removed ${i}";
+                        break;;
+                    [Nn]* ) echo -e "  ${INFO} Skipped ${i}"; break;;
+                esac
+            done
+        else
+            echo -e "  ${INFO} Package ${i} not installed"
+        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
+    # Remove dnsmasq config files
+    ${SUDO} rm -f /etc/dnsmasq.conf /etc/dnsmasq.conf.orig /etc/dnsmasq.d/*-pihole*.conf &> /dev/null
+    echo -e "  ${TICK} Removing dnsmasq config files"
 
-	# Take care of any additional package cleaning
-	printf "::: Auto removing & cleaning remaining dependencies..."
-	package_cleanup &> /dev/null & spinner $!; printf "done!\n";
-
-	# Call removeNoPurge to remove PiHole specific files
-	removeNoPurge
+    # Call removeNoPurge to remove Pi-hole specific files
+    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
+    # Only web directories/files that are created by Pi-hole should be removed
+    echo -ne "  ${INFO} Removing Web Interface..."
+    ${SUDO} rm -rf /var/www/html/admin &> /dev/null
+    ${SUDO} rm -rf /var/www/html/pihole &> /dev/null
+    ${SUDO} rm -f /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
-		fi
-	fi
+    # If the web directory is empty after removing these files, then the parent html directory can be removed.
+    if [ -d "/var/www/html" ]; then
+        if [[ ! "$(ls -A /var/www/html)" ]]; then
+            ${SUDO} rm -rf /var/www/html &> /dev/null
+        fi
+    fi
+    echo -e "${OVER}  ${TICK} Removed Web Interface"
 
-	# Attempt to preserve backwards compatibility with older versions
-	# to guarantee no additional changes were made to /etc/crontab after
-	# the installation of pihole, /etc/crontab.pihole should be permanently
-	# 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
-	fi
+    # Attempt to preserve backwards compatibility with older versions
+    # to guarantee no additional changes were made to /etc/crontab after
+    # the installation of pihole, /etc/crontab.pihole should be permanently
+    # preserved.
+    if [[ -f /etc/crontab.orig ]]; then
+        ${SUDO} mv /etc/crontab /etc/crontab.pihole
+        ${SUDO} mv /etc/crontab.orig /etc/crontab
+        ${SUDO} service cron restart
+        echo -e "  ${TICK} Restored the default system cron"
+    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
-	fi
+    # Attempt to preserve backwards compatibility with older versions
+    if [[ -f /etc/cron.d/pihole ]];then
+        ${SUDO} rm -f /etc/cron.d/pihole &> /dev/null
+        echo -e "  ${TICK} Removed /etc/cron.d/pihole"
+    fi
 
-	echo "::: Removing config files and scripts..."
-	package_check lighttpd > /dev/null
-	if [ $? -eq 1 ]; then
-		${SUDO} rm -rf /etc/lighttpd/ &> /dev/null
-	else
-		if [ -f /etc/lighttpd/lighttpd.conf.orig ]; then
-			${SUDO} mv /etc/lighttpd/lighttpd.conf.orig /etc/lighttpd/lighttpd.conf
-		fi
-	fi
+    if package_check lighttpd > /dev/null; then
+        if [[ -f /etc/lighttpd/lighttpd.conf.orig ]]; then
+            ${SUDO} mv /etc/lighttpd/lighttpd.conf.orig /etc/lighttpd/lighttpd.conf
+        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
+        if [[ -f /etc/lighttpd/external.conf ]]; then
+            ${SUDO} rm /etc/lighttpd/external.conf
+        fi
 
-	# If the pihole user exists, then remove
-	if id "pihole" >/dev/null 2>&1; then
-        	echo "::: Removing pihole user..."
-		${SUDO} userdel -r pihole
-	fi
+        echo -e "  ${TICK} Removed lighttpd configs"
+    fi
 
-	echo ":::"
-	printf "::: Finished removing PiHole from your system. Sorry to see you go!\n"
-	printf "::: Reach out to us at https://github.com/pi-hole/pi-hole/issues if you need help\n"
-	printf "::: Reinstall by simpling running\n:::\n:::\tcurl -sSL https://install.pi-hole.net | bash\n:::\n::: at any time!\n:::\n"
-	printf "::: PLEASE RESET YOUR DNS ON YOUR ROUTER/CLIENTS TO RESTORE INTERNET CONNECTIVITY!\n"
+    ${SUDO} rm -f /etc/dnsmasq.d/adList.conf &> /dev/null
+    ${SUDO} rm -f /etc/dnsmasq.d/01-pihole.conf &> /dev/null
+    ${SUDO} rm -f /etc/dnsmasq.d/06-rfc6761.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 -f /usr/local/bin/pihole &> /dev/null
+    ${SUDO} rm -f /etc/bash_completion.d/pihole &> /dev/null
+    ${SUDO} rm -f /etc/sudoers.d/pihole &> /dev/null
+    echo -e "  ${TICK} Removed config files"
+
+    # Restore Resolved
+    if [[ -e /etc/systemd/resolved.conf.orig ]]; then
+        ${SUDO} cp -p /etc/systemd/resolved.conf.orig /etc/systemd/resolved.conf
+        systemctl reload-or-restart systemd-resolved
+    fi
+
+    # Remove FTL
+    if command -v pihole-FTL &> /dev/null; then
+        echo -ne "  ${INFO} Removing pihole-FTL..."
+        if [[ -x "$(command -v systemctl)" ]]; then
+            systemctl stop pihole-FTL
+        else
+            service pihole-FTL stop
+        fi
+        ${SUDO} rm -f /etc/init.d/pihole-FTL
+        ${SUDO} rm -f /usr/bin/pihole-FTL
+        echo -e "${OVER}  ${TICK} Removed pihole-FTL"
+    fi
+
+    # If the pihole manpage exists, then delete and rebuild man-db
+    if [[ -f /usr/local/share/man/man8/pihole.8 ]]; then
+        ${SUDO} rm -f /usr/local/share/man/man8/pihole.8 /usr/local/share/man/man8/pihole-FTL.8 /usr/local/share/man/man5/pihole-FTL.conf.5
+        ${SUDO} mandb -q &>/dev/null
+        echo -e "  ${TICK} Removed pihole man page"
+    fi
+
+    # If the pihole user exists, then remove
+    if id "pihole" &> /dev/null; then
+        if ${SUDO} userdel -r pihole 2> /dev/null; then
+            echo -e "  ${TICK} Removed 'pihole' user"
+        else
+            echo -e "  ${CROSS} Unable to remove 'pihole' user"
+        fi
+    fi
+    # If the pihole group exists, then remove
+    if getent group "pihole" &> /dev/null; then
+        if ${SUDO} groupdel pihole 2> /dev/null; then
+            echo -e "  ${TICK} Removed 'pihole' group"
+        else
+            echo -e "  ${CROSS} Unable to remove 'pihole' group"
+        fi
+    fi
+
+    echo -e "\\n   We're sorry to see you go, but thanks for checking out Pi-hole!
+       If you need help, reach out to us on GitHub, Discourse, Reddit or Twitter
+       Reinstall at any time: ${COL_WHITE}curl -sSL https://install.pi-hole.net | bash${COL_NC}
+
+      ${COL_LIGHT_RED}Please reset the DNS on your router/clients to restore internet connectivity
+      ${COL_LIGHT_GREEN}Uninstallation Complete! ${COL_NC}"
 }
 
 ######### SCRIPT ###########
-echo "::: Preparing to remove packages, be sure that each may be safely removed depending on your operating system."
-echo "::: (SAFE TO REMOVE ALL ON RASPBIAN)"
+echo -e "  ${INFO} Be sure to confirm if any dependencies should not be removed"
 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
-		[Yy]* ) removeAndPurge; break;;
-
-		[Nn]* ) removeNoPurge; break;;
-	esac
+    echo -e "  ${INFO} ${COL_YELLOW}The following dependencies may have been added by the Pi-hole install:"
+    echo -n "    "
+    for i in "${DEPS[@]}"; do
+        echo -n "${i} "
+    done
+    echo "${COL_NC}"
+    read -rp "  ${QST} Do you wish to go through each dependency for removal? (Choosing No will leave all dependencies installed) [Y/n] " yn
+    case ${yn} in
+        [Yy]* ) removeAndPurge; break;;
+        [Nn]* ) removeNoPurge; break;;
+        * ) removeAndPurge; break;;
+    esac
 done

autotest

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

block hulu ads/lighttpd.conf

@@ -1,43 +0,0 @@
-# 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 file 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_alias",
-	"mod_compress",
- 	"mod_redirect",
-   "mod_rewrite"
-)
-
-server.document-root        = "/var/www"
-server.upload-dirs          = ( "/var/cache/lighttpd/uploads" )
-server.errorlog             = "/var/log/lighttpd/error.log"
-server.pid-file             = "/var/run/lighttpd.pid"
-server.username             = "www-data"
-server.groupname            = "www-data"
-server.port                 = 80
-
-
-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" )
-
-# 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"
-
-$HTTP["host"] =~ "ads.hulu.com|ads-v-darwin.hulu.com|ads-e-darwin.hulu.com" {
-	url.redirect = ( ".*" => "http://192.168.1.101:8200/MediaItems/19.mov")
-}

block hulu ads/minidlna.conf

@@ -1,17 +0,0 @@
-# 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
-# MiniDLNA config file 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.
-
-media_dir=V,/var/lib/minidlna/videos/
-port=8200
-friendly_name=pihole
-serial=12345678
-model_number=1
-inotify=yes

manpages/pihole-FTL.8

@@ -0,0 +1,152 @@
+.TH "Pihole-FTL" "8" "pihole-FTL" "Pi-hole" "November 2020"
+.SH "NAME"
+pihole-FTL - Pi-hole : The Faster-Than-Light (FTL) Engine
+.br
+.SH "SYNOPSIS"
+\fBservice pihole-FTL \fR(\fBstart\fR|\fBstop\fR|\fBrestart\fR)
+.br
+
+\fBpihole-FTL debug\fR
+.br
+\fBpihole-FTL test\fR
+.br
+\fBpihole-FTL -v|-vv\fR
+.br
+\fBpihole-FTL -t\fR
+.br
+\fBpihole-FTL -b\fR
+.br
+\fBpihole-FTL -f\fR
+.br
+\fBpihole-FTL -h\fR
+.br
+\fBpihole-FTL dnsmasq-test\fR
+.br
+\fBpihole-FTL regex-test str\fR
+.br
+\fBpihole-FTL regex-test str rgx\fR
+.br
+\fBpihole-FTL lua\fR
+.br
+\fBpihole-FTL luac\fR
+.br
+\fBpihole-FTL dhcp-discover\fR
+.br
+\fBpihole-FTL --\fR (\fBoptions\fR)
+.br
+
+.SH "DESCRIPTION"
+Pi-hole : The Faster-Than-Light (FTL) Engine is a lightweight, purpose-built daemon used to provide statistics needed for the Pi-hole Web Interface, and its API can be easily integrated into your own projects. Although it is an optional component of the Pi-hole ecosystem, it will be installed by default to provide statistics. As the name implies, FTL does its work \fIvery\fR \fIquickly\fR!
+.br
+
+Usage
+.br
+
+\fBservice pihole-FTL start\fR
+.br
+    Start the pihole-FTL daemon
+.br
+
+\fBservice pihole-FTL stop\fR
+.br
+    Stop the pihole-FTL daemon
+.br
+
+\fBservice pihole-FTL restart\fR
+.br
+    If the pihole-FTP daemon is running, stop and then start, otherwise start.
+.br
+
+Command line arguments
+.br
+
+\fBdebug\fR
+.br
+    Don't go into daemon mode (stay in foreground) + more verbose logging
+.br
+
+\fBtest\fR
+.br
+    Start FTL and process everything, but shut down immediately afterwards
+.br
+
+\fB-v, version\fR
+.br
+    Don't start FTL, show only version
+.br
+
+\fB-vv\fR
+.br
+    Don't start FTL, show verbose version information of embedded applications
+.br
+
+\fB-t, tag\fR
+.br
+    Don't start FTL, show only git tag
+.br
+
+\fB-b, branch\fR
+.br
+    Don't start FTL, show only git branch FTL was compiled from
+.br
+
+\fB-f, no-daemon\fR
+.br
+    Don't go into background (daemon mode)
+.br
+
+\fB-h, help\fR
+.br
+    Don't start FTL, show help
+.br
+
+\fBdnsmasq-test\fR
+.br
+    Test resolver config file syntax
+.br
+
+\fBregex-test str\fR
+.br
+    Test str against all regular expressions in the database
+.br
+
+\fBregex-test str rgx\fR
+.br
+    Test str against regular expression given by rgx
+.br
+
+\fBlua\fR
+.br
+    Start the embedded Lua interpreter
+.br
+
+\fBluac\fR
+.br
+    Execute the embedded Lua compiler
+.br
+
+\fBdhcp-discover\fR
+.br
+    Discover DHCP servers in the local network
+.br
+
+\fB--\fR  (options)
+.br
+    Pass options to internal dnsmasq resolver
+.br
+.SH "EXAMPLE"
+Command line arguments can be arbitrarily combined, e.g:
+.br
+
+\fBpihole-FTL debug test\fR
+.br
+
+Start ftl in foreground with more verbose logging, process everything and shutdown immediately
+.br
+.SH "SEE ALSO"
+\fBpihole\fR(8), \fBpihole-FTL.conf\fR(5)
+.br
+.SH "COLOPHON"
+
+Get sucked into the latest news and community activity by entering Pi-hole's orbit. Information about Pi-hole, and the latest version of the software can be found at https://pi-hole.net
+.br

manpages/pihole-FTL.conf.5

@@ -0,0 +1,313 @@
+.TH "pihole-FTL.conf" "5" "pihole-FTL.conf" "pihole-FTL.conf" "November 2020"
+.SH "NAME"
+
+pihole-FTL.conf - FTL's config file
+.br
+.SH "DESCRIPTION"
+
+/etc/pihole/pihole-FTL.conf will be read by \fBpihole-FTL(8)\fR on startup.
+.br
+For each setting the option shown first is the default.
+.br
+
+\fBBLOCKINGMODE=IP|IP-AAAA-NODATA|NODATA|NXDOMAIN|NULL\fR
+.br
+    How should FTL reply to blocked queries?
+
+    IP             - Pi-hole's IPs for blocked domains
+
+    IP-AAAA-NODATA - Pi-hole's IP + NODATA-IPv6 for blocked domains
+
+    NODATA         - Using NODATA for blocked domains
+
+    NXDOMAIN       - NXDOMAIN for blocked domains
+
+    NULL           - Null IPs for blocked domains
+.br
+
+\fBCNAME_DEEP_INSPECT=true|false\fR
+.br
+    Use this option to disable deep CNAME inspection. This might be beneficial for very low-end devices.
+.br
+
+\fBBLOCK_ESNI=true|false\fR
+.br
+    Block requests to _esni.* sub-domains.
+.br
+
+\fBMAXLOGAGE=24.0\fR
+.br
+    Up to how many hours of queries should be imported from the database and logs?
+.br
+    Maximum is 744 (31 days)
+.br
+
+\fBPRIVACYLEVEL=0|1|2|3|4\fR
+.br
+    Privacy level used to collect Pi-hole statistics.
+.br
+    0 - show everything
+.br
+    1 - hide domains
+.br
+    2 - hide domains and clients
+.br
+    3 - anonymous mode (hide everything)
+.br
+    4 - disable all statistics
+.br
+
+\fBIGNORE_LOCALHOST=no|yes\fR
+.br
+    Should FTL ignore queries coming from the local machine?
+.br
+
+\fBAAAA_QUERY_ANALYSIS=yes|no\fR
+.br
+    Should FTL analyze AAAA queries?
+.br
+
+\fBANALYZE_ONLY_A_AND_AAAA=false|true\fR
+.br
+    Should FTL only analyze A and AAAA queries?
+.br
+
+\fBSOCKET_LISTENING=localonly|all\fR
+.br
+    Listen only for local socket connections on the API port or permit all connections.
+.br
+
+\fBFTLPORT=4711\fR
+.br
+    On which port should FTL be listening?
+.br
+
+\fBRESOLVE_IPV6=yes|no\fR
+.br
+    Should FTL try to resolve IPv6 addresses to hostnames?
+.br
+
+\fBRESOLVE_IPV4=yes|no\fR
+.br
+    Should FTL try to resolve IPv4 addresses to hostnames?
+.br
+
+\fBDELAY_STARTUP=0\fR
+.br
+    Time in seconds (between 0 and 300) to delay FTL startup.
+.br
+
+\fBNICE=-10\fR
+.br
+    Set the niceness of the Pi-hole FTL process.
+.br
+    Can be disabled altogether by setting a value of -999.
+.br
+
+\fBNAMES_FROM_NETDB=true|false\fR
+.br
+    Control whether FTL should use a fallback option and try to obtain client names from checking the network table.
+.br
+    E.g. IPv6 clients without a hostname will be compared via MAC address to known clients.
+.br
+
+\fB\fBREFRESH_HOSTNAMES=IPV4|ALL|NONE\fR
+.br
+    Change how (and if) hourly PTR requests are made to check for changes in client and upstream server hostnames:
+.br
+    IPV4 - Do the hourly PTR lookups only for IPv4 addresses resolving issues in networks with many short-lived PE IPv6 addresses.
+.br
+    ALL  - Do the hourly PTR lookups for all addresses. This can create a lot of PTR queries in networks with many IPv6 addresses.
+.br
+    NONE - Don't do hourly PTR lookups. Look up hostnames once (when first seeing a client) and never again. Future hostname changes may be missed.
+.br
+
+\fBMAXNETAGE=365\fR
+.br
+    IP addresses (and associated host names) older than the specified number of days are removed.
+.br
+    This avoids dead entries in the network overview table.
+.br
+
+\fBEDNS0_ECS=true|false\fR
+.br
+    Should we overwrite the query source when client information is provided through EDNS0 client subnet (ECS) information?
+.br
+
+\fBPARSE_ARP_CACHE=true|false\fR
+.br
+    Parse ARP cache to fill network overview table.
+.br
+
+\fBDBIMPORT=yes|no\fR
+.br
+    Should FTL load information from the database on startup to be aware of the most recent history?
+.br
+
+\fBMAXDBDAYS=365\fR
+.br
+    How long should queries be stored in the database? Setting this to 0 disables the database
+.br
+
+\fBDBINTERVAL=1.0\fR
+.br
+    How often do we store queries in FTL's database [minutes]?
+.br
+    Accepts value between 0.1 (6 sec) and 1440 (1 day)
+.br
+
+\fBDBFILE=/etc/pihole/pihole-FTL.db\fR
+.br
+    Specify path and filename of FTL's SQLite long-term database.
+.br
+    Setting this to DBFILE= disables the database altogether
+.br
+
+\fBLOGFILE=/var/log/pihole-FTL.log\fR
+.br
+    The location of FTL's log file.
+.br
+
+\fBPIDFILE=/run/pihole-FTL.pid\fR
+.br
+    The file which contains the PID of FTL's main process.
+.br
+
+\fBPORTFILE=/run/pihole-FTL.port\fR
+.br
+    Specify path and filename where the FTL process will write its API port number.
+.br
+
+\fBSOCKETFILE=/run/pihole/FTL.sock\fR
+.br
+    The file containing the socket FTL's API is listening on.
+.br
+
+\fBSETUPVARSFILE=/etc/pihole/setupVars.conf\fR
+.br
+    The config file of Pi-hole containing, e.g., the current blocking status (do not change).
+.br
+
+\fBMACVENDORDB=/etc/pihole/macvendor.db\fR
+.br
+    The database containing MAC -> Vendor information for the network table.
+.br
+
+\fBGRAVITYDB=/etc/pihole/gravity.db\fR
+.br
+    Specify path and filename of FTL's SQLite3 gravity database. This database contains all domains relevant for Pi-hole's DNS blocking.
+.br
+
+\fBDEBUG_ALL=false|true\fR
+.br
+    Enable all debug flags. If this is set to true, all other debug config options are ignored.
+.br
+
+\fBDEBUG_DATABASE=false|true\fR
+.br
+    Print debugging information about database actions such as SQL statements and performance.
+.br
+
+\fBDEBUG_NETWORKING=false|true\fR
+.br
+    Prints a list of the detected network interfaces on the startup of FTL.
+.br
+
+\fBDEBUG_LOCKS=false|true\fR
+.br
+    Print information about shared memory locks.
+.br
+    Messages will be generated when waiting, obtaining, and releasing a lock.
+.br
+
+\fBDEBUG_QUERIES=false|true\fR
+.br
+    Print extensive DNS query information (domains, types, replies, etc.).
+.br
+
+\fBDEBUG_FLAGS=false|true\fR
+.br
+    Print flags of queries received by the DNS hooks.
+.br
+    Only effective when \fBDEBUG_QUERIES\fR is enabled as well.
+
+\fBDEBUG_SHMEM=false|true\fR
+.br
+    Print information about shared memory buffers.
+.br
+    Messages are either about creating or enlarging shmem objects or string injections.
+.br
+
+\fBDEBUG_GC=false|true\fR
+.br
+    Print information about garbage collection (GC):
+.br
+    What is to be removed, how many have been removed and how long did GC take.
+.br
+
+\fBDEBUG_ARP=false|true\fR
+.br
+    Print information about ARP table processing:
+.br
+    How long did parsing take, whether read MAC addresses are valid, and if the macvendor.db file exists.
+.br
+
+\fBDEBUG_REGEX=false|true\fR
+.br
+    Controls if FTL should print extended details about regex matching.
+.br
+
+\fBDEBUG_API=false|true\fR
+.br
+    Print extra debugging information during telnet API calls.
+.br
+    Currently only used to send extra information when getting all queries.
+.br
+
+\fBDEBUG_OVERTIME=false|true\fR
+.br
+    Print information about overTime memory operations, such as initializing or moving overTime slots.
+.br
+
+\fBDEBUG_EXTBLOCKED=false|true\fR
+.br
+    Print information about why FTL decided that certain queries were recognized as being externally blocked.
+.br
+
+\fBDEBUG_CAPS=false|true\fR
+.br
+    Print information about POSIX capabilities granted to the FTL process.
+.br
+    The current capabilities are printed on receipt of SIGHUP i.e. after executing `killall -HUP pihole-FTL`.
+.br
+
+\fBDEBUG_DNSMASQ_LINES=false|true\fR
+.br
+    Print file and line causing a dnsmasq event into FTL's log files.
+.br
+    This is handy to implement additional hooks missing from FTL.
+.br
+
+\fBDEBUG_VECTORS=false|true\fR
+.br
+    FTL uses dynamically allocated vectors for various tasks.
+.br
+    This config option enables extensive debugging information such as information about allocation, referencing, deletion, and appending.
+.br
+
+\fBDEBUG_RESOLVER=false|true\fR
+.br
+    Extensive information about hostname resolution like which DNS servers are used in the first and second hostname resolving tries.
+.br
+
+.SH "SEE ALSO"
+
+\fBpihole\fR(8), \fBpihole-FTL\fR(8)
+.br
+.SH "COLOPHON"
+
+Pi-hole : The Faster-Than-Light (FTL) Engine is a lightweight, purpose-built daemon used to provide statistics needed for the Pi-hole Web Interface, and its API can be easily integrated into your own projects. Although it is an optional component of the Pi-hole ecosystem, it will be installed by default to provide statistics. As the name implies, FTL does its work \fIvery quickly\fR!
+.br
+
+Get sucked into the latest news and community activity by entering Pi-hole's orbit. Information about Pi-hole, and the latest version of the software can be found at https://pi-hole.net
+.br

manpages/pihole.8

@@ -0,0 +1,379 @@
+.TH "Pi-hole" "8" "Pi-hole" "Pi-hole" "April 2020"
+.SH "NAME"
+
+Pi-hole : A black-hole for internet advertisements
+.br
+.SH "SYNOPSIS"
+
+\fBpihole\fR (\fB-w\fR|\fB-b\fR|\fB--wild\fR|\fB--regex\fR) [options] domain(s)
+.br
+\fBpihole -a\fR \fB-p\fR password
+.br
+\fBpihole -a\fR (\fB-c|-f|-k\fR)
+.br
+\fBpihole -a -e\fR email
+.br
+\fBpihole -a -i\fR interface
+.br
+\fBpihole -a -l\fR privacylevel
+.br
+\fBpihole -c\fR [-j|-r|-e]
+.br
+\fBpihole\fR \fB-d\fR [-a]
+.br
+\fBpihole -f
+.br
+pihole -r
+.br
+pihole -t
+.br
+pihole -g\fR
+.br
+\fBpihole\fR -\fBq\fR [options]
+.br
+\fBpihole\fR \fB-l\fR (\fBon|off|off noflush\fR)
+.br
+\fBpihole -up \fR[--check-only]
+.br
+\fBpihole -v\fR [-p|-a|-f] [-c|-l|-hash]
+.br
+\fBpihole uninstall
+.br
+pihole status
+.br
+pihole restartdns\fR [options]
+.br
+\fBpihole\fR (\fBenable\fR|\fBdisable\fR [time])
+.br
+\fBpihole\fR \fBcheckout\fR repo [branch]
+.br
+\fBpihole\fR \fBhelp\fR
+.br
+.SH "DESCRIPTION"
+
+Available commands and options:
+.br
+
+\fB-w, whitelist\fR [options] [<domain1> <domain2 ...>]
+.br
+    Adds or removes specified domain or domains to the Whitelist
+.br
+
+\fB-b, blacklist\fR [options] [<domain1> <domain2 ...>]
+.br
+    Adds or removes specified domain or domains to the blacklist
+.br
+
+\fB--regex, regex\fR [options] [<regex1> <regex2 ...>]
+.br
+    Add or removes specified regex filter to the regex blacklist
+.br
+
+\fB--white-regex\fR [options] [<regex1> <regex2 ...>]
+.br
+    Add or removes specified regex filter to the regex whitelist
+.br
+
+\fB--wild, wildcard\fR [options] [<domain1> <domain2 ...>]
+.br
+    Add or removes specified domain to the wildcard blacklist
+.br
+
+\fB--white-wild\fR [options] [<domain1> <domain2 ...>]
+.br
+    Add or removes specified domain to the wildcard whitelist
+.br
+
+    (Whitelist/Blacklist manipulation options):
+.br
+      -d, --delmode     Remove domain(s) from the list
+.br
+      -nr, --noreload   Update list without refreshing dnsmasq
+.br
+      -q, --quiet       Make output less verbose
+.br
+      -l, --list        Display all your listed domains
+.br
+      --nuke            Removes all entries in a list
+.br
+
+\fB-d, debug\fR [-a]
+.br
+    Start a debugging session
+.br
+
+      -a                Enable automated debugging
+.br
+
+\fB-f, flush\fR
+.br
+    Flush the Pi-hole log
+.br
+
+\fB-r, reconfigure\fR
+.br
+    Reconfigure or Repair Pi-hole subsystems
+.br
+
+\fB-t, tail\fR
+.br
+    View the live output of the Pi-hole log
+.br
+
+\fB-a, admin\fR [options]
+.br
+
+    (Admin options):
+.br
+      -p, password      Set Web Interface password
+.br
+      -c, celsius       Set Celsius as preferred temperature unit
+.br
+      -f, fahrenheit    Set Fahrenheit as preferred temperature unit
+.br
+      -k, kelvin        Set Kelvin as preferred temperature unit
+.br
+      -e, email         Set an administrative contact address for the
+                        Block Page
+.br
+      -i, interface     Specify dnsmasq's interface listening behavior
+.br
+      -l, privacylevel  <level> Set privacy level
+                        (0 = lowest, 3 = highest)
+.br
+
+\fB-c, chronometer\fR	[options]
+.br
+    Calculates stats and displays to an LCD
+.br
+
+    (Chronometer Options):
+.br
+      -j, --json        Output stats as JSON formatted string
+.br
+      -r, --refresh     Set update frequency (in seconds)
+.br
+      -e, --exit        Output stats and exit without refreshing
+.br
+
+\fB-g, updateGravity\fR
+.br
+    Update the list of ad-serving domains
+.br
+
+\fB-q, query\fR [option]
+.br
+    Query the adlists for a specified domain
+.br
+
+    (Query options):
+.br
+      -adlist           Print the name of the block list URL
+.br
+      -exact            Search the block lists for exact domain matches
+.br
+      -all              Return all query matches within a block list
+.br
+
+\fB-h, --help, help\fR
+.br
+    Show a help dialog
+.br
+
+\fB-l, logging\fR [on|off|off noflush]
+.br
+    Specify whether the Pi-hole log should be used
+.br
+
+	(Logging options):
+.br
+      on                Enable the Pi-hole log at /var/log/pihole.log
+.br
+      off               Disable and flush the Pi-hole log at
+                        /var/log/pihole.log
+.br
+      off noflush       Disable the Pi-hole log at /var/log/pihole.log
+.br
+
+\fB-up, updatePihole\fR [--check-only]
+.br
+    Update Pi-hole subsystems
+.br
+
+      --check-only      Exit script before update is performed.
+.br
+
+\fB-v, version\fR [repo] [options]
+.br
+    Show installed versions of Pi-hole, Web Interface &amp; FTL
+.br
+
+.br
+    (repo options):
+.br
+      -p, --pihole      Only retrieve info regarding Pi-hole repository
+.br
+      -a, --admin       Only retrieve info regarding AdminLTE
+                        repository
+.br
+      -f, --ftl         Only retrieve info regarding FTL repository
+.br
+    (version options):
+.br
+      -c, --current     Return the current version
+.br
+      -l, --latest      Return the latest version
+.br
+      --hash            Return the GitHub hash from your local
+                        repositories
+.br
+
+\fBuninstall\fR
+.br
+    Uninstall Pi-hole from your system
+.br
+
+\fBstatus\fR
+.br
+    Display the running status of Pi-hole subsystems
+.br
+
+\fBenable\fR
+.br
+    Enable Pi-hole subsystems
+.br
+
+\fBdisable\fR [time]
+.br
+    Disable Pi-hole subsystems, optionally for a set duration
+.br
+
+    (time options):
+.br
+      #s                Disable Pi-hole functionality for # second(s)
+.br
+      #m                Disable Pi-hole functionality for # minute(s)
+.br
+
+\fBrestartdns\fR [options]
+.br
+    Full restart Pi-hole subsystems. Without any options (see below) a full restart causes config file parsing and history re-reading
+.br
+
+    (restart options):
+.br
+      reload            Updates the lists (incl. HOSTS files) and flushes DNS cache. Does not reparse config files
+.br
+      reload-lists      Updates the lists (excl. HOSTS files) WITHOUT flushing the DNS cache. Does not reparse config files
+.br
+
+\fBcheckout\fR [repo] [branch]
+.br
+    Switch Pi-hole subsystems to a different GitHub branch
+.br
+
+    (repo options):
+.br
+      core              Change the branch of Pi-hole's core subsystem
+.br
+      web               Change the branch of Admin Console subsystem
+.br
+      ftl               Change the branch of Pi-hole's FTL subsystem
+.br
+    (branch options):
+.br
+      master            Update subsystems to the latest stable release
+.br
+      dev               Update subsystems to the latest development
+                        release
+.br
+      branchname        Update subsystems to the specified branchname
+.br
+.SH "EXAMPLE"
+
+Some usage examples
+.br
+
+Whitelist/blacklist manipulation
+.br
+
+\fBpihole -w iloveads.example.com\fR
+.br
+    Adds "iloveads.example.com" to whitelist
+.br
+
+\fBpihole -b -d noads.example.com\fR
+.br
+    Removes "noads.example.com" from blacklist
+.br
+
+\fBpihole --wild example.com\fR
+.br
+    Adds example.com as a wildcard - would block all subdomains of
+    example.com, including example.com itself.
+.br
+
+\fBpihole --regex "ad.*\\.example\\.com$"\fR
+.br
+    Adds "ad.*\\.example\\.com$" to the regex blacklist.
+    Would block all subdomains of example.com which start with "ad"
+.br
+
+Changing the Web Interface password
+.br
+
+\fBpihole -a -p ExamplePassword\fR
+.br
+    Change the password to "ExamplePassword"
+.br
+
+Updating lists from internet sources
+.br
+
+\fBpihole -g\fR
+.br
+    Update the list of ad-serving domains
+.br
+
+Displaying version information
+.br
+
+\fBpihole -v -a -c\fR
+.br
+    Display the current version of AdminLTE
+.br
+
+Temporarily disabling Pi-hole
+.br
+
+\fBpihole disable 5m\fR
+.br
+    Disable Pi-hole functionality for five minutes
+.br
+
+Switching Pi-hole subsystem branches
+.br
+
+\fBpihole checkout master\fR
+.br
+    Switch to master branch
+.br
+
+\fBpihole checkout core dev\fR
+.br
+    Switch to core development branch
+.br
+
+\fBpihole arpflush\fR
+.br
+    Flush information stored in Pi-hole's network tables
+.br
+
+.SH "SEE ALSO"
+
+\fBlighttpd\fR(8), \fBpihole-FTL\fR(8)
+.br
+.SH "COLOPHON"
+
+Get sucked into the latest news and community activity by entering Pi-hole's orbit. Information about Pi-hole, and the latest version of the software can be found at https://pi-hole.net.
+.br

pihole

@@ -1,4 +1,5 @@
-#!/bin/bash
+#!/usr/bin/env bash
+
 # Pi-hole: A black hole for Internet advertisements
 # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
 # Network-wide ad blocking via your own hardware.
@@ -9,36 +10,24 @@
 # Please see LICENSE file for your rights under this license.
 
 readonly PI_HOLE_SCRIPT_DIR="/opt/pihole"
-readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
 
-# Must be root to use this tool
-if [[ ! $EUID -eq 0 ]];then
-  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
+# setupVars and PI_HOLE_BIN_DIR are not readonly here because in some functions (checkout),
+# they might get set again when the installer is sourced. This causes an
+# error due to modifying a readonly variable.
+setupVars="/etc/pihole/setupVars.conf"
+PI_HOLE_BIN_DIR="/usr/local/bin"
+readonly FTL_PID_FILE="/run/pihole-FTL.pid"
+
+readonly colfile="${PI_HOLE_SCRIPT_DIR}/COL_TABLE"
+source "${colfile}"
 
 webpageFunc() {
-  source /opt/pihole/webpage.sh
+  source "${PI_HOLE_SCRIPT_DIR}/webpage.sh"
   main "$@"
   exit 0
 }
 
-whitelistFunc() {
- "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
-  exit 0
-}
-
-blacklistFunc() {
-  "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
-  exit 0
-}
-
-wildcardFunc() {
+listFunc() {
   "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
   exit 0
 }
@@ -65,8 +54,14 @@ flushFunc() {
   exit 0
 }
 
+arpFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/piholeARPTable.sh "$@"
+  exit 0
+}
+
 updatePiholeFunc() {
-  "${PI_HOLE_SCRIPT_DIR}"/update.sh
+  shift
+  "${PI_HOLE_SCRIPT_DIR}"/update.sh "$@"
   exit 0
 }
 
@@ -76,70 +71,12 @@ reconfigurePiholeFunc() {
 }
 
 updateGravityFunc() {
-  "${PI_HOLE_SCRIPT_DIR}"/gravity.sh "$@"
-  exit 0
-}
-
-scanList(){
-  domain="${1}"
-  list="${2}"
-  method="${3}"
-  if [[ ${method} == "-exact" ]] ; then
-    grep -i -E "(^|\s)${domain}($|\s)" "${list}"
-  else
-    grep -i "${domain}" "${list}"
-  fi
-}
-
-processWildcards() {
-  IFS="." read -r -a array <<< "${1}"
-  for (( i=${#array[@]}-1; i>=0; i-- )); do
-    ar=""
-    for (( j=${#array[@]}-1; j>${#array[@]}-i-2; j-- )); do
-      if [[ $j == $((${#array[@]}-1)) ]]; then
-        ar="${array[$j]}"
-      else
-        ar="${array[$j]}.${ar}"
-      fi
-    done
-    echo "${ar}"
-  done
+  exec "${PI_HOLE_SCRIPT_DIR}"/gravity.sh "$@"
 }
 
 queryFunc() {
-  domain="${2}"
-  method="${3}"
-  lists=( /etc/pihole/list.* /etc/pihole/blacklist.txt)
-  for list in ${lists[@]}; do
-    if [ -e "${list}" ]; then
-      result=$(scanList ${domain} ${list} ${method})
-      # Remove empty lines before couting number of results
-      count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
-      echo "::: ${list} (${count} results)"
-      if [[ ${count} > 0 ]]; then
-        echo "${result}"
-      fi
-      echo ""
-    else
-      echo "::: ${list} does not exist"
-      echo ""
-    fi
-  done
-
-  # Scan for possible wildcard matches
-  if [ -e "${wildcardlist}" ]; then
-    local wildcards=($(processWildcards "${domain}"))
-    for domain in ${wildcards[@]}; do
-      result=$(scanList "\/${domain}\/" ${wildcardlist})
-      # Remove empty lines before couting number of results
-      count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
-      if [[ ${count} > 0 ]]; then
-        echo "::: Wildcard blocking ${domain} (${count} results)"
-        echo "${result}"
-        echo ""
-      fi
-    done
-  fi
+  shift
+  "${PI_HOLE_SCRIPT_DIR}"/query.sh "$@"
   exit 0
 }
 
@@ -157,26 +94,79 @@ uninstallFunc() {
 
 versionFunc() {
   shift
-  "${PI_HOLE_SCRIPT_DIR}"/version.sh "$@"
-  exit 0
+  exec "${PI_HOLE_SCRIPT_DIR}"/version.sh "$@"
+}
+
+# Get PID of main pihole-FTL process
+getFTLPID() {
+  local pid
+
+  if [ -s "${FTL_PID_FILE}" ]; then
+    # -s: FILE exists and has a size greater than zero
+    pid="$(<"$FTL_PID_FILE")"
+    # Exploit prevention: unset the variable if there is malicious content
+    # Verify that the value read from the file is numeric
+    [[ "$pid" =~ [^[:digit:]] ]] && unset pid
+  fi
+
+  # If FTL is not running, or the PID file contains malicious stuff, substitute
+  # negative PID to signal this to the caller
+  echo "${pid:=-1}"
 }
 
 restartDNS() {
-  dnsmasqPid=$(pidof dnsmasq)
-  if [[ "${dnsmasqPid}" ]]; then
-    # Service already running - reload config
-    if [[ -x "$(command -v systemctl)" ]]; then
-      systemctl restart dnsmasq
+  local svcOption svc str output status pid icon
+  svcOption="${1:-restart}"
+
+  # Determine if we should reload or restart
+  if [[ "${svcOption}" =~ "reload-lists" ]]; then
+    # Reloading of the lists has been requested
+    # Note 1: This will NOT re-read any *.conf files
+    # Note 2: We cannot use killall here as it does
+    #         not know about real-time signals
+    pid="$(getFTLPID)"
+    if [[ "$pid" -eq "-1" ]]; then
+      svc="true"
+      str="FTL is not running"
+      icon="${INFO}"
     else
-      service dnsmasq restart
+      svc="kill -RTMIN ${pid}"
+      str="Reloading DNS lists"
+      icon="${TICK}"
+    fi
+  elif [[ "${svcOption}" =~ "reload" ]]; then
+    # Reloading of the DNS cache has been requested
+    # Note: This will NOT re-read any *.conf files
+    pid="$(getFTLPID)"
+    if [[ "$pid" -eq "-1" ]]; then
+      svc="true"
+      str="FTL is not running"
+      icon="${INFO}"
+    else
+      svc="kill -HUP ${pid}"
+      str="Flushing DNS cache"
+      icon="${TICK}"
     fi
   else
-    # Service not running, start it up
-    if [[ -x "$(command -v systemctl)" ]]; then
-      systemctl start dnsmasq
-    else
-      service dnsmasq start
-    fi
+    # A full restart has been requested
+    svc="service pihole-FTL restart"
+    str="Restarting DNS server"
+    icon="${TICK}"
+  fi
+
+  # Print output to Terminal, but not to Web Admin
+  [[ -t 1 ]] && echo -ne "  ${INFO} ${str}..."
+
+  output=$( { ${svc}; } 2>&1 )
+  status="$?"
+
+  if [[ "${status}" -eq 0 ]]; then
+    [[ -t 1 ]] && echo -e "${OVER}  ${icon} ${str}"
+    return 0
+  else
+    [[ ! -t 1 ]] && local OVER=""
+    echo -e "${OVER}  ${CROSS} ${output}"
+    return 1
   fi
 }
 
@@ -190,41 +180,69 @@ Time:
   #s                  Disable Pi-hole functionality for # second(s)
   #m                  Disable Pi-hole functionality for # minute(s)"
     exit 0
+
   elif [[ "${1}" == "0" ]]; then
     # Disable Pi-hole
-    sed -i 's/^addn-hosts=\/etc\/pihole\/gravity.list/#addn-hosts=\/etc\/pihole\/gravity.list/' /etc/dnsmasq.d/01-pihole.conf
-    sed -i 's/^addn-hosts=\/etc\/pihole\/black.list/#addn-hosts=\/etc\/pihole\/black.list/' /etc/dnsmasq.d/01-pihole.conf
-    if [[ -e "$wildcardlist" ]]; then
-      mv "$wildcardlist" "/etc/pihole/wildcard.list"
+    if grep -cq "BLOCKING_ENABLED=false" "${setupVars}"; then
+      echo -e "  ${INFO} Blocking already disabled, nothing to do"
+      exit 0
     fi
-    echo "::: Blocking has been disabled!"
     if [[ $# > 1 ]]; then
-      if [[ "${2}" == *"s"* ]]; then
+      local error=false
+      if [[ "${2}" == *"s" ]]; then
         tt=${2%"s"}
-        echo "::: Blocking will be re-enabled in ${tt} seconds"
-        nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
-      elif [[ "${2}" == *"m"* ]]; then
+        if [[ "${tt}" =~ ^-?[0-9]+$ ]];then
+          local str="Disabling blocking for ${tt} seconds"
+          echo -e "  ${INFO} ${str}..."
+          local str="Blocking will be re-enabled in ${tt} seconds"
+          nohup "${PI_HOLE_SCRIPT_DIR}"/pihole-reenable.sh ${tt} </dev/null &>/dev/null &
+        else
+          local error=true
+        fi
+      elif [[ "${2}" == *"m" ]]; then
         tt=${2%"m"}
-        echo "::: Blocking will be re-enabled in ${tt} minutes"
-        tt=$((${tt}*60))
-        nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
+          if [[ "${tt}" =~ ^-?[0-9]+$ ]];then
+          local str="Disabling blocking for ${tt} minutes"
+          echo -e "  ${INFO} ${str}..."
+          local str="Blocking will be re-enabled in ${tt} minutes"
+          tt=$((${tt}*60))
+          nohup "${PI_HOLE_SCRIPT_DIR}"/pihole-reenable.sh ${tt} </dev/null &>/dev/null &
+        else
+          local error=true
+        fi
+      elif [[ -n "${2}" ]]; then
+        local error=true
       else
-        echo "::: Unknown format for delayed reactivation of the blocking!"
-        echo "::: Example:"
-        echo ":::    pihole disable 5s    -    will disable blocking for 5 seconds"
-        echo ":::    pihole disable 7m    -    will disable blocking for 7 minutes"
-        echo "::: Blocking will not automatically be re-enabled!"
+        echo -e "  ${INFO} Disabling blocking"
       fi
+
+      if [[ ${error} == true ]];then
+        echo -e "  ${COL_LIGHT_RED}Unknown format for delayed reactivation of the blocking!${COL_NC}"
+        echo -e "  Try 'pihole disable --help' for more information."
+        exit 1
+      fi
+
+      local str="Pi-hole Disabled"
+      sed -i "/BLOCKING_ENABLED=/d" "${setupVars}"
+      echo "BLOCKING_ENABLED=false" >> "${setupVars}"
     fi
   else
     # Enable Pi-hole
-    echo "::: Blocking has been enabled!"
-    sed -i 's/^#addn-hosts/addn-hosts/' /etc/dnsmasq.d/01-pihole.conf
-    if [[ -e "/etc/pihole/wildcard.list" ]]; then
-      mv "/etc/pihole/wildcard.list" "$wildcardlist"
+    killall -q pihole-reenable
+    if grep -cq "BLOCKING_ENABLED=true" "${setupVars}"; then
+      echo -e "  ${INFO} Blocking already enabled, nothing to do"
+      exit 0
     fi
+    echo -e "  ${INFO} Enabling blocking"
+    local str="Pi-hole Enabled"
+
+    sed -i "/BLOCKING_ENABLED=/d" "${setupVars}"
+    echo "BLOCKING_ENABLED=true" >> "${setupVars}"
   fi
-  restartDNS
+
+  restartDNS reload-lists
+
+  echo -e "${OVER}  ${TICK} ${str}"
 }
 
 piholeLogging() {
@@ -236,70 +254,137 @@ Specify whether the Pi-hole log should be used
 
 Options:
   on                  Enable the Pi-hole log at /var/log/pihole.log
-  off                 Disable the Pi-hole log at /var/log/pihole.log"
+  off                 Disable and flush the Pi-hole log at /var/log/pihole.log
+  off noflush         Disable the Pi-hole log at /var/log/pihole.log"
     exit 0
   elif [[ "${1}" == "off" ]]; then
     # Disable logging
     sed -i 's/^log-queries/#log-queries/' /etc/dnsmasq.d/01-pihole.conf
     sed -i 's/^QUERY_LOGGING=true/QUERY_LOGGING=false/' /etc/pihole/setupVars.conf
-    pihole -f
-    echo "::: Logging has been disabled!"
+    if [[ "${2}" != "noflush" ]]; then
+      # Flush logs
+      "${PI_HOLE_BIN_DIR}"/pihole -f
+    fi
+    echo -e "  ${INFO} Disabling logging..."
+    local str="Logging has been disabled!"
   elif [[ "${1}" == "on" ]]; then
     # Enable logging
     sed -i 's/^#log-queries/log-queries/' /etc/dnsmasq.d/01-pihole.conf
     sed -i 's/^QUERY_LOGGING=false/QUERY_LOGGING=true/' /etc/pihole/setupVars.conf
-    echo "::: Logging has been enabled!"
+    echo -e "  ${INFO} Enabling logging..."
+    local str="Logging has been enabled!"
   else
-    echo "::: Invalid option passed, please pass 'on' or 'off'"
+    echo -e "  ${COL_LIGHT_RED}Invalid option${COL_NC}
+  Try 'pihole logging --help' for more information."
     exit 1
   fi
   restartDNS
+  echo -e "${OVER}  ${TICK} ${str}"
 }
 
-piholeStatus() {
-  if [[ "$(netstat -plnt | grep -c ':53 ')" -gt "0" ]]; then
-    if [[ "${1}" != "web" ]]; then
-      echo "::: DNS service is running"
-    fi
+analyze_ports() {
+  local lv4 lv6 port=${1}
+  # FTL is listening at least on at least one port when this
+  # function is getting called
+  # Check individual address family/protocol combinations
+  # For a healthy Pi-hole, they should all be up (nothing printed)
+  lv4="$(ss --ipv4 --listening --numeric --tcp --udp src :${port})"
+  if grep -q "udp " <<< "${lv4}"; then
+      echo -e "     ${TICK} UDP (IPv4)"
   else
-    if [[ "${1}" == "web" ]]; then
-      echo "-1";
+      echo -e "     ${CROSS} UDP (IPv4)"
+  fi
+  if grep -q "tcp " <<< "${lv4}"; then
+      echo -e "     ${TICK} TCP (IPv4)"
+  else
+      echo -e "     ${CROSS} TCP (IPv4)"
+  fi
+  lv6="$(ss --ipv6 --listening --numeric --tcp --udp src :${port})"
+  if grep -q "udp " <<< "${lv6}"; then
+      echo -e "     ${TICK} UDP (IPv6)"
+  else
+      echo -e "     ${CROSS} UDP (IPv6)"
+  fi
+  if grep -q "tcp " <<< "${lv6}"; then
+      echo -e "     ${TICK} TCP (IPv6)"
+  else
+      echo -e "     ${CROSS} TCP (IPv6)"
+  fi
+  echo ""
+}
+
+statusFunc() {
+  # Determine if there is pihole-FTL service is listening
+  local listening pid port
+
+  pid="$(getFTLPID)"
+  if [[ "$pid" -eq "-1" ]]; then
+    case "${1}" in
+      "web") echo "-1";;
+      *) echo -e "  ${CROSS} DNS service is NOT running";;
+    esac
+    return 0
+  else
+    #get the port pihole-FTL is listening on by using FTL's telnet API
+    port="$(echo ">dns-port >quit" | nc 127.0.0.1 4711)"
+    if [[ "${port}" == "0" ]]; then
+      case "${1}" in
+        "web") echo "-1";;
+        *) echo -e "  ${CROSS} DNS service is NOT listening";;
+      esac
+      return 0
     else
-      echo "::: DNS service is NOT running"
+      if [[ "${1}" != "web" ]]; then
+        echo -e "  ${TICK} FTL is listening on port ${port}"
+        analyze_ports "${port}"
+      fi
     fi
-    return
   fi
 
-  if [[ "$(grep -i "^#addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf)" ]]; then
-    # List is commented out
-    if [[ "${1}" == "web" ]]; then
-      echo 0;
-    else
-      echo "::: Pi-hole blocking is Disabled";
-    fi
-  elif [[ "$(grep -i "^addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf)" ]]; then
-    # List set
-    if [[ "${1}" == "web" ]]; then
-      echo 1;
-    else
-      echo "::: Pi-hole blocking is Enabled";
-    fi
+  # Determine if Pi-hole's blocking is enabled
+  if grep -q "BLOCKING_ENABLED=false" /etc/pihole/setupVars.conf; then
+    # A config is commented out
+    case "${1}" in
+      "web") echo 0;;
+      *) echo -e "  ${CROSS} Pi-hole blocking is disabled";;
+    esac
+  elif grep -q "BLOCKING_ENABLED=true" /etc/pihole/setupVars.conf;  then
+    # Configs are set
+    case "${1}" in
+      "web") echo "$port";;
+      *) echo -e "  ${TICK} Pi-hole blocking is enabled";;
+    esac
   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
+    # No configs were found
+    case "${1}" in
+      "web") echo -2;;
+      *) echo -e "  ${INFO} Pi-hole blocking will be enabled";;
+    esac
+    # Enable blocking
+    "${PI_HOLE_BIN_DIR}"/pihole enable
   fi
+
 }
 
 tailFunc() {
-  echo "Press Ctrl-C to exit"
-  tail -F /var/log/pihole.log
+  # Warn user if Pi-hole's logging is disabled
+  local logging_enabled=$(grep -c "^log-queries" /etc/dnsmasq.d/01-pihole.conf)
+  if [[ "${logging_enabled}" == "0" ]]; then
+    # No "log-queries" lines are found.
+    # Commented out lines (such as "#log-queries") are ignored
+    echo "  ${CROSS} Warning: Query logging is disabled"
+  fi
+  echo -e "  ${INFO} Press Ctrl-C to exit"
+
+  # Strip date from each line
+  # Color blocklist/blacklist/wildcard entries as red
+  # Color A/AAAA/DHCP strings as white
+  # Color everything else as gray
+  tail -f /var/log/pihole.log | grep --line-buffered "${1}" | sed -E \
+    -e "s,($(date +'%b %d ')| dnsmasq\[[0-9]*\]),,g" \
+    -e "s,(.*(blacklisted |gravity blocked ).*),${COL_RED}&${COL_NC}," \
+    -e "s,.*(query\\[A|DHCP).*,${COL_NC}&${COL_NC}," \
+    -e "s,.*,${COL_GRAY}&${COL_NC},"
   exit 0
 }
 
@@ -307,15 +392,17 @@ piholeCheckoutFunc() {
   if [[ "$2" == "-h" ]] || [[ "$2" == "--help" ]]; then
     echo "Usage: pihole checkout [repo] [branch]
 Example: 'pihole checkout master' or 'pihole checkout core dev'
-Switch Pi-hole subsystems to a different Github branch
+Switch Pi-hole subsystems to a different GitHub branch
 
 Repositories:
   core [branch]       Change the branch of Pi-hole's core subsystem
-  web [branch]        Change the branch of Admin Console subsystem
+  web [branch]        Change the branch of Web Interface subsystem
+  ftl [branch]        Change the branch of Pi-hole's FTL subsystem
 
 Branches:
   master              Update subsystems to the latest stable release
-  dev                 Update subsystems to the latest development release"
+  dev                 Update subsystems to the latest development release
+  branchname          Update subsystems to the specified branchname"
     exit 0
   fi
 
@@ -325,33 +412,29 @@ Branches:
 }
 
 tricorderFunc() {
+  local tricorder_token
   if [[ ! -p "/dev/stdin" ]]; then
-    echo "Please do not call Tricorder directly."
+    echo -e "  ${INFO} Please do not call Tricorder directly"
     exit 1
   fi
 
-  if ! timeout 2 nc -z tricorder.pi-hole.net 9998 &> /dev/null; then
-    echo "Unable to connect to Pi-hole's Tricorder server."
-    exit 1
+  tricorder_token=$(curl --silent --fail --show-error --upload-file "-" https://tricorder.pi-hole.net/upload < /dev/stdin 2>&1)
+  if [[ "${tricorder_token}" != "https://tricorder.pi-hole.net/"* ]]; then
+      echo -e "${CROSS} uploading failed, contact Pi-hole support for assistance."
+      # Log curl error (if available)
+      if [ -n "${tricorder_token}" ]; then
+          echo -e "${INFO} Error message: ${COL_RED}${tricorder_token}${COL_NC}\\n"
+          tricorder_token=""
+      fi
+      exit 1
   fi
+  echo "Upload successful, your token is: ${COL_GREEN}${tricorder_token}${COL_NC}"
+  exit 0
+}
 
-  if command -v openssl &> /dev/null; then
-    openssl s_client -quiet -connect tricorder.pi-hole.net:9998 2> /dev/null < /dev/stdin
-    exit "$?"
-  else
-    echo "Your debug log will be transmitted unencrypted via plain-text"
-    echo "There is a possibility that this could be intercepted by a third party"
-    echo "If you wish to cancel, press Ctrl-C to exit within 10 seconds"
-    secs="10"
-    while [[ "$secs" -gt "0" ]]; do
-       echo -ne "."
-       sleep 1
-       : $((secs--))
-    done
-    echo " "
-    nc tricorder.pi-hole.net 9999 < /dev/stdin
-    exit "$?"
-  fi
+updateCheckFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/updatecheck.sh "$@"
+  exit 0
 }
 
 helpFunc() {
@@ -362,19 +445,25 @@ Add '-h' after specific commands for more information on usage
 Whitelist/Blacklist Options:
   -w, whitelist       Whitelist domain(s)
   -b, blacklist       Blacklist domain(s)
-  -wild, wildcard     Blacklist domain(s), and all its subdomains
+  --regex, regex      Regex blacklist domains(s)
+  --white-regex       Regex whitelist domains(s)
+  --wild, wildcard    Wildcard blacklist domain(s)
+  --white-wild        Wildcard whitelist domain(s)
                         Add '-h' for more info on whitelist/blacklist usage
 
 Debugging Options:
   -d, debug           Start a debugging session
-                        Add '-a' to enable automated debugging
+                        Add '-a' to automatically upload the log to tricorder.pi-hole.net
   -f, flush           Flush the Pi-hole log
   -r, reconfigure     Reconfigure or Repair Pi-hole subsystems
-  -t, tail            View the live output of the Pi-hole log
+  -t, tail [arg]      View the live output of the Pi-hole log.
+                      Add an optional argument to filter the log
+                      (regular expressions are supported)
+
 
 Options:
-  -a, admin           Admin Console options
-                        Add '-h' for more info on admin console usage
+  -a, admin           Web interface options
+                        Add '-h' for more info on Web Interface usage
   -c, chronometer     Calculates stats and displays to an LCD
                         Add '-h' for more info on chronometer usage
   -g, updateGravity   Update the list of ad-serving domains
@@ -382,18 +471,22 @@ Options:
   -l, logging         Specify whether the Pi-hole log should be used
                         Add '-h' for more info on logging usage
   -q, query           Query the adlists for a specified domain
-                        Add '-exact' AFTER a specified domain for exact match
+                        Add '-h' for more info on query usage
   -up, updatePihole   Update Pi-hole subsystems
-  -v, version         Show installed versions of Pi-hole, Admin Console & FTL
+                        Add '--check-only' to exit script before update is performed.
+  -v, version         Show installed versions of Pi-hole, Web Interface & FTL
                         Add '-h' for more info on version usage
   uninstall           Uninstall Pi-hole from your system
   status              Display the running status of Pi-hole subsystems
   enable              Enable Pi-hole subsystems
   disable             Disable Pi-hole subsystems
                         Add '-h' for more info on disable usage
-  restartdns          Restart Pi-hole subsystems
-  checkout            Switch Pi-hole subsystems to a different Github branch
-                        Add '-h' for more info on checkout usage";
+  restartdns          Full restart Pi-hole subsystems
+                        Add 'reload' to update the lists and flush the cache without restarting the DNS server
+                        Add 'reload-lists' to only update the lists WITHOUT flushing the cache or restarting the DNS server
+  checkout            Switch Pi-hole subsystems to a different GitHub branch
+                        Add '-h' for more info on checkout usage
+  arpflush            Flush information stored in Pi-hole's network tables";
   exit 0
 }
 
@@ -401,14 +494,32 @@ if [[ $# = 0 ]]; then
   helpFunc
 fi
 
+case "${1}" in
+  "-h" | "help" | "--help"      ) helpFunc;;
+esac
+
+# Must be root to use this tool
+if [[ ! $EUID -eq 0 ]];then
+  if [[ -x "$(command -v sudo)" ]]; then
+    exec sudo bash "$0" "$@"
+    exit $?
+  else
+    echo -e "  ${CROSS} sudo is needed to run pihole commands.  Please run this script as root or install sudo."
+    exit 1
+  fi
+fi
+
 # Handle redirecting to specific functions based on arguments
 case "${1}" in
-  "-w" | "whitelist"            ) whitelistFunc "$@";;
-  "-b" | "blacklist"            ) blacklistFunc "$@";;
-  "-wild" | "wildcard"          ) wildcardFunc "$@";;
+  "-w" | "whitelist"            ) listFunc "$@";;
+  "-b" | "blacklist"            ) listFunc "$@";;
+  "--wild" | "wildcard"         ) listFunc "$@";;
+  "--regex" | "regex"           ) listFunc "$@";;
+  "--white-regex" | "white-regex" ) listFunc "$@";;
+  "--white-wild" | "white-wild"   ) listFunc "$@";;
   "-d" | "debug"                ) debugFunc "$@";;
   "-f" | "flush"                ) flushFunc "$@";;
-  "-up" | "updatePihole"        ) updatePiholeFunc;;
+  "-up" | "updatePihole"        ) updatePiholeFunc "$@";;
   "-r"  | "reconfigure"         ) reconfigurePiholeFunc;;
   "-g" | "updateGravity"        ) updateGravityFunc "$@";;
   "-c" | "chronometer"          ) chronometerFunc "$@";;
@@ -419,11 +530,13 @@ case "${1}" in
   "uninstall"                   ) uninstallFunc;;
   "enable"                      ) piholeEnable 1;;
   "disable"                     ) piholeEnable 0 "$2";;
-  "status"                      ) piholeStatus "$2";;
-  "restartdns"                  ) restartDNS;;
+  "status"                      ) statusFunc "$2";;
+  "restartdns"                  ) restartDNS "$2";;
   "-a" | "admin"                ) webpageFunc "$@";;
-  "-t" | "tail"                 ) tailFunc;;
+  "-t" | "tail"                 ) tailFunc "$2";;
   "checkout"                    ) piholeCheckoutFunc "$@";;
   "tricorder"                   ) tricorderFunc;;
+  "updatechecker"               ) updateCheckFunc "$@";;
+  "arpflush"                    ) arpFunc "$@";;
   *                             ) helpFunc;;
 esac

test/README.md

@@ -0,0 +1,25 @@
+# Recommended way to run tests
+
+Make sure you have Docker and Python w/pip package manager.
+
+From command line all you need to do is:
+
+- `pip install tox`
+- `tox`
+
+Tox handles setting up a virtual environment for python dependencies, installing dependencies, building the docker images used by tests, and finally running tests.  It's an easy way to have travis-ci like build behavior locally.
+
+## Alternative py.test method of running tests
+
+You're responsible for setting up your virtual env and dependencies in this situation.
+
+```
+py.test -vv -n auto -m "build_stage"
+py.test -vv -n auto -m "not build_stage"
+```
+
+The build_stage tests have to run first to create the docker images, followed by the actual tests which utilize said images. Unless you're changing your dockerfiles you shouldn't have to run the build_stage every time - but it's a good idea to rebuild at least once a day in case the base Docker images or packages change.
+
+# How do I debug python?
+
+Highly recommended: Setup PyCharm on a **Docker enabled** machine. Having a python debugger like PyCharm changes your life if you've never used it :)

test/_centos_7.Dockerfile

@@ -1,4 +1,5 @@
 FROM centos:7
+RUN yum install -y git
 
 ENV GITDIR /etc/.pihole
 ENV SCRIPTDIR /opt/pihole
@@ -12,5 +13,6 @@ RUN true && \
     chmod +x $SCRIPTDIR/*
 
 ENV PH_TEST true
+ENV OS_CHECK_DOMAIN_NAME dev-supportedos.pi-hole.net
 
 #sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_centos_8.Dockerfile

@@ -0,0 +1,18 @@
+FROM centos:8
+RUN yum install -y git
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+ENV OS_CHECK_DOMAIN_NAME dev-supportedos.pi-hole.net
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_debian_10.Dockerfile

@@ -1,4 +1,4 @@
-FROM buildpack-deps:jessie-scm
+FROM buildpack-deps:buster-scm
 
 ENV GITDIR /etc/.pihole
 ENV SCRIPTDIR /opt/pihole
@@ -12,5 +12,6 @@ RUN true && \
     chmod +x $SCRIPTDIR/*
 
 ENV PH_TEST true
+ENV OS_CHECK_DOMAIN_NAME dev-supportedos.pi-hole.net
 
 #sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_debian_11.Dockerfile

@@ -0,0 +1,17 @@
+FROM buildpack-deps:bullseye-scm
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+ENV OS_CHECK_DOMAIN_NAME dev-supportedos.pi-hole.net
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_debian_9.Dockerfile

@@ -0,0 +1,17 @@
+FROM buildpack-deps:stretch-scm
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+ENV OS_CHECK_DOMAIN_NAME dev-supportedos.pi-hole.net
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_fedora_33.Dockerfile

@@ -0,0 +1,18 @@
+FROM fedora:33
+RUN dnf install -y git
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+ENV OS_CHECK_DOMAIN_NAME dev-supportedos.pi-hole.net
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_fedora_34.Dockerfile

@@ -0,0 +1,18 @@
+FROM fedora:34
+RUN dnf install -y git
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+ENV OS_CHECK_DOMAIN_NAME dev-supportedos.pi-hole.net
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_ubuntu_16.Dockerfile

@@ -0,0 +1,17 @@
+FROM buildpack-deps:xenial-scm
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+ENV OS_CHECK_DOMAIN_NAME dev-supportedos.pi-hole.net
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_ubuntu_18.Dockerfile

@@ -0,0 +1,17 @@
+FROM buildpack-deps:bionic-scm
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+ENV OS_CHECK_DOMAIN_NAME dev-supportedos.pi-hole.net
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_ubuntu_20.Dockerfile

@@ -0,0 +1,18 @@
+FROM buildpack-deps:focal-scm
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+ENV OS_CHECK_DOMAIN_NAME dev-supportedos.pi-hole.net
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/_ubuntu_21.Dockerfile

@@ -0,0 +1,18 @@
+FROM buildpack-deps:hirsute-scm
+
+ENV GITDIR /etc/.pihole
+ENV SCRIPTDIR /opt/pihole
+
+RUN mkdir -p $GITDIR $SCRIPTDIR /etc/pihole
+ADD . $GITDIR
+RUN cp $GITDIR/advanced/Scripts/*.sh $GITDIR/gravity.sh $GITDIR/pihole $GITDIR/automated\ install/*.sh $SCRIPTDIR/
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$SCRIPTDIR
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN true && \
+    chmod +x $SCRIPTDIR/*
+
+ENV PH_TEST true
+ENV OS_CHECK_DOMAIN_NAME dev-supportedos.pi-hole.net
+
+#sed '/# Start the installer/Q' /opt/pihole/basic-install.sh > /opt/pihole/stub_basic-install.sh && \

test/conftest.py

@@ -1,61 +1,172 @@
 import pytest
 import testinfra
+import testinfra.backend.docker
+import subprocess
+from textwrap import dedent
+
+
+SETUPVARS = {
+    'PIHOLE_INTERFACE': 'eth99',
+    'PIHOLE_DNS_1': '4.2.2.1',
+    'PIHOLE_DNS_2': '4.2.2.2'
+}
+
+IMAGE = 'pytest_pihole:test_container'
+
+tick_box = "[\x1b[1;32m\u2713\x1b[0m]"
+cross_box = "[\x1b[1;31m\u2717\x1b[0m]"
+info_box = "[i]"
+
+
+# Monkeypatch sh to bash, if they ever support non hard code /bin/sh this can go away
+# https://github.com/pytest-dev/pytest-testinfra/blob/master/testinfra/backend/docker.py
+def run_bash(self, command, *args, **kwargs):
+    cmd = self.get_command(command, *args)
+    if self.user is not None:
+        out = self.run_local(
+            "docker exec -u %s %s /bin/bash -c %s", self.user, self.name, cmd
+        )
+    else:
+        out = self.run_local("docker exec %s /bin/bash -c %s", self.name, cmd)
+    out.command = self.encode(cmd)
+    return out
+
+
+testinfra.backend.docker.DockerBackend.run = run_bash
 
-check_output = testinfra.get_backend(
-    "local://"
-).get_module("Command").check_output
 
 @pytest.fixture
-def Pihole(Docker):
-    ''' used to contain some script stubbing, now pretty much an alias.
-    Also provides bash as the default run function shell '''
-    def run_bash(self, command, *args, **kwargs):
-        cmd = self.get_command(command, *args)
-        if self.user is not None:
-            out = self.run_local(
-                "docker exec -u %s %s /bin/bash -c %s",
-                self.user, self.name, cmd)
-        else:
-            out = self.run_local(
-                "docker exec %s /bin/bash -c %s", self.name, cmd)
-        out.command = self.encode(cmd)
-        return out
+def host():
+    # run a container
+    docker_id = subprocess.check_output(
+        ['docker', 'run', '-t', '-d', '--cap-add=ALL', IMAGE]).decode().strip()
 
-    funcType = type(Docker.run)
-    Docker.run = funcType(run_bash, Docker, testinfra.backend.docker.DockerBackend)
-    return Docker
+    # return a testinfra connection to the container
+    docker_host = testinfra.get_host("docker://" + docker_id)
 
-@pytest.fixture
-def Docker(request, args, image, cmd):
-    ''' combine our fixtures into a docker run command and setup finalizer to cleanup '''
-    assert 'docker' in check_output('id'), "Are you in the docker group?"
-    docker_run = "docker run {} {} {}".format(args, image, cmd)
-    docker_id = check_output(docker_run)
+    yield docker_host
+    # at the end of the test suite, destroy the container
+    subprocess.check_call(['docker', 'rm', '-f', docker_id])
 
-    def teardown():
-        check_output("docker rm -f %s", docker_id)
-    request.addfinalizer(teardown)
 
-    docker_container = testinfra.get_backend("docker://" + docker_id)
-    docker_container.id = docker_id
-    return docker_container
+# Helper functions
+def mock_command(script, args, container):
+    '''
+    Allows for setup of commands we don't really want to have to run for real
+    in unit tests
+    '''
+    full_script_path = '/usr/local/bin/{}'.format(script)
+    mock_script = dedent(r'''\
+    #!/bin/bash -e
+    echo "\$0 \$@" >> /var/log/{script}
+    case "\$1" in'''.format(script=script))
+    for k, v in args.items():
+        case = dedent('''
+        {arg})
+        echo {res}
+        exit {retcode}
+        ;;'''.format(arg=k, res=v[0], retcode=v[1]))
+        mock_script += case
+    mock_script += dedent('''
+    esac''')
+    container.run('''
+    cat <<EOF> {script}\n{content}\nEOF
+    chmod +x {script}
+    rm -f /var/log/{scriptlog}'''.format(script=full_script_path,
+                                         content=mock_script,
+                                         scriptlog=script))
 
-@pytest.fixture
-def args(request):
-    ''' -t became required when tput began being used '''
-    return '-t -d'
 
-@pytest.fixture(params=['debian', 'centos'])
-def tag(request):
-    ''' consumed by image to make the test matrix '''
-    return request.param
+def mock_command_passthrough(script, args, container):
+    '''
+    Per other mock_command* functions, allows intercepting of commands we don't want to run for real
+    in unit tests, however also allows only specific arguments to be mocked. Anything not defined will
+    be passed through to the actual command.
 
-@pytest.fixture()
-def image(request, tag):
-    ''' built by test_000_build_containers.py '''
-    return 'pytest_pihole:{}'.format(tag)
+    Example use-case: mocking `git pull` but still allowing `git clone` to work as intended
+    '''
+    orig_script_path = container.check_output('command -v {}'.format(script))
+    full_script_path = '/usr/local/bin/{}'.format(script)
+    mock_script = dedent(r'''\
+    #!/bin/bash -e
+    echo "\$0 \$@" >> /var/log/{script}
+    case "\$1" in'''.format(script=script))
+    for k, v in args.items():
+        case = dedent('''
+        {arg})
+        echo {res}
+        exit {retcode}
+        ;;'''.format(arg=k, res=v[0], retcode=v[1]))
+        mock_script += case
+    mock_script += dedent(r'''
+    *)
+    {orig_script_path} "\$@"
+    ;;'''.format(orig_script_path=orig_script_path))
+    mock_script += dedent('''
+    esac''')
+    container.run('''
+    cat <<EOF> {script}\n{content}\nEOF
+    chmod +x {script}
+    rm -f /var/log/{scriptlog}'''.format(script=full_script_path,
+                                         content=mock_script,
+                                         scriptlog=script))
 
-@pytest.fixture()
-def cmd(request):
-    ''' default to doing nothing by tailing null, but don't exit '''
-    return 'tail -f /dev/null'
+
+def mock_command_run(script, args, container):
+    '''
+    Allows for setup of commands we don't really want to have to run for real
+    in unit tests
+    '''
+    full_script_path = '/usr/local/bin/{}'.format(script)
+    mock_script = dedent(r'''\
+    #!/bin/bash -e
+    echo "\$0 \$@" >> /var/log/{script}
+    case "\$1 \$2" in'''.format(script=script))
+    for k, v in args.items():
+        case = dedent('''
+        \"{arg}\")
+        echo {res}
+        exit {retcode}
+        ;;'''.format(arg=k, res=v[0], retcode=v[1]))
+        mock_script += case
+    mock_script += dedent('''
+    esac''')
+    container.run('''
+    cat <<EOF> {script}\n{content}\nEOF
+    chmod +x {script}
+    rm -f /var/log/{scriptlog}'''.format(script=full_script_path,
+                                         content=mock_script,
+                                         scriptlog=script))
+
+
+def mock_command_2(script, args, container):
+    '''
+    Allows for setup of commands we don't really want to have to run for real
+    in unit tests
+    '''
+    full_script_path = '/usr/local/bin/{}'.format(script)
+    mock_script = dedent(r'''\
+    #!/bin/bash -e
+    echo "\$0 \$@" >> /var/log/{script}
+    case "\$1 \$2" in'''.format(script=script))
+    for k, v in args.items():
+        case = dedent('''
+        \"{arg}\")
+        echo \"{res}\"
+        exit {retcode}
+        ;;'''.format(arg=k, res=v[0], retcode=v[1]))
+        mock_script += case
+    mock_script += dedent('''
+    esac''')
+    container.run('''
+    cat <<EOF> {script}\n{content}\nEOF
+    chmod +x {script}
+    rm -f /var/log/{scriptlog}'''.format(script=full_script_path,
+                                         content=mock_script,
+                                         scriptlog=script))
+
+
+def run_script(Pihole, script):
+    result = Pihole.run(script)
+    assert result.rc == 0
+    return result

test/requirements.txt

@@ -2,4 +2,5 @@ docker-compose
 pytest
 pytest-xdist
 pytest-cov
-testinfra
+pytest-testinfra
+tox

test/setup.py

@@ -0,0 +1,6 @@
+from setuptools import setup
+
+setup(
+    setup_requires=['pytest-runner'],
+    tests_require=['pytest'],
+)

test/test_000_build_containers.py

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

test/test_centos_7_support.py

@@ -0,0 +1,63 @@
+from .conftest import (
+    tick_box,
+    info_box,
+    mock_command,
+)
+
+
+def test_php_upgrade_default_optout_centos_eq_7(host):
+    '''
+    confirms the default behavior to opt-out of installing PHP7 from REMI
+    '''
+    package_manager_detect = host.run('''
+    source /opt/pihole/basic-install.sh
+    package_manager_detect
+    select_rpm_php
+    ''')
+    expected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS. '
+                                  'Deprecated PHP may be in use.')
+    assert expected_stdout in package_manager_detect.stdout
+    remi_package = host.package('remi-release')
+    assert not remi_package.is_installed
+
+
+def test_php_upgrade_user_optout_centos_eq_7(host):
+    '''
+    confirms installer behavior when user opt-out of installing PHP7 from REMI
+    (php not currently installed)
+    '''
+    # Whiptail dialog returns Cancel for user prompt
+    mock_command('whiptail', {'*': ('', '1')}, host)
+    package_manager_detect = host.run('''
+    source /opt/pihole/basic-install.sh
+    package_manager_detect
+    select_rpm_php
+    ''')
+    expected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS. '
+                                  'Deprecated PHP may be in use.')
+    assert expected_stdout in package_manager_detect.stdout
+    remi_package = host.package('remi-release')
+    assert not remi_package.is_installed
+
+
+def test_php_upgrade_user_optin_centos_eq_7(host):
+    '''
+    confirms installer behavior when user opt-in to installing PHP7 from REMI
+    (php not currently installed)
+    '''
+    # Whiptail dialog returns Continue for user prompt
+    mock_command('whiptail', {'*': ('', '0')}, host)
+    package_manager_detect = host.run('''
+    source /opt/pihole/basic-install.sh
+    package_manager_detect
+    select_rpm_php
+    ''')
+    assert 'opt-out' not in package_manager_detect.stdout
+    expected_stdout = info_box + (' Enabling Remi\'s RPM repository '
+                                  '(https://rpms.remirepo.net)')
+    assert expected_stdout in package_manager_detect.stdout
+    expected_stdout = tick_box + (' Remi\'s RPM repository has '
+                                  'been enabled for PHP7')
+    assert expected_stdout in package_manager_detect.stdout
+    remi_package = host.package('remi-release')
+    assert remi_package.is_installed

test/test_centos_8_support.py

@@ -0,0 +1,68 @@
+from .conftest import (
+    tick_box,
+    info_box,
+    mock_command,
+)
+
+
+def test_php_upgrade_default_continue_centos_gte_8(host):
+    '''
+    confirms the latest version of CentOS continues / does not optout
+    (should trigger on CentOS7 only)
+    '''
+    package_manager_detect = host.run('''
+    source /opt/pihole/basic-install.sh
+    package_manager_detect
+    select_rpm_php
+    ''')
+    unexpected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS.'
+                                    ' Deprecated PHP may be in use.')
+    assert unexpected_stdout not in package_manager_detect.stdout
+    # ensure remi was not installed on latest CentOS
+    remi_package = host.package('remi-release')
+    assert not remi_package.is_installed
+
+
+def test_php_upgrade_user_optout_skipped_centos_gte_8(host):
+    '''
+    confirms installer skips user opt-out of installing PHP7 from REMI on
+    latest CentOS (should trigger on CentOS7 only)
+    (php not currently installed)
+    '''
+    # Whiptail dialog returns Cancel for user prompt
+    mock_command('whiptail', {'*': ('', '1')}, host)
+    package_manager_detect = host.run('''
+    source /opt/pihole/basic-install.sh
+    package_manager_detect
+    select_rpm_php
+    ''')
+    unexpected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS.'
+                                    ' Deprecated PHP may be in use.')
+    assert unexpected_stdout not in package_manager_detect.stdout
+    # ensure remi was not installed on latest CentOS
+    remi_package = host.package('remi-release')
+    assert not remi_package.is_installed
+
+
+def test_php_upgrade_user_optin_skipped_centos_gte_8(host):
+    '''
+    confirms installer skips user opt-in to installing PHP7 from REMI on
+    latest CentOS (should trigger on CentOS7 only)
+    (php not currently installed)
+    '''
+    # Whiptail dialog returns Continue for user prompt
+    mock_command('whiptail', {'*': ('', '0')}, host)
+    package_manager_detect = host.run('''
+    source /opt/pihole/basic-install.sh
+    package_manager_detect
+    select_rpm_php
+    ''')
+    assert 'opt-out' not in package_manager_detect.stdout
+    unexpected_stdout = info_box + (' Enabling Remi\'s RPM repository '
+                                    '(https://rpms.remirepo.net)')
+    assert unexpected_stdout not in package_manager_detect.stdout
+    unexpected_stdout = tick_box + (' Remi\'s RPM repository has '
+                                    'been enabled for PHP7')
+    assert unexpected_stdout not in package_manager_detect.stdout
+    remi_package = host.package('remi-release')
+    assert not remi_package.is_installed

test/test_centos_common_support.py

@@ -0,0 +1,125 @@
+import pytest
+from .conftest import (
+    tick_box,
+    info_box,
+    cross_box,
+    mock_command,
+)
+
+
+def test_release_supported_version_check_centos(host):
+    '''
+    confirms installer exits on unsupported releases of CentOS
+    '''
+    # modify /etc/redhat-release to mock an unsupported CentOS release
+    host.run('echo "CentOS Linux release 6.9" > /etc/redhat-release')
+    package_manager_detect = host.run('''
+    source /opt/pihole/basic-install.sh
+    package_manager_detect
+    select_rpm_php
+    ''')
+    expected_stdout = cross_box + (' CentOS 6 is not supported.')
+    assert expected_stdout in package_manager_detect.stdout
+    expected_stdout = 'Please update to CentOS release 7 or later'
+    assert expected_stdout in package_manager_detect.stdout
+
+
+def test_enable_epel_repository_centos(host):
+    '''
+    confirms the EPEL package repository is enabled when installed on CentOS
+    '''
+    package_manager_detect = host.run('''
+    source /opt/pihole/basic-install.sh
+    package_manager_detect
+    select_rpm_php
+    ''')
+    expected_stdout = info_box + (' Enabling EPEL package repository '
+                                  '(https://fedoraproject.org/wiki/EPEL)')
+    assert expected_stdout in package_manager_detect.stdout
+    expected_stdout = tick_box + ' Installed epel-release'
+    assert expected_stdout in package_manager_detect.stdout
+    epel_package = host.package('epel-release')
+    assert epel_package.is_installed
+
+
+def test_php_version_lt_7_detected_upgrade_default_optout_centos(host):
+    '''
+    confirms the default behavior to opt-out of upgrading to PHP7 from REMI
+    '''
+    # first we will install the default php version to test installer behavior
+    php_install = host.run('yum install -y php')
+    assert php_install.rc == 0
+    php_package = host.package('php')
+    default_centos_php_version = php_package.version.split('.')[0]
+    if int(default_centos_php_version) >= 7:  # PHP7 is supported/recommended
+        pytest.skip("Test deprecated . Detected default PHP version >= 7")
+    package_manager_detect = host.run('''
+    source /opt/pihole/basic-install.sh
+    package_manager_detect
+    select_rpm_php
+    ''')
+    expected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS. '
+                                  'Deprecated PHP may be in use.')
+    assert expected_stdout in package_manager_detect.stdout
+    remi_package = host.package('remi-release')
+    assert not remi_package.is_installed
+
+
+def test_php_version_lt_7_detected_upgrade_user_optout_centos(host):
+    '''
+    confirms installer behavior when user opt-out to upgrade to PHP7 via REMI
+    '''
+    # first we will install the default php version to test installer behavior
+    php_install = host.run('yum install -y php')
+    assert php_install.rc == 0
+    php_package = host.package('php')
+    default_centos_php_version = php_package.version.split('.')[0]
+    if int(default_centos_php_version) >= 7:  # PHP7 is supported/recommended
+        pytest.skip("Test deprecated . Detected default PHP version >= 7")
+    # Whiptail dialog returns Cancel for user prompt
+    mock_command('whiptail', {'*': ('', '1')}, host)
+    package_manager_detect = host.run('''
+    source /opt/pihole/basic-install.sh
+    package_manager_detect
+    select_rpm_php
+    ''')
+    expected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS. '
+                                  'Deprecated PHP may be in use.')
+    assert expected_stdout in package_manager_detect.stdout
+    remi_package = host.package('remi-release')
+    assert not remi_package.is_installed
+
+
+def test_php_version_lt_7_detected_upgrade_user_optin_centos(host):
+    '''
+    confirms installer behavior when user opt-in to upgrade to PHP7 via REMI
+    '''
+    # first we will install the default php version to test installer behavior
+    php_install = host.run('yum install -y php')
+    assert php_install.rc == 0
+    php_package = host.package('php')
+    default_centos_php_version = php_package.version.split('.')[0]
+    if int(default_centos_php_version) >= 7:  # PHP7 is supported/recommended
+        pytest.skip("Test deprecated . Detected default PHP version >= 7")
+    # Whiptail dialog returns Continue for user prompt
+    mock_command('whiptail', {'*': ('', '0')}, host)
+    package_manager_detect = host.run('''
+    source /opt/pihole/basic-install.sh
+    package_manager_detect
+    select_rpm_php
+    install_dependent_packages PIHOLE_WEB_DEPS[@]
+    ''')
+    expected_stdout = info_box + (' User opt-out of PHP 7 upgrade on CentOS. '
+                                  'Deprecated PHP may be in use.')
+    assert expected_stdout not in package_manager_detect.stdout
+    expected_stdout = info_box + (' Enabling Remi\'s RPM repository '
+                                  '(https://rpms.remirepo.net)')
+    assert expected_stdout in package_manager_detect.stdout
+    expected_stdout = tick_box + (' Remi\'s RPM repository has '
+                                  'been enabled for PHP7')
+    assert expected_stdout in package_manager_detect.stdout
+    remi_package = host.package('remi-release')
+    assert remi_package.is_installed
+    updated_php_package = host.package('php')
+    updated_php_version = updated_php_package.version.split('.')[0]
+    assert int(updated_php_version) == 7

test/test_centos_fedora_common_support.py

@@ -0,0 +1,65 @@
+from .conftest import (
+    tick_box,
+    cross_box,
+    mock_command,
+)
+
+
+def mock_selinux_config(state, host):
+    '''
+    Creates a mock SELinux config file with expected content
+    '''
+    # validate state string
+    valid_states = ['enforcing', 'permissive', 'disabled']
+    assert state in valid_states
+    # getenforce returns the running state of SELinux
+    mock_command('getenforce', {'*': (state.capitalize(), '0')}, host)
+    # create mock configuration with desired content
+    host.run('''
+    mkdir /etc/selinux
+    echo "SELINUX={state}" > /etc/selinux/config
+    '''.format(state=state.lower()))
+
+
+def test_selinux_enforcing_exit(host):
+    '''
+    confirms installer prompts to exit when SELinux is Enforcing by default
+    '''
+    mock_selinux_config("enforcing", host)
+    check_selinux = host.run('''
+    source /opt/pihole/basic-install.sh
+    checkSelinux
+    ''')
+    expected_stdout = cross_box + ' Current SELinux: Enforcing'
+    assert expected_stdout in check_selinux.stdout
+    expected_stdout = 'SELinux Enforcing detected, exiting installer'
+    assert expected_stdout in check_selinux.stdout
+    assert check_selinux.rc == 1
+
+
+def test_selinux_permissive(host):
+    '''
+    confirms installer continues when SELinux is Permissive
+    '''
+    mock_selinux_config("permissive", host)
+    check_selinux = host.run('''
+    source /opt/pihole/basic-install.sh
+    checkSelinux
+    ''')
+    expected_stdout = tick_box + ' Current SELinux: Permissive'
+    assert expected_stdout in check_selinux.stdout
+    assert check_selinux.rc == 0
+
+
+def test_selinux_disabled(host):
+    '''
+    confirms installer continues when SELinux is Disabled
+    '''
+    mock_selinux_config("disabled", host)
+    check_selinux = host.run('''
+    source /opt/pihole/basic-install.sh
+    checkSelinux
+    ''')
+    expected_stdout = tick_box + ' Current SELinux: Disabled'
+    assert expected_stdout in check_selinux.stdout
+    assert check_selinux.rc == 0

test/test_fedora_support.py

@@ -0,0 +1,16 @@
+def test_epel_and_remi_not_installed_fedora(host):
+    '''
+    confirms installer does not attempt to install EPEL/REMI repositories
+    on Fedora
+    '''
+    package_manager_detect = host.run('''
+    source /opt/pihole/basic-install.sh
+    package_manager_detect
+    select_rpm_php
+    ''')
+    assert package_manager_detect.stdout == ''
+
+    epel_package = host.package('epel-release')
+    assert not epel_package.is_installed
+    remi_package = host.package('remi-release')
+    assert not remi_package.is_installed

test/test_shellcheck.py

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

test/tox.centos_7.ini

@@ -0,0 +1,8 @@
+[tox]
+envlist = py38
+
+[testenv]
+whitelist_externals = docker
+deps = -rrequirements.txt
+commands = docker build -f _centos_7.Dockerfile -t pytest_pihole:test_container ../
+           pytest {posargs:-vv -n auto} ./test_automated_install.py ./test_centos_fedora_common_support.py ./test_centos_common_support.py ./test_centos_7_support.py

test/tox.centos_8.ini

@@ -0,0 +1,8 @@
+[tox]
+envlist = py38
+
+[testenv]
+whitelist_externals = docker
+deps = -rrequirements.txt
+commands = docker build -f _centos_8.Dockerfile -t pytest_pihole:test_container ../
+           pytest {posargs:-vv -n auto} ./test_automated_install.py ./test_centos_fedora_common_support.py ./test_centos_common_support.py ./test_centos_8_support.py

test/tox.debian_10.ini

@@ -0,0 +1,8 @@
+[tox]
+envlist = py38
+
+[testenv]
+whitelist_externals = docker
+deps = -rrequirements.txt
+commands = docker build -f _debian_10.Dockerfile -t pytest_pihole:test_container ../
+           pytest {posargs:-vv -n auto} ./test_automated_install.py

test/tox.debian_11.ini

@@ -0,0 +1,8 @@
+[tox]
+envlist = py38
+
+[testenv]
+whitelist_externals = docker
+deps = -rrequirements.txt
+commands = docker build -f _debian_11.Dockerfile -t pytest_pihole:test_container ../
+           pytest {posargs:-vv -n auto} ./test_automated_install.py