Merge pull request #2056 from pi-hole/release/v3.3.1

Pi-hole core v3.3.1

.github/ISSUE_TEMPLATE.md

@@ -1,33 +1,37 @@
-**In raising this issue, I confirm the following (please check boxes, eg [X]) Failure to fill the template will close your issue:**
+**In raising this issue, I confirm the following:** `{please fill the checkboxes, e.g: [X]}`
 
 - [] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md).
-- [] The issue I am reporting can be *replicated*
+- [] 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?:**
+**How familiar are you with the the source code relevant to this issue?:**
 
-_{replace this text with a number from 1 to 10, with 1 being not familiar, and 10 being very familiar}_
+`{Replace this with a number from 1 to 10. 1 being not familiar, and 10 being very familiar}`
 
 ---
-**[FEATURE REQUEST | QUESTION | OTHER]:**
+**Expected behaviour:**
 
-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.
+`{A detailed description of what you expect to see}`
 
-**[BUG | ISSUE] Expected Behaviour:**
+**Actual behaviour:**
 
+`{A detailed description and/or screenshots of what you do see}`
 
-**[BUG | ISSUE] Actual Behaviour:**
+**Steps to reproduce:**
 
+`{Detailed steps of how we can reproduce this}`
 
-**[BUG | ISSUE] Steps to reproduce:**
+**Debug token provided by [uploading `pihole -d` log](https://discourse.pi-hole.net/t/the-pihole-command-with-examples/738#debug):**
 
--
--
--
--
+`{Alphanumeric token}`
 
-**(Optional) Debug token generated by `pihole -d`:**
+**Troubleshooting undertaken, and/or other relevant information:**
 
-`<token>`
+`{Steps of what you have done to fix this}`
 
-_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
+> * `{Please delete this quoted section when opening your issue}`
+> * You must follow the template instructions. Failure to do so will result in your issue being closed.
+> * Please [submit any feature requests here](https://discourse.pi-hole.net/c/feature-requests), so it is votable and trackable by the community.
+> * Please respect that Pi-hole is developed by volunteers, who can only reply in their spare time.
+> * Detail helps us understand and resolve an issue quicker, but please ensure it's relevant.
+> * _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 +1,31 @@
-**By submitting this pull request, I confirm the following (please check boxes, eg [X]) _Failure to fill the template will close your PR_:**
+**By submitting this pull request, I confirm the following:** 
+*please fill any appropriate checkboxes, e.g: [X]*
 
-***Please submit all pull requests against the `development` branch. Failure to do so will delay or deny your request***
+- [ ] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md), as well as this entire template.
+- [ ] I have made only one major change in my proposed changes.
+- [ ] I have commented my proposed changes within the code.
+- [ ] I have tested my proposed changes, and have included unit tests where possible.
+- [ ] I am willing to help maintain this change if there are issues with it later.
+- [ ] I give this submission freely and claim no ownership.
+- [ ] It is compatible with the [EUPL 1.2 license](https://opensource.org/licenses/EUPL-1.1)
+- [ ] I have squashed any insignificant commits. ([`git rebase`](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html))
 
-- [] 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}_
+Please make sure you [Sign Off](https://github.com/pi-hole/pi-hole/wiki/How-to-signoff-your-commits.) all commits. Pi-hole enforces the [DCO](https://github.com/pi-hole/pi-hole/wiki/Contributing-to-the-project).
 
 ---
-_{replace this line with your pull request content}_
+**What does this PR aim to accomplish?:**
+*A detailed description, screenshots (if necessary), as well as links to any relevant GitHub issues*
 
 
-_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
+**How does this PR accomplish the above?:**
+*A detailed description (such as a changelog) and screenshots (if necessary) of the implemented fix*
+
+
+**What documentation changes (if any) are needed to support this PR?:**
+*A detailed list of any necessary changes*
+
+
+---
+* You must follow the template instructions. Failure to do so will result in your pull request being closed.
+* Please respect that Pi-hole is developed by volunteers, who can only reply in their spare time.
+

.gitignore

@@ -3,4 +3,69 @@
 *.swp
 __pycache__
 .cache
-.pullapprove.yml
+
+# Created by https://www.gitignore.io/api/jetbrains+iml
+
+### JetBrains+iml ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# All idea files, with execptions
+.idea
+!.idea/codeStyles/*
+!.idea/codeStyleSettings.xml
+
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+# Gradle:
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# CMake
+cmake-build-debug/
+
+# Mongo Explorer plugin:
+.idea/**/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Ruby plugin and RubyMine
+/.rakeTasks
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### JetBrains+iml Patch ###
+# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+
+*.iml
+.idea/misc.xml
+*.ipr
+
+# End of https://www.gitignore.io/api/jetbrains+iml

.idea/codeStyles/Project.xml

@@ -0,0 +1,13 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <option name="OTHER_INDENT_OPTIONS">
+      <value>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </value>
+    </option>
+    <MarkdownNavigatorCodeStyleSettings>
+      <option name="RIGHT_MARGIN" value="72" />
+    </MarkdownNavigatorCodeStyleSettings>
+  </code_scheme>
+</component>

.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

.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)'
-  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:
-      - admin

.stickler.yml

@@ -0,0 +1,3 @@
+linters:
+  shellcheck:
+    shell: bash

CONTRIBUTING.md

@@ -28,6 +28,7 @@ When requesting or submitting new features, first consider whether it might be u
 
 - 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.
+- Read and understand the [DCO guidelines](https://github.com/pi-hole/pi-hole/wiki/Contributing-to-the-project) for the project.
 
 ## Technical Requirements
 

LICENSE

@@ -12,81 +12,63 @@ This license applies to the whole project EXCEPT:
 The licenses that existed prior to this change have remained intact.
 
 -------------------------------------------------------------
+EUROPEAN UNION PUBLIC LICENCE v. 1.2
 
-European Union Public Licence
-V. 1.1
+EUPL © the European Union 2007, 2016
 
-EUPL (C) the European Community 2007
-
-This European Union Public Licence (the "EUPL") applies to the Work or Software (as defined below) which is provided under the terms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such use is covered by a right of the copyright holder of the Work).
-
-The Original Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following notice immediately following the copyright notice for the Original Work:
-
-Licensed under the EUPL V.1.1
-
-or has expressed by any other mean his willingness to license under the EUPL.
+This European Union Public Licence (the EUPL) applies to the Work (as defined below) which is provided under the terms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such use is covered by a right of the copyright holder of the Work).
+The Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following notice immediately following the copyright notice for the Work:
+Licensed under the EUPL
+or has expressed by any other means his willingness to license under the EUPL.
 
 1. Definitions
 
 In this Licence, the following terms have the following meaning:
 
 - The Licence: this Licence.
-
-- The Original Work or the Software: the software distributed and/or communicated by the Licensor under this Licence, available as Source Code and also as Executable Code as the case may be.
-
+- The Original Work: the work or software distributed or communicated by the Licensor under this Licence, available as Source Code and also as Executable Code as the case may be.
 - Derivative Works: the works or software that could be created by the Licensee, based upon the Original Work or modifications thereof. This Licence does not define the extent of modification or dependence on the Original Work required in order to classify a work as a Derivative Work; this extent is determined by copyright law applicable in the country mentioned in Article 15.
-
-- The Work: the Original Work and/or its Derivative Works.
-
+- The Work: the Original Work or its Derivative Works.
 - The Source Code: the human-readable form of the Work which is the most convenient for people to study and modify.
-
 - The Executable Code: any code which has generally been compiled and which is meant to be interpreted by a computer as a program.
-
-- The Licensor: the natural or legal person that distributes and/or communicates the Work under the Licence.
-
+- The Licensor: the natural or legal person that distributes or communicates the Work under the Licence.
 - Contributor(s): any natural or legal person who modifies the Work under the Licence, or otherwise contributes to the creation of a Derivative Work.
-
-- The Licensee or "You": any natural or legal person who makes any usage of the Software under the terms of the Licence.
-
-- Distribution and/or Communication: any act of selling, giving, lending, renting, distributing, communicating, transmitting, or otherwise making available, on-line or off-line, copies of the Work or providing access to its essential functionalities at the disposal of any other natural or legal person.
+- The Licensee or You: any natural or legal person who makes any usage of the Work under the terms of the Licence.
+- Distribution or Communication: any act of selling, giving, lending, renting, distributing, communicating, transmitting, or otherwise making available, online or offline, copies of the Work or providing access to its essential functionalities at the disposal of any other natural or legal person.
 
 2. Scope of the rights granted by the Licence
 
-The Licensor hereby grants You a world-wide, royalty-free, non-exclusive, sub-licensable licence to do the following, for the duration of copyright vested in the Original Work:
-
+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, sublicensable licence to do the following, for the duration of copyright vested in the Original Work:
 - use the Work in any circumstance and for all usage,
 - reproduce the Work,
-- modify the Original Work, and make Derivative Works based upon the Work,
+- modify the Work, and make Derivative Works based upon the Work,
 - communicate to the public, including the right to make available or display the Work or copies thereof to the public and perform publicly, as the case may be, the Work,
 - distribute the Work or copies thereof,
 - lend and rent the Work or copies thereof,
-- sub-license rights in the Work or copies thereof.
-
+- sublicense rights in the Work or copies thereof.
 Those rights can be exercised on any media, supports and formats, whether now known or later invented, as far as the applicable law permits so.
-
 In the countries where moral rights apply, the Licensor waives his right to exercise his moral right to the extent allowed by law in order to make effective the licence of the economic rights here above listed.
-
-The Licensor grants to the Licensee royalty-free, non exclusive usage rights to any patents held by the Licensor, to the extent necessary to make use of the rights granted on the Work under this Licence.
+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to any patents held by the Licensor, to the extent necessary to make use of the rights granted on the Work under this Licence.
 
 3. Communication of the Source Code
 
-The Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as Executable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with each copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to the Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to distribute and/or communicate the Work.
+The Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as Executable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with each copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to the Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to distribute or communicate the Work.
 
 4. Limitations on copyright
 
-Nothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the exclusive rights of the rights owners in the Original Work or Software, of the exhaustion of those rights or of other applicable limitations thereto.
+Nothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the exclusive rights of the rights owners in the Work, of the exhaustion of those rights or of other applicable limitations thereto.
 
 5. Obligations of the Licensee
 
 The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those obligations are the following:
 
-Attribution right: the Licensee shall keep intact all copyright, patent or trademarks notices and all notices that refer to the Licence and to the disclaimer of warranties. The Licensee must include a copy of such notices and a copy of the Licence with every copy of the Work he/she distributes and/or communicates. The Licensee must cause any Derivative Work to carry prominent notices stating that the Work has been modified and the date of modification.
+Attribution right: The Licensee shall keep intact all copyright, patent or trademarks notices and all notices that refer to the Licence and to the disclaimer of warranties. The Licensee must include a copy of such notices and a copy of the Licence with every copy of the Work he/she distributes or communicates. The Licensee must cause any Derivative Work to carry prominent notices stating that the Work has been modified and the date of modification.
 
-Copyleft clause: If the Licensee distributes and/or communicates copies of the Original Works or Derivative Works based upon the Original Work, this Distribution and/or Communication will be done under the terms of this Licence or of a later version of this Licence unless the Original Work is expressly distributed only under this version of the Licence. The Licensee (becoming Licensor) cannot offer or impose any additional terms or conditions on the Work or Derivative Work that alter or restrict the terms of the Licence.
+Copyleft clause: If the Licensee distributes or communicates copies of the Original Works or Derivative Works, this Distribution or Communication will be done under the terms of this Licence or of a later version of this Licence unless the Original Work is expressly distributed only under this version of the Licence - for example by communicating EUPL v. 1.2 only. The Licensee (becoming Licensor) cannot offer or impose any additional terms or conditions on the Work or Derivative Work that alter or restrict the terms of the Licence.
 
-Compatibility clause: If the Licensee Distributes and/or Communicates Derivative Works or copies thereof based upon both the Original Work and another work  licensed under a Compatible Licence, this Distribution and/or Communication can be done under the terms of this Compatible Licence. For the sake of this clause, "Compatible Licence" refers to the licences listed in the appendix attached to this Licence. Should the Licensee’s obligations under the Compatible Licence conflict with his/her obligations under this Licence, the obligations of the Compatible Licence shall prevail.
+Compatibility clause: If the Licensee Distributes or Communicates Derivative Works or copies thereof based upon both the Work and another work licensed under a Compatible Licence, this Distribution or Communication can be done under the terms of this Compatible Licence. For the sake of this clause, Compatible Licence refers to the licences listed in the appendix attached to this Licence. Should the Licensee's obligations under the Compatible Licence conflict with his/her obligations under this Licence, the obligations of the Compatible Licence shall prevail.
 
-Provision of Source Code: When distributing and/or communicating copies of the Work, the Licensee will provide a machine-readable copy of the Source Code or indicate a repository where this Source will be easily and freely available for as long as the Licensee continues to distribute and/or communicate the Work.
+Provision of Source Code: When distributing or communicating copies of the Work, the Licensee will provide a machine-readable copy of the Source Code or indicate a repository where this Source will be easily and freely available for as long as the Licensee continues to distribute or communicate the Work.
 
 Legal Protection: This Licence does not grant permission to use the trade names, trademarks, service marks, or names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the copyright notice.
 
@@ -100,10 +82,8 @@ Each time You accept the Licence, the original Licensor and subsequent Contribut
 
 7. Disclaimer of Warranty
 
-The Work is a work in progress, which is continuously improved by numerous contributors. It is not a finished work and may therefore contain defects or "bugs" inherent to this type of software development.
-
-For the above reason, the Work is provided under the Licence on an "as is" basis and without warranties of any kind concerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or errors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this Licence.
-
+The Work is a work in progress, which is continuously improved by numerous Contributors. It is not a finished work and may therefore contain defects or bugs inherent to this type of development.
+For the above reason, the Work is provided under the Licence on an as is basis and without warranties of any kind concerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or errors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this Licence.
 This disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work.
 
 8. Disclaimer of Liability
@@ -112,56 +92,55 @@ Except in the cases of wilful misconduct or damages directly caused to natural p
 
 9. Additional agreements
 
-While distributing the Original Work or Derivative Works, You may choose to conclude an additional agreement to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or services consistent with this Licence. However, in accepting such obligations, You may act only on your own behalf and on your sole responsibility, not on behalf of the original Licensor or any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against such Contributor by the fact You have accepted any such warranty or additional liability.
+While distributing the Work, You may choose to conclude an additional agreement, defining obligations or services consistent with this Licence. However, if accepting obligations, You may act only on your own behalf and on your sole responsibility, not on behalf of the original Licensor or any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against such Contributor by the fact You have accepted any warranty or additional liability.
 
 10. Acceptance of the Licence
 
-The provisions of this Licence can be accepted by clicking on an icon "I agree" placed under the bottom of a window displaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of applicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms and conditions.
-
-Similarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You by Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution and/or Communication by You of the Work or copies thereof.
+The provisions of this Licence can be accepted by clicking on an icon I agree placed under the bottom of a window displaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of applicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms and conditions.
+Similarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You by Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution or Communication by You of the Work or copies thereof.
 
 11. Information to the public
 
-In case of any Distribution and/or Communication of the Work by means of electronic communication by You (for example, by offering to download the Work from a remote location) the distribution channel or media (for example, a website) must at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence and the way it may be accessible, concluded, stored and reproduced by the Licensee.
+In case of any Distribution or Communication of the Work by means of electronic communication by You (for example, by offering to download the Work from a remote location) the distribution channel or media (for example, a website) must at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence and the way it may be accessible, concluded, stored and reproduced by the Licensee.
 
 12. Termination of the Licence
 
 The Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms of the Licence.
-
 Such a termination will not terminate the licences of any person who has received the Work from the Licensee under the Licence, provided such persons remain in full compliance with the Licence.
 
 13. Miscellaneous
 
-Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the Work licensed hereunder.
-
-If any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or enforceability of the Licence as a whole. Such provision will be construed and/or reformed so as necessary to make it valid and enforceable.
-
-The European Commission may publish other linguistic versions and/or new versions of this Licence, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence. New versions of the Licence will be published with a unique version number.
-
+Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the Work.
+If any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or enforceability of the Licence as a whole. Such provision will be construed or reformed so as necessary to make it valid and enforceable.
+The European Commission may publish other linguistic versions or new versions of this Licence or updated versions of the Appendix, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence. New versions of the Licence will be published with a unique version number.
 All linguistic versions of this Licence, approved by the European Commission, have identical value. Parties can take advantage of the linguistic version of their choice.
 
 14. Jurisdiction
 
-Any litigation resulting from the interpretation of this License, arising between the European Commission, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice of the European Communities, as laid down in article 238 of the Treaty establishing the European Community.
-
-Any litigation arising between Parties, other than the European Commission, and resulting from the interpretation of this License, will be subject to the exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business.
+Without prejudice to specific agreement between parties,
+- any litigation resulting from the interpretation of this License, arising between the European Union institutions, bodies, offices or agencies, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice of the European Union, as laid down in article 272 of the Treaty on the Functioning of the European Union,
+- any litigation arising between other parties and resulting from the interpretation of this License, will be subject to the exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business.
 
 15. Applicable Law
 
-This Licence shall be governed by the law of the European Union country where the Licensor resides or has his registered office.
-
-This licence shall be governed by the Belgian law if:
-
-- a litigation arises between the European Commission, as a Licensor, and any Licensee;
-- the Licensor, other than the European Commission, has no residence or registered office inside a European Union country.
-
+Without prejudice to specific agreement between parties,
+- this Licence shall be governed by the law of the European Union Member State where the Licensor has his seat, resides or has his registered office,
+- this licence shall be governed by Belgian law if the Licensor has no seat, residence or registered office inside a European Union Member State.
 
 ===
+
 Appendix
 
-"Compatible Licences" according to article 5 EUPL are:
-- GNU General Public License (GNU GPL) v. 2
+Compatible Licences according to Article 5 EUPL are:
+- GNU General Public License (GPL) v. 2, v. 3
+- GNU Affero General Public License (AGPL) v. 3
 - Open Software License (OSL) v. 2.1, v. 3.0
-- Common Public License v. 1.0
-- Eclipse Public License v. 1.0
-- Cecill v. 2.0
+- Eclipse Public License (EPL) v. 1.0
+- CeCILL v. 2.0, v. 2.1
+- Mozilla Public Licence (MPL) v. 2
+- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
+- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for works other than software
+- European Union Public Licence (EUPL) v. 1.1, v. 1.2
+- Québec Free and Open-Source Licence - Reciprocity (LiLiQ-R) or Strong Reciprocity (LiLiQ-R+)
+- The European Commission may update this Appendix to later versions of the above licences without producing a new version of the EUPL, as long as they provide the rights granted in Article 2 of this Licence and protect the covered Source Code from exclusive appropriation.
+-  All other changes or additions to this Appendix require the production of a new EUPL version.

README.md

@@ -1,175 +1,217 @@
 <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>
+<a href="https://pi-hole.net"><img src="https://pi-hole.github.io/graphics/Vortex/Vortex_with_text.png" width="150" height="255" alt="Pi-hole"></a><br/>
+<b>Network-wide ad blocking via your own Linux hardware</b><br/>
 </p>
 
-<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>
-</p>
+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.
 
-## The multi-platform, network-wide ad blocker
+- **Easy-to-install**: our versatile installer walks you through the process, and [takes less than ten minutes](https://www.youtube.com/watch?v=vKWjx1AQYgs)
+- **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://discourse.pi-hole.net/t/hardware-software-requirements/273)
+- **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 which helps ensure _you_ are the sole person in control of your privacy
 
-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.
+-----
+<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" alt="Codacy Grade"/></a>
+<a href="https://travis-ci.org/pi-hole/pi-hole"><img src="https://travis-ci.org/pi-hole/pi-hole.svg?branch=development" alt="Travis Build Status"/></a>
+<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" alt="BountySource"/></a>
 
-- Web Browsers
-- Cell Phones
-- Smart TV's
-- Internet-connected home automation
-- Anything that communicates with the Internet
+## One-Step Automated Install
+Those who want to get started quickly and conveniently, may install Pi-hole using the following command:
 
-<p align="center">
-<a href=http://www.digitalocean.com/?refcode=344d234950e1><img src="https://assets.pi-hole.net/static/DOHostingSlug.png"></a>
-</p>
+#### `curl -sSL https://install.pi-hole.net | bash`
 
-## Your Support Still Matters
-
-Digital Ocean helps with our infrastructure, but our developers are all volunteers so *your donations help keep us innovating*. Sending a donation using our links below helps us offset a portion of our monthly costs.
-
--   ![Paypal](https://assets.pi-hole.net/static/paypal.png) [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
--   ![Bitcoin](https://assets.pi-hole.net/static/Bitcoin.png) Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
-
-### One-Step Automated Install
-1.  Install a [supported operating system](https://discourse.pi-hole.net/t/hardware-software-requirements/273/1)
-2.  Run the command below (it downloads [this script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) in case you want to read over it first!)
-
-### `curl -sSL https://install.pi-hole.net | bash`
-
-#### Alternative Semi-Automated Install Methods
-_If you wish to read over the script before running it, run `nano basic-install.sh` to open the file in a text viewer._
-
-##### Clone our repository and run the automated installer from your device.
+## Alternative Install Methods
+[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
 ```
 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
-
-```bash
+### Method 2: Manually download the installer and run
+```
 wget -O basic-install.sh https://install.pi-hole.net
-bash basic-install.sh
+sudo bash basic-install.sh
 ```
 
-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
 
-## 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); just 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 always 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
+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, as well as the importance of keeping it maintained.
 
-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.
+Make no mistake: **your support is absolutely vital to help keep us innovating!**
 
-### Gravity
+### Donations
+Sending a donation using our links below is **extremely helpful** in offsetting a portion of our monthly expenses:
 
-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`.
+&nbsp;<img src="https://pi-hole.github.io/graphics/Badges/paypal-badge-black.svg" width="24" height="24" alt="PP"/> <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY">Donate via PayPal</a><br/>
+&nbsp;<img src="https://pi-hole.github.io/graphics/Badges/bitcoin-badge-black.svg" width="24" height="24" alt="BTC"/> Bitcoin Address: <code>1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL</code>
 
+### Alternative support
+If you'd rather not donate (_which is okay!_), there are other ways you can help support us:
 
+- [Digital Ocean](http://www.digitalocean.com/?refcode=344d234950e1) affiliate link
+- [Vultr](http://www.vultr.com/?ref=7190426) affiliate link
+- [UNIXstickers.com](http://unixstickers.refr.cc/jacobs) affiliate link
+- [Pi-hole Swag Store](https://pi-hole.net/shop/)
+- Spreading the word about our software, and how you have benefited from it
 
-#### Other Operating Systems
+### Contributing via GitHub
+We welcome _everyone_ to contribute to issue reports, suggest new features, and create pull requests.
 
-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.
+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 that it asks will help the volunteers quickly understand what you're aiming to achieve.
 
-### Web Interface
+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.
 
-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:
+### Presentations about Pi-hole
+Word-of-mouth continues to help our project grow immensely, and so we are helping make this easier for people.
 
-`http://192.168.1.x/admin/index.php` or `http://pi.hole/admin`
+If you are going to be presenting Pi-hole at a conference, meetup or even a school project, [get in touch with us](https://pi-hole.net/2017/05/17/giving-a-presentation-on-pi-hole-contact-us-first-for-some-goodies-and-support/) so we can hook you up with free swag to hand out to your audience!
 
-![Pi-hole Advanced Stats Dashboard](https://assets.pi-hole.net/static/dashboard212.png)
+-----
 
-### Whitelist and blacklist
+## Getting in touch with us
+While we are primarily reachable on our <a href="https://discourse.pi-hole.net/">Discourse User Forum</a>, we can also be found on a variety of social media outlets. **Please be sure to check the FAQ's** before starting a new discussion, as we do not have the spare time to reply to every request for assistance.
 
-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>
+<ul>
+  <li><a href="https://discourse.pi-hole.net/c/faqs">Frequently Asked Questions</a></li>
+  <li><a href="https://github.com/pi-hole/pi-hole/wiki">Pi-hole Wiki</a></li>
+  <li><a href="https://discourse.pi-hole.net/c/feature-requests?order=votes">Feature Requests</a></li>
+</ul>
+<br/>
+<ul>
+  <li><a href="https://discourse.pi-hole.net/">Discourse User Forum</a></li>
+  <li><a href="https://www.reddit.com/r/pihole/">Reddit</a></li>
+  <li><a href="https://gitter.im/pi-hole/pi-hole">Gitter</a> (Real-time chat)</li>
+  <li><a href="https://twitter.com/The_Pi_Hole">Twitter</a></li>
+  <li><a href="https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w">YouTube</a></li>
+  <li><a href="https://www.facebook.com/ThePiHole/">Facebook</a></li>
+</ul>
 
-### Settings
+-----
 
-The settings page lets you control and configure your Pi-hole™.  You can do things like:
+## Breakdown of Features
+### The Command Line Interface
+The `pihole` command has all the functionality necessary to be able to fully administer the Pi-hole, without the need of the Web Interface. It's fast, user-friendly, and auditable by anyone with understanding of `bash`.
 
-- enable Pi-hole's built-in DHCP server
-- exclude domains from the graphs
-- configure upstream DNS servers
-- and more!
+<a href="https://pi-hole.github.io/graphics/Screenshots/blacklist-cli.gif"><img src="https://pi-hole.github.io/graphics/Screenshots/blacklist-cli.gif" alt="Pi-hole Blacklist Demo"/></a>
 
-![Settings page](https://assets.pi-hole.net/static/settings212.png)
+Some notable features include:
+* [Whitelisting, Blacklisting and Wildcards](https://github.com/pi-hole/pi-hole/wiki/Core-Function-Breakdown#whitelisting-blacklisting-and-wildcards)
+* [Debugging utility](https://github.com/pi-hole/pi-hole/wiki/Core-Function-Breakdown#debugger)
+* [Viewing the live log file](https://github.com/pi-hole/pi-hole/wiki/Core-Function-Breakdown#tail)
+* [Real-time Statistics via `ssh`](https://github.com/pi-hole/pi-hole/wiki/Core-Function-Breakdown#chronometer) or [your TFT LCD screen](http://www.amazon.com/exec/obidos/ASIN/B00ID39LM4/pihole09-20)
+* [Updating Ad Lists](https://github.com/pi-hole/pi-hole/wiki/Core-Function-Breakdown#gravity)
+* [Querying Ad Lists for blocked domains](https://github.com/pi-hole/pi-hole/wiki/Core-Function-Breakdown#query)
+* [Enabling and Disabling Pi-hole](https://github.com/pi-hole/pi-hole/wiki/Core-Function-Breakdown#enable--disable)
+* ... and *many* more!
 
-#### Built-in DHCP Server
+You can read our [Core Feature Breakdown](https://github.com/pi-hole/pi-hole/wiki/Core-Function-Breakdown), as well as read up on [example usage](https://discourse.pi-hole.net/t/the-pihole-command-with-examples/738) for more information.
 
-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>
+### 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!
 
-## API
+<a href="https://pi-hole.github.io/graphics/Screenshots/dashboard.png"><img src="https://pi-hole.github.io/graphics/Screenshots/dashboard.png" width="888" height="522" alt="Pi-hole Dashboard"/></a>
 
-A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON:
+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!
 
-``` json
-{
-    "domains_being_blocked": "136708",
-    "dns_queries_today": "18108",
-    "ads_blocked_today": "14648",
-    "ads_percentage_today": "80.89"
-}
-```
+There are several ways to [access the dashboard](https://discourse.pi-hole.net/t/how-do-i-access-pi-holes-dashboard-admin-interface/3168):
 
-The same output can be achieved on the CLI by running `chronometer.sh -j`
+1. `http://<IP_ADDPRESS_OF_YOUR_PI_HOLE>/admin/`
+2. `http:/pi.hole/admin/` (when using Pi-hole as your DNS server)
+3. `http://pi.hole/` (when using Pi-hole as your DNS server)
 
-## Real-time Statistics
+## The Faster-Than-Light Engine
+The [FTL Engine](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, FTL does this all *very quickly*!
 
-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)
+Some of the statistics you can integrate include:
+* 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
 
-## Pi-hole™ Projects
+The API can be accessed via [`telnet`](https://github.com/pi-hole/FTL), the Web (`admin/api.php`) and Command Line (`pihole -c -j`). You can out find [more details over here](https://discourse.pi-hole.net/t/pi-hole-api/1863).
 
--   [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)
+-----
+
+## The Origin Of Pi-hole
+Pi-hole being a **advertising-aware DNS/Web server**, makes use of the following technologies:
+
+* [`dnsmasq`](http://www.thekelleys.org.uk/dnsmasq/doc.html) - a lightweight DNS and DHCP server
+* [`curl`](https://curl.haxx.se) - A command line tool for transferring data with URL syntax
+* [`lighttpd`](https://www.lighttpd.net) - webserver designed and optimized for high performance
+* [`php`](https://secure.php.net) - a popular general-purpose web scripting language
+* [AdminLTE Dashboard](https://github.com/almasaeed2010/AdminLTE) - premium admin control panel based on Bootstrap 3.x
+
+While quite outdated at this point, [this original blog post about Pi-hole](https://jacobsalmela.com/2015/06/16/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0/) goes into **great detail** about how Pi-hole was originally setup and how it works. Syntactically, it's no longer accurate, but the same basic principles and logic still apply to Pi-hole's current state.
+
+-----
+
+## Pi-hole Projects
+- [The Big Blocklist Collection](https://wally3k.github.io)
+- [Docker Pi-hole container (x86 and ARM)](https://hub.docker.com/r/diginc/pi-hole/)
+- [Pi-Hole in the cloud](http://blog.codybunch.com/2015/07/28/Pi-Hole-in-the-cloud/)
+- [Pie in the Sky-Hole [A Pi-Hole in the cloud for ad-blocking via DNS]](https://dlaa.me/blog/post/skyhole)
+- [Pi-hole Enable/Disable Button](http://thetimmy.silvernight.org/pages/endisbutton/)
+- [Minibian Pi-hole](https://munkjensen.net/wiki/index.php/See_my_Pi-Hole#Minibian_Pi-hole)
+- [CHiP-hole: Network-wide Ad-blocker](https://www.hackster.io/jacobsalmela/chip-hole-network-wide-ad-blocker-98e037)
+- [Chrome Extension: Pi-Hole List Editor](https://chrome.google.com/webstore/detail/pi-hole-list-editor/hlnoeoejkllgkjbnnnhfolapllcnaglh) ([Source Code](https://github.com/packtloss/pihole-extension))
+- [Splunk: Pi-hole Visualiser](https://splunkbase.splunk.com/app/3023/)
+- [Adblocking with Pi-hole and Ubuntu 14.04 on VirtualBox](https://hbalagtas.blogspot.com.au/2016/02/adblocking-with-pi-hole-and-ubuntu-1404.html)
+- [Pi-hole stats in your Mac's menu bar](https://getbitbar.com/plugins/Network/pi-hole.1m.py)
+- [Pi-hole unRAID Template](https://forums.lime-technology.com/topic/36810-support-spants-nodered-mqtt-dashing-couchdb/)
+- [Copernicus: Windows Tray Application](https://github.com/goldbattle/copernicus)
+- [Let your blink1 device blink when Pi-hole filters ads](https://gist.github.com/elpatron68/ec0b4c582e5abf604885ac1e068d233f)
+- [Pi-hole metrics](https://github.com/nlamirault/pihole_exporter) exporter for [Prometheus](https://prometheus.io/)
+- [Magic Mirror with DNS Filtering](https://zonksec.com/blog/magic-mirror-dns-filtering/#dnssoftware)
+- [Pi-hole Droid: 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)
+-----
 
 ## Coverage
-
--   [Adafruit livestream install](https://www.youtube.com/watch?v=eg4u2j1HYlI)
--   [TekThing: 5 fun, easy projects for a Raspberry Pi](https://youtu.be/QwrKlyC2kdM?t=1m42s)
--   [Pi-hole on Adafruit's blog](https://blog.adafruit.com/2016/03/04/pi-hole-is-a-black-hole-for-internet-ads-piday-raspberrypi-raspberry_pi/)
--   [The Defrag Show - MSDN/Channel 9](https://channel9.msdn.com/Shows/The-Defrag-Show/Defrag-Endoscope-USB-Camera-The-Final-HoloLens-Vote-Adblock-Pi-and-more?WT.mc_id=dlvr_twitter_ch9#time=20m39s)
--   [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/)
+- [Lifehacker: Turn A Raspberry Pi Into An Ad Blocker With A Single Command](https://www.lifehacker.com.au/2015/02/turn-a-raspberry-pi-into-an-ad-blocker-with-a-single-command/)
+- [MakeUseOf: Adblock Everywhere: The Raspberry Pi-Hole Way](http://www.makeuseof.com/tag/adblock-everywhere-raspberry-pi-hole-way/)
+- [Catchpoint: Ad-Blocking on Apple iOS9: Valuing the End User Experience](http://blog.catchpoint.com/2015/09/14/ad-blocking-apple/)
+- [Security Now Netcast: Pi-hole](https://www.youtube.com/watch?v=p7-osq_y8i8&t=100m26s)
+- [TekThing: Raspberry Pi-Hole Makes Ads Disappear!](https://youtu.be/8Co59HU2gY0?t=2m)
+- [Foolish Tech Show](https://youtu.be/bYyena0I9yc?t=2m4s)
+- [Block Ads on All Home Devices for $53.18](https://medium.com/@robleathern/block-ads-on-all-home-devices-for-53-18-a5f1ec139693#.gj1xpgr5d)
+- [Pi-Hole for Ubuntu 14.04](http://www.boyter.org/2015/12/pi-hole-ubuntu-14-04/)
+- [MacObserver Podcast 585](https://www.macobserver.com/tmo/podcast/macgeekgab-585)
+- [The Defrag Show: Endoscope USB Camera, The Final [HoloLens] Vote, Adblock Pi and more](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)
+- [Adafruit: Pi-hole is a black hole for internet ads](https://blog.adafruit.com/2016/03/04/pi-hole-is-a-black-hole-for-internet-ads-piday-raspberrypi-raspberry_pi/)
+- [Digital Trends: 5 Fun, Easy Projects You Can Try With a $35 Raspberry Pi](https://youtu.be/QwrKlyC2kdM?t=1m42s)
+- [Adafruit: Raspberry Pi Quick Look at Pi Hole ad blocking server with Tony D](https://www.youtube.com/watch?v=eg4u2j1HYlI)
+- [Devacron: OrangePi Zero as an Ad-Block server with Pi-Hole](http://www.devacron.com/orangepi-zero-as-an-ad-block-server-with-pi-hole/)
+- [Linux Pro: The Hole Truth](http://www.linuxpromagazine.com/Issues/2017/200/The-sysadmin-s-daily-grind-Pi-hole)
+- [CryptoAUSTRALIA: How We Tried 5 Privacy Focused Raspberry Pi Projects](https://blog.cryptoaustralia.org.au/2017/10/05/5-privacy-focused-raspberry-pi-projects/)
+- [CryptoAUSTRALIA: Pi-hole Workshop](https://blog.cryptoaustralia.org.au/2017/11/02/pi-hole-network-wide-ad-blocker/)
+- [Know How 355: Killing ads with a Raspberry Pi-Hole!](https://www.twit.tv/shows/know-how/episodes/355)

advanced/01-pihole.conf

@@ -21,6 +21,7 @@
 ###############################################################################
 
 addn-hosts=/etc/pihole/gravity.list
+addn-hosts=/etc/pihole/black.list
 addn-hosts=/etc/pihole/local.list
 
 domain-needed
@@ -38,9 +39,9 @@ interface=@INT@
 
 cache-size=10000
 
-log-queries
+log-queries=extra
 log-facility=/var/log/pihole.log
 
-local-ttl=300
+local-ttl=2
 
 log-async

advanced/Scripts/COL_TABLE

@@ -0,0 +1,49 @@
+# Determine if terminal is capable of showing colours
+if [[ -t 1 ]] && [[ $(tput colors) -ge 8 ]]; then
+  # Bold and underline may not show up on all clients
+  # If something MUST be emphasised, 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,102 +8,566 @@
 #
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
+LC_NUMERIC=C
 
-#Functions##############################################################################################################
-piLog="/var/log/pihole.log"
-gravity="/etc/pihole/gravity.list"
-
-. /etc/pihole/setupVars.conf
-
-function GetFTLData {
+# 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/"$(cat /var/run/pihole-FTL.port)"
+    exec 3<>"/dev/tcp/127.0.0.1/$ftl_port"
 
     # Test if connection is open
-    if { >&3; } 2> /dev/null; then
-       # Send command to FTL
-       echo -e ">$1" >&3
+    if { "true" >&3; } 2> /dev/null; then
+      # Send command to FTL
+      echo -e ">$1" >&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
+      read -r -t 1 LINE <&3
+      until [[ ! $? ]] || [[ "$LINE" == *"EOM"* ]]; do
+         echo "$LINE" >&1
+         read -r -t 1 LINE <&3
+      done
 
-       # Close connection
-       exec 3>&-
-       exec 3<&-
+      # Close connection
+      exec 3>&-
+      exec 3<&-
    fi
+  else
+    echo "0"
+  fi
 }
 
-outputJSON() {
-	get_summary_data
-	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}}"
+# Print spaces to align right-side additional text
+printFunc() {
+  local text_last
+
+  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 colours
+    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: Visualise 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
 }
 
-get_summary_data() {
-	local summary=$(GetFTLData "stats")
-	domains_being_blocked_raw=$(grep "domains_being_blocked" <<< "${summary}" | grep -Eo "[0-9]+$")
-	domains_being_blocked=$(printf "%'.f" ${domains_being_blocked_raw})
-	dns_queries_today_raw=$(grep "dns_queries_today" <<< "$summary" | grep -Eo "[0-9]+$")
-	dns_queries_today=$(printf "%'.f" ${dns_queries_today_raw})
-	ads_blocked_today_raw=$(grep "ads_blocked_today" <<< "$summary" | grep -Eo "[0-9]+$")
-	ads_blocked_today=$(printf "%'.f" ${ads_blocked_today_raw})
-	ads_percentage_today_raw=$(grep "ads_percentage_today" <<< "$summary" | grep -Eo "[0-9.]+$")
-	LC_NUMERIC=C ads_percentage_today=$(printf "%'.f" ${ads_percentage_today_raw})
+# Perform on first Chrono run (not for JSON formatted string)
+get_init_stats() {
+  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 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
+
+  # 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
+
+    sys_throttle_raw=$(vgt=$(sudo vcgencmd get_throttled); echo "${vgt##*x}")
+
+    # Active Throttle Notice: http://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
+
+    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
+      *) 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 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
 }
 
-normalChrono() {
-	for (( ; ; )); do
-		get_summary_data
-		domain=$(GetFTLData recentBlocked)
-		clear
-		# Displays a colorful Pi-hole logo
-		echo " ___ _     _        _"
-		echo "| _ (_)___| |_  ___| |___"
-		echo "|  _/ |___| ' \/ _ \ / -_)"
-		echo "|_| |_|   |_||_\___/_\___|"
-		echo ""
-		echo "        ${IPV4_ADDRESS}"
-		echo ""
-		uptime | cut -d' ' -f11-
-		#uptime -p	#Doesn't work on all versions of uptime
-		uptime | awk -F'( |,|:)+' '{if ($7=="min") m=$6; else {if ($7~/^day/) {d=$6;h=$8;m=$9} else {h=$6;m=$7}}} {print d+0,"days,",h+0,"hours,",m+0,"minutes."}'
-		echo "-------------------------------"
-		echo "Recently blocked:"
-		echo "  $domain"
+get_sys_stats() {
+  local ph_ver_raw
+  local cpu_raw
+  local ram_raw
+  local disk_raw
 
-		echo "Blocking:      ${domains_being_blocked}"
-		echo "Queries:       ${dns_queries_today}"
-		echo "Pi-holed:      ${ads_blocked_today} (${ads_percentage_today}%)"
+  # 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"
 
-		sleep 5
-	done
+    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]}"
+      ph_lte_ver="${ph_ver_raw[1]}"
+      ph_ftl_ver="${ph_ver_raw[2]}"
+    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=$(route -n | awk '$4 == "UG" {print $2;exit}')
+
+    # 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
+
+  # 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 behaviour
+  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 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
+
+  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
+    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
 }
 
-displayHelp() {
-	cat << EOM
-::: Displays stats about your piHole!
-:::
-::: Usage: sudo pihole -c [optional:-j]
-::: Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds
-:::
-::: Options:
-:::  -j, --json		output stats as JSON formatted string
-:::  -h, --help		display this help text
-EOM
-    exit 0
+get_ftl_stats() {
+  local stats_raw
+
+  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
+    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 [[ "$*" == *"-r"* ]]; then
+      num="$*"
+      num="${num/*-r /}"
+      num="${num/ */}"
+      num_str="Refresh set for every $num seconds"
+    else
+      num_str=""
+    fi
+
+    clear
+
+    # Remove exit message heading on third refresh
+    if [[ "$count" -le 2 ]] && [[ "$*" != *"-e"* ]]; 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
+| ¯_/¯|_| ' \\/ _ \\ / -_)$lte_ver_str
+|_| |_| |_||_\\___/_\\___|$ftl_ver_str
+ ${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 [[ "$scr_lines" -gt 17 ]] && [[ "$chrono_width" != "small" ]]; then
+      printFunc "  LAN addr: " "${IPV4_ADDRESS/\/*/}" "$lan_info"
+    fi
+
+    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 [[ "$*" == *"-e"* ]]; then
+      exit 0
+    else
+      if [[ "$*" == *"-r"* ]]; 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}}"
+}
+
+helpFunc() {
+    if [[ "$1" == "?" ]]; then
+      echo "Unknown option. Please view 'pihole -c --help' for more information"
+    else
+      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
+  -h, --help          Display this help text"
+  fi
+
+  exit 0
 }
 
 if [[ $# = 0 ]]; then
-	normalChrono
+  chronoFunc
 fi
 
 for var in "$@"; do
-	case "$var" in
-		"-j" | "--json"  ) outputJSON;;
-		"-h" | "--help"  ) displayHelp;;
-		*                ) exit 1;;
-	esac
+  case "$var" in
+    "-j" | "--json"    ) jsonFunc;;
+    "-h" | "--help"    ) helpFunc;;
+    "-r" | "--refresh" ) chronoFunc "$@";;
+    "-e" | "--exit"    ) chronoFunc "$@";;
+    *                  ) helpFunc "?";;
+  esac
 done

advanced/Scripts/list.sh

@@ -3,232 +3,264 @@
 # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
 # Network-wide ad blocking via your own hardware.
 #
-# Whitelists and blacklists domains
+# Whitelist and blacklist domains
 #
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
-
-
-#globals
+# Globals
 basename=pihole
-piholeDir=/etc/${basename}
-whitelist=${piholeDir}/whitelist.txt
-blacklist=${piholeDir}/blacklist.txt
+piholeDir=/etc/"${basename}"
+whitelist="${piholeDir}"/whitelist.txt
+blacklist="${piholeDir}"/blacklist.txt
 readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
 reload=false
 addmode=true
 verbose=true
 
 domList=()
-domToRemoveList=()
 
 listMain=""
 listAlt=""
 
+colfile="/opt/pihole/COL_TABLE"
+source ${colfile}
+
+
 helpFunc() {
+  if [[ "${listMain}" == "${whitelist}" ]]; then
+    param="w"
+    type="white"
+  elif [[ "${listMain}" == "${wildcardlist}" ]]; then
+    param="wild"
+    type="wildcard black"
+  else
+    param="b"
+    type="black"
+  fi
 
-    if [[ ${listMain} == ${whitelist} ]]; then
-        letter="w"
-        word="white"
-    else
-        letter="b"
-        word="black"
-    fi
+    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
 
-	cat << EOM
-::: Immediately ${word}lists one or more domains in the hosts file
-:::
-::: Usage: pihole -${letter} domain1 [domain2 ...]
-:::
-::: Options:
-:::  -d, --delmode            Remove domains from the ${word}list
-:::  -nr, --noreload          Update ${word}list without refreshing dnsmasq
-:::  -q, --quiet              Output is less verbose
-:::  -h, --help               Show this help dialog
-:::  -l, --list               Display your ${word}listed domains
-EOM
-if [[ "${letter}" == "b" ]]; then
-	echo ":::  -wild, --wildcard        Add wildcard entry (only blacklist)"
-fi
-	exit 0
+Options:
+  -d, --delmode       Remove domain(s) from the ${type}list
+  -nr, --noreload     Update ${type}list without refreshing dnsmasq
+  -q, --quiet         Make output less verbose
+  -h, --help          Show this help dialog
+  -l, --list          Display all your ${type}listed domains
+  --nuke              Removes all entries in a list"
+
+  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"
+  # 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"
 }
 
-HandleOther(){
-	# First, convert everything to lowercase
-	domain=$(sed -e "y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/" <<< "$1")
+HandleOther() {
+  # Convert to lowercase
+  domain="${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
+  # Check validity of domain
+  if [[ "${#domain}" -le 253 ]]; then
+    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
+
+  if [[ -n "${validDomain}" ]]; then
+    domList=("${domList[@]}" ${validDomain})
+  else
+    echo -e "  ${CROSS} ${domain} is not a valid argument or domain name!"
+  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}"
-		fi
-	done
+  # Check whitelist file exists, and if not, create it
+  if [[ ! -f "${whitelist}" ]]; then
+    touch "${whitelist}"
+  fi
+
+  # Check blacklist file exists, and if not, create it
+  if [[ ! -f "${blacklist}" ]]; then
+    touch "${blacklist}"
+  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}"
+    fi
+  done
 }
 
 AddDomain() {
-	list="$2"
-    domain=$(EscapeRegexp "$1")
+  list="$2"
+  domain=$(EscapeRegexp "$1")
 
-    if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
+  [[ "${list}" == "${whitelist}" ]] && listname="whitelist"
+  [[ "${list}" == "${blacklist}" ]] && listname="blacklist"
+  [[ "${list}" == "${wildcardlist}" ]] && listname="wildcard blacklist"
 
-		bool=true
-		#Is the domain in the list we want to add it to?
-		grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
+  if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
+    [[ "${list}" == "${whitelist}" && -z "${type}" ]] && type="--whitelist-only"
+    [[ "${list}" == "${blacklist}" && -z "${type}" ]] && type="--blacklist-only"
+    bool=true
+    # Is the domain in the list we want to add it to?
+    grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
 
-		if [[ "${bool}" == false ]]; then
-		  #domain not found in the whitelist file, add it!
-		  if [[ "${verbose}" == true ]]; then
-			echo "::: Adding $1 to $list..."
-		  fi
-		  reload=true
-		  # Add it to the list we want to add it to
-		  echo "$1" >> "${list}"
-		else
-	        if [[ "${verbose}" == true ]]; then
-	            echo "::: ${1} already exists in ${list}, no need to add!"
-	        fi
-		fi
+    if [[ "${bool}" == false ]]; then
+      # Domain not found in the whitelist file, add it!
+      if [[ "${verbose}" == true ]]; then
+      echo -e "  ${INFO} Adding $1 to $listname..."
+      fi
+      reload=true
+      # Add it to the list we want to add it to
+      echo "$1" >> "${list}"
+    else
+      if [[ "${verbose}" == true ]]; then
+        echo -e "  ${INFO} ${1} already exists in ${listname}, no need to add!"
+      fi
+    fi
+  elif [[ "${list}" == "${wildcardlist}" ]]; then
+    source "${piholeDir}/setupVars.conf"
+    # Remove the /* from the end of the IP addresses
+    IPV4_ADDRESS=${IPV4_ADDRESS%/*}
+    IPV6_ADDRESS=${IPV6_ADDRESS%/*}
+    [[ -z "${type}" ]] && type="--wildcard-only"
+    bool=true
+    # Is the domain in the list?
+    grep -e "address=\/${domain}\/" "${wildcardlist}" > /dev/null 2>&1 || bool=false
 
-	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
-		fi
-	fi
+    if [[ "${bool}" == false ]]; then
+      if [[ "${verbose}" == true ]]; then
+      echo -e "  ${INFO} Adding $1 to wildcard blacklist..."
+      fi
+      reload="restart"
+      echo "address=/$1/${IPV4_ADDRESS}" >> "${wildcardlist}"
+      if [[ "${#IPV6_ADDRESS}" > 0 ]]; then
+        echo "address=/$1/${IPV6_ADDRESS}" >> "${wildcardlist}"
+      fi
+    else
+      if [[ "${verbose}" == true ]]; then
+        echo -e "  ${INFO} ${1} already exists in wildcard blacklist, no need to add!"
+      fi
+    fi
+  fi
 }
 
 RemoveDomain() {
-    list="$2"
-    domain=$(EscapeRegexp "$1")
+  list="$2"
+  domain=$(EscapeRegexp "$1")
 
-    if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
+  [[ "${list}" == "${whitelist}" ]] && listname="whitelist"
+  [[ "${list}" == "${blacklist}" ]] && listname="blacklist"
+  [[ "${list}" == "${wildcardlist}" ]] && listname="wildcard blacklist"
 
-        bool=true
-        #Is it in the list? Logic follows that if its whitelisted it should not be blacklisted and vice versa
-        grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
-        if [[ "${bool}" == true ]]; then
-            # Remove it from the other one
-            echo "::: Removing $1 from $list..."
-            # /I flag: search case-insensitive
-            sed -i "/${domain}/Id" "${list}"
-            reload=true
-        else
-            if [[ "${verbose}" == true ]]; then
-                echo "::: ${1} does not exist in ${list}, no need to remove!"
-            fi
-        fi
-
-    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
+  if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
+    bool=true
+    [[ "${list}" == "${whitelist}" && -z "${type}" ]] && type="--whitelist-only"
+    [[ "${list}" == "${blacklist}" && -z "${type}" ]] && type="--blacklist-only"
+    # 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 -e "  ${INFO} Removing $1 from $listname..."
+      # /I flag: search case-insensitive
+      sed -i "/${domain}/Id" "${list}"
+      reload=true
+    else
+      if [[ "${verbose}" == true ]]; then
+        echo -e "  ${INFO} ${1} does not exist in ${listname}, no need to remove!"
+      fi
     fi
+  elif [[ "${list}" == "${wildcardlist}" ]]; then
+    [[ -z "${type}" ]] && type="--wildcard-only"
+    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 -e "  ${INFO} Removing $1 from $listname..."
+      # /I flag: search case-insensitive
+      sed -i "/address=\/${domain}/Id" "${list}"
+      reload=true
+    else
+      if [[ "${verbose}" == true ]]; then
+        echo -e "  ${INFO} ${1} does not exist in ${listname}, no need to remove!"
+      fi
+    fi
+  fi
 }
 
+# Update Gravity
 Reload() {
-	# Reload hosts file
-	pihole -g -sd
+  echo ""
+  pihole -g --skip-download "${type:-}"
 }
 
 Displaylist() {
-    if [[ ${listMain} == ${whitelist} ]]; then
-        string="gravity resistant domains"
+  if [[ -f ${listMain} ]]; then
+    if [[ "${listMain}" == "${whitelist}" ]]; then
+      string="gravity resistant domains"
     else
-        string="domains caught in the sinkhole"
+      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;
+    verbose=false
+    echo -e "Displaying $string:\n"
+    count=1
+    while IFS= read -r RD; do
+      echo "  ${count}: ${RD}"
+      count=$((count+1))
+    done < "${listMain}"
+  else
+    echo -e "  ${COL_LIGHT_RED}${listMain} does not exist!${COL_NC}"
+  fi
+  exit 0;
+}
+
+NukeList() {
+  if [[ -f "${listMain}" ]]; then
+    # Back up original list
+    cp "${listMain}" "${listMain}.bck~"
+    # Empty out file
+    echo "" > "${listMain}"
+  fi
 }
 
 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
+  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;;
+    "-q" | "--quiet"     ) verbose=false;;
+    "-h" | "--help"      ) helpFunc;;
+    "-l" | "--list"      ) Displaylist;;
+    "--nuke"             ) NukeList;;
+    *                    ) HandleOther "${var}";;
+  esac
 done
 
 shift
 
 if [[ $# = 0 ]]; then
-	helpFunc
+  helpFunc
 fi
 
 PoplistFile
 
-if ${reload}; then
-	Reload
+if [[ "${reload}" != false ]]; then
+  # Ensure that "restart" is used for Wildcard updates
+  Reload "${reload}"
 fi

advanced/Scripts/piholeCheckout.sh

@@ -3,13 +3,14 @@
 # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
 # Network-wide ad blocking via your own hardware.
 #
-# Checkout other branches than master
+# 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
@@ -18,9 +19,103 @@ PH_TEST="true" source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
 # setupVars set in basic-install.sh
 
 source "${setupVars}"
-
 update="false"
 
+coltable="/opt/pihole/COL_TABLE"
+source ${coltable}
+
+check_download_exists() {
+  status=$(curl --head --silent "https://ftl.pi-hole.net/${1}" | head -n 1)
+  if grep -q "404" <<< "$status"; then
+    return 1
+  else
+    return 0
+  fi
+}
+
+FTLinstall() {
+  # Download and install FTL binary
+  local binary
+  binary="${1}"
+  local path
+  path="${2}"
+  local str
+  str="Installing FTL"
+  echo -ne "  ${INFO} ${str}..."
+
+  if curl -sSL --fail "https://ftl.pi-hole.net/${path}" -o "/tmp/${binary}"; then
+    # Get sha1 of the binary we just downloaded for verification.
+    curl -sSL --fail "https://ftl.pi-hole.net/${path}.sha1" -o "/tmp/${binary}.sha1"
+    # Check if we just downloaded text, or a binary file.
+    cd /tmp || return 1
+    if sha1sum --status --quiet -c "${binary}".sha1; then
+      echo -n "transferred... "
+      stop_service pihole-FTL &> /dev/null
+      install -T -m 0755 "/tmp/${binary}" "/usr/bin/pihole-FTL"
+      rm "/tmp/${binary}" "/tmp/${binary}.sha1"
+      start_service pihole-FTL &> /dev/null
+      echo -e "${OVER}  ${TICK} ${str}"
+      return 0
+    else
+      echo -e "${OVER}  ${CROSS} ${str}"
+      echo -e "  ${COL_LIGHT_RED}Error: Download of binary from ftl.pi-hole.net failed${COL_NC}"
+      return 1
+    fi
+  else
+    echo -e "${OVER}  ${CROSS} ${str}"
+    echo -e "  ${COL_LIGHT_RED}Error: URL not found${COL_NC}"
+  fi
+}
+
+get_binary_name() {
+  local machine
+  machine=$(uname -m)
+
+  local str
+  str="Detecting architecture"
+  echo -ne "  ${INFO} ${str}..."
+  if [[ "${machine}" == "arm"* || "${machine}" == *"aarch"* ]]; then
+    # ARM
+    local rev
+    rev=$(uname -m | sed "s/[^0-9]//g;")
+    local lib
+    lib=$(ldd /bin/ls | grep -E '^\s*/lib' | awk '{ print $1 }')
+    if [[ "${lib}" == "/lib/ld-linux-aarch64.so.1" ]]; then
+      echo -e "${OVER}  ${TICK} Detected ARM-aarch64 architecture"
+      binary="pihole-FTL-aarch64-linux-gnu"
+    elif [[ "${lib}" == "/lib/ld-linux-armhf.so.3" ]]; then
+      if [[ "$rev" -gt "6" ]]; then
+        echo -e "${OVER}  ${TICK} Detected ARM-hf architecture (armv7+)"
+        binary="pihole-FTL-arm-linux-gnueabihf"
+      else
+        echo -e "${OVER}  ${TICK} Detected ARM-hf architecture (armv6 or lower) Using ARM binary"
+        binary="pihole-FTL-arm-linux-gnueabi"
+      fi
+    else
+      echo -e "${OVER}  ${TICK} Detected ARM architecture"
+      binary="pihole-FTL-arm-linux-gnueabi"
+    fi
+  elif [[ "${machine}" == "ppc" ]]; then
+    # PowerPC
+    echo -e "${OVER}  ${TICK} Detected PowerPC architecture"
+    binary="pihole-FTL-powerpc-linux-gnu"
+  elif [[ "${machine}" == "x86_64" ]]; then
+    # 64bit
+    echo -e "${OVER}  ${TICK} Detected x86_64 architecture"
+    binary="pihole-FTL-linux-x86_64"
+  else
+    # Something else - we try to use 32bit executable and warn the user
+    if [[ ! "${machine}" == "i686" ]]; then
+      echo -e "${OVER}  ${CROSS} ${str}...
+      ${COL_LIGHT_RED}Not able to detect architecture (unknown: ${machine}), trying 32bit executable
+      Contact support if you experience issues (e.g: FTL not running)${COL_NC}"
+    else
+      echo -e "${OVER}  ${TICK} Detected 32bit (i686) architecture"
+    fi
+    binary="pihole-FTL-linux-x86_32"
+  fi
+}
+
 fully_fetch_repo() {
   # Add upstream branches to shallow clone
   local directory="${1}"
@@ -35,91 +130,109 @@ fully_fetch_repo() {
   return 0
 }
 
-get_available_branches(){
+get_available_branches() {
   # Return available branches
-  local directory="${1}"
+  local directory
+  directory="${1}"
+  local output
 
   cd "${directory}" || return 1
-  # Get reachable remote branches
-  git remote show origin | grep 'tracked' | sed 's/tracked//;s/ //g'
+  # Get reachable remote branches, but store STDERR as STDOUT variable
+  output=$( { git remote show origin | grep 'tracked' | sed 's/tracked//;s/ //g'; } 2>&1 )
+  echo "$output"
   return
 }
 
-
 fetch_checkout_pull_branch() {
   # Check out specified branch
-  local directory="${1}"
-  local branch="${2}"
+  local directory
+  directory="${1}"
+  local branch
+  branch="${2}"
 
   # Set the reference for the requested branch, fetch, check it put and pull it
-  cd "${directory}"
+  cd "${directory}" || return 1
   git remote set-branches origin "${branch}" || return 1
+  git stash --all --quiet &> /dev/null || true
+  git clean --quiet --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 directory
+  directory="${1}"
+  local branch
+  branch="${2}"
   local oldbranch
 
   cd "${directory}" || return 1
 
   oldbranch="$(git symbolic-ref HEAD)"
 
-  git checkout "${branch}" || return 1
+  str="Switching to branch: '${branch}' from '${oldbranch}'"
+  echo -ne "  ${INFO} $str"
+  git checkout "${branch}" --quiet || return 1
+  echo -e "${OVER}  ${TICK} $str"
 
-  if [ "$(git diff "${oldbranch}" | grep -c "^")" -gt "0" ]; then
+
+  if [[ "$(git diff "${oldbranch}" | grep -c "^")" -gt "0" ]]; then
     update="true"
   fi
 
-  git pull || return 1
+  git_pull=$(git pull || return 1)
+
+  if [[ "$git_pull" == *"up-to-date"* ]]; then
+    echo -e "  ${INFO} ${git_pull}"
+  else
+    echo -e "$git_pull\\n"
+  fi
+
   return 0
 }
 
 warning1() {
-  echo "::: Note that changing the branch is a severe change of your Pi-hole system."
-  echo "::: This is not supported unless one of the developers explicitly asks you to do this!"
-  read -r -p "::: Have you read and understood this? [y/N] " response
-  case ${response} in
+  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 "::: Continuing."
+    echo ""
     return 0
     ;;
   *)
-    echo "::: Aborting."
+    echo -e "\\n  ${INFO} Branch change has been cancelled"
     return 1
     ;;
   esac
 }
 
-checkout()
-{
+checkout() {
   local corebranches
   local webbranches
 
   # Avoid globbing
   set -f
 
-  #This is unlikely
+  # 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"
+    echo -e "  ${COL_LIGHT_RED}Error: Core Pi-hole repo is missing from system!
+  Please re-run install script from https://github.com/pi-hole/pi-hole${COL_NC}"
     exit 1;
   fi
-  if [[ ${INSTALL_WEB} == "true" ]]; then
+  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"
+     echo -e "  ${COL_LIGHT_RED}Error: Web Admin repo is missing from system!
+  Please re-run install script from https://github.com/pi-hole/pi-hole${COL_NC}"
       exit 1;
     fi
   fi
 
   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>'"
+    echo -e "  ${COL_LIGHT_RED}Invalid option${COL_NC}
+  Try 'pihole checkout --help' for more information."
     exit 1
   fi
 
@@ -129,74 +242,121 @@ checkout()
 
   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; }
+    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 developement branch"; exit 1; }
+    if [[ "${INSTALL_WEB}" == "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 "::: done!"
+    #echo -e "  ${TICK} Pi-hole Core"
+
+    get_binary_name
+    local path
+    path="development/${binary}"
+    echo "development" > /etc/pihole/ftlbranch
+    FTLinstall "${binary}" "${path}"
   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; }
+    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} == "true" ]]; then
-      echo "::: Web interface"
-      fetch_checkout_pull_branch "${webInterfaceDir}" "master" || { echo "Unable to pull web master branch"; exit 1; }
+      echo -e "  ${INFO} Web interface"
+      fetch_checkout_pull_branch "${webInterfaceDir}" "master" || { echo "  ${CROSS} Unable to pull Web master branch"; exit 1; }
     fi
-    echo "::: done!"
+    #echo -e "  ${TICK} Web Interface"
+    get_binary_name
+    local path
+    path="master/${binary}"
+    echo "master" > /etc/pihole/ftlbranch
+    FTLinstall "${binary}" "${path}"
   elif [[ "${1}" == "core" ]] ; then
-    echo -n "::: Fetching remote branches for Pi-hole core from ${piholeGitUrl} ... "
+    str="Fetching branches from ${piholeGitUrl}"
+    echo -ne "  ${INFO} $str"
     if ! fully_fetch_repo "${PI_HOLE_FILES_DIR}" ; then
-      echo "::: Fetching all branches for Pi-hole core repo failed!"
+      echo -e "${OVER}  ${CROSS} $str"
       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 [[ "${corebranches[*]}" == *"master"* ]]; then
+      echo -e "${OVER}  ${TICK} $str
+  ${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 "::: Requested branch \"${2}\" is not available!"
-      echo "::: Available branches for core are:"
-      for e in "${corebranches[@]}"; do echo ":::   $e"; done
+      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}" == "true" ]] ; then
-    echo -n "::: Fetching remote branches for the web interface from ${webInterfaceGitUrl} ... "
+  elif [[ "${1}" == "web" ]] && [[ "${INSTALL_WEB}" == "true" ]] ; then
+    str="Fetching branches from ${webInterfaceGitUrl}"
+    echo -ne "  ${INFO} $str"
     if ! fully_fetch_repo "${webInterfaceDir}" ; then
-      echo "::: Fetching all branches for Pi-hole web interface repo failed!"
+      echo -e "${OVER}  ${CROSS} $str"
       exit 1
     fi
     webbranches=($(get_available_branches "${webInterfaceDir}"))
-    echo " done!"
-    echo "::: ${#webbranches[@]} branches available"
-    echo ":::"
-    # Have to user chosing the branch he wants
+
+    if [[ "${webbranches[*]}" == *"master"* ]]; then
+      echo -e "${OVER}  ${TICK} $str
+  ${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 "::: Requested branch \"${2}\" is not available!"
-      echo "::: Available branches for web are:"
-      for e in "${webbranches[@]}"; do echo ":::   $e"; done
+      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
+    get_binary_name
+    local path
+    path="${2}/${binary}"
+
+    if check_download_exists "$path"; then
+        echo "  ${TICK} Branch ${2} exists"
+        echo "${2}" > /etc/pihole/ftlbranch
+        FTLinstall "${binary}" "${path}"
+    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 "::: Requested option \"${1}\" is not available!"
+    echo -e "  ${INFO} 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 [[ ( ! "${1}" == "web" && ! "${1}" == "ftl" ) && "${update}" == "true" ]]; then
+    echo -e "  ${INFO} Running installer to upgrade your installation"
     if "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh" --unattended; then
-     exit 0
+      exit 0
     else
-     echo "Unable to complete update, contact Pi-hole"
-     exit 1
+      echo -e "  ${COL_LIGHT_RED} Error: Unable to complete update, please contact support${COL_NC}"
+      exit 1
     fi
   fi
 }
-

advanced/Scripts/piholeLogFlush.sh

@@ -8,17 +8,56 @@
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
-echo -n "::: Flushing /var/log/pihole.log ..."
-# Test if logrotate is available on this system
-if command -v /usr/sbin/logrotate &> /dev/null; then
-  # Flush twice to move all data out of sight of FTL
-  /usr/sbin/logrotate --force /etc/pihole/logrotate
-  /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
+colfile="/opt/pihole/COL_TABLE"
+source ${colfile}
+
+# 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=...")
+DBFILE="$(sed -n -e 's/^\s^.DBFILE\s*=\s*//p' /etc/pihole/pihole-FTL.conf)"
+# 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 -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 /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
+  # 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")
+
+fi
+
+if [[ "$@" != *"quiet"* ]]; then
+  echo -e "${OVER}  ${TICK} Flushed /var/log/pihole.log"
+  echo -e "  ${TICK} Deleted ${deleted} queries from database"
 fi
-echo "... done!"

advanced/Scripts/update.sh

@@ -10,17 +10,19 @@
 # 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
+
+# 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
@@ -30,14 +32,14 @@ source ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh
 GitCheckUpdateAvail() {
   local directory="${1}"
   curdir=$PWD
-  cd "${directory}"
+  cd "${directory}" || return
 
   # Fetch latest changes in this repo
   git fetch --quiet origin
 
   # @ alone is a shortcut for HEAD. Older versions of git
   # need @{0}
-  LOCAL="$(git rev-parse @{0})"
+  LOCAL="$(git rev-parse "@{0}")"
 
   # The suffix @{upstream} to a branchname
   # (short form <branchname>@{u}) refers
@@ -46,23 +48,23 @@ GitCheckUpdateAvail() {
   # (configured with branch.<name>.remote and
   # branch.<name>.merge). A missing branchname
   # defaults to the current one.
-  REMOTE="$(git rev-parse @{upstream})"
+  REMOTE="$(git rev-parse "@{upstream}")"
 
-  if [[ ${#LOCAL} == 0 ]]; then
-    echo "::: Error: Local revision could not be obtained, ask Pi-hole support."
-    echo "::: Additional debugging output:"
+  if [[ "${#LOCAL}" == 0 ]]; then
+    echo -e "\\n  ${COL_LIGHT_RED}Error: Local revision could not be obtained, please contact Pi-hole Support
+  Additional debugging output:${COL_NC}"
     git status
     exit
   fi
-  if [[ ${#REMOTE} == 0 ]]; then
-    echo "::: Error: Remote revision could not be obtained, ask Pi-hole support."
-    echo "::: Additional debugging output:"
+  if [[ "${#REMOTE}" == 0 ]]; then
+    echo -e "\\n  ${COL_LIGHT_RED}Error: Remote revision could not be obtained, please contact Pi-hole Support
+  Additional debugging output:${COL_NC}"
     git status
     exit
   fi
 
   # Change back to original directory
-  cd "${curdir}"
+  cd "${curdir}" || exit
 
   if [[ "${LOCAL}" != "${REMOTE}" ]]; then
     # Local branch is behind remote branch -> Update
@@ -76,9 +78,10 @@ GitCheckUpdateAvail() {
 }
 
 FTLcheckUpdate() {
-
-	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')
+	local FTLversion
+	FTLversion=$(/usr/bin/pihole-FTL tag)
+	local FTLlatesttag
+	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
@@ -90,53 +93,59 @@ FTLcheckUpdate() {
 main() {
   local pihole_version_current
   local web_version_current
+  local basicError="\\n  ${COL_LIGHT_RED}Unable to complete update, please contact Pi-hole Support${COL_NC}"
+  
+  # shellcheck disable=1090,2154
   source "${setupVars}"
 
-  #This is unlikely
+  # 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"
+    echo -e "\\n  ${COL_LIGHT_RED}Error: Core Pi-hole repo is missing from system!
+  Please re-run install script from https://pi-hole.net${COL_NC}"
     exit 1;
   fi
 
-  echo "::: Checking for updates..."
+  echo -e "  ${INFO} Checking for updates..."
 
   if GitCheckUpdateAvail "${PI_HOLE_FILES_DIR}" ; then
     core_update=true
-    echo "::: Pi-hole Core:   update available"
+    echo -e "  ${INFO} Pi-hole Core:\\t${COL_YELLOW}update available${COL_NC}"
   else
     core_update=false
-    echo "::: Pi-hole Core:   up to date"
+    echo -e "  ${INFO} Pi-hole Core:\\t${COL_LIGHT_GREEN}up to date${COL_NC}"
   fi
 
   if FTLcheckUpdate ; then
     FTL_update=true
-    echo "::: FTL:            update available"
+    echo -e "  ${INFO} FTL:\\t\\t${COL_YELLOW}update available${COL_NC}"
   else
     FTL_update=false
-    echo "::: FTL:            up to date"
+    echo -e "  ${INFO} FTL:\\t\\t${COL_LIGHT_GREEN}up to date${COL_NC}"
   fi
 
-  if ${FTL_update}; then
-    echo ":::"
-    echo "::: FTL out of date"
+  # 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 -e "  ${INFO} FTL out of date"
     FTLdetect
-    echo ":::"
+    echo ""
   fi
 
-  if [[ ${INSTALL_WEB} == true ]]; then
+  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"
+      echo -e "\\n  ${COL_LIGHT_RED}Error: Web Admin repo is missing from system!
+  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} Web Interface:\\t${COL_YELLOW}update available${COL_NC}"
     else
       web_update=false
-      echo "::: Web Interface:  up to date"
+      echo -e "  ${INFO} Web Interface:\\t${COL_LIGHT_GREEN}up to date${COL_NC}"
     fi
 
     # Logic
@@ -151,72 +160,69 @@ main() {
 
     if ! ${core_update} && ! ${web_update} ; then
       if ! ${FTL_update} ; then
-        echo ":::"
-        echo "::: Everything is up to date!"
+        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"
+      echo ""
+      echo -e "  ${INFO} 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"
+      echo ""
+      echo -e "  ${INFO} 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
-
+      ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || \
+        echo -e "${basicError}" && exit 1
     elif ${core_update} && ${web_update} ; then
-      echo ":::"
-      echo "::: Updating Pi-hole core and web admin files"
+      echo ""
+      echo -e "  ${INFO} 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
+      ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --unattended || \
+        echo -e "${basicError}" && exit 1
     else
-      echo "*** Update script has malfunctioned, fallthrough reached. Please contact support"
+      echo -e "  ${COL_LIGHT_RED}Update script has malfunctioned, please contact Pi-hole Support${COL_NC}"
       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!"
+        echo ""
+        echo -e "  ${INFO} Everything is up to date!"
         exit 0
       fi
     else
-      echo ":::"
-      echo "::: Pi-hole core files out of date"
+      echo ""
+      echo -e "  ${INFO} 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
+      ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || \
+        echo -e "${basicError}" && 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}"
-    echo "::: If you had made any changes in '/var/www/html/admin/', they have been stashed using 'git stash'"
+    echo ""
+    echo -e "  ${INFO} Web Admin version is now at ${web_version_current/* v/v}
+  ${INFO} If you had made any changes in '/var/www/html/admin/', 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}"
-    echo "::: If you had made any changes in '/etc/.pihole/', they have been stashed using 'git stash'"
+    echo ""
+    echo -e "  ${INFO} Pi-hole version is now at ${pihole_version_current/* v/v}
+  ${INFO} If you had made any changes in '/etc/.pihole/', they have been stashed using 'git stash'"
   fi
 
-  if [[ ${FTL_update} == true ]]; then
+  if [[ "${FTL_update}" == true ]]; then
     FTL_version_current="$(/usr/bin/pihole-FTL tag)"
-    echo ":::"
-    echo "::: FTL version is now at ${FTL_version_current}"
+    echo -e "\\n  ${INFO} FTL version is now at ${FTL_version_current/* v/v}"
     start_service pihole-FTL
     enable_service pihole-FTL
   fi
 
-
   echo ""
   exit 0
-
 }
 
 main

advanced/Scripts/updatecheck.sh

@@ -0,0 +1,66 @@
+#!/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 || return 1
+}
+
+if [[ "$2" == "remote" ]]; then
+
+  if [[ "$3" == "reboot" ]]; then
+    sleep 30
+  fi
+
+  GITHUB_CORE_VERSION="$(json_extract tag_name "$(curl -q 'https://api.github.com/repos/pi-hole/pi-hole/releases/latest' 2> /dev/null)")"
+  GITHUB_WEB_VERSION="$(json_extract tag_name "$(curl -q 'https://api.github.com/repos/pi-hole/AdminLTE/releases/latest' 2> /dev/null)")"
+  GITHUB_FTL_VERSION="$(json_extract tag_name "$(curl -q 'https://api.github.com/repos/pi-hole/FTL/releases/latest' 2> /dev/null)")"
+
+  echo -n "${GITHUB_CORE_VERSION} ${GITHUB_WEB_VERSION} ${GITHUB_FTL_VERSION}" > "/etc/pihole/GitHubVersions"
+
+else
+
+  CORE_BRANCH="$(get_local_branch /etc/.pihole)"
+  WEB_BRANCH="$(get_local_branch /var/www/html/admin)"
+  FTL_BRANCH="$(pihole-FTL branch)"
+
+  echo -n "${CORE_BRANCH} ${WEB_BRANCH} ${FTL_BRANCH}" > "/etc/pihole/localbranches"
+
+  CORE_VERSION="$(get_local_version /etc/.pihole)"
+  WEB_VERSION="$(get_local_version /var/www/html/admin)"
+  FTL_VERSION="$(pihole-FTL version)"
+
+  echo -n "${CORE_VERSION} ${WEB_VERSION} ${FTL_VERSION}" > "/etc/pihole/localversions"
+
+fi

advanced/Scripts/version.sh

@@ -3,24 +3,29 @@
 # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
 # Network-wide ad blocking via your own hardware.
 #
-# shows version numbers
+# Show version numbers
 #
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
 # Variables
 DEFAULT="-1"
-PHGITDIR="/etc/.pihole/"
+COREGITDIR="/etc/.pihole/"
 WEBGITDIR="/var/www/html/admin/"
 
 getLocalVersion() {
+  # 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}" || { echo "${DEFAULT}"; return 1; }
-  version=$(git describe --tags --always || \
-            echo "${DEFAULT}")
+  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
@@ -33,13 +38,18 @@ getLocalVersion() {
 }
 
 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
 
-  cd "${directory}" || { echo "${DEFAULT}"; return 1; }
-  hash=$(git rev-parse --short HEAD || \
-         echo "${DEFAULT}")
+  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
@@ -49,12 +59,33 @@ getLocalHash() {
   return 0
 }
 
+getRemoteHash(){
+  # 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
+}
+
 getRemoteVersion(){
   # Get the version from the remote origin
   local daemon="${1}"
   local version
 
-  version=$(curl --silent --fail https://api.github.com/repos/pi-hole/${daemon}/releases/latest | \
+  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
@@ -66,72 +97,72 @@ getRemoteVersion(){
   return 0
 }
 
-#PHHASHLATEST=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/commits/master | \
-#                   grep sha | \
-#                   head -n1 | \
-#                   awk -F ' ' '{ print $2 }' | \
-#                   tr -cd '[[:alnum:]]._-')
-
-#WEBHASHLATEST=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/commits/master | \
-#                   grep sha | \
-#                   head -n1 | \
-#                   awk -F ' ' '{ print $2 }' | \
-#                   tr -cd '[[:alnum:]]._-')
-
-
-normalOutput() {
-	echo "::: Pi-hole version is $(getLocalVersion "${PHGITDIR}") (Latest version is $(getRemoteVersion pi-hole))"
-	if [ -d "${WEBGITDIR}" ]; then
-		echo "::: Web-Admin version is $(getLocalVersion "${WEBGITDIR}") (Latest version is $(getRemoteVersion AdminLTE))"
-	fi
-}
-
-webOutput() {
-  if [ -d "${WEBGITDIR}" ]; then
-    case "${1}" in
-      "-l" | "--latest"    ) echo $(getRemoteVersion AdminLTE);;
-      "-c" | "--current"   ) echo $(getLocalVersion "${WEBGITDIR}");;
-      "-h" | "--hash"      ) echo $(getLocalHash "${WEBGITDIR}");;
-      *                    ) echo "::: Invalid Option!"; exit 1;
-    esac
-  else
-    echo "::: Web interface not installed!"; exit 1;
+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 [[ -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
+
+  [[ -n "$output" ]] && echo "  $output"
 }
 
-coreOutput() {
-  case "${1}" in
-    "-l" | "--latest"    ) echo $(getRemoteVersion pi-hole);;
-    "-c" | "--current"   ) echo $(getLocalVersion "${PHGITDIR}");;
-    "-h" | "--hash"      ) echo $(getLocalHash "${PHGITDIR}");;
-    *                    ) echo "::: Invalid Option!"; exit 1;
-  esac
+errorOutput() {
+  echo "  Invalid Option! Try 'pihole -v --help' for more information."
+  exit 1
+}
+  
+defaultOutput() {
+  versionOutput "pi-hole" "$@"
+  versionOutput "AdminLTE" "$@"
+  versionOutput "FTL" "$@"
 }
 
 helpFunc() {
-	cat << EOM
-:::
-::: Show Pi-hole/Web Admin versions
-:::
-::: Usage: pihole -v [ -a | -p ] [ -l | -c ]
-:::
-::: Options:
-:::  -a, --admin          Show both current and latest versions of web admin
-:::  -p, --pihole         Show both current and latest versions of Pi-hole core files
-:::  -l, --latest         (Only after -a | -p) Return only latest version
-:::  -c, --current        (Only after -a | -p) Return only current version
-:::  -h, --help           Show this help dialog
-:::
-EOM
-	exit 0
+  echo "Usage: pihole -v [repo | option] [option]
+Example: 'pihole -v -p -l'
+Show Pi-hole, Admin Console & FTL versions
+
+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
+  -h, --help           Show this help dialog"
+  exit 0
 }
 
-if [[ $# = 0 ]]; then
-	normalOutput
-fi
-
 case "${1}" in
-  "-a" | "--admin"     ) shift; webOutput "$@";;
-  "-p" | "--pihole"    ) shift; coreOutput "$@" ;;
+  "-p" | "--pihole"    ) shift; versionOutput "pi-hole" "$@";;
+  "-a" | "--admin"     ) shift; versionOutput "AdminLTE" "$@";;
+  "-f" | "--ftl"       ) shift; versionOutput "FTL" "$@";;
   "-h" | "--help"      ) helpFunc;;
+  *                    ) defaultOutput "$@";;
 esac

advanced/Scripts/webpage.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.
@@ -8,31 +10,32 @@
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
-
 readonly setupVars="/etc/pihole/setupVars.conf"
 readonly dnsmasqconfig="/etc/dnsmasq.d/01-pihole.conf"
 readonly dhcpconfig="/etc/dnsmasq.d/02-pihole-dhcp.conf"
 # 03 -> wildcards
 readonly dhcpstaticconfig="/etc/dnsmasq.d/04-pihole-static-dhcp.conf"
 
+coltable="/opt/pihole/COL_TABLE"
+if [[ -f ${coltable} ]]; then
+  source ${coltable}
+fi
+
 helpFunc() {
-	cat << EOM
-::: Set admin options for the web interface of pihole
-:::
-::: Usage: pihole -a [options]
-:::
-::: Options:
-:::  -p, password		Set web interface password, an empty input will remove any previously set password
-:::  -c, celsius		Set Celsius temperature unit
-:::  -f, fahrenheit		Set Fahrenheit temperature unit
-:::  -k, kelvin			Set Kelvin temperature unit
-:::  -h, --help			Show this help dialog
-:::  -i, interface		Setup interface listening behavior of dnsmasq
-:::               		pihole -a -i local  : Listen on all interfaces, but allow only queries from
-:::               		                      devices that are at most one hop away (local devices)
-:::               		pihole -a -i single : Listen only on one interface (see PIHOLE_INTERFACE)
-:::               		pihole -a -i all    : Listen on all interfaces, permit all origins
-EOM
+  echo "Usage: pihole -a [options]
+Example: pihole -a -p password
+Set options for the Admin Console
+
+Options:
+  -p, password        Set Admin Console password
+  -c, celsius         Set Celsius as preferred temperature unit
+  -f, fahrenheit      Set Fahrenheit as preferred temperature unit
+  -k, kelvin          Set Kelvin as preferred temperature unit
+  -r, hostrecord      Add a name to the DNS associated to an IPv4/IPv6 address
+  -e, email           Set an administrative contact address for the Block Page
+  -h, --help          Show this help dialog
+  -i, interface       Specify dnsmasq's interface listening behavior
+                        Add '-h' for more info on interface usage"
 	exit 0
 }
 
@@ -61,21 +64,19 @@ delete_dnsmasq_setting() {
 	sed -i "/${1}/d" "${dnsmasqconfig}"
 }
 
-SetTemperatureUnit(){
-
+SetTemperatureUnit() {
 	change_setting "TEMPERATUREUNIT" "${unit}"
-
+  echo -e "  ${TICK} Set temperature unit to ${unit}"
 }
 
-HashPassword(){
-    # Compute password hash twice to avoid rainbow table vulnerability
-    return=$(echo -n ${1} | sha256sum | sed 's/\s.*$//')
-		return=$(echo -n ${return} | sha256sum | sed 's/\s.*$//')
-		echo ${return}
+HashPassword() {
+  # Compute password hash twice to avoid rainbow table vulnerability
+  return=$(echo -n ${1} | sha256sum | sed 's/\s.*$//')
+  return=$(echo -n ${return} | sha256sum | sed 's/\s.*$//')
+  echo ${return}
 }
 
-SetWebPassword(){
-
+SetWebPassword() {
 	if [ "${SUDO_USER}" == "www-data" ]; then
 		echo "Security measure: user www-data is not allowed to change webUI password!"
 		echo "Exiting"
@@ -92,12 +93,15 @@ SetWebPassword(){
     readonly PASSWORD="${args[2]}"
     readonly CONFIRM="${PASSWORD}"
   else
+    # Prevents a bug if the user presses Ctrl+C and it continues to hide the text typed.
+    # So we reset the terminal via stty if the user does press Ctrl+C
+    trap '{ echo -e "\nNo password will be set" ; stty sane ; exit 1; }' INT
     read -s -p "Enter New Password (Blank for no password): " PASSWORD
     echo ""
 
     if [ "${PASSWORD}" == "" ]; then
       change_setting "WEBPASSWORD" ""
-      echo "Password Removed"
+      echo -e "  ${TICK} Password Removed"
       exit 0
     fi
 
@@ -106,12 +110,12 @@ SetWebPassword(){
   fi
 
 	if [ "${PASSWORD}" == "${CONFIRM}" ] ; then
-		hash=$(HashPassword ${PASSWORD})
+		hash=$(HashPassword "${PASSWORD}")
 		# Save hash to file
 		change_setting "WEBPASSWORD" "${hash}"
-		echo "New password set"
+		echo -e "  ${TICK} New password set"
 	else
-		echo "Passwords don't match. Your password has not been changed"
+		echo -e "  ${CROSS} Passwords don't match. Your password has not been changed"
 		exit 1
 	fi
 }
@@ -149,6 +153,7 @@ ProcessDNSSettings() {
 	if [[ "${DNSSEC}" == true ]]; then
 		echo "dnssec
 trust-anchor=.,19036,8,2,49AAC11D7B6F6446702E54A1607371607A1A41855200FD2CE1CDDE32F24E8FB5
+trust-anchor=.,20326,8,2,E06D44B80B8F1D39A95C0B0D7C65D08458E880409BBC683457104237C7F8EC8D
 " >> "${dnsmasqconfig}"
 	fi
 
@@ -170,13 +175,21 @@ trust-anchor=.,19036,8,2,49AAC11D7B6F6446702E54A1607371607A1A41855200FD2CE1CDDE3
 		add_dnsmasq_setting "local-service"
 	else
 		# Listen only on one interface
+		# Use eth0 as fallback interface if interface is missing in setupVars.conf
+		if [ -z "${PIHOLE_INTERFACE}" ]; then
+			PIHOLE_INTERFACE="eth0"
+		fi
+
 		add_dnsmasq_setting "interface" "${PIHOLE_INTERFACE}"
 	fi
+	if [[ "${CONDITIONAL_FORWARDING}" == true ]]; then
+		add_dnsmasq_setting "server=/${CONDITIONAL_FORWARDING_DOMAIN}/${CONDITIONAL_FORWARDING_IP}"
+		add_dnsmasq_setting "server=/${CONDITIONAL_FORWARDING_REVERSE}/${CONDITIONAL_FORWARDING_IP}"
+	fi
 
 }
 
-SetDNSServers(){
-
+SetDNSServers() {
 	# Save setting to file
 	delete_setting "PIHOLE_DNS"
 	IFS=',' read -r -a array <<< "${args[2]}"
@@ -202,77 +215,80 @@ SetDNSServers(){
 	else
 		change_setting "DNSSEC" "false"
 	fi
+	if [[ "${args[6]}" == "conditional_forwarding" ]]; then
+		change_setting "CONDITIONAL_FORWARDING" "true"
+		change_setting "CONDITIONAL_FORWARDING_IP" "${args[7]}"
+		change_setting "CONDITIONAL_FORWARDING_DOMAIN" "${args[8]}"
+		change_setting "CONDITIONAL_FORWARDING_REVERSE" "${args[9]}"
+	else
+		change_setting "CONDITIONAL_FORWARDING" "false"
+		delete_setting "CONDITIONAL_FORWARDING_IP"
+		delete_setting "CONDITIONAL_FORWARDING_DOMAIN"
+		delete_setting "CONDITIONAL_FORWARDING_REVERSE"
+	fi
 
 	ProcessDNSSettings
 
 	# Restart dnsmasq to load new configuration
 	RestartDNS
-
 }
 
-SetExcludeDomains(){
-
+SetExcludeDomains() {
 	change_setting "API_EXCLUDE_DOMAINS" "${args[2]}"
-
 }
 
-SetExcludeClients(){
-
+SetExcludeClients() {
 	change_setting "API_EXCLUDE_CLIENTS" "${args[2]}"
-
 }
 
-Reboot(){
+Poweroff(){
+        nohup bash -c "sleep 5; poweroff" &> /dev/null </dev/null &
+}
 
+Reboot() {
 	nohup bash -c "sleep 5; reboot" &> /dev/null </dev/null &
-
 }
 
-RestartDNS(){
-
-	if [ -x "$(command -v systemctl)" ]; then
-		systemctl restart dnsmasq &> /dev/null
-	else
-		service dnsmasq restart &> /dev/null
-	fi
-
+RestartDNS() {
+  /usr/local/bin/pihole restartdns
 }
 
-SetQueryLogOptions(){
-
+SetQueryLogOptions() {
 	change_setting "API_QUERY_LOG_SHOW" "${args[2]}"
-
 }
 
 ProcessDHCPSettings() {
-
 	source "${setupVars}"
 
 	if [[ "${DHCP_ACTIVE}" == "true" ]]; then
+    interface="${PIHOLE_INTERFACE}"
 
-	interface=$(grep 'PIHOLE_INTERFACE=' /etc/pihole/setupVars.conf | sed "s/.*=//")
+    # Use eth0 as fallback interface
+    if [ -z ${interface} ]; then
+      interface="eth0"
+    fi
 
-	# Use eth0 as fallback interface
-	if [ -z ${interface} ]; then
-		interface="eth0"
-	fi
+    if [[ "${PIHOLE_DOMAIN}" == "" ]]; then
+      PIHOLE_DOMAIN="lan"
+      change_setting "PIHOLE_DOMAIN" "${PIHOLE_DOMAIN}"
+    fi
 
-	if [[ "${PIHOLE_DOMAIN}" == "" ]]; then
-		PIHOLE_DOMAIN="local"
-		change_setting "PIHOLE_DOMAIN" "${PIHOLE_DOMAIN}"
-	fi
+    if [[ "${DHCP_LEASETIME}" == "0" ]]; then
+      leasetime="infinite"
+    elif [[ "${DHCP_LEASETIME}" == "" ]]; then
+      leasetime="24"
+      change_setting "DHCP_LEASETIME" "${leasetime}"
+    elif [[ "${DHCP_LEASETIME}" == "24h" ]]; then
+      #Installation is affected by known bug, introduced in a previous version.
+      #This will automatically clean up setupVars.conf and remove the unnecessary "h"
+      leasetime="24"
+      change_setting "DHCP_LEASETIME" "${leasetime}"
+    else
+      leasetime="${DHCP_LEASETIME}h"
+    fi
 
-	if [[ "${DHCP_LEASETIME}" == "0" ]]; then
-		leasetime="infinite"
-	elif [[ "${DHCP_LEASETIME}" == "" ]]; then
-		leasetime="24h"
-		change_setting "DHCP_LEASETIME" "${leasetime}"
-	else
-		leasetime="${DHCP_LEASETIME}h"
-	fi
-
-	# Write settings to file
-	echo "###############################################################################
+    # Write settings to file
+    echo "###############################################################################
 #  DHCP SERVER CONFIG FILE AUTOMATICALLY POPULATED BY PI-HOLE WEB INTERFACE.  #
 #            ANY CHANGES MADE TO THIS FILE WILL BE LOST ON CHANGE             #
 ###############################################################################
@@ -283,26 +299,27 @@ dhcp-leasefile=/etc/pihole/dhcp.leases
 #quiet-dhcp
 " > "${dhcpconfig}"
 
-if [[ "${PIHOLE_DOMAIN}" != "none" ]]; then
-	echo "domain=${PIHOLE_DOMAIN}" >> "${dhcpconfig}"
-fi
+  if [[ "${PIHOLE_DOMAIN}" != "none" ]]; then
+    echo "domain=${PIHOLE_DOMAIN}" >> "${dhcpconfig}"
+  fi
 
-	if [[ "${DHCP_IPv6}" == "true" ]]; then
-echo "#quiet-dhcp6
+    if [[ "${DHCP_IPv6}" == "true" ]]; then
+  echo "#quiet-dhcp6
 #enable-ra
 dhcp-option=option6:dns-server,[::]
 dhcp-range=::100,::1ff,constructor:${interface},ra-names,slaac,${leasetime}
 ra-param=*,0,0
 " >> "${dhcpconfig}"
-	fi
+    fi
 
 	else
-		rm "${dhcpconfig}" &> /dev/null
+	  if [[ -f "${dhcpconfig}" ]]; then
+		  rm "${dhcpconfig}" &> /dev/null
+		fi
 	fi
 }
 
-EnableDHCP(){
-
+EnableDHCP() {
 	change_setting "DHCP_ACTIVE" "true"
 	change_setting "DHCP_START" "${args[2]}"
 	change_setting "DHCP_END" "${args[3]}"
@@ -320,8 +337,7 @@ EnableDHCP(){
 	RestartDNS
 }
 
-DisableDHCP(){
-
+DisableDHCP() {
 	change_setting "DHCP_ACTIVE" "false"
 
 	# Remove possible old setting from file
@@ -333,23 +349,20 @@ DisableDHCP(){
 	RestartDNS
 }
 
-SetWebUILayout(){
-
+SetWebUILayout() {
 	change_setting "WEBUIBOXEDLAYOUT" "${args[2]}"
-
 }
 
 CustomizeAdLists() {
-
   list="/etc/pihole/adlists.list"
 
-	if [[ "${args[2]}" == "enable" ]] ; then
+	if [[ "${args[2]}" == "enable" ]]; then
 		sed -i "\\@${args[3]}@s/^#http/http/g" "${list}"
-	elif [[ "${args[2]}" == "disable" ]] ; then
+	elif [[ "${args[2]}" == "disable" ]]; then
 		sed -i "\\@${args[3]}@s/^http/#http/g" "${list}"
-	elif [[ "${args[2]}" == "add" ]] ; then
+	elif [[ "${args[2]}" == "add" ]]; then
 		echo "${args[3]}" >> ${list}
-	elif [[ "${args[2]}" == "del" ]] ; then
+	elif [[ "${args[2]}" == "del" ]]; then
 	  var=$(echo "${args[3]}" | sed 's/\//\\\//g')
 	  sed -i "/${var}/Id" "${list}"
 	else
@@ -358,18 +371,15 @@ CustomizeAdLists() {
   fi
 }
 
-SetPrivacyMode(){
-
-	if [[ "${args[2]}" == "true" ]] ; then
+SetPrivacyMode() {
+	if [[ "${args[2]}" == "true" ]]; then
 		change_setting "API_PRIVACY_MODE" "true"
 	else
 		change_setting "API_PRIVACY_MODE" "false"
 	fi
-
 }
 
 ResolutionSettings() {
-
 	typ="${args[2]}"
 	state="${args[3]}"
 
@@ -378,11 +388,9 @@ ResolutionSettings() {
 	elif [[ "${typ}" == "clients" ]]; then
 		change_setting "API_GET_CLIENT_HOSTNAME" "${state}"
 	fi
-
 }
 
 AddDHCPStaticAddress() {
-
 	mac="${args[2]}"
 	ip="${args[3]}"
 	host="${args[4]}"
@@ -397,45 +405,84 @@ AddDHCPStaticAddress() {
 		# Full info given
 		echo "dhcp-host=${mac},${ip},${host}" >> "${dhcpstaticconfig}"
 	fi
-
 }
 
 RemoveDHCPStaticAddress() {
-
 	mac="${args[2]}"
 	sed -i "/dhcp-host=${mac}.*/d" "${dhcpstaticconfig}"
-
 }
 
-SetHostRecord(){
+SetHostRecord() {
+  if [[ "${1}" == "-h" ]] || [[ "${1}" == "--help" ]]; then
+    echo "Usage: pihole -a hostrecord <domain> [IPv4-address],[IPv6-address]
+Example: 'pihole -a hostrecord home.domain.com 192.168.1.1,2001:db8:a0b:12f0::1'
+Add a name to the DNS associated to an IPv4/IPv6 address
 
-	if [ -n "${args[3]}" ]; then
+Options:
+  \"\"                  Empty: Remove host record
+  -h, --help          Show this help dialog"
+    exit 0
+  fi
+
+	if [[ -n "${args[3]}" ]]; then
 		change_setting "HOSTRECORD" "${args[2]},${args[3]}"
-		echo "Setting host record for ${args[2]} -> ${args[3]}"
+		echo -e "  ${TICK} Setting host record for ${args[2]} to ${args[3]}"
 	else
 		change_setting "HOSTRECORD" ""
-		echo "Removing host record"
+		echo -e "  ${TICK} Removing host record"
 	fi
 
 	ProcessDNSSettings
 
 	# Restart dnsmasq to load new configuration
 	RestartDNS
-
 }
 
-SetListeningMode(){
+SetAdminEmail() {
+  if [[ "${1}" == "-h" ]] || [[ "${1}" == "--help" ]]; then
+    echo "Usage: pihole -a email <address>
+Example: 'pihole -a email admin@address.com'
+Set an administrative contact address for the Block Page
 
+Options:
+  \"\"                  Empty: Remove admin contact
+  -h, --help          Show this help dialog"
+    exit 0
+  fi
+
+	if [[ -n "${args[2]}" ]]; then
+		change_setting "ADMIN_EMAIL" "${args[2]}"
+		echo -e "  ${TICK} Setting admin contact to ${args[2]}"
+	else
+		change_setting "ADMIN_EMAIL" ""
+		echo -e "  ${TICK} Removing admin contact"
+	fi
+}
+
+SetListeningMode() {
 	source "${setupVars}"
 
-	if [[ "${args[2]}" == "all" ]] ; then
-		echo "Listening on all interfaces, permiting all origins, hope you have a firewall!"
+  if [[ "$3" == "-h" ]] || [[ "$3" == "--help" ]]; then
+    echo "Usage: pihole -a -i [interface]
+Example: 'pihole -a -i local'
+Specify dnsmasq's network interface listening behavior
+
+Interfaces:
+  local               Listen on all interfaces, but only allow queries from
+                      devices that are at most one hop away (local devices)
+  single              Listen only on ${PIHOLE_INTERFACE} interface
+  all                 Listen on all interfaces, permit all origins"
+    exit 0
+  fi
+
+	if [[ "${args[2]}" == "all" ]]; then
+    echo -e "  ${INFO} Listening on all interfaces, permiting all origins. Please use a firewall!"
 		change_setting "DNSMASQ_LISTENING" "all"
-	elif [[ "${args[2]}" == "local" ]] ; then
-		echo "Listening on all interfaces, permitting only origins that are at most one hop away (local devices)"
+	elif [[ "${args[2]}" == "local" ]]; then
+    echo -e "  ${INFO} Listening on all interfaces, permiting origins from one hop away (LAN)"
 		change_setting "DNSMASQ_LISTENING" "local"
 	else
-		echo "Listening only on interface ${PIHOLE_INTERFACE}"
+		echo -e "  ${INFO} Listening only on interface ${PIHOLE_INTERFACE}"
 		change_setting "DNSMASQ_LISTENING" "single"
 	fi
 
@@ -446,17 +493,19 @@ SetListeningMode(){
 		# Restart dnsmasq to load new configuration
 		RestartDNS
 	fi
-
 }
 
-Teleporter()
-{
+Teleporter() {
 	local datetimestamp=$(date "+%Y-%m-%d_%H-%M-%S")
 	php /var/www/html/admin/scripts/pi-hole/php/teleporter.php > "pi-hole-teleporter_${datetimestamp}.zip"
 }
 
-main() {
+audit()
+{
+	echo "${args[2]}" >> /etc/pihole/auditlog.list
+}
 
+main() {
 	args=("$@")
 
 	case "${args[1]}" in
@@ -467,6 +516,7 @@ main() {
 		"setdns"            ) SetDNSServers;;
 		"setexcludedomains" ) SetExcludeDomains;;
 		"setexcludeclients" ) SetExcludeClients;;
+		"poweroff"          ) Poweroff;;
 		"reboot"            ) Reboot;;
 		"restartdns"        ) RestartDNS;;
 		"setquerylog"       ) SetQueryLogOptions;;
@@ -478,10 +528,12 @@ main() {
 		"resolve"           ) ResolutionSettings;;
 		"addstaticdhcp"     ) AddDHCPStaticAddress;;
 		"removestaticdhcp"  ) RemoveDHCPStaticAddress;;
-		"hostrecord"        ) SetHostRecord;;
-		"-i" | "interface"  ) SetListeningMode;;
+		"-r" | "hostrecord" ) SetHostRecord "$3";;
+		"-e" | "email"      ) SetAdminEmail "$3";;
+		"-i" | "interface"  ) SetListeningMode "$@";;
 		"-t" | "teleporter" ) Teleporter;;
 		"adlist"            ) CustomizeAdLists;;
+		"audit"             ) audit;;
 		*                   ) helpFunc;;
 	esac
 
@@ -490,5 +542,4 @@ main() {
 	if [[ $# = 0 ]]; then
 		helpFunc
 	fi
-
 }

advanced/blockingpage.css

@@ -1,136 +1,383 @@
-/* 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 occured. 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;
+  src: local("Source Sans Pro"), local("SourceSansPro-Regular"), url("/admin/style/vendor/SourceSansPro/SourceSansPro-Regular.ttf") format("truetype");
+}
+
+@font-face {
+  font-family: "Source Sans Pro";
+  font-style: normal;
+  font-weight: 700;
+  src: local("Source Sans Pro Bold"), local("SourceSansPro-Bold"), url("/admin/style/vendor/SourceSansPro/SourceSansPro-Bold.ttf") format("truetype");
+}
 
 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; }
+#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: normal;
+  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; }
+
+/* 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,0,1,1,1v1a1.371,1.371,0,0,1-1,1H1a1.371,1.371,0,0,1-1-1V12a1.371,1.371,0,0,1,1-1H2V8H1A1.371,1.371,0,0,1,0,7V6A1.371,1.371,0,0,1,1,5H4A1.371,1.371,0,0,1,5,6v5H6ZM3.5,0A1.5,1.5,0,1,1,2,1.5,1.5,1.5,0,0,1,3.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: bold 1.8rem Consolas, Courier, monospace;
+  padding: 5px 10px 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 colour */
+.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; }
+
+@keyframes slidein { from { max-height: 0; opacity: 0; } to { max-height: 300px; opacity: 1; } }
+#bpMoreToggle:checked ~ #bpMoreInfo { display: block; margin-top: 8px; animation: slidein 0.05s linear; }
+#bpMoreInfo { display: none; margin-top: 10px; }
+
+#bpQueryOutput {
+  font-size: 1.2rem;
+  line-height: 1.65rem;
+  margin: 5px 0 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; }
+}

advanced/index.js

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

advanced/index.php

@@ -1,224 +1,353 @@
 <?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;
-}
+// Sanitise HTTP_HOST output
+$serverName = htmlspecialchars($_SERVER["HTTP_HOST"]);
 
-$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 = [];
+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);
+
+// Check if this is served over HTTP or HTTPS
+if(isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == "on") {
+    $proto = "https";
+} else {
+    $proto = "http";
 }
 
-// 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();
+// Set mobile friendly viewport
+$viewPort = '<meta name="viewport" content="width=device-width, initial-scale=1, maximum-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");
 }
 
-// Get Pi-hole version
-$piHoleVersion = exec('cd /etc/.pihole/ && git describe --tags --abbrev=0');
+// Determine block page type
+if ($serverName === "pi.hole") {
+    // Redirect to Web Interface
+    exit(header("Location: /admin"));
+} elseif (filter_var($serverName, FILTER_VALIDATE_IP) || in_array($serverName, $authorizedHosts)) {
+    // Set Splash Page output
+    $splashPage = "
+    <html><head>
+        $viewPort
+        <link rel='stylesheet' href='/pihole/blockingpage.css' type='text/css'/>
+    </head><body id='splashpage'><img src='/admin/img/logo.svg'/><br/>Pi-<b>hole</b>: Your black hole for Internet advertisements</body></html>
+    ";
 
-// Don't show the URI if it is the root directory
-if($uri == "/")
-{
-	$uri = "";
+    // Set splash/landing page based off presence of $landPage
+    $renderPage = is_file(getcwd()."/$landPage") ? include $landPage : "$splashPage";
+
+    // Unset variables so as to not be included in $landPage
+    unset($serverName, $svPasswd, $svEmail, $authorizedHosts, $validExtTypes, $currentUrlExt, $viewPort);
+
+    // Render splash/landing page when directly browsing via IP or authorised hostname
+    exit($renderPage);
+} 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().'<html>
+        <head><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"><defs><style>a {text-decoration: none;} circle {stroke: rgba(152,2,2,0.5); fill: none; stroke-width: 2;} rect {fill: rgba(152,2,2,0.5);} text {opacity: 0.3; font: 11px Arial;}</style></defs><circle cx="8" cy="8" r="7"/><rect x="10.3" y="-6" width="2" height="12" transform="rotate(45)"/><text x="19.3" y="12">Blocked by Pi-hole</text></svg></a>';
+    exit(setHeader()."<html>
+        <head>$viewPort</head>
+        <body>$blockImg</body>
+    </html>");
 }
 
+/* Start processing Block Page from here */
+
+// Define admin email address text based off $svEmail presence
+$bpAskAdmin = !empty($svEmail) ? '<a href="mailto:'.$svEmail.'?subject=Site Blocked: '.$serverName.'"></a>' : "<span/>";
+
+// Determine if at least one block list has been generated
+if (empty(glob("/etc/pihole/list.0.*.domains")))
+    die("[ERROR] There are no domain lists generated lists within <code>/etc/pihole/</code>! Please update gravity by running <code>pihole -g</code>, or repair Pi-hole using <code>pihole -r</code>.");
+
+// Set location of adlists file
+if (is_file("/etc/pihole/adlists.list")) {
+    $adLists = "/etc/pihole/adlists.list";
+} elseif (is_file("/etc/pihole/adlists.default")) {
+    $adLists = "/etc/pihole/adlists.default";
+} else {
+    die("[ERROR] File not found: <code>/etc/pihole/adlists.list</code>");
+}
+
+// Get all URLs starting with "http" or "www" from adlists and re-index array numerically
+$adlistsUrls = array_values(preg_grep("/(^http)|(^www)/i", file($adLists, FILE_IGNORE_NEW_LINES)));
+
+if (empty($adlistsUrls))
+    die("[ERROR]: There are no adlist URL's found within <code>$adLists</code>");
+
+// 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"];
+    $queryAds = file("http://127.0.0.1/admin/scripts/pi-hole/php/queryads.php?domain=$serverName&bp", 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 {
+        // 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());
+    }
+}
+
+// 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]";
+}
+
+// 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";
+
+    // 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";
+    }
+}
+
+// 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 localised
+// 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'/>
-	<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'/>
+  <meta charset="UTF-8">
+  <?=$viewPort ?>
+  <meta name="robots" content="noindex,nofollow"/>
+  <meta http-equiv="x-dns-prefetch-control" content="off">
+  <link rel="shortcut icon" href="<?=$proto ?>://pi.hole/admin/img/favicon.png" type="image/x-icon"/>
+  <link rel="stylesheet" href="<?=$proto ?>://pi.hole/pihole/blockingpage.css" type="text/css"/>
+  <title>● <?=$serverName ?></title>
+  <script src="<?=$proto ?>://pi.hole/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="body">
+<body id="blockpage"><div id="bpWrapper">
 <header>
-	<h1><a href='/'>Website Blocked</a></h1>
+  <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://github.com/pi-hole/pi-hole/wiki/What-is-Pi-hole%3F-A-simple-explanation"><?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>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>
+  <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>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;
 
-    $.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>
+<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 inIframe () {
-    try {
-        return window.self !== window.top;
-    } catch (e) {
-        return true;
+  function add() {
+    $("#bpOutput").removeClass("hidden error exception");
+    $("#bpOutput").addClass("add");
+    var domain = "<?=$serverName ?>";
+    var pw = $("#bpWLPassword");
+    if(domain.length === 0) {
+      return;
     }
-}
-
-// 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();
-}
-
-$( "#whitelisting" ).on( "click", function(){ $( "#whitelistingform" ).removeAttr( "hidden" ); });
-
-// 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 <---");
-		}
-	});
-}
-// Handle enter button for adding domains
-$(document).keypress(function(e) {
-    if(e.which === 13 && $("#pw").is(":focus")) {
+    $.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");
+        } else {
+          $("#bpOutput").removeClass("add");
+          $("#bpOutput").addClass("error");
+          $("#bpOutput").html(""+response+"");
+        }
+      },
+      error: function(jqXHR, exception) {
+        $("#bpOutput").removeClass("add");
+        $("#bpOutput").addClass("exception");
+      }
+    });
+  }
+  <?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,18 +2,16 @@
 # (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                         #
 ###############################################################################
 
@@ -39,9 +37,8 @@ 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/"
@@ -50,32 +47,29 @@ compress.filetype           = ( "application/javascript", "text/css", "text/html
 # 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." )
-}
-
-# Entering just "pi.hole" into a browser redirects to "pi.hole/admin/"
-$HTTP["host"] == "pi.hole" {
-    $HTTP["url"] == "/" {
-        url.redirect = ( "" => "/admin/" )
+    $HTTP["url"] =~ ".ttf$" {
+        # Allow Block Page access to local fonts
+        setenv.add-response-header = ( "Access-Control-Allow-Origin" => "*" )
     }
 }
 
+# Block . files from being served, such as .git, .github, .gitignore
+$HTTP["url"] =~ "^/admin/\.(.*)" {
+     url.access-deny = ("")
+}
+
 # Add user chosen options held in external file
 include_shell "cat external.conf 2>/dev/null"

advanced/lighttpd.conf.fedora

@@ -7,13 +7,11 @@
 # 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                         #
 ###############################################################################
 
@@ -42,7 +40,7 @@ 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/"
@@ -74,25 +72,22 @@ fastcgi.server = ( ".php" =>
 
 # 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." )
-}
-
-# Entering just "pi.hole" into a browser redirects to "pi.hole/admin/"
-$HTTP["host"] == "pi.hole" {
-    $HTTP["url"] == "/" {
-        url.redirect = ( "" => "/admin/" )
+    $HTTP["url"] =~ ".ttf$" {
+        # Allow Block Page access to local fonts
+        setenv.add-response-header = ( "Access-Control-Allow-Origin" => "*" )
     }
 }
 
+# Block . files from being served, such as .git, .github, .gitignore
+$HTTP["url"] =~ "^/admin/\.(.*)" {
+     url.access-deny = ("")
+}
+
 # Add user chosen options held in external file
 include_shell "cat external.conf 2>/dev/null"

advanced/logrotate

@@ -8,3 +8,14 @@
 	notifempty
 	nomail
 }
+
+/var/log/pihole-FTL.log {
+	# su #
+	weekly
+	copytruncate
+	rotate 3
+	compress
+	delaycompress
+	notifempty
+	nomail
+}

advanced/pihole-FTL.service

@@ -25,9 +25,13 @@ 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
-    chmod 0644 /var/log/pihole-FTL.log /run/pihole-FTL.pid /run/pihole-FTL.port
+    touch /var/log/pihole-FTL.log /run/pihole-FTL.pid /run/pihole-FTL.port /var/log/pihole.log
+    mkdir -p /var/run/pihole
+    mkdir -p /var/log/pihole
+    chown pihole:pihole /var/run/pihole /var/log/pihole
+    rm /var/run/pihole/FTL.sock
+    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 /var/log/pihole.log
     su -s /bin/sh -c "/usr/bin/pihole-FTL" "$FTLUSER"
     echo
   fi

advanced/pihole.cron

@@ -14,16 +14,21 @@
 # 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
+# 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
 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 so it doesn't get out of control
-#          Stats will be viewable in the Web interface thanks to the cron job above
+# Pi-hole: Flush the log daily at 00:00
 #          The flush script will use logrotate if available
-00 00   * * *   root    PATH="$PATH:/usr/local/bin/" pihole flush
+#          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
+
+# Pi-hole: Grab local version and branch every 10 minutes
+*/10 *  * * *   root    PATH="$PATH:/usr/local/bin/" pihole updatechecker local
+
+# Pi-hole: Grab remote version every 24 hours
+59 17  * * *   root    PATH="$PATH:/usr/local/bin/" pihole updatechecker remote
+@reboot root    PATH="$PATH:/usr/local/bin/" pihole updatechecker remote reboot

automated install/uninstall.sh

@@ -8,33 +8,57 @@
 # 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 "\n  ${COL_LIGHT_GREEN}Uninstall has been cancelled${COL_NC}"; exit 0;;
+    * ) echo -e "\n  ${COL_LIGHT_GREEN}Uninstall has been cancelled${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
+	# 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 "::: Please install sudo or run this as root."
+    echo -e "  ${CROSS} ${str}
+       Script called with non-root privileges
+       The Pi-hole requires elevated privleges to uninstall"
 		exit 1
 	fi
 fi
 
+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}"
+
+# distro_check() sourced from basic-install.sh
+distro_check
+
+# Install packages used by the Pi-hole
+if [[ "${INSTALL_WEB}" == true ]]; then
+  # Install the Web dependencies
+  DEPS=("${INSTALLER_DEPS[@]}" "${PIHOLE_DEPS[@]}" "${PIHOLE_WEB_DEPS[@]}")
+# Otherwise,
+else
+  # just install the Core dependencies
+  DEPS=("${INSTALLER_DEPS[@]}" "${PIHOLE_DEPS[@]}")
+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
 	}
@@ -43,9 +67,7 @@ if [ -x "$(command -v rpm)" ]; then
 	}
 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"
 	}
@@ -54,62 +76,51 @@ elif [ -x "$(command -v apt-get)" ]; then
 		${SUDO} ${PKG_MANAGER} -y autoclean
 	}
 else
-	echo "OS distribution not supported"
-	exit
+  echo -e "  ${CROSS} OS distribution not supported"
+	exit 1
 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"
-}
-
 removeAndPurge() {
 	# Purge dependencies
-	echo ":::"
-	for i in "${PIHOLE_DEPS[@]}"; do
+  echo ""
+	for i in "${DEPS[@]}"; do
 		package_check ${i} > /dev/null
-		if [ $? -eq 0 ]; then
+		if [[ "$?" -eq 0 ]]; then
 			while true; do
-				read -rp "::: Do you wish to remove ${i} from your system? [y/n]: " yn
+				read -rp "  ${QST} Do you wish to remove ${COL_WHITE}${i}${COL_NC} 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";;
+					[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
-			printf ":::\tPackage %s not installed... Not removing.\n" "${i}"
+			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/01-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";
+	echo -ne "  ${INFO} Removing & cleaning remaining dependencies..."
+	package_cleanup &> /dev/null
+  echo -e "${OVER}  ${TICK} Removed & cleaned up remaining dependencies"
 
-	# Call removeNoPurge to remove PiHole specific files
+	# 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..."
+	# 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 /var/www/html/index.lighttpd.orig &> /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
@@ -117,65 +128,96 @@ removeNoPurge() {
     			${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
+    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
+		${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
+	if [[ $? -eq 1 ]]; then
 		${SUDO} rm -rf /etc/lighttpd/ &> /dev/null
+    	echo -e "  ${TICK} Removed lighttpd"
 	else
 		if [ -f /etc/lighttpd/lighttpd.conf.orig ]; then
 			${SUDO} mv /etc/lighttpd/lighttpd.conf.orig /etc/lighttpd/lighttpd.conf
 		fi
 	fi
 
-	${SUDO} rm /etc/dnsmasq.d/adList.conf &> /dev/null
-	${SUDO} rm /etc/dnsmasq.d/01-pihole.conf &> /dev/null
+	${SUDO} rm -f /etc/dnsmasq.d/adList.conf &> /dev/null
+	${SUDO} rm -f /etc/dnsmasq.d/01-pihole.conf &> /dev/null
 	${SUDO} rm -rf /var/log/*pihole* &> /dev/null
 	${SUDO} rm -rf /etc/pihole/ &> /dev/null
 	${SUDO} rm -rf /etc/.pihole/ &> /dev/null
 	${SUDO} rm -rf /opt/pihole/ &> /dev/null
-	${SUDO} rm /usr/local/bin/pihole &> /dev/null
-	${SUDO} rm /etc/bash_completion.d/pihole &> /dev/null
-	${SUDO} rm /etc/sudoers.d/pihole &> /dev/null
+	${SUDO} rm -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"
+
+  # 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 user exists, then remove
-	if id "pihole" >/dev/null 2>&1; then
-        	echo "::: Removing pihole user..."
-		${SUDO} userdel -r pihole
+	if id "pihole" &> /dev/null; then
+		${SUDO} userdel -r pihole 2> /dev/null
+    if [[ "$?" -eq 0 ]]; then
+      echo -e "  ${TICK} Removed 'pihole' user"
+    else
+      echo -e "  ${CROSS} Unable to remove 'pihole' user"
+    fi
 	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"
+  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)"
+if command -v vcgencmd &> /dev/null; then
+  echo -e "  ${INFO} All dependencies are safe to remove on Raspbian"
+else
+  echo -e "  ${INFO} Be sure to confirm if any dependencies should not be removed"
+fi
 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
+  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

pihole

@@ -1,4 +1,5 @@
 #!/bin/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,21 +10,23 @@
 # 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"
+readonly colfile="${PI_HOLE_SCRIPT_DIR}/COL_TABLE"
+source "${colfile}"
+
 # Must be root to use this tool
 if [[ ! $EUID -eq 0 ]];then
-  if [ -x "$(command -v sudo)" ];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."
+    echo -e "  ${CROSS} sudo is needed to run pihole commands.  Please run this script as root or install sudo."
     exit 1
   fi
 fi
 
 webpageFunc() {
-  source /opt/pihole/webpage.sh
+  source "${PI_HOLE_SCRIPT_DIR}/webpage.sh"
   main "$@"
   exit 0
 }
@@ -61,7 +64,7 @@ debugFunc() {
 }
 
 flushFunc() {
-  "${PI_HOLE_SCRIPT_DIR}"/piholeLogFlush.sh
+  "${PI_HOLE_SCRIPT_DIR}"/piholeLogFlush.sh "$@"
   exit 0
 }
 
@@ -80,17 +83,28 @@ updateGravityFunc() {
   exit 0
 }
 
+# Scan an array of files for matching strings
 scanList(){
-  domain="${1}"
-  list="${2}"
-  method="${3}"
-  if [[ ${method} == "-exact" ]] ; then
-    grep -i -E "(^|\s)${domain}($|\s)" "${list}"
-  else
-    grep -i "${domain}" "${list}"
-  fi
+  # Escape full stops
+  local domain="${1//./\\.}" lists="${2}" type="${3:-}"
+
+  # Prevent grep from printing file path
+  cd "/etc/pihole" || exit 1
+
+  # Prevent grep -i matching slowly: http://bit.ly/2xFXtUX
+  export LC_CTYPE=C
+
+  # /dev/null forces filename to be printed when only one list has been generated
+  # shellcheck disable=SC2086
+  case "${type}" in
+    "exact" ) grep -i -E -l "(^|\\s)${domain}($|\\s|#)" ${lists} /dev/null;;
+    "wc"    ) grep -i -o -m 1 "/${domain}/" ${lists};;
+    *       ) grep -i "${domain}" ${lists} /dev/null;;
+  esac
 }
 
+# Print each subdomain
+# e.g: foo.bar.baz.com = "foo.bar.baz.com bar.baz.com baz.com com"
 processWildcards() {
   IFS="." read -r -a array <<< "${1}"
   for (( i=${#array[@]}-1; i>=0; i-- )); do
@@ -107,39 +121,192 @@ processWildcards() {
 }
 
 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
+  shift
+  local options="$*" adlist="" all="" exact="" blockpage="" matchType="match"
 
-  # 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 ""
+  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:
+  -adlist             Print the name of the block list URL
+  -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
+
+  if [[ ! -e "/etc/pihole/adlists.list" ]]; then
+    echo -e "${COL_LIGHT_RED}The file '/etc/pihole/adlists.list' was not found${COL_NC}"
+    exit 1
+  fi
+
+  # Handle valid options
+  if [[ "${options}" == *"-bp"* ]]; then
+    exact="exact"; blockpage=true
+  else
+    [[ "${options}" == *"-adlist"* ]] && adlist=true
+    [[ "${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
+
+  # Scan Whitelist and Blacklist
+  lists="whitelist.txt blacklist.txt"
+  mapfile -t results <<< "$(scanList "${domainQuery}" "${lists}" "${exact}")"
+
+  if [[ -n "${results[*]}" ]]; then
+    wbMatch=true
+
+    # Loop through each result in order to print unique file title once
+    for result in "${results[@]}"; do
+      fileName="${result%%.*}"
+
+      if [[ -n "${blockpage}" ]]; then
+        echo "π ${result}"
+        exit 0
+      elif [[ -n "${exact}" ]]; then
+        echo " ${matchType^} found in ${COL_BOLD}${fileName^}${COL_NC}"
+      else
+        # Only print filename title once per file
+        if [[ ! "${fileName}" == "${fileName_prev:-}" ]]; then
+          echo " ${matchType^} found in ${COL_BOLD}${fileName^}${COL_NC}"
+          fileName_prev="${fileName}"
+        fi
+        echo "   ${result#*:}"
       fi
     done
   fi
+
+  # Scan Wildcards
+  if [[ -e "${wildcardlist}" ]]; then
+    # Determine all subdomains, domain and TLDs
+    mapfile -t wildcards <<< "$(processWildcards "${domainQuery}")"
+
+    for match in "${wildcards[@]}"; do
+      # Search wildcard list for matches
+      mapfile -t results <<< "$(scanList "${match}" "${wildcardlist}" "wc")"
+
+      if [[ -n "${results[*]}" ]]; then
+        if [[ -z "${wcMatch:-}" ]] && [[ -z "${blockpage}" ]]; then
+          wcMatch=true
+          echo " ${matchType^} found in ${COL_BOLD}Wildcards${COL_NC}:"
+        fi
+
+        case "${blockpage}" in
+          true ) echo "π ${wildcardlist##*/}"; exit 0;;
+          *    ) echo "   *.${match}";;
+        esac
+      fi
+    done
+  fi
+
+  # Get version sorted *.domains filenames (without dir path)
+  lists=("$(cd "/etc/pihole" || exit 0; printf "%s\\n" -- *.domains | sort -V)")
+
+  # Query blocklists for occurences of domain
+  mapfile -t results <<< "$(scanList "${domainQuery}" "${lists[*]}" "${exact}")"
+
+  # 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} found within 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
+
+  # Remove unwanted content from non-exact $results
+  if [[ -z "${exact}" ]]; then
+    # Delete lines starting with #
+    # Remove comments after domain
+    # Remove hosts format IP address
+    mapfile -t results <<< "$(IFS=$'\n'; sed \
+      -e "/:#/d" \
+      -e "s/[ \\t]#.*//g" \
+      -e "s/:.*[ \\t]/:/g" \
+    <<< "${results[*]}")"
+
+    # Exit if result was in a comment
+    [[ -z "${results[*]}" ]] && exit 0
+  fi
+
+  # Get adlist file content as array
+  if [[ -n "${adlist}" ]] || [[ -n "${blockpage}" ]]; then
+    for adlistUrl in $(< "/etc/pihole/adlists.list"); do
+      if [[ "${adlistUrl:0:4}" =~ (http|www.) ]]; then
+        adlists+=("${adlistUrl}")
+      fi
+    done
+  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
+    fileName="${result/:*/}"
+
+    # Determine *.domains URL using filename's number
+    if [[ -n "${adlist}" ]] || [[ -n "${blockpage}" ]]; then
+      fileNum="${fileName/list./}"; fileNum="${fileNum%%.*}"
+      fileName="${adlists[$fileNum]}"
+
+      # Discrepency occurs when adlists has been modified, but Gravity has not been run
+      if [[ -z "${fileName}" ]]; then
+        fileName="${COL_LIGHT_RED}(no associated adlists URL found)${COL_NC}"
+      fi
+    fi
+
+    if [[ -n "${blockpage}" ]]; then
+      echo "${fileNum} ${fileName}"
+    elif [[ -n "${exact}" ]]; then
+      echo "   ${fileName}"
+    else
+      if [[ ! "${fileName}" == "${fileName_prev:-}" ]]; then
+        count=""
+        echo " ${matchType^} found in ${COL_BOLD}${fileName}${COL_NC}:"
+        fileName_prev="${fileName}"
+      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 "   ${result#*:}"
+      fi
+    fi
+  done
+
   exit 0
 }
 
@@ -162,164 +329,308 @@ versionFunc() {
 }
 
 restartDNS() {
-  dnsmasqPid=$(pidof dnsmasq)
-  if [[ ${dnsmasqPid} ]]; then
-    # service already running - reload config
-    if [ -x "$(command -v systemctl)" ]; then
-      systemctl restart dnsmasq
-    else
-      service dnsmasq restart
-    fi
+  local svcOption svc str output status
+  svcOption="${1:-}"
+
+  # Determine if we should reload or restart dnsmasq
+  if [[ "${svcOption}" =~ "reload" ]]; then
+    # Using SIGHUP will NOT re-read any *.conf files
+    svc="killall -s SIGHUP dnsmasq"
   else
-    # service not running, start it up
-    if [ -x "$(command -v systemctl)" ]; then
-      systemctl start dnsmasq
+    # Get PID of dnsmasq to determine if it needs to start or restart
+    if pidof dnsmasq &> /dev/null; then
+      svcOption="restart"
     else
-      service dnsmasq start
+      svcOption="start"
     fi
+    svc="service dnsmasq ${svcOption}"
   fi
+
+  # Print output to Terminal, but not to Web Admin
+  str="${svcOption^}ing DNS service"
+  [[ -t 1 ]] && echo -ne "  ${INFO} ${str}..."
+
+  output=$( { ${svc}; } 2>&1 )
+  status="$?"
+
+  if [[ "${status}" -eq 0 ]]; then
+    [[ -t 1 ]] && echo -e "${OVER}  ${TICK} ${str}"
+  else
+    [[ ! -t 1 ]] && local OVER=""
+    echo -e "${OVER}  ${CROSS} ${output}"
+  fi
+
+  # Send signal to FTL to have it re-parse the gravity files
+  killall -s SIGHUP pihole-FTL
 }
 
 piholeEnable() {
-  if [[ "${1}" == "0" ]] ; then
-    #Disable Pihole
+  if [[ "${2}" == "-h" ]] || [[ "${2}" == "--help" ]]; then
+    echo "Usage: pihole disable [time]
+Example: 'pihole disable', or 'pihole disable 5m'
+Disable Pi-hole subsystems
+
+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
-    echo "::: Blocking has been disabled!"
-    if [[ $# > 1 ]] ; then
-      if [[ ${2} == *"s"* ]] ; then
+    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"
+    fi
+    if [[ $# > 1 ]]; 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 bash -c "sleep ${tt}; pihole enable" </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 bash -c "sleep ${tt}; pihole enable" </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"
     fi
   else
-    #Enable pihole
-    echo "::: Blocking has been enabled!"
+    # Enable Pi-hole
+    echo -e "  ${INFO} Enabling blocking"
+    local str="Pi-hole 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"
+    fi
   fi
+
   restartDNS
+
+  echo -e "${OVER}  ${TICK} ${str}"
 }
 
 piholeLogging() {
   shift
+  if [[ "${1}" == "-h" ]] || [[ "${1}" == "--help" ]]; then
+    echo "Usage: pihole logging [options]
+Example: 'pihole logging on'
+Specify whether the Pi-hole log should be used
 
-  if [[ "${1}" == "off" ]] ; then
-    #Disable Logging
+Options:
+  on                  Enable 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!"
-  elif [[ "${1}" == "on" ]] ; then
-    #Enable logging
+    if [[ "${2}" != "noflush" ]]; then
+      # Flush logs
+      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 ') > 0 ]]; then
-    if [[ "${1}" != "web" ]] ; then
-      echo "::: DNS service is running"
+statusFunc() {
+  local addnConfigs
+
+  # Determine if service is running on port 53 (Cr: https://superuser.com/a/806331)
+  if (echo > /dev/tcp/localhost/53) >/dev/null 2>&1; then
+    if [[ "${1}" != "web" ]]; then
+      echo -e "  ${TICK} DNS service is running"
     fi
   else
-    if [[ "${1}" == "web" ]] ; then
-      echo "-1";
-    else
-      echo "::: DNS service is NOT running"
-    fi
-    return
+    case "${1}" in
+      "web") echo "-1";;
+      *) echo -e "  ${CROSS} DNS service is NOT running";;
+    esac
+    return 0
   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 addn-hosts configs are commented out
+  addnConfigs=$(grep -i "addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf)
+
+  if [[ "${addnConfigs}" =~ "#" ]]; then
+    # A config is commented out
+    case "${1}" in
+      "web") echo 0;;
+      *) echo -e "  ${CROSS} Pi-hole blocking is Disabled";;
+    esac
+  elif [[ -n "${addnConfigs}" ]]; then
+    # Configs are set
+    case "${1}" in
+      "web") echo 1;;
+      *) 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
+    # No configs were found
+    case "${1}" in
+      "web") echo 99;;
+      *) echo -e "  ${INFO} No hosts file linked to dnsmasq, adding it in enabled state";;
+    esac
+    # Add addn-host= to dnsmasq
     echo "addn-hosts=/etc/pihole/gravity.list" >> /etc/dnsmasq.d/01-pihole.conf
     restartDNS
   fi
 }
 
 tailFunc() {
-  echo "Press Ctrl-C to exit"
-  tail -F /var/log/pihole.log
+  echo -e "  ${INFO} Press Ctrl-C to exit"
+
+  # Retrieve IPv4/6 addresses
+  source /etc/pihole/setupVars.conf
+
+  # Strip date from each line
+  # Colour blocklist/blacklist/wildcard entries as red
+  # Colour A/AAAA/DHCP strings as white
+  # Colour everything else as gray
+  tail -f /var/log/pihole.log | sed -E \
+    -e "s,($(date +'%b %d ')| dnsmasq[.*[0-9]]),,g" \
+    -e "s,(.*(gravity.list|black.list| config ).* is (${IPV4_ADDRESS%/*}|${IPV6_ADDRESS:-NULL}).*),${COL_RED}&${COL_NC}," \
+    -e "s,.*(query\\[A|DHCP).*,${COL_NC}&${COL_NC}," \
+    -e "s,.*,${COL_GRAY}&${COL_NC},"
   exit 0
 }
 
 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
+
+Repositories:
+  core [branch]       Change the branch of Pi-hole's core subsystem
+  web [branch]        Change the branch of Admin Console 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"
+    exit 0
+  fi
+
   source "${PI_HOLE_SCRIPT_DIR}"/piholeCheckout.sh
   shift
   checkout "$@"
 }
 
+tricorderFunc() {
+  if [[ ! -p "/dev/stdin" ]]; then
+    echo -e "  ${INFO} Please do not call Tricorder directly"
+    exit 1
+  fi
+
+  if ! (echo > /dev/tcp/tricorder.pi-hole.net/9998) >/dev/null 2>&1; then
+    echo -e "  ${CROSS} Unable to connect to Pi-hole's Tricorder server"
+    exit 1
+  fi
+
+  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 -e "  ${INFO} ${COL_YELLOW}Security Notice${COL_NC}: ${COL_WHITE}openssl${COL_NC} is not installed
+       Your debug log will be transmitted unencrypted via plain-text
+       There is a possibility that this could be intercepted by a third party
+       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() {
-	cat << EOM
-::: Control all Pi-hole specific functions
-:::
-::: Usage: pihole [options]
-:::		Add -h after -w (whitelist), -b (blacklist), -c (chronometer), or -a (admin) for more information on usage
-:::
-::: Options:
-:::  -w, whitelist            Whitelist domain(s)
-:::  -b, blacklist            Blacklist domain(s) (exact match)
-:::  -wild, wildcard          Blacklist whole domain(s) (wildcard)
-:::  -d, debug                Start a debugging session
-:::                             Automated debugging can be enabled with '-a'.
-:::                             'pihole -d -a'
-:::  -f, flush                Flush the 'pihole.log' file
-:::  -t, tail                 Output the last lines of the 'pihole.log' file. Lines are appended as the file grows
-:::  -up, updatePihole        Update Pi-hole components
-:::  -r, reconfigure          Reconfigure or Repair Pi-hole
-:::  -g, updateGravity        Update the list of ad-serving domains
-:::  -c, chronometer          Calculates stats and displays to an LCD
-:::  -h, help                 Show this help dialog
-:::  -v, version              Show installed versions of Pi-hole and Web-Admin
-:::  -q, query                Query the adlists for a specific domain
-:::                             'pihole -q domain -exact' shows exact matches only
-:::  -l, logging              Enable or Disable logging (pass 'on' or 'off')
-:::  -a, admin                Admin webpage options
-:::  uninstall                Uninstall Pi-hole from your system! :(
-:::  status                   Display if Pi-hole is Enabled or Disabled
-:::  enable                   Enable Pi-hole DNS Blocking
-:::  disable                  Disable Pi-hole DNS Blocking
-:::                             Blocking can also be disabled only temporarily, e.g.,
-:::                             'pihole disable 5m' - will disable blocking for 5 minutes
-:::  restartdns               Restart dnsmasq
-:::  checkout                 Check out different branches
-EOM
+  echo "Usage: pihole [options]
+Example: 'pihole -w -h'
+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
+                        Add '-h' for more info on whitelist/blacklist usage
+
+Debugging Options:
+  -d, debug           Start a debugging session
+                        Add '-a' to enable automated debugging
+  -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
+
+Options:
+  -a, admin           Admin Console options
+                        Add '-h' for more info on admin console 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
+  -h, --help, help    Show this help dialog
+  -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 '-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 '-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";
   exit 0
 }
 
@@ -333,7 +644,7 @@ case "${1}" in
   "-b" | "blacklist"            ) blacklistFunc "$@";;
   "-wild" | "wildcard"          ) wildcardFunc "$@";;
   "-d" | "debug"                ) debugFunc "$@";;
-  "-f" | "flush"                ) flushFunc;;
+  "-f" | "flush"                ) flushFunc "$@";;
   "-up" | "updatePihole"        ) updatePiholeFunc;;
   "-r"  | "reconfigure"         ) reconfigurePiholeFunc;;
   "-g" | "updateGravity"        ) updateGravityFunc "$@";;
@@ -344,11 +655,13 @@ case "${1}" in
   "-l" | "logging"              ) piholeLogging "$@";;
   "uninstall"                   ) uninstallFunc;;
   "enable"                      ) piholeEnable 1;;
-  "disable"                     ) piholeEnable 0 $2;;
-  "status"                      ) piholeStatus "$2";;
-  "restartdns"                  ) restartDNS;;
+  "disable"                     ) piholeEnable 0 "$2";;
+  "status"                      ) statusFunc "$2";;
+  "restartdns"                  ) restartDNS "$2";;
   "-a" | "admin"                ) webpageFunc "$@";;
   "-t" | "tail"                 ) tailFunc;;
   "checkout"                    ) piholeCheckoutFunc "$@";;
+  "tricorder"                   ) tricorderFunc;;
+  "updatechecker"               ) updateCheckFunc "$@";;
   *                             ) helpFunc;;
 esac

test/test_automated_install.py

@@ -9,6 +9,10 @@ SETUPVARS = {
     'PIHOLE_DNS_2' : '4.2.2.2'
 }
 
+tick_box="[\x1b[1;32m\xe2\x9c\x93\x1b[0m]".decode("utf-8")
+cross_box="[\x1b[1;31m\xe2\x9c\x97\x1b[0m]".decode("utf-8")
+info_box="[i]".decode("utf-8")
+
 def test_setupVars_are_sourced_to_global_scope(Pihole):
     ''' currently update_dialogs sources setupVars with a dot,
     then various other functions use the variables.
@@ -55,6 +59,8 @@ def test_setupVars_saved_to_file(Pihole):
     TERM=xterm
     source /opt/pihole/basic-install.sh
     {}
+    mkdir -p /etc/dnsmasq.d
+    version_check_dnsmasq
     finalExports
     cat /etc/pihole/setupVars.conf
     '''.format(set_setup_vars))
@@ -74,7 +80,7 @@ def test_configureFirewall_firewalld_running_no_errors(Pihole):
     source /opt/pihole/basic-install.sh
     configureFirewall
     ''')
-    expected_stdout = 'Configuring FirewallD for httpd and dnsmasq.'
+    expected_stdout = 'Configuring FirewallD for httpd and dnsmasq'
     assert expected_stdout in configureFirewall.stdout
     firewall_calls = Pihole.run('cat /var/log/firewall-cmd').stdout
     assert 'firewall-cmd --state' in firewall_calls
@@ -89,7 +95,7 @@ def test_configureFirewall_firewalld_disabled_no_errors(Pihole):
     source /opt/pihole/basic-install.sh
     configureFirewall
     ''')
-    expected_stdout = 'No active firewall detected.. skipping firewall configuration.'
+    expected_stdout = 'No active firewall detected.. skipping firewall configuration'
     assert expected_stdout in configureFirewall.stdout
 
 def test_configureFirewall_firewalld_enabled_declined_no_errors(Pihole):
@@ -173,105 +179,13 @@ def test_installPiholeWeb_fresh_install_no_errors(Pihole):
     source /opt/pihole/basic-install.sh
     installPiholeWeb
     ''')
-    assert 'Installing pihole custom index page...' in installWeb.stdout
+    assert info_box + ' Installing blocking page...' in installWeb.stdout
+    assert tick_box + ' Creating directory for blocking page, and copying files' in installWeb.stdout
+    assert cross_box + ' Backing up index.lighttpd.html' in installWeb.stdout
     assert 'No default index.lighttpd.html file found... not backing up' in installWeb.stdout
+    assert tick_box + ' Installing sudoer file' in installWeb.stdout
     web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
     assert 'index.php' in web_directory
-    assert 'index.js' in web_directory
-    assert 'blockingpage.css' in web_directory
-
-def test_installPiholeWeb_empty_directory_no_errors(Pihole):
-    ''' confirms all web page assets from Core repo are installed in an emtpy directory '''
-    installWeb = Pihole.run('''
-    source /opt/pihole/basic-install.sh
-    mkdir -p /var/www/html/pihole
-    installPiholeWeb
-    ''')
-    assert 'Installing pihole custom index page...' in installWeb.stdout
-    assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
-    assert 'index.php missing, replacing...' in installWeb.stdout
-    assert 'index.js missing, replacing...' in installWeb.stdout
-    assert 'blockingpage.css missing, replacing...' in installWeb.stdout
-    web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
-    assert 'index.php' in web_directory
-    assert 'index.js' in web_directory
-    assert 'blockingpage.css' in web_directory
-
-def test_installPiholeWeb_index_php_no_errors(Pihole):
-    ''' confirms all web page assets from Core repo are installed when necessary '''
-    installWeb = Pihole.run('''
-    source /opt/pihole/basic-install.sh
-    mkdir -p /var/www/html/pihole
-    touch /var/www/html/pihole/index.php
-    installPiholeWeb
-    ''')
-    assert 'Installing pihole custom index page...' in installWeb.stdout
-    assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
-    assert 'Existing index.php detected, not overwriting' in installWeb.stdout
-    assert 'index.js missing, replacing...' in installWeb.stdout
-    assert 'blockingpage.css missing, replacing...' in installWeb.stdout
-    web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
-    assert 'index.php' in web_directory
-    assert 'index.js' in web_directory
-    assert 'blockingpage.css' in web_directory
-
-def test_installPiholeWeb_index_js_no_errors(Pihole):
-    ''' confirms all web page assets from Core repo are installed when necessary '''
-    installWeb = Pihole.run('''
-    source /opt/pihole/basic-install.sh
-    mkdir -p /var/www/html/pihole
-    touch /var/www/html/pihole/index.js
-    installPiholeWeb
-    ''')
-    assert 'Installing pihole custom index page...' in installWeb.stdout
-    assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
-    assert 'index.php missing, replacing...' in installWeb.stdout
-    assert 'Existing index.js detected, not overwriting' in installWeb.stdout
-    assert 'blockingpage.css missing, replacing...' in installWeb.stdout
-    web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
-    assert 'index.php' in web_directory
-    assert 'index.js' in web_directory
-    assert 'blockingpage.css' in web_directory
-
-def test_installPiholeWeb_blockingpage_css_no_errors(Pihole):
-    ''' confirms all web page assets from Core repo are installed when necessary '''
-    installWeb = Pihole.run('''
-    source /opt/pihole/basic-install.sh
-    mkdir -p /var/www/html/pihole
-    touch /var/www/html/pihole/blockingpage.css
-    installPiholeWeb
-    ''')
-    assert 'Installing pihole custom index page...' in installWeb.stdout
-    assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
-    assert 'index.php missing, replacing...' in installWeb.stdout
-    assert 'index.js missing, replacing...' in installWeb.stdout
-    assert 'Existing blockingpage.css detected, not overwriting' in installWeb.stdout
-    web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
-    assert 'index.php' in web_directory
-    assert 'index.js' in web_directory
-    assert 'blockingpage.css' in web_directory
-
-def test_installPiholeWeb_already_populated_no_errors(Pihole):
-    ''' confirms all web page assets from Core repo are installed when necessary '''
-    installWeb = Pihole.run('''
-    source /opt/pihole/basic-install.sh
-    mkdir -p /var/www/html/pihole
-    touch /var/www/html/pihole/index.php
-    touch /var/www/html/pihole/index.js
-    touch /var/www/html/pihole/blockingpage.css
-    installPiholeWeb
-    ''')
-    assert 'Installing pihole custom index page...' in installWeb.stdout
-    assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
-    assert 'Existing index.php detected, not overwriting' in installWeb.stdout
-    assert 'index.php missing, replacing...' not in installWeb.stdout
-    assert 'Existing index.js detected, not overwriting' in installWeb.stdout
-    assert 'index.js missing, replacing...' not in installWeb.stdout
-    assert 'Existing blockingpage.css detected, not overwriting' in installWeb.stdout
-    assert 'blockingpage.css missing, replacing... ' not in installWeb.stdout
-    web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
-    assert 'index.php' in web_directory
-    assert 'index.js' in web_directory
     assert 'blockingpage.css' in web_directory
 
 def test_update_package_cache_success_no_errors(Pihole):
@@ -281,9 +195,8 @@ def test_update_package_cache_success_no_errors(Pihole):
     distro_check
     update_package_cache
     ''')
-    assert 'Updating local cache of available packages...' in updateCache.stdout
-    assert 'ERROR' not in updateCache.stdout
-    assert 'done!' in updateCache.stdout
+    assert tick_box + ' Update local cache of available packages' in updateCache.stdout
+    assert 'Error: Unable to update package cache.' not in updateCache.stdout
 
 def test_update_package_cache_failure_no_errors(Pihole):
     ''' confirms package cache was not updated'''
@@ -293,9 +206,8 @@ def test_update_package_cache_failure_no_errors(Pihole):
     distro_check
     update_package_cache
     ''')
-    assert 'Updating local cache of available packages...' in updateCache.stdout
-    assert 'ERROR' in updateCache.stdout
-    assert 'done!' not in updateCache.stdout
+    assert cross_box + ' Update local cache of available packages' in updateCache.stdout
+    assert 'Error: Unable to update package cache.' in updateCache.stdout
 
 def test_FTL_detect_aarch64_no_errors(Pihole):
     ''' confirms only aarch64 package is downloaded for FTL engine '''
@@ -307,7 +219,11 @@ def test_FTL_detect_aarch64_no_errors(Pihole):
     source /opt/pihole/basic-install.sh
     FTLdetect
     ''')
-    expected_stdout = 'Detected ARM-aarch64 architecture'
+    expected_stdout = info_box + ' FTL Checks...'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Detected ARM-aarch64 architecture'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
     assert expected_stdout in detectPlatform.stdout
 
 def test_FTL_detect_armv6l_no_errors(Pihole):
@@ -320,7 +236,11 @@ def test_FTL_detect_armv6l_no_errors(Pihole):
     source /opt/pihole/basic-install.sh
     FTLdetect
     ''')
-    expected_stdout = 'Detected ARM-hf architecture (armv6 or lower)'
+    expected_stdout = info_box + ' FTL Checks...'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Detected ARM-hf architecture (armv6 or lower)'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
     assert expected_stdout in detectPlatform.stdout
 
 def test_FTL_detect_armv7l_no_errors(Pihole):
@@ -333,7 +253,11 @@ def test_FTL_detect_armv7l_no_errors(Pihole):
     source /opt/pihole/basic-install.sh
     FTLdetect
     ''')
-    expected_stdout = 'Detected ARM-hf architecture (armv7+)'
+    expected_stdout = info_box + ' FTL Checks...'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Detected ARM-hf architecture (armv7+)'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
     assert expected_stdout in detectPlatform.stdout
 
 def test_FTL_detect_x86_64_no_errors(Pihole):
@@ -342,7 +266,11 @@ def test_FTL_detect_x86_64_no_errors(Pihole):
     source /opt/pihole/basic-install.sh
     FTLdetect
     ''')
-    expected_stdout = 'Detected x86_64 architecture'
+    expected_stdout = info_box + ' FTL Checks...'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Detected x86_64 architecture'
+    assert expected_stdout in detectPlatform.stdout
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
     assert expected_stdout in detectPlatform.stdout
 
 def test_FTL_detect_unknown_no_errors(Pihole):
@@ -363,9 +291,12 @@ def test_FTL_download_aarch64_no_errors(Pihole):
     source /opt/pihole/basic-install.sh
     FTLinstall pihole-FTL-aarch64-linux-gnu
     ''')
-    expected_stdout = 'done'
+    expected_stdout = tick_box + ' Downloading and Installing FTL'
     assert expected_stdout in download_binary.stdout
-    assert 'failed' not in download_binary.stdout
+    error = 'Error: Download of binary from Github failed'
+    assert error not in download_binary.stdout
+    error = 'Error: URL not found'
+    assert error not in download_binary.stdout
 
 def test_FTL_download_unknown_fails_no_errors(Pihole):
     ''' confirms unknown binary is not downloaded for FTL engine '''
@@ -374,9 +305,10 @@ def test_FTL_download_unknown_fails_no_errors(Pihole):
     source /opt/pihole/basic-install.sh
     FTLinstall pihole-FTL-mips
     ''')
-    expected_stdout = 'failed'
+    expected_stdout = cross_box + ' Downloading and Installing FTL'
     assert expected_stdout in download_binary.stdout
-    assert 'done' not in download_binary.stdout
+    error = 'Error: URL not found'
+    assert error in download_binary.stdout
 
 def test_FTL_binary_installed_and_responsive_no_errors(Pihole):
     ''' confirms FTL binary is copied and functional in installed location '''
@@ -402,6 +334,61 @@ def test_FTL_binary_installed_and_responsive_no_errors(Pihole):
 #     assert '644 /run/pihole-FTL.pid' in support_files.stdout
 #     assert '644 /var/log/pihole-FTL.log' in support_files.stdout
 
+def test_IPv6_only_link_local(Pihole):
+    ''' confirms IPv6 blocking is disabled for Link-local address '''
+    # mock ip -6 address to return Link-local address
+    mock_command_2('ip', {'-6 address':('inet6 fe80::d210:52fa:fe00:7ad7/64 scope link', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    useIPv6dialog
+    ''')
+    expected_stdout = 'Unable to find IPv6 ULA/GUA address, IPv6 adblocking will not be enabled'
+    assert expected_stdout in detectPlatform.stdout
+
+def test_IPv6_only_ULA(Pihole):
+    ''' confirms IPv6 blocking is enabled for ULA addresses '''
+    # mock ip -6 address to return ULA address
+    mock_command_2('ip', {'-6 address':('inet6 fda2:2001:5555:0:d210:52fa:fe00:7ad7/64 scope global', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    useIPv6dialog
+    ''')
+    expected_stdout = 'Found IPv6 ULA address, using it for blocking IPv6 ads'
+    assert expected_stdout in detectPlatform.stdout
+
+def test_IPv6_only_GUA(Pihole):
+    ''' confirms IPv6 blocking is enabled for GUA addresses '''
+    # mock ip -6 address to return GUA address
+    mock_command_2('ip', {'-6 address':('inet6 2003:12:1e43:301:d210:52fa:fe00:7ad7/64 scope global', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    useIPv6dialog
+    ''')
+    expected_stdout = 'Found IPv6 GUA address, using it for blocking IPv6 ads'
+    assert expected_stdout in detectPlatform.stdout
+
+def test_IPv6_GUA_ULA_test(Pihole):
+    ''' confirms IPv6 blocking is enabled for GUA and ULA addresses '''
+    # mock ip -6 address to return GUA and ULA addresses
+    mock_command_2('ip', {'-6 address':('inet6 2003:12:1e43:301:d210:52fa:fe00:7ad7/64 scope global\ninet6 fda2:2001:5555:0:d210:52fa:fe00:7ad7/64 scope global', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    useIPv6dialog
+    ''')
+    expected_stdout = 'Found IPv6 ULA address, using it for blocking IPv6 ads'
+    assert expected_stdout in detectPlatform.stdout
+
+def test_IPv6_ULA_GUA_test(Pihole):
+    ''' confirms IPv6 blocking is enabled for GUA and ULA addresses '''
+    # mock ip -6 address to return ULA and GUA addresses
+    mock_command_2('ip', {'-6 address':('inet6 fda2:2001:5555:0:d210:52fa:fe00:7ad7/64 scope global\ninet6 2003:12:1e43:301:d210:52fa:fe00:7ad7/64 scope global', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    useIPv6dialog
+    ''')
+    expected_stdout = 'Found IPv6 ULA address, using it for blocking IPv6 ads'
+    assert expected_stdout in detectPlatform.stdout
+
 # 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 '''
@@ -424,6 +411,27 @@ def mock_command(script, args, container):
     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('''\
+    #!/bin/bash -e
+    echo "\$0 \$@" >> /var/log/{script}
+    case "\$1 \$2" in'''.format(script=script))
+    for k, v in args.iteritems():
+        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

test/test_shellcheck.py

@@ -7,7 +7,7 @@ run_local = testinfra.get_backend(
 
 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;"
+    shellcheck = "find . -type f -name 'update.sh' | while read file; do shellcheck -x \"$file\" -e SC1090,SC1091; done;"
     results = run_local(shellcheck)
     print results.stdout
     assert '' == results.stdout