Merge pull request #1617 from pi-hole/hotfix/CIDR

Hotfix/cidr (Pi-hole 3.1.1)

.editorconfig

@@ -0,0 +1,38 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = tab
+tab_width = 2
+charset = utf-8
+trim_trailing_whitespace = true
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.{js,py}]
+charset = utf-8
+
+# 4 space indentation
+[*.py]
+indent_style = space
+indent_size = 4
+
+# Tab indentation (no size specified)
+[Makefile]
+indent_style = tab
+
+# Indentation override for all JS under lib directory
+[scripts/**.js]
+indent_style = space
+indent_size = 2
+
+# Matches the exact files either package.json or .travis.yml
+[{package.json,.travis.yml}]
+indent_style = space
+indent_size = 2

.gitattributes

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

.github/ISSUE_TEMPLATE.md

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

.github/PULL_REQUEST_TEMPLATE.md

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

.gitignore

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

.idea/codeStyleSettings.xml

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

.pullapprove.yml

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

.travis.yml

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

CONTRIBUTING.md

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

LICENSE

@@ -1,339 +1,146 @@
-GNU GENERAL PUBLIC LICENSE
-                       Version 2, June 1991
+Copyright (C) 2017 Pi-hole, LLC (https://pi-hole.net)
+Pi-hole Core
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
+This software is licensed under the European Union Public License (EUPL)
+The license is available in the 22 official languages of the EU. The English version is included here.
+Please see https://joinup.ec.europa.eu/community/eupl/og_page/eupl for official translations of the other languages.
 
-                            Preamble
+This license applies to the whole project EXCEPT:
 
-  The licenses for most software are designed to take away your
-freedom to share and change it.  By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users.  This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it.  (Some other Free Software Foundation software is covered by
-the GNU Lesser General Public License instead.)  You can apply it to
-your programs, too.
+ - any commits made to the master branch prior to the release of version 3.0
 
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
+The licenses that existed prior to this change have remained intact.
 
-  To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
+-------------------------------------------------------------
+EUROPEAN UNION PUBLIC LICENCE v. 1.2
 
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have.  You must make sure that they, too, receive or can get the
-source code.  And you must show them these terms so they know their
-rights.
+EUPL © the European Union 2007, 2016
 
-  We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
+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.
 
-  Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software.  If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
+1. Definitions
 
-  Finally, any free program is threatened constantly by software
-patents.  We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary.  To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
+In this Licence, the following terms have the following meaning:
 
-  The precise terms and conditions for copying, distribution and
-modification follow.
+- The Licence: this Licence.
+- 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 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 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 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.
 
-                    GNU GENERAL PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+2. Scope of the rights granted by the Licence
 
-  0. This License applies to any program or other work which contains
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License.  The "Program", below,
-refers to any such program or work, and a "work based on the Program"
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language.  (Hereinafter, translation is included without limitation in
-the term "modification".)  Each licensee is addressed as "you".
+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 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,
+- 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.
 
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope.  The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
+3. Communication of the Source Code
 
-  1. You may copy and distribute verbatim copies of the Program's
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
+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.
 
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
+4. Limitations on copyright
 
-  2. You may modify your copy or copies of the Program or any portion
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
+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.
 
-    a) You must cause the modified files to carry prominent notices
-    stating that you changed the files and the date of any change.
+5. Obligations of the Licensee
 
-    b) You must cause any work that you distribute or publish, that in
-    whole or in part contains or is derived from the Program or any
-    part thereof, to be licensed as a whole at no charge to all third
-    parties under the terms of this License.
+The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those obligations are the following:
 
-    c) If the modified program normally reads commands interactively
-    when run, you must cause it, when started running for such
-    interactive use in the most ordinary way, to print or display an
-    announcement including an appropriate copyright notice and a
-    notice that there is no warranty (or else, saying that you provide
-    a warranty) and that users may redistribute the program under
-    these conditions, and telling the user how to view a copy of this
-    License.  (Exception: if the Program itself is interactive but
-    does not normally print such an announcement, your work based on
-    the Program is not required to print an announcement.)
+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.
 
-These requirements apply to the modified work as a whole.  If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works.  But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
+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.
 
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
+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.
 
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
+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.
 
-  3. You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
+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.
 
-    a) Accompany it with the complete corresponding machine-readable
-    source code, which must be distributed under the terms of Sections
-    1 and 2 above on a medium customarily used for software interchange; or,
+6. Chain of Authorship
 
-    b) Accompany it with a written offer, valid for at least three
-    years, to give any third party, for a charge no more than your
-    cost of physically performing source distribution, a complete
-    machine-readable copy of the corresponding source code, to be
-    distributed under the terms of Sections 1 and 2 above on a medium
-    customarily used for software interchange; or,
+The original Licensor warrants that the copyright in the Original Work granted hereunder is owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
 
-    c) Accompany it with the information you received as to the offer
-    to distribute corresponding source code.  (This alternative is
-    allowed only for noncommercial distribution and only if you
-    received the program in object code or executable form with such
-    an offer, in accord with Subsection b above.)
+Each Contributor warrants that the copyright in the modifications he/she brings to the Work are owned by him/her or licensed to him/her and that he/she has the power and authority to grant the Licence.
 
-The source code for a work means the preferred form of the work for
-making modifications to it.  For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable.  However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
+Each time You accept the Licence, the original Licensor and subsequent Contributors grant You a licence to their contributions to the Work, under the terms of this Licence.
 
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
+7. Disclaimer of Warranty
 
-  4. You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License.  Any attempt
-otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
+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.
 
-  5. You are not required to accept this License, since you have not
-signed it.  However, nothing else grants you permission to modify or
-distribute the Program or its derivative works.  These actions are
-prohibited by law if you do not accept this License.  Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
+8. Disclaimer of Liability
 
-  6. Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions.  You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
+Except in the cases of wilful misconduct or damages directly caused to natural persons, the Licensor will in no event be liable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the Work, including without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss of data or any commercial damage, even if the Licensor has been advised of the possibility of such damage. However, the Licensor will be liable under statutory product liability laws as far such laws apply to the Work.
 
-  7. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all.  For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
+9. Additional agreements
 
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
+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.
 
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices.  Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
+10. Acceptance of the Licence
 
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
+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.
 
-  8. If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded.  In such case, this License incorporates
-the limitation as if written in the body of this License.
+11. Information to the public
 
-  9. The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
+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.
 
-Each version is given a distinguishing version number.  If the Program
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation.  If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
+12. Termination of the Licence
 
-  10. If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author
-to ask for permission.  For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this.  Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
+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.
 
-                            NO WARRANTY
+13. Miscellaneous
 
-  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
+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.
 
-  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
+14. Jurisdiction
 
-                     END OF TERMS AND CONDITIONS
+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.
 
-            How to Apply These Terms to Your New Programs
+15. Applicable Law
 
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
+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.
 
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
+===
 
-    {description}
-    Copyright (C) {year}  {fullname}
+Appendix
 
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License along
-    with this program; if not, write to the Free Software Foundation, Inc.,
-    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
-
-    Gnomovision version 69, Copyright (C) year name of author
-    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, the commands you use may
-be called something other than `show w' and `show c'; they could even be
-mouse-clicks or menu items--whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary.  Here is a sample; alter the names:
-
-  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
-  `Gnomovision' (which makes passes at compilers) written by James Hacker.
-
-  {signature of Ty Coon}, 1 April 1989
-  Ty Coon, President of Vice
-
-This General Public License does not permit incorporating your program into
-proprietary programs.  If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.
+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
+- 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,79 +1,128 @@
-[![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=3011939)](https://www.bountysource.com/trackers/3011939-pi-hole-pi-hole?utm_source=3011939&utm_medium=shield&utm_campaign=TRACKER_BADGE)   
+<p align="center">
+<a href=https://www.bountysource.com/trackers/3011939-pi-hole-pi-hole?utm_source=3011939&utm_medium=shield&utm_campaign=TRACKER_BADGE><img src="https://www.bountysource.com/badge/tracker?tracker_id=3011939"></a>
+<a href="https://www.codacy.com/app/Pi-hole/pi-hole?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=pi-hole/pi-hole&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/c558a0f8d7124c99b02b84f0f5564238"/></a>
+<a href=https://travis-ci.org/pi-hole/pi-hole><img src="https://travis-ci.org/pi-hole/pi-hole.svg?branch=development"></a>
+</p>
 
-# Automated Install
+<p align="center">
+<a href=https://discourse.pi-hole.net><img src="https://assets.pi-hole.net/static/Vortex_with_text_and_TM.png" width=210></a>
+</p>
 
-Designed For Raspberry Pi A+, B, B+, 2, 3B, and Zero (with an Ethernet/Wi-Fi adapter)
-Works on most Debian and CentOS/RHEL based distributions!
+## The multi-platform, network-wide ad blocker
 
-1.  Install Raspbian
-2.  Run the command below (downloads [this script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) in case you want to read over it first!)
+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.
 
-## `curl -L https://install.pi-hole.net | bash`
+- Web Browsers
+- Cell Phones
+- Smart TV's
+- Internet-connected home automation
+- Anything that communicates with the Internet
 
-### Alternative Semi-Automated install
+<p align="center">
+<a href=http://www.digitalocean.com/?refcode=344d234950e1><img src="https://assets.pi-hole.net/static/DOHostingSlug.png"></a>
+</p>
+
+## Your Support Still Matters
+
+Digital Ocean helps with our infrastructure, but our developers are all volunteers so *your donations help keep us innovating*. Sending a donation using our links below helps us offset a portion of our monthly costs.
+
+-   ![Paypal](https://assets.pi-hole.net/static/paypal.png) [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
+-   ![Bitcoin](https://assets.pi-hole.net/static/Bitcoin.png) Bitcoin Address: 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
+
+### One-Step Automated Install
+1.  Install a [supported operating system](https://discourse.pi-hole.net/t/hardware-software-requirements/273/1)
+2.  Run the command below (it downloads [this script](https://github.com/pi-hole/pi-hole/blob/master/automated%20install/basic-install.sh) in case you want to read over it first!)
+
+### `curl -sSL https://install.pi-hole.net | bash`
+
+#### Alternative Semi-Automated Install Methods
+_If you wish to read over the script before running it, run `nano basic-install.sh` to open the file in a text viewer._
+
+##### Clone our repository and run the automated installer from your device.
+
+```
+git clone --depth 1 https://github.com/pi-hole/pi-hole.git Pi-hole
+cd Pi-hole/automated\ install/
+bash basic-install.sh
+```
+
+##### Or
 
 ```bash
 wget -O basic-install.sh https://install.pi-hole.net
-chmod +x basic-install.sh
-./basic-install.sh
+bash basic-install.sh
 ```
 
-If you wish to read over the script before running it, then after the `wget` command, do `nano basic-install.sh` to open a text viewer
+Once installed, [configure your router to have **DHCP clients use the Pi as their DNS server**](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245) and then any device that connects to your network will have ads blocked without any further configuration. Alternatively, you can manually set each device to use Pi-hole™ as their DNS server.
 
-Once installed, [configure your router to have **DHCP clients use the Pi as their DNS server**](http://pi-hole.net/faq/can-i-set-the-pi-hole-to-be-the-dns-server-at-my-router-so-i-dont-have-to-change-settings-for-my-devices/) and then any device that connects to your network will have ads blocked without any further configuration. Alternatively, you can manually set each device to [use the Raspberry Pi as its DNS server](http://pi-hole.net/faq/how-do-i-use-the-pi-hole-as-my-dns-server/).
+## 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>
 
-## How To Install Pi-hole
-
-[![60-second install tutorial](http://i.imgur.com/5TEc3a6.png)](https://www.youtube.com/watch?v=TzFLJqUeirA)
-
-## How It Works
-
-**Watch the 60-second video below to get a quick overview**
-
-[![Pi-hole exlplained](http://i.imgur.com/pG1m937.png)](https://youtu.be/9Eti3xibiho)
-
-## Pi-hole Is Free, But Powered By Your Donations
-
-Send a one-time donation or sign up for Optimal.com's service using our link below to provide us with a small portion of the monthly fee.
-
--   ![Paypal](http://i.imgur.com/3muNfxu.png) : [Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
--   ![Flattr](http://i.imgur.com/ZFceFRu.png) : [Donate](https://flattr.com/submit/auto?user_id=jacobsalmela&url=https://github.com/pi-hole/pi-hole)
--   ![Bitcoin](http://i.imgur.com/FIlmOMG.png) : 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
 
 ## Get Help Or Connect With Us On The Web
 
--   [@The_Pi_Hole](https://twitter.com/The_Pi_Hole)
--   [/r/pihole](https://www.reddit.com/r/pihole/)
--   [Pi-hole YouTube channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w)
--   [Wiki](https://github.com/pi-hole/pi-hole/wiki/Customization)
--   [FAQs](https://pi-hole.net/help/)
+-   [Users Forum](https://discourse.pi-hole.net/)
+-   [FAQs](https://discourse.pi-hole.net/c/faqs)
+-   [Wiki](https://github.com/pi-hole/pi-hole/wiki)
+-   ![Twitter](https://assets.pi-hole.net/static/twitter.png) [Tweet @The_Pi_Hole](https://twitter.com/The_Pi_Hole)
+-   ![Reddit](https://assets.pi-hole.net/static/reddit.png) [Reddit /r/pihole](https://www.reddit.com/r/pihole/)
+-   ![YouTube](https://assets.pi-hole.net/static/youtube.png)  [Pi-hole channel](https://www.youtube.com/channel/UCT5kq9w0wSjogzJb81C9U0w)
 -   [![Join the chat at https://gitter.im/pi-hole/pi-hole](https://badges.gitter.im/pi-hole/pi-hole.svg)](https://gitter.im/pi-hole/pi-hole?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 ## Technical Details
 
-The Pi-hole is an **advertising-aware DNS/Web server**. If an ad domain is queried, a small Web page or GIF is delivered in place of the advertisement. You can also [replace ads with any image you want](http://pi-hole.net/faq/is-it-possible-to-change-the-blank-page-that-takes-place-of-the-ads-to-something-else/) since it is just a simple Webpage taking place of the ads.
+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.
 
 ### Gravity
 
-The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/gravity.sh) does most of the magic. The script pulls in ad domains from many sources and compiles them into a single list of [over 1.6 million entries](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0) (if you decide to use the [mahakala list](https://github.com/pi-hole/pi-hole/commit/963eacfe0537a7abddf30441c754c67ca1e40965)).
+The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/gravity.sh) does most of the magic. The script pulls in ad domains from many sources and compiles them into a single list of [over 1.6 million entries](http://jacobsalmela.com/block-millions-ads-network-wide-with-a-raspberry-pi-hole-2-0) (if you decide to use the [mahakala list](https://github.com/pi-hole/pi-hole/commit/963eacfe0537a7abddf30441c754c67ca1e40965)). This script is controlled by the `pihole` command. Please run `pihole -h` to see what commands can be run via `pihole`.
 
-## Web Interface
 
-The [Web interface](https://github.com/jacobsalmela/AdminLTE#pi-hole-admin-dashboard) will be installed automatically so you can view stats and change settings. You can find it at:
+
+#### Other Operating Systems
+
+The automated install is only for a clean install of a Debian family or Fedora based system, such as the Raspberry Pi. However, this script will work for most UNIX-like systems, some with some slight **modifications** that we can help you work through. If you can install `dnsmasq` and a web server, it should work OK. If there are other platforms you'd like supported, let us know.
+
+### Web Interface
+
+The [Web interface](https://github.com/pi-hole/AdminLTE#pi-hole-admin-dashboard) will be installed automatically so you can view stats and change settings. You can find it at:
 
 `http://192.168.1.x/admin/index.php` or `http://pi.hole/admin`
 
-![Pi-hole Advanced Stats Dashboard](http://i.imgur.com/gTq2GbS.png)
+![Pi-hole Advanced Stats Dashboard](https://assets.pi-hole.net/static/dashboard212.png)
 
 ### Whitelist and blacklist
 
-Domains can be whitelisted and blacklisted using two pre-installed scripts. See [the wiki page](https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting) for more details ![Whitelist editor in the Web interface](http://i.imgur.com/ogu2ewg.png)
+Domains can be whitelisted and blacklisted using either the web interface or the command line. See [the wiki page](https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting) for more details
+<p align="center">
+<a href=https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting><img src="https://assets.pi-hole.net/static/whitelist212.png"></a>
+</p>
+
+### Settings
+
+The settings page lets you control and configure your Pi-hole™.  You can do things like:
+
+- enable Pi-hole's built-in DHCP server
+- exclude domains from the graphs
+- configure upstream DNS servers
+- and more!
+
+![Settings page](https://assets.pi-hole.net/static/settings212.png)
+
+#### Built-in DHCP Server
+
+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>
 
 ## API
 
 A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON:
 
-```json
+``` json
 {
     "domains_being_blocked": "136708",
     "dns_queries_today": "18108",
@@ -86,15 +135,16 @@ The same output can be achieved on the CLI by running `chronometer.sh -j`
 
 ## Real-time Statistics
 
-You can view [real-time stats](http://pi-hole.net/faq/install-the-real-time-lcd-monitor-chronometer/) via `ssh` or on an [2.8" LCD screen](http://amzn.to/1P0q1Fj). This is accomplished via [`chronometer.sh`](https://github.com/pi-hole/pi-hole/blob/master/advanced/Scripts/chronometer.sh). ![Pi-hole LCD](http://i.imgur.com/nBEqycp.jpg)
+You can view [real-time stats](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)
 
-## Pi-hole Projects
+## Pi-hole™ Projects
 
+-   [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://www.stinebaugh.info/get-led-alerts-for-each-blocked-ad-using-pi-hole/)
+-   [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 Visualizser](https://splunkbase.splunk.com/app/3023/)
+-   [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)
@@ -103,6 +153,10 @@ You can view [real-time stats](http://pi-hole.net/faq/install-the-real-time-lcd-
 -   [Pi-hole on/off button](http://thetimmy.silvernight.org/pages/endisbutton/)
 -   [Minibian Pi-hole](http://munkjensen.net/wiki/index.php/See_my_Pi-Hole#Minibian_Pi-hole)
 -   [Windows Tray Stat Application](https://github.com/goldbattle/copernicus)
+-   [Let your blink1 device blink when Pi-hole filters ads](https://gist.github.com/elpatron68/ec0b4c582e5abf604885ac1e068d233f)
+-   [Pi-hole Prometheus exporter](https://github.com/nlamirault/pihole_exporter): a [Prometheus](https://prometheus.io/) exporter for Pi-hole
+-   [Pi-hole Droid - open source Android client](https://github.com/friimaind/pi-hole-droid)
+-   [Windows DNS Swapper](https://github.com/roots84/DNS-Swapper), see [#1400](https://github.com/pi-hole/pi-hole/issues/1400)
 
 ## Coverage
 
@@ -119,7 +173,4 @@ You can view [real-time stats](http://pi-hole.net/faq/install-the-real-time-lcd-
 -   [Foolish Tech Show](https://youtu.be/bYyena0I9yc?t=2m4s)
 -   [Pi-hole on Ubuntu](http://www.boyter.org/2015/12/pi-hole-ubuntu-14-04/)
 -   [Catchpoint: iOS 9 Ad Blocking](http://blog.catchpoint.com/2015/09/14/ad-blocking-apple/)
-
-## Other Operating Systems
-
-This script will work for other UNIX-like systems with some slight **modifications**. As long as you can install `dnsmasq` and a Webserver, it should work OK. The automated install is only for a clean install of a Debian based system, such as the Raspberry Pi.
+-   [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/)

adlists.default

@@ -1,56 +1,23 @@
-## Pi-hole ad-list default sources. Updated 22/05/2016 #########################
-#                                                                              #
-#  To make changes to this file:                                               #
-#    1. run `cp /etc/pihole/adlists.default /etc/pihole/adlists.list`          #
-#    2. run `nano /etc/pihole/adlists.list`                                    #
-#    3. Uncomment or comment any of the below lists                            #
-#                                                                              #
-#  Know of any other lists? Feel free to let us know about them, or add them   #
-#  to this file!                                                               #
-################################################################################
-
 # The below list amalgamates several lists we used previously.
 # See `https://github.com/StevenBlack/hosts` for details
+##StevenBlack's list
 https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts
 
-# Other lists we consider safe:
-http://mirror1.malwaredomains.com/files/justdomains
+##MalwareDomains
+https://mirror1.malwaredomains.com/files/justdomains
+
+##Cameleon
 http://sysctl.org/cameleon/hosts
+
+##Zeustracker
 https://zeustracker.abuse.ch/blocklist.php?download=domainblocklist
+
+##Disconnect.me Tracking
 https://s3.amazonaws.com/lists.disconnect.me/simple_tracking.txt
+
+##Disconnect.me Ads
 https://s3.amazonaws.com/lists.disconnect.me/simple_ad.txt
 
-# hosts-file.net list. Updated frequently, but has been known to block legitimate sites.
+##Hosts-file.net
 https://hosts-file.net/ad_servers.txt
 
-# Mahakala list. Has been known to block legitimage domains including the entire .com range.
-# Warning: Due to the sheer size of this list, the web admin console will be unresponsive.
-#http://adblock.mahakala.is/
-
-# ADZHOSTS list. Has been known to block legitimate domains
-#http://optimate.dl.sourceforge.net/project/adzhosts/HOSTS.txt
-
-# Windows 10 telemetry list
-#https://raw.githubusercontent.com/crazy-max/WindowsSpyBlocker/master/data/hosts/win10/spy.txt
-
-# Securemecca.com list - Also blocks "adult" sites (pornography/gambling etc)
-#http://securemecca.com/Downloads/hosts.txt
-
-# Quidsup's tracker list
-https://raw.githubusercontent.com/quidsup/notrack/master/trackers.txt
-
-# Block the BBC News website Breaking News banner
-#https://raw.githubusercontent.com/BreakingTheNews/BreakingTheNews.github.io/master/hosts
-
-# List of known C&C malware servers (see https://github.com/pi-hole/pi-hole/issues/528)
-https://ransomwaretracker.abuse.ch/downloads/RW_DOMBL.txt
-
-# Untested Lists:
-#https://raw.githubusercontent.com/reek/anti-adblock-killer/master/anti-adblock-killer-filters.txt
-#https://raw.githubusercontent.com/Dawsey21/Lists/master/main-blacklist.txt
-#http://malwaredomains.lehigh.edu/files/domains.txt
-# Following two lists should be used simultaneously: (readme https://github.com/notracking/hosts-blocklists/)
-#https://raw.github.com/notracking/hosts-blocklists/master/hostnames.txt
-#https://raw.github.com/notracking/hosts-blocklists/master/domains.txt
-# Combination of serveral host files on the internet (warning some facebook domains are also blocked but you can go to facebook.com). See https://github.com/mat1th/Dns-add-block for more information.
-#https://raw.githubusercontent.com/mat1th/Dns-add-block/master/hosts

advanced/01-pihole.conf

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

advanced/Scripts/blacklist.sh

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

advanced/Scripts/chronometer.sh

@@ -1,148 +1,435 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
 # Calculates stats and displays to an LCD
 #
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
 
+# Retrieve stats from FTL engine
+pihole-FTL() {
+  ftl_port=$(cat /var/run/pihole-FTL.port 2> /dev/null)
+  if [[ -n "$ftl_port" ]]; then
+    # Open connection to FTL
+    exec 3<>"/dev/tcp/localhost/$ftl_port"
 
-#Functions##############################################################################################################
-piLog="/var/log/pihole.log"
-gravity="/etc/pihole/gravity.list"
+    # Test if connection is open
+    if { "true" >&3; } 2> /dev/null; then
+      # Send command to FTL
+      echo -e ">$1" >&3
 
-today=$(date "+%b %e")
+      # Read input
+      read -r -t 1 LINE <&3
+      until [[ ! $? ]] || [[ "$LINE" == *"EOM"* ]]; do
+         echo "$LINE" >&1
+         read -r -t 1 LINE <&3
+      done
 
-function CalcBlockedDomains(){
-	CheckIPv6
-	if [ -e "$gravity" ]; then
-		#Are we IPV6 or IPV4?
-		if [[ -n ${piholeIPv6} ]];then
-			#We are IPV6
-			blockedDomainsTotal=$(wc -l /etc/pihole/gravity.list | awk '{print $1/2}')
-		else
-			#We are IPV4
-			blockedDomainsTotal=$(wc -l /etc/pihole/gravity.list | awk '{print $1}')
-		fi
-	else
-		blockedDomainsTotal="Err."
-	fi
+      # Close connection
+      exec 3>&-
+      exec 3<&-
+   fi
+  else
+    echo -e "${COL_LIGHT_RED}FTL offline${COL_NC}"
+  fi
 }
 
-function CalcQueriesToday(){
-	if [ -e "$piLog" ];then
-		queriesToday=$(cat "$piLog" | grep "$today" | awk '/query/ {print $6}' | wc -l)
-	else
-		queriesToday="Err."
-	fi
+# Print spaces to align right-side content
+printFunc() {
+  txt_len="${#2}"
+  
+  # Reduce string length when using colour code
+  [ "${2:0:1}" == "" ] && txt_len=$((txt_len-7))
+  
+  if [[ "$3" == "last" ]]; then
+    # Prevent final line from printing trailing newline
+    scr_size=( $(stty size 2>/dev/null || echo 24 80) )
+    scr_width="${scr_size[1]}"
+    
+    title_len="${#1}"
+    spc_num=$(( (scr_width - title_len) - txt_len ))
+    [[ "$spc_num" -lt 0 ]] && spc_num="0"
+    spc=$(printf "%${spc_num}s")
+    
+    printf "%s%s$spc" "$1" "$2"
+  else
+    # Determine number of spaces for padding
+    spc_num=$(( 20 - txt_len ))
+    [[ "$spc_num" -lt 0 ]] && spc_num="0"
+    spc=$(printf "%${spc_num}s")
+
+    # Print string (Max 20 characters, prevents overflow)
+    printf "%s%s$spc" "$1" "${2:0:20}"
+  fi
 }
 
-function CalcblockedToday(){
-	if [ -e "$piLog" ] && [ -e "$gravity" ];then
-		blockedToday=$(cat ${piLog} | awk '/\/etc\/pihole\/gravity.list/ && !/address/ {print $6}' | wc -l)
-	else
-		blockedToday="Err."
-	fi
+# Perform on first Chrono run (not for JSON formatted string)
+get_init_stats() {
+  LC_NUMERIC=C
+  calcFunc(){ awk "BEGIN {print $*}"; }
+
+  # 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 model number, or OS distro info
+  if command -v vcgencmd &> /dev/null; then
+    sys_rev=$(awk '/Revision/ {print $3}' < /proc/cpuinfo)
+    case "$sys_rev" in
+      000[2-6]) sys_model=" 1, Model B";; # 256MB
+      000[7-9]) sys_model=" 1, Model A" ;; # 256MB
+      000d|000e|000f) sys_model=" 1, Model B";; # 512MB
+      0010|0013) sys_model=" 1, Model B+";; # 512MB
+      0012|0015) sys_model=" 1, Model A+";; # 256MB
+      a0104[0-1]|a21041|a22042) sys_model=" 2, Model B";; # 1GB
+      900021) sys_model=" 1, Model A+";; # 512MB
+      900032) sys_model=" 1, Model B+";; # 512MB
+      90009[2-3]|920093) sys_model=" Zero";; # 512MB
+      9000c1) sys_model=" Zero W";; # 512MB
+      a02082|a[2-3]2082) sys_model=" 3, Model B";; # 1GB
+      *) sys_model="" ;;
+    esac
+    sys_type="Raspberry Pi$sys_model"
+  else
+    source "/etc/os-release"
+    CODENAME=$(sed 's/[()]//g' <<< "${VERSION/* /}")
+    sys_type="${NAME/ */} ${CODENAME^} $VERSION_ID"
+  fi
+
+  # Get core count
+  sys_cores=$(grep -c "^processor" /proc/cpuinfo)
+  [[ "$sys_cores" -ne 1 ]] && sys_cores_plu="cores" || sys_cores_plu="core"
+
+  # 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
 }
 
-function CalcPercentBlockedToday(){
-	if [ "$queriesToday" != "Err." ] && [ "$blockedToday" != "Err." ]; then
-		if [ "$queriesToday" != 0 ]; then #Fixes divide by zero error :)
-		 #scale 2 rounds the number down, so we'll do scale 4 and then trim the last 2 zeros
-			percentBlockedToday=$(echo "scale=4; $blockedToday/$queriesToday*100" | bc)
-			percentBlockedToday=$(sed 's/.\{2\}$//' <<< "$percentBlockedToday")
-		else
-			percentBlockedToday=0
-		fi
-	fi
+get_sys_stats() {
+  local ph_ver_raw
+  local cpu_raw
+  local ram_raw
+  local disk_raw
+
+  # Update every 12 refreshes (Def: every 60s)
+  count=$((count+1))
+  if [[ "$count" == "1" ]] || (( "$count" % 12 == 0 )); then
+    [[ -n "$setupVars" ]] && source "$setupVars"
+    
+    
+    ph_ver_raw=($(pihole -v -c 2> /dev/null | sed -n 's/^.* v/v/p'))
+    if [[ -n "${ph_ver_raw[0]}" ]]; then
+      ph_core_ver="${ph_ver_raw[0]}"
+      ph_lte_ver="${ph_ver_raw[1]}"
+      ph_ftl_ver="${ph_ver_raw[2]}"
+    else
+      ph_core_ver="${COL_LIGHT_RED}API unavailable${COL_NC}"
+    fi
+    
+    sys_name=$(hostname)
+    
+    [[ -n "$TEMPERATUREUNIT" ]] && temp_unit="$TEMPERATUREUNIT" || temp_unit="c"
+    
+    # Get storage stats for partition mounted on /
+    disk_raw=($(df -B1 / 2> /dev/null | awk 'END{ print $3,$2,$5 }'))
+    disk_used="${disk_raw[0]}"
+    disk_total="${disk_raw[1]}"
+    disk_perc="${disk_raw[2]}"
+    
+    net_gateway=$(route -n | awk '$4 == "UG" {print $2;exit}')
+    
+    # Get DHCP stats, if feature is enabled
+    if [[ "$DHCP_ACTIVE" == "true" ]]; then
+      ph_dhcp_eip="${DHCP_END##*.}"
+      ph_dhcp_max=$(( ${DHCP_END##*.} - ${DHCP_START##*.} + 1 ))
+    fi
+    
+    # Get alt DNS server, or print total count of alt DNS servers
+    if [[ -z "${PIHOLE_DNS_3}" ]]; then
+      ph_alts="${PIHOLE_DNS_2}"
+    else
+      dns_count="0"
+      [[ -n "${PIHOLE_DNS_2}" ]] && dns_count=$((dns_count+1))
+      [[ -n "${PIHOLE_DNS_3}" ]] && dns_count=$((dns_count+1))
+      [[ -n "${PIHOLE_DNS_4}" ]] && dns_count=$((dns_count+1))
+      [[ -n "${PIHOLE_DNS_5}" ]] && dns_count=$((dns_count+1))
+      [[ -n "${PIHOLE_DNS_6}" ]] && dns_count=$((dns_count+1))
+      [[ -n "${PIHOLE_DNS_7}" ]] && dns_count=$((dns_count+1))
+      [[ -n "${PIHOLE_DNS_8}" ]] && dns_count=$((dns_count+1))
+      [[ -n "${PIHOLE_DNS_9}" ]] && dns_count="$dns_count+"
+      ph_alts="${dns_count} others"
+    fi
+  fi
+  
+  sys_uptime=$(hrSecs "$(cut -d. -f1 /proc/uptime)")
+  sys_loadavg=$(cut -d " " -f1,2,3 /proc/loadavg)
+  
+  # Get CPU usage, only counting processes over 1% CPU as active
+  cpu_raw=$(ps -eo pcpu,rss --no-headers | grep -E -v "    0")
+  cpu_tasks=$(wc -l <<< "$cpu_raw")
+  cpu_taskact=$(sed -r "/(^ 0.)/d" <<< "$cpu_raw" | wc -l)
+  cpu_perc=$(awk '{sum+=$1} END {printf "%.0f\n", sum/'"$sys_cores"'}' <<< "$cpu_raw")
+  
+  # Get CPU clock speed
+  if [[ -n "$scaling_freq_file" ]]; then
+    cpu_mhz=$(( $(< /sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq) / 1000 ))
+  else
+    cpu_mhz=$(lscpu | awk -F "[ .]+" '/MHz/ {print $4;exit}')
+  fi
+  
+  # Determine correct string format for CPU clock speed
+  if [[ -n "$cpu_mhz" ]]; then
+    [[ "$cpu_mhz" -le "999" ]] && cpu_freq="$cpu_mhz MHz" || cpu_freq="$(calcFunc "$cpu_mhz"/1000) Ghz"
+    [[ -n "$cpu_freq" ]] && cpu_freq_str=" @ $cpu_freq" || cpu_freq_str=""
+  fi
+  
+  # Determine colour for temperature
+  if [[ -n "$temp_file" ]]; then
+    if [[ "$temp_unit" == "C" ]]; then
+      cpu_temp=$(printf "%'.0fc\n" "$(calcFunc "$(< $temp_file) / 1000")")
+      
+      case "${cpu_temp::-1}" in
+        -*|[0-9]|[1-3][0-9]) cpu_col="$COL_LIGHT_BLUE";;
+        4[0-9]) cpu_col="";;
+        5[0-9]) cpu_col="$COL_YELLOW";;
+        6[0-9]) cpu_col="$COL_LIGHT_RED";;
+        *) cpu_col="$COL_URG_RED";;
+      esac
+      
+      # $COL_NC$COL_DARK_GRAY is needed for $COL_URG_RED
+      cpu_temp_str=", $cpu_col$cpu_temp$COL_NC$COL_DARK_GRAY"
+      
+    elif [[ "$temp_unit" == "F" ]]; then
+      cpu_temp=$(printf "%'.0ff\n" "$(calcFunc "($(< $temp_file) / 1000) * 9 / 5 + 32")")
+      
+      case "${cpu_temp::-1}" in
+        -*|[0-9]|[0-9][0-9]) cpu_col="$COL_LIGHT_BLUE";;
+        1[0-1][0-9]) cpu_col="";;
+        1[2-3][0-9]) cpu_col="$COL_YELLOW";;
+        1[4-5][0-9]) cpu_col="$COL_LIGHT_RED";;
+        *) cpu_col="$COL_URG_RED";;
+      esac
+      
+      cpu_temp_str=", $cpu_col$cpu_temp$COL_NC$COL_DARK_GRAY"
+      
+    else
+      cpu_temp_str=$(printf ", %'.0fk\n" "$(calcFunc "($(< $temp_file) / 1000) + 273.15")")
+    fi
+  else
+    cpu_temp_str=""
+  fi
+  
+  ram_raw=($(awk '/MemTotal:/{total=$2} /MemFree:/{free=$2} /Buffers:/{buffers=$2} /^Cached:/{cached=$2} END {printf "%.0f %.0f %.0f", (total-free-buffers-cached)*100/total, (total-free-buffers-cached)*1024, total*1024}' /proc/meminfo))
+  ram_perc="${ram_raw[0]}"
+  ram_used="${ram_raw[1]}"
+  ram_total="${ram_raw[2]}"
+  
+  if [[ "$(pihole status web 2> /dev/null)" == "1" ]]; then
+    ph_status="${COL_LIGHT_GREEN}Active"
+  else
+    ph_status="${COL_LIGHT_RED}Inactive"
+  fi
+  
+  if [[ "$DHCP_ACTIVE" == "true" ]]; then
+    ph_dhcp_num=$(wc -l 2> /dev/null < "/etc/pihole/dhcp.leases")
+  fi
 }
 
-function CheckIPv6(){
-	piholeIPv6file="/etc/pihole/.useIPv6"
-	if [[ -f ${piholeIPv6file} ]];then
-	    # If the file exists, then the user previously chose to use IPv6 in the automated installer
-	    piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
-	fi
+get_ftl_stats() {
+  local stats_raw
+  
+  stats_raw=($(pihole-FTL "stats"))
+  domains_being_blocked_raw="${stats_raw[1]}"
+  dns_queries_today_raw="${stats_raw[3]}"
+  ads_blocked_today_raw="${stats_raw[5]}"
+  ads_percentage_today_raw="${stats_raw[7]}"
+
+  # Only retrieve these stats when not called from jsonFunc
+  if [[ -z "$1" ]]; then
+    local recent_blocked_raw
+    local top_ad_raw
+    local top_domain_raw
+    local top_client_raw
+  
+    domains_being_blocked=$(printf "%'.0f\n" "${domains_being_blocked_raw}")
+    dns_queries_today=$(printf "%'.0f\n" "${dns_queries_today_raw}")
+    ads_blocked_today=$(printf "%'.0f\n" "${ads_blocked_today_raw}")
+    ads_percentage_today=$(printf "%'.0f\n" "${ads_percentage_today_raw}")
+    
+    recent_blocked_raw=$(pihole-FTL recentBlocked)
+    top_ad_raw=($(pihole-FTL "top-ads (1)"))
+    top_domain_raw=($(pihole-FTL "top-domains (1)"))
+    top_client_raw=($(pihole-FTL "top-clients (1)"))
+    
+    # Limit strings to 40 characters to prevent overflow
+    recent_blocked="${recent_blocked_raw:0:40}"
+    top_ad="${top_ad_raw[2]:0:40}"
+    top_domain="${top_domain_raw[2]:0:40}"
+    [[ "${top_client_raw[3]}" ]] && top_client="${top_client_raw[3]:0:40}" || top_client="${top_client_raw[2]:0:40}"
+  fi
 }
 
-function outputJSON(){
-	CalcQueriesToday
-	CalcblockedToday
-	CalcPercentBlockedToday
+chronoFunc() {
+  get_init_stats
+  
+  for (( ; ; )); do
+    get_sys_stats
+    get_ftl_stats
+    
+    # Do not print LTE/FTL strings if API is unavailable
+    ph_core_str="        ${COL_DARK_GRAY}Pi-hole: $ph_core_ver${COL_NC}"
+    if [[ -n "$ph_lte_ver" ]]; then
+      ph_lte_str="      ${COL_DARK_GRAY}AdminLTE: $ph_lte_ver${COL_NC}"
+      ph_ftl_str="           ${COL_DARK_GRAY}FTL: $ph_ftl_ver${COL_NC}"
+    fi
+    
+    clear
+    
+  	echo -e "|¯¯¯(¯)__|¯|_  ___|¯|___$ph_core_str
+| ¯_/¯|__| ' \/ _ \ / -_)$ph_lte_str
+|_| |_|  |_||_\___/_\___|$ph_ftl_str
+ ${COL_DARK_GRAY}——————————————————————————————————————————————————————————${COL_NC}"
 
-	CalcBlockedDomains
-
-	printf '{"domains_being_blocked":"%s","dns_queries_today":"%s","ads_blocked_today":"%s","ads_percentage_today":"%s"}\n' "$blockedDomainsTotal" "$queriesToday" "$blockedToday" "$percentBlockedToday"
+    printFunc "  Hostname: " "$sys_name"
+    [ -n "$sys_type" ] && printf "%s(%s)%s\n"  "$COL_DARK_GRAY" "$sys_type" "$COL_NC" || printf "\n"
+    
+    printf "%s\n" "    Uptime: $sys_uptime"
+    
+    printFunc " Task Load: " "$sys_loadavg"
+    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Active: $cpu_taskact of $cpu_tasks tasks" "$COL_NC"
+    
+    printFunc " CPU usage: " "$cpu_perc%"
+    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "$sys_cores $sys_cores_plu$cpu_freq_str$cpu_temp_str" "$COL_NC"
+    
+    printFunc " RAM usage: " "$ram_perc%"
+    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Used: $(hrBytes "$ram_used") of $(hrBytes "$ram_total")" "$COL_NC"
+    
+    printFunc " HDD usage: " "$disk_perc"
+    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Used: $(hrBytes "$disk_used") of $(hrBytes "$disk_total")" "$COL_NC"
+    
+    printFunc "  LAN addr: " "${IPV4_ADDRESS/\/*/}"
+    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Gateway: $net_gateway" "$COL_NC"
+    
+    if [[ "$DHCP_ACTIVE" == "true" ]]; then
+      printFunc "      DHCP: " "$DHCP_START to $ph_dhcp_eip"
+      printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Leased: $ph_dhcp_num of $ph_dhcp_max" "$COL_NC"
+    fi
+    
+    printFunc "   Pi-hole: " "$ph_status"
+    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Blocking: $domains_being_blocked sites" "$COL_NC"
+    
+    printFunc " Ads Today: " "$ads_percentage_today%"
+    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "$ads_blocked_today of $dns_queries_today queries" "$COL_NC"
+    
+    printFunc "   Fwd DNS: " "$PIHOLE_DNS_1"
+    printf "%s(%s)%s\n" "$COL_DARK_GRAY" "Alt DNS: $ph_alts" "$COL_NC"
+    
+    echo -e " ${COL_DARK_GRAY}——————————————————————————————————————————————————————————${COL_NC}"
+    echo " Recently blocked: $recent_blocked"
+    echo "   Top Advertiser: $top_ad"
+    echo "       Top Domain: $top_domain"
+    printFunc "       Top Client: " "$top_client" "last"
+    
+    if [[ "$1" == "exit" ]]; then
+      exit 0
+    else
+      if [[ -n "$1" ]]; then
+        sleep "${1}"
+      else
+        sleep 5
+      fi
+    fi
+    
+  done
 }
 
-function normalChrono(){
-	for (( ; ; ))
-	do
-		clear
-		# Displays a colorful Pi-hole logo
-		echo " ___ _     _        _"
-		echo "| _ (_)___| |_  ___| |___"
-		echo "|  _/ |___| ' \/ _ \ / -_)"
-		echo "|_| |_|   |_||_\___/_\___|"
-		echo ""
-		echo "        $(ifconfig eth0 | awk '/inet addr/ {print $2}' | cut -d':' -f2)"
-		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 "-------------------------------"
-		# Uncomment to continually read the log file and display the current domain being blocked
-		#tail -f /var/log/pihole.log | awk '/\/etc\/pihole\/gravity.list/ {if ($7 != "address" && $7 != "name" && $7 != "/etc/pihole/gravity.list") print $7; else;}'
-
-		#uncomment next 4 lines to use original query count calculation
-		#today=$(date "+%b %e")
-		#todaysQueryCount=$(cat /var/log/pihole.log | grep "$today" | awk '/query/ {print $7}' | wc -l)
-		#todaysQueryCountV4=$(cat /var/log/pihole.log | grep "$today" | awk '/query/ && /\[A\]/ {print $7}' | wc -l)
-		#todaysQueryCountV6=$(cat /var/log/pihole.log | grep "$today" | awk '/query/ && /\[AAAA\]/ {print $7}' | wc -l)
-
-
-		CalcQueriesToday
-		CalcblockedToday
-		CalcPercentBlockedToday
-
-		CalcBlockedDomains
-
-		echo "Blocking:      $blockedDomainsTotal"
-		#below commented line does not add up to todaysQueryCount
-		#echo "Queries:       $todaysQueryCountV4 / $todaysQueryCountV6"
-		echo "Queries:       $queriesToday" #same total calculation as dashboard
-	  echo "Pi-holed:      $blockedToday ($percentBlockedToday%)"
-
-		sleep 5
-	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}}"
 }
 
-function displayHelp(){
- 	echo "::: Displays stats about your piHole!"
-    echo ":::"
-    echo "::: Usage: sudo pihole -c [optional:-j]"
-    echo "::: Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds"
-    echo ":::"
-    echo "::: Options:"
-    echo ":::  -j, --json		output stats as JSON formatted string"
-    echo ":::  -h, --help		display this help text"
-
-    exit 1
+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
+for var in "$@"; do
   case "$var" in
-    "-j" | "--json"  ) outputJSON;;
-    "-h" | "--help"  ) displayHelp;;
-    *                ) exit 1;;
+    "-j" | "--json"    ) jsonFunc;;
+    "-h" | "--help"    ) helpFunc;;
+    "-r" | "--refresh" ) chronoFunc "$2";;
+    "-e" | "--exit"    ) chronoFunc "exit";;
+    *                  ) helpFunc "?";;
   esac
 done

advanced/Scripts/list.sh

@@ -0,0 +1,225 @@
+#!/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.
+#
+# 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
+basename=pihole
+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=""
+
+helpFunc() {
+  if [[ "${listMain}" == "${whitelist}" ]]; then
+    param="w"
+    type="white"
+  elif [[ "${listMain}" == "${wildcardlist}" ]]; then
+    param="wild"
+    type="wildcard black"
+  else
+    param="b"
+    type="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
+
+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"
+
+  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"
+}
+
+HandleOther() {
+  # First, convert everything to lowercase
+  domain=$(sed -e "y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/" <<< "$1")
+
+  # Check validity of domain
+  validDomain=$(echo "${domain}" | perl -lne 'print if /(?!.*[^a-z0-9-\.].*)^((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9-]+\.)*[a-z]{2,63}/')
+  if [[ -z "${validDomain}" ]]; then
+    echo "::: $1 is not a valid argument or domain name"
+  else
+    domList=("${domList[@]}" ${validDomain})
+  fi
+}
+
+PoplistFile() {
+  # Check whitelist file exists, and if not, create it
+  if [[ ! -f ${whitelist} ]]; then
+    touch ${whitelist}
+  fi
+
+  for dom in "${domList[@]}"; do
+      # Logic: If addmode then add to desired list and remove from the other; if delmode then remove from desired list but do not add to the other
+    if ${addmode}; then
+      AddDomain "${dom}" "${listMain}"
+      RemoveDomain "${dom}" "${listAlt}"
+      if [[ "${listMain}" == "${whitelist}" || "${listMain}" == "${blacklist}" ]]; then
+        RemoveDomain "${dom}" "${wildcardlist}"
+      fi
+    else
+      RemoveDomain "${dom}" "${listMain}"
+    fi
+  done
+}
+
+AddDomain() {
+  list="$2"
+  domain=$(EscapeRegexp "$1")
+
+  if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
+    bool=true
+    # Is the domain in the list we want to add it to?
+    grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
+
+    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
+  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
+}
+
+RemoveDomain() {
+    list="$2"
+    domain=$(EscapeRegexp "$1")
+
+    if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
+      bool=true
+      # Is it in the list? Logic follows that if its whitelisted it should not be blacklisted and vice versa
+      grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
+      if [[ "${bool}" == true ]]; then
+        # Remove it from the other one
+        echo "::: Removing $1 from $list..."
+        # /I flag: search case-insensitive
+        sed -i "/${domain}/Id" "${list}"
+        reload=true
+      else
+        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
+    fi
+}
+
+Reload() {
+  # Reload hosts file
+  pihole -g -sd
+}
+
+Displaylist() {
+  if [[ "${listMain}" == "${whitelist}" ]]; then
+    string="gravity resistant domains"
+  else
+    string="domains caught in the sinkhole"
+  fi
+  verbose=false
+  echo -e "Displaying $string:\n"
+  count=1
+  while IFS= read -r RD; do
+    echo "${count}: ${RD}"
+    count=$((count+1))
+  done < "${listMain}"
+  exit 0;
+}
+
+for var in "$@"; do
+  case "${var}" in
+    "-w" | "whitelist"   ) listMain="${whitelist}"; listAlt="${blacklist}";;
+    "-b" | "blacklist"   ) listMain="${blacklist}"; listAlt="${whitelist}";;
+    "-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
+done
+
+shift
+
+if [[ $# = 0 ]]; then
+  helpFunc
+fi
+
+PoplistFile
+
+if ${reload}; then
+  Reload
+fi

advanced/Scripts/piholeCheckout.sh

@@ -0,0 +1,206 @@
+#!/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.
+#
+# 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"
+
+# webInterfaceGitUrl set in basic-install.sh
+# webInterfaceDir set in basic-install.sh
+# piholeGitURL set in basic-install.sh
+# is_repo() sourced from basic-install.sh
+# setupVars set in basic-install.sh
+
+source "${setupVars}"
+update="false"
+
+# Colour codes
+red="\e[1;31m"
+def="\e[0m"
+
+fully_fetch_repo() {
+  # Add upstream branches to shallow clone
+  local directory="${1}"
+
+  cd "${directory}" || return 1
+  if is_repo "${directory}"; then
+    git remote set-branches origin '*' || return 1
+    git fetch --quiet || return 1
+  else
+    return 1
+  fi
+  return 0
+}
+
+get_available_branches() {
+  # Return available branches
+  local directory="${1}"
+
+  cd "${directory}" || return 1
+  # Get reachable remote branches
+  git remote show origin | grep 'tracked' | sed 's/tracked//;s/ //g'
+  return
+}
+
+
+fetch_checkout_pull_branch() {
+  # Check out specified branch
+  local directory="${1}"
+  local branch="${2}"
+
+  # Set the reference for the requested branch, fetch, check it put and pull it
+  cd "${directory}"
+  git remote set-branches origin "${branch}" || return 1
+  git stash --all --quiet &> /dev/null || true
+  git clean --force -d || true
+  git fetch --quiet || return 1
+  checkout_pull_branch "${directory}" "${branch}" || return 1
+}
+
+checkout_pull_branch() {
+  # Check out specified branch
+  local directory="${1}"
+  local branch="${2}"
+  local oldbranch
+
+  cd "${directory}" || return 1
+
+  oldbranch="$(git symbolic-ref HEAD)"
+
+  git checkout "${branch}" || return 1
+
+  if [ "$(git diff "${oldbranch}" | grep -c "^")" -gt "0" ]; then
+    update="true"
+  fi
+
+  git pull || return 1
+  return 0
+}
+
+warning1() {
+  echo "  Please note that changing branches severely alters your Pi-hole subsystems"
+  echo "  Features that work on the master branch, may not on a development branch"
+  echo -e "  ${red}This feature is NOT supported unless a Pi-hole developer explicitly asks!${def}"
+  read -r -p "  Have you read and understood this? [y/N] " response
+  case ${response} in
+  [yY][eE][sS]|[yY])
+    echo "::: Continuing with branch change."
+    return 0
+    ;;
+  *)
+    echo "::: Branch change has been cancelled."
+    return 1
+    ;;
+  esac
+}
+
+checkout() {
+  local corebranches
+  local webbranches
+
+  # Avoid globbing
+  set -f
+
+  #This is unlikely
+  if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
+    echo "::: Critical Error: Core Pi-hole repo is missing from system!"
+    echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
+    exit 1;
+  fi
+  if [[ ${INSTALL_WEB} == "true" ]]; then
+    if ! is_repo "${webInterfaceDir}" ; then
+      echo "::: Critical Error: Web Admin repo is missing from system!"
+      echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
+      exit 1;
+    fi
+  fi
+
+  if [[ -z "${1}" ]]; then
+    echo "::: No option detected. Please use 'pihole checkout <master|dev>'."
+    echo "::: Or enter the repository and branch you would like to check out:"
+    echo "::: 'pihole checkout <web|core> <branchname>'"
+    exit 1
+  fi
+
+  if ! warning1 ; then
+    exit 1
+  fi
+
+  if [[ "${1}" == "dev" ]] ; then
+    # Shortcut to check out development branches
+    echo "::: Shortcut \"dev\" detected - checking out development / devel branches ..."
+    echo "::: Pi-hole core"
+    fetch_checkout_pull_branch "${PI_HOLE_FILES_DIR}" "development" || { echo "Unable to pull Core developement branch"; exit 1; }
+    if [[ ${INSTALL_WEB} == "true" ]]; then
+      echo "::: Web interface"
+      fetch_checkout_pull_branch "${webInterfaceDir}" "devel" || { echo "Unable to pull Web development branch"; exit 1; }
+    fi
+    echo "::: done!"
+  elif [[ "${1}" == "master" ]] ; then
+    # Shortcut to check out master branches
+    echo "::: Shortcut \"master\" detected - checking out master branches ..."
+    echo "::: Pi-hole core"
+    fetch_checkout_pull_branch "${PI_HOLE_FILES_DIR}" "master" || { echo "Unable to pull Core master branch"; exit 1; }
+    if [[ ${INSTALL_WEB} == "true" ]]; then
+      echo "::: Web interface"
+      fetch_checkout_pull_branch "${webInterfaceDir}" "master" || { echo "Unable to pull web master branch"; exit 1; }
+    fi
+    echo "::: done!"
+  elif [[ "${1}" == "core" ]] ; then
+    echo -n "::: Fetching remote branches for Pi-hole core from ${piholeGitUrl} ... "
+    if ! fully_fetch_repo "${PI_HOLE_FILES_DIR}" ; then
+      echo "::: Fetching all branches for Pi-hole core repo failed!"
+      exit 1
+    fi
+    corebranches=($(get_available_branches "${PI_HOLE_FILES_DIR}"))
+    echo " done!"
+    echo "::: ${#corebranches[@]} branches available"
+    echo ":::"
+    # Have to user chosing the branch he wants
+    if ! (for e in "${corebranches[@]}"; do [[ "$e" == "${2}" ]] && exit 0; done); then
+      echo "::: Requested branch \"${2}\" is not available!"
+      echo "::: Available branches for core are:"
+      for e in "${corebranches[@]}"; do echo ":::   $e"; done
+      exit 1
+    fi
+    checkout_pull_branch "${PI_HOLE_FILES_DIR}" "${2}"
+  elif [[ "${1}" == "web" && "${INSTALL_WEB}" == "true" ]] ; then
+    echo -n "::: Fetching remote branches for the web interface from ${webInterfaceGitUrl} ... "
+    if ! fully_fetch_repo "${webInterfaceDir}" ; then
+      echo "::: Fetching all branches for Pi-hole web interface repo failed!"
+      exit 1
+    fi
+    webbranches=($(get_available_branches "${webInterfaceDir}"))
+    echo " done!"
+    echo "::: ${#webbranches[@]} branches available"
+    echo ":::"
+    # Have to user chosing the branch he wants
+    if ! (for e in "${webbranches[@]}"; do [[ "$e" == "${2}" ]] && exit 0; done); then
+      echo "::: Requested branch \"${2}\" is not available!"
+      echo "::: Available branches for web are:"
+      for e in "${webbranches[@]}"; do echo ":::   $e"; done
+      exit 1
+    fi
+    checkout_pull_branch "${webInterfaceDir}" "${2}"
+  else
+    echo "::: Requested option \"${1}\" is not available!"
+    exit 1
+  fi
+
+  # Force updating everything
+  if [[ ! "${1}" == "web" && "${update}" == "true" ]]; then
+    echo "::: Running installer to upgrade your installation"
+    if "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh" --unattended; then
+      exit 0
+    else
+      echo "Unable to complete update, contact Pi-hole"
+      exit 1
+    fi
+  fi
+}

advanced/Scripts/piholeDebug.sh

@@ -1,466 +1,541 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
 # Generates pihole_debug.log to be used for troubleshooting.
 #
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+
 
 set -o pipefail
 
 ######## GLOBAL VARS ########
+VARSFILE="/etc/pihole/setupVars.conf"
 DEBUG_LOG="/var/log/pihole_debug.log"
 DNSMASQFILE="/etc/dnsmasq.conf"
-PIHOLECONFFILE="/etc/dnsmasq.d/01-pihole.conf"
+DNSMASQCONFDIR="/etc/dnsmasq.d/*"
 LIGHTTPDFILE="/etc/lighttpd/lighttpd.conf"
 LIGHTTPDERRFILE="/var/log/lighttpd/error.log"
 GRAVITYFILE="/etc/pihole/gravity.list"
-HOSTSFILE="/etc/hosts"
 WHITELISTFILE="/etc/pihole/whitelist.txt"
 BLACKLISTFILE="/etc/pihole/blacklist.txt"
-ADLISTSFILE="/etc/pihole/adlists.list"
+ADLISTFILE="/etc/pihole/adlists.list"
 PIHOLELOG="/var/log/pihole.log"
+PIHOLEGITDIR="/etc/.pihole/"
+ADMINGITDIR="/var/www/html/admin/"
 WHITELISTMATCHES="/tmp/whitelistmatches.list"
+readonly FTLLOG="/var/log/pihole-FTL.log"
 
+TIMEOUT=60
 # Header info and introduction
-echo "::: Beginning Pi-hole debug at $(date)!"
-echo "::: This debugging process will collect information from your running configuration,"
-echo "::: and optionally upload the generated log to a unique and random directory on"
-echo "::: Termbin.com. NOTE: All log files auto-delete after 1 month and you are the only"
-echo "::: person who is given the unique URL. Please consider where you post this link."
-echo "::: "
+cat << EOM
+::: Beginning Pi-hole debug at $(date)!
+:::
+::: This process collects information from your Pi-hole, and optionally uploads
+::: it to a unique and random directory on tricorder.pi-hole.net.
+:::
+::: NOTE: All log files auto-delete after 48 hours and ONLY the Pi-hole developers
+::: can access your data via the given token. We have taken these extra steps to
+::: secure your data and will work to further reduce any personal information gathered.
+:::
+::: Please read and note any issues, and follow any directions advised during this process.
+EOM
 
-
-######## FIRST CHECK ########
-# Must be root to debug
-if [[ "$EUID" -eq 0 ]]; then
-	echo "::: Script is executing as root user..."
-else
-	echo "::: Non-root user detected..."
-	# Check if sudo is actually installed
-	if [ -x "$(command -v sudo)" ]; then
-		export SUDO="sudo"
-		echo "::: sudo command located, debug will run under sudo."
-	else
-		echo "::: Unable to locate sudo command. Please install sudo or run this as root."
-		exit 1
-	fi
-fi
-
-# Ensure the file exists, create if not, clear if exists.
-if [ ! -f "$DEBUG_LOG" ]; then
-	${SUDO} touch ${DEBUG_LOG}
-	${SUDO} chmod 644 ${DEBUG_LOG}
-	${SUDO} chown "$USER":root ${DEBUG_LOG}
-else 
-	truncate -s 0 ${DEBUG_LOG}
-fi
+source ${VARSFILE}
 
 ### Private functions exist here ###
-function log_write {
-  echo "$1" >> "${DEBUG_LOG}"
+log_write() {
+    echo "${@}" >&3
 }
 
-function version_check {
-  log_write "############################################################"
-  log_write "##########           Installed Versions           ##########"
-  log_write "############################################################"
-
-  echo "::: Detecting Pi-hole installed versions."
-  pi_hole_ver="$(cd /etc/.pihole/ && git describe --tags --abbrev=0)" \
-  && log_write "Pi-hole Version: $pi_hole_ver" || log_write "Pi-hole git repository not detected."
-  admin_ver="$(cd /var/www/html/admin && git describe --tags --abbrev=0)" \
-  && log_write "WebUI Version: $admin_ver" || log_write "Pi-hole Admin Pages git repository not detected."
-
-  echo "::: Writing lighttpd version to logfile."
-  light_ver="$(lighttpd -v |& head -n1)" && log_write "${light_ver}" || log_write "lighttpd not installed."
-
-  echo "::: Writing PHP version to logfile."
-  php_ver="$(php -v |& head -n1)" && log_write "${php_ver}" || log_write "PHP not installed."
+log_echo() {
+  case ${1} in
+    -n)
+      echo -n ":::       ${2}"
+      log_write "${2}"
+      ;;
+    -r)
+      echo ":::       ${2}"
+      log_write "${2}"
+      ;;
+    -l)
+      echo "${2}"
+      log_write "${2}"
+      ;;
+     *)
+      echo ":::  ${1}"
+      log_write "${1}"
+  esac
 }
 
-function distro_check {
-	echo "############################################################" >> ${DEBUG_LOG}
-	echo "########          Installed OS Distribution        #########" >> ${DEBUG_LOG}
-	echo "############################################################" >> ${DEBUG_LOG}
-
-	echo "::: Checking installed OS Distribution release."
-	TMP=$(cat /etc/*release || echo "Failed to find release")
-
-	echo "::: Writing OS Distribution release to logfile."
-	echo "$TMP" >> ${DEBUG_LOG}
-	echo >> ${DEBUG_LOG}
+header_write() {
+  log_echo ""
+  log_echo "---= ${1}"
+  log_write ""
 }
 
-function ip_check {
-	echo "############################################################" >> ${DEBUG_LOG}
-	echo "########           IP Address Information          #########" >> ${DEBUG_LOG}
-	echo "############################################################" >> ${DEBUG_LOG}
+file_parse() {
+    while read -r line; do
+		  if [ ! -z "${line}" ]; then
+			  [[ "${line}" =~ ^#.*$  || ! "${line}" || "${line}" == "WEBPASSWORD="* ]] && continue
+				log_write "${line}"
+			fi
+		done < "${1}"
+		log_write ""
+}
 
-    echo "::: Writing local IPs to logfile"
-    IPADDR="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet") print $(i+1) }')"
-    echo "$IPADDR" >> ${DEBUG_LOG}
+block_parse() {
+  log_write "${1}"
+}
 
-    IP6ADDR="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet6") print $(i+1) }')" \
-    && echo "$IP6ADDR" >> ${DEBUG_LOG} || echo "No IPv6 addresses found." >> ${DEBUG_LOG}
-    echo >> ${DEBUG_LOG}
+lsof_parse() {
+  local user
+  local process
 
-    echo "::: Locating default gateway and checking connectivity"
-    GATEWAY=$(ip r | grep default | cut -d ' ' -f 3)
-    if [[ $? = 0 ]]
-    then
-    echo "::: Pinging default IPv4 gateway..."
-    GATEWAY_CHECK=$(ping -q -w 3 -c 3 -n "${GATEWAY}" | tail -n3)
-        if [[ $? = 0 ]]
-        then
-        echo "IPv4 Gateway check:" >> ${DEBUG_LOG}
-        else
-        echo "IPv4 Gateway check failed:" >> ${DEBUG_LOG}
-        fi
-    echo "$GATEWAY_CHECK" >> ${DEBUG_LOG}
-    echo >> ${DEBUG_LOG}
+  user=$(echo ${1} | cut -f 3 -d ' ' | cut -c 2-)
+  process=$(echo ${1} | cut -f 2 -d ' ' | cut -c 2-)
+  [[ ${2} -eq ${process} ]] \
+  && echo ":::       Correctly configured." \
+  || log_echo ":::       Failure: Incorrectly configured daemon."
 
-    echo "::: Pinging Internet via IPv4..."
-    INET_CHECK=$(ping -q -w 5 -c 3 -n 8.8.8.8 | tail -n3)
-        if [[ $? = 0 ]]
-        then
-        echo "IPv4 Internet check:" >> ${DEBUG_LOG}
-        else
-        echo "IPv4 Internet check failed:" >> ${DEBUG_LOG}
-        fi
-    echo "$INET_CHECK" >> ${DEBUG_LOG}
-    echo >> ${DEBUG_LOG}
-    fi
+  log_write "Found user ${user} with process ${process}"
+}
 
-    GATEWAY6=$(ip -6 r | grep default | cut -d ' ' -f 3)
-    if [[ $? = 0 ]]
-    then
-    echo "::: Pinging default IPv6 gateway..."
-    GATEWAY6_CHECK=$(ping6 -q -w 3 -c 3 -n "${GATEWAY6}" | tail -n3)
-        if [[ $? = 0 ]]
-        then
-        echo "IPv6 Gateway check:" >> ${DEBUG_LOG}
-        else
-        echo "IPv6 Gateway check failed:" >> ${DEBUG_LOG}
-        fi
 
-    echo "::: Pinging Internet via IPv6..."
-    GATEWAY6_CHECK=$(ping6 -q -w 3 -c 3 -n 2001:4860:4860::8888 | tail -n3)
-        if [[ $? = 0 ]]
-        then
-        echo "IPv6 Internet check:" >> ${DEBUG_LOG}
-        else
-        echo "IPv6 Internet check failed:" >> ${DEBUG_LOG}
-        fi
+version_check() {
+  header_write "Detecting Installed Package Versions:"
 
+  local error_found
+  local pi_hole_ver
+  local pi_hole_branch
+  local pi_hole_commit
+  local admin_ver
+  local admin_branch
+  local admin_commit
+  local light_ver
+  local php_ver
+  local status
+  error_found=0
+
+  cd "${PIHOLEGITDIR}" &> /dev/null || \
+    { status="Pi-hole git directory not found."; error_found=1; }
+  if git status &> /dev/null; then
+    pi_hole_ver=$(git describe --tags --abbrev=0)
+    pi_hole_branch=$(git rev-parse --abbrev-ref HEAD)
+    pi_hole_commit=$(git describe --long --dirty --tags --always)
+    log_echo -r "Pi-hole: ${pi_hole_ver:-Untagged} (${pi_hole_branch:-Detached}:${pi_hole_commit})"
+  else
+    status=${status:-"Pi-hole repository damaged."}
+    error_found=1
+  fi
+  if [[ "${status}" ]]; then
+    log_echo "${status}"
+    unset status
+  fi
+
+  cd "${ADMINGITDIR}" || \
+    { status="Pi-hole Dashboard git directory not found."; error_found=1; }
+  if git status &> /dev/null; then
+    admin_ver=$(git describe --tags --abbrev=0)
+    admin_branch=$(git rev-parse --abbrev-ref HEAD)
+    admin_commit=$(git describe --long --dirty --tags --always)
+    log_echo -r "Pi-hole Dashboard: ${admin_ver:-Untagged} (${admin_branch:-Detached}:${admin_commit})"
+  else
+    status=${status:-"Pi-hole Dashboard repository damaged."}
+    error_found=1
+  fi
+  if [[ "${status}" ]]; then
+    log_echo "${status}"
+    unset status
+  fi
+
+	if light_ver=$(lighttpd -v |& head -n1 | cut -d " " -f1); then
+	  log_echo -r "${light_ver}"
+	else
+	  log_echo "lighttpd not installed."
+	  error_found=1
+	fi
+	if php_ver=$(php -v |& head -n1); then
+	  log_echo -r "${php_ver}"
+	else
+	  log_echo "PHP not installed."
+	  error_found=1
+	fi
+
+	return "${error_found}"
+}
+
+dir_check() {
+  header_write "Detecting contents of ${1}:"
+  for file in $1*; do
+    header_write "File ${file} found"
+    echo -n ":::       Parsing..."
+    file_parse "${file}"
+    echo "done"
+  done
+  echo ":::"
+}
+
+files_check() {
+  #Check non-zero length existence of ${1}
+  header_write "Detecting existence of ${1}:"
+  local search_file="${1}"
+  if [[ -s ${search_file} ]]; then
+     echo -n ":::       File exists, parsing..."
+     file_parse "${search_file}"
+     echo "done"
+     return 0
+  else
+    log_echo "${1} not found!"
+    return 1
+  fi
+  echo ":::"
+}
+
+source_file() {
+  local file_found=$(files_check "${1}") \
+   && (source "${1}" &> /dev/null && echo "${file_found} and was successfully sourced") \
+   || log_echo -l "${file_found} and could not be sourced"
+}
+
+distro_check() {
+  local soft_fail
+  header_write "Detecting installed OS Distribution"
+  soft_fail=0
+	local distro="$(cat /etc/*release)" && block_parse "${distro}" || (log_echo "Distribution details not found." && soft_fail=1)
+	return "${soft_fail}"
+}
+
+processor_check() {
+  header_write "Checking processor variety"
+  log_write $(uname -m) && return 0 || return 1
+}
+
+ipv6_check() {
+  # Check if system is IPv6 enabled, for use in other functions
+  if [[ $IPV6_ADDRESS ]]; then
+    ls /proc/net/if_inet6 &>/dev/null
+    return 0
+  else
+    return 1
+  fi
+}
+
+ip_check() {
+  local protocol=${1}
+  local gravity=${2}
+  header_write "Checking IPv${protocol} Stack"
+
+  local ip_addr_list="$(ip -${protocol} addr show dev ${PIHOLE_INTERFACE} | awk -F ' ' '{ for(i=1;i<=NF;i++) if ($i ~ '/^inet/') print $(i+1) }')"
+  if [[ -n ${ip_addr_list} ]]; then
+    log_write "IPv${protocol} on ${PIHOLE_INTERFACE}"
+    log_write "Gravity configured for: ${2:-NOT CONFIGURED}"
+    log_write "----"
+    log_write "${ip_addr_list}"
+    echo ":::       IPv${protocol} addresses located on ${PIHOLE_INTERFACE}"
+    ip_ping_check ${protocol}
+    return $(( 0 + $? ))
+  else
+    log_echo "No IPv${protocol} found on ${PIHOLE_INTERFACE}"
+    return 1
+  fi
+}
+
+ip_ping_check() {
+  local protocol=${1}
+  local cmd
+
+  if [[ ${protocol} == "6" ]]; then
+    cmd="ping6"
+    g_addr="2001:4860:4860::8888"
+  else
+    cmd="ping"
+    g_addr="8.8.8.8"
+  fi
+
+  local ip_def_gateway=$(ip -${protocol} route | grep default | cut -d ' ' -f 3)
+  if [[ -n ${ip_def_gateway} ]]; then
+    echo -n ":::        Pinging default IPv${protocol} gateway: "
+    if ! ping_gateway="$(${cmd} -q -W 3 -c 3 -n ${ip_def_gateway} -I ${PIHOLE_INTERFACE} | tail -n 3)"; then
+     log_echo "Gateway did not respond."
+     return 1
     else
-    GATEWAY_CHECK="No IPv6 Gateway Detected"
+      log_echo "Gateway responded."
+      log_write "${ping_gateway}"
     fi
-    echo "$GATEWAY_CHECK" >> ${DEBUG_LOG}
-
-
-    echo >> ${DEBUG_LOG}
-}
-
-function hostnameCheck {
-    echo "############################################################" >> ${DEBUG_LOG}
-	echo "########            Hostname Information           #########" >> ${DEBUG_LOG}
-	echo "############################################################" >> ${DEBUG_LOG}
-
-    echo "::: Writing locally configured hostnames to logfile"
-    # Write the hostname output to compare against entries in /etc/hosts, which is logged next
-    echo "This Pi-hole is: $(hostname)" >> ${DEBUG_LOG}
-
-    echo "::: Writing hosts file to debug log..."
-    echo "###              Hosts              ###" >> ${DEBUG_LOG}
-
-    if [ -e "$HOSTSFILE" ]
-    then
-	    cat "$HOSTSFILE" >> ${DEBUG_LOG}
-	    echo >> ${DEBUG_LOG}
+    echo -n ":::        Pinging Internet via IPv${protocol}: "
+    if ! ping_inet="$(${cmd} -q -W 3 -c 3 -n ${g_addr} -I ${PIHOLE_INTERFACE} | tail -n 3)"; then
+      log_echo "Query did not respond."
+      return 1
     else
-	    echo "No hosts file found!" >> ${DEBUG_LOG}
-	    printf ":::\tNo hosts file found!\n"
+      log_echo "Query responded."
+      log_write "${ping_inet}"
     fi
+  else
+    log_echo "        No gateway detected."
+  fi
+  return 0
 }
 
-function portCheck {
-  echo "############################################################" >> ${DEBUG_LOG}
-	echo "########           Open Port Information           #########" >> ${DEBUG_LOG}
-	echo "############################################################" >> ${DEBUG_LOG}
+port_check() {
+  local lsof_value
 
-    echo "::: Detecting local server port 80 and 53 processes."
-
-    ${SUDO} lsof -i :80 >> ${DEBUG_LOG}
-    ${SUDO} lsof -i :53 >> ${DEBUG_LOG}
-    echo >> ${DEBUG_LOG}
+  lsof_value=$(lsof -i ${1}:${2} -FcL | tr '\n' ' ') \
+  && lsof_parse "${lsof_value}" "${3}" \
+  || log_echo "Failure: IPv${1} Port not in use"
 }
 
-function testResolver {
-	echo "############################################################" >> ${DEBUG_LOG}
-	echo "############      Resolver Functions Check      ############" >> ${DEBUG_LOG}
-	echo "############################################################" >> ${DEBUG_LOG}
+daemon_check() {
+  # Check for daemon ${1} on port ${2}
+	header_write "Daemon Process Information"
 
+	echo ":::     Checking ${2} port for ${1} listener."
+
+	if [[ ${IPV6_READY} ]]; then
+	  port_check 6 "${2}" "${1}"
+  fi
+	lsof_value=$(lsof -i 4:${2} -FcL | tr '\n' ' ') \
+    port_check 4 "${2}" "${1}"
+}
+
+testResolver() {
+  local protocol="${1}"
+  header_write "Resolver Functions Check (IPv${protocol})"
+  local IP="${2}"
+  local g_addr
+  local l_addr
+  local url
+  local testurl
+  local localdig
+  local piholedig
+  local remotedig
+
+  if [[ ${protocol} == "6" ]]; then
+    g_addr="2001:4860:4860::8888"
+    l_addr="::1"
+    r_type="AAAA"
+  else
+    g_addr="8.8.8.8"
+    l_addr="127.0.0.1"
+    r_type="A"
+  fi
 
 	# Find a blocked url that has not been whitelisted.
-    TESTURL="doubleclick.com"
-	if [ -s "$WHITELISTMATCHES" ]; then
-		while read -r line; do
-			CUTURL=${line#*" "}
-			if [ "$CUTURL" != "Pi-Hole.IsWorking.OK" ]; then
-				while read -r line2; do
-					CUTURL2=${line2#*" "}
-					if [ "$CUTURL" != "$CUTURL2" ]; then
-						TESTURL="$CUTURL"
-						break 2
-					fi
-				done < "$WHITELISTMATCHES"
-			fi
-		done < "$GRAVITYFILE"
-	fi
+	url=$(shuf -n 1 "${GRAVITYFILE}" | awk -F ' ' '{ print $2 }')
 
-	echo "Resolution of $TESTURL from Pi-hole:" >> ${DEBUG_LOG}
-	LOCALDIG=$(dig "$TESTURL" @127.0.0.1)
-	if [[ $? = 0 ]]
-	then
-	    echo "$LOCALDIG" >> ${DEBUG_LOG}
+	testurl="${url:-doubleclick.com}"
+
+
+	log_write "Resolution of ${testurl} from Pi-hole (${l_addr}):"
+	if localdig=$(dig -"${protocol}" "${testurl}" @${l_addr} +short "${r_type}"); then
+		log_write "${localdig}"
 	else
-	    echo "Failed to resolve $TESTURL on Pi-hole" >> ${DEBUG_LOG}
+		log_write "Failed to resolve ${testurl} on Pi-hole (${l_addr})"
 	fi
-	echo >> ${DEBUG_LOG}
+	log_write ""
 
-
-	echo "Resolution of $TESTURL from 8.8.8.8:" >> ${DEBUG_LOG}
-	REMOTEDIG=$(dig "$TESTURL" @8.8.8.8)
-	if [[ $? = 0 ]]
-	then
-	    echo "$REMOTEDIG" >> ${DEBUG_LOG}
+	log_write "Resolution of ${testurl} from Pi-hole (${IP}):"
+	if piholedig=$(dig -"${protocol}" "${testurl}" @"${IP}" +short "${r_type}"); then
+		log_write "${piholedig}"
 	else
-	    echo "Failed to resolve $TESTURL on 8.8.8.8" >> ${DEBUG_LOG}
+		log_write "Failed to resolve ${testurl} on Pi-hole (${IP})"
 	fi
-	echo >> ${DEBUG_LOG}
+	log_write ""
 
-	echo "Pi-hole dnsmasq specific records lookups" >> ${DEBUG_LOG}
-    echo "Cache Size:" >> ${DEBUG_LOG}
-    dig +short chaos txt cachesize.bind >> ${DEBUG_LOG}
-    echo "Insertions count:" >> ${DEBUG_LOG}
-    dig +short chaos txt insertions.bind >> ${DEBUG_LOG}
-    echo "Evictions count:" >> ${DEBUG_LOG}
-    dig +short chaos txt evictions.bind >> ${DEBUG_LOG}
-    echo "Misses count:" >> ${DEBUG_LOG}
-    dig +short chaos txt misses.bind >> ${DEBUG_LOG}
-    echo "Hits count:" >> ${DEBUG_LOG}
-    dig +short chaos txt hits.bind >> ${DEBUG_LOG}
-    echo "Auth count:" >> ${DEBUG_LOG}
-    dig +short chaos txt auth.bind >> ${DEBUG_LOG}
-    echo "Upstream Servers:" >> ${DEBUG_LOG}
-    dig +short chaos txt servers.bind >> ${DEBUG_LOG}
-    echo >> ${DEBUG_LOG}
+
+	log_write "Resolution of ${testurl} from ${g_addr}:"
+	if remotedig=$(dig -"${protocol}" "${testurl}" @${g_addr} +short "${r_type}"); then
+		log_write "${remotedig:-NXDOMAIN}"
+	else
+		log_write "Failed to resolve ${testurl} on upstream server ${g_addr}"
+	fi
+	log_write ""
 }
 
-function checkProcesses {
-	echo "#######################################" >> ${DEBUG_LOG}
-	echo "########### Processes Check ###########" >> ${DEBUG_LOG}
-	echo "#######################################" >> ${DEBUG_LOG}
-	echo ":::"
-	echo "::: Logging status of lighttpd and dnsmasq..."
-	PROCESSES=( lighttpd dnsmasq )
-	for i in "${PROCESSES[@]}"
-	do
-		echo "" >> ${DEBUG_LOG}
-		echo -n "$i" >> "$DEBUG_LOG"
-		echo " processes status:" >> ${DEBUG_LOG}
-		${SUDO} systemctl -l status "$i" >> "$DEBUG_LOG"
+testChaos(){
+  # Check Pi-hole specific records
+
+	log_write "Pi-hole dnsmasq specific records lookups"
+	log_write "Cache Size:"
+	log_write $(dig +short chaos txt cachesize.bind)
+	log_write "Upstream Servers:"
+	log_write $(dig +short chaos txt servers.bind)
+	log_write ""
+
+}
+checkProcesses() {
+	header_write "Processes Check"
+
+	echo ":::     Logging status of lighttpd, dnsmasq and pihole-FTL..."
+	PROCESSES=( lighttpd dnsmasq pihole-FTL )
+	for i in "${PROCESSES[@]}"; do
+		log_write "Status for ${i} daemon:"
+		log_write $(systemctl is-active "${i}")
 	done
-	echo >> ${DEBUG_LOG}
+	log_write ""
 }
 
-function debugLighttpd {
-	echo "::: Writing lighttpd to debug log..."
-	echo "#######################################" >> ${DEBUG_LOG}
-	echo "############ lighttpd.conf ############" >> ${DEBUG_LOG}
-	echo "#######################################" >> ${DEBUG_LOG}
-	if [ -e "$LIGHTTPDFILE" ]
-	then
-		while read -r line; do
-			if [ ! -z "$line" ]; then
-				[[ "$line" =~ ^#.*$ ]] && continue
-				echo "$line" >> ${DEBUG_LOG}
-			fi
-		done < "$LIGHTTPDFILE"
-		echo >> ${DEBUG_LOG}
-	else
-		echo "No lighttpd.conf file found!" >> ${DEBUG_LOG}
-		printf ":::\tNo lighttpd.conf file found\n"
-	fi
-	
-	if [ -e "$LIGHTTPDERRFILE" ]
-	then
-		echo "#######################################" >> ${DEBUG_LOG}
-		echo "######### lighttpd error.log ##########" >> ${DEBUG_LOG}
-		echo "#######################################" >> ${DEBUG_LOG}
-		cat "$LIGHTTPDERRFILE" >> ${DEBUG_LOG}
-	else
-		echo "No lighttpd error.log file found!" >> ${DEBUG_LOG}
-		printf ":::\tNo lighttpd error.log file found\n"
-	fi
-	echo >> ${DEBUG_LOG}
+debugLighttpd() {
+  echo ":::     Checking for necessary lighttpd files."
+  files_check "${LIGHTTPDFILE}"
+  files_check "${LIGHTTPDERRFILE}"
+  echo ":::"
 }
 
-### END FUNCTIONS ###
-
-version_check
-distro_check
-ip_check
-hostnameCheck
-portCheck
-checkProcesses
-testResolver
-debugLighttpd
-
-echo "::: Writing dnsmasq.conf to debug log..."
-echo "#######################################" >> ${DEBUG_LOG}
-echo "############### Dnsmasq ###############" >> ${DEBUG_LOG}
-echo "#######################################" >> ${DEBUG_LOG}
-if [ -e "$DNSMASQFILE" ]
-then
-	#cat $DNSMASQFILE >> $DEBUG_LOG
-	while read -r line; do
-		if [ ! -z "$line" ]; then
-			[[ "$line" =~ ^#.*$ ]] && continue
-			echo "$line" >> ${DEBUG_LOG}
-        fi
-	done < "$DNSMASQFILE"
-	echo >> ${DEBUG_LOG}
-else
-	echo "No dnsmasq.conf file found!" >> ${DEBUG_LOG}
-	printf ":::\tNo dnsmasq.conf file found!\n"
-fi
-
-echo "::: Writing 01-pihole.conf to debug log..."
-echo "#######################################" >> ${DEBUG_LOG}
-echo "########### 01-pihole.conf ############" >> ${DEBUG_LOG}
-echo "#######################################" >> ${DEBUG_LOG}
-if [ -e "$PIHOLECONFFILE" ]
-then
-	while read -r line; do
-		if [ ! -z "$line" ]; then
-			[[ "$line" =~ ^#.*$ ]] && continue
-			echo "$line" >> ${DEBUG_LOG}
-        fi
-	done < "$PIHOLECONFFILE"
-	echo >> ${DEBUG_LOG}
-else
-	echo "No 01-pihole.conf file found!" >> ${DEBUG_LOG}
-	printf ":::\tNo 01-pihole.conf file found\n"
-fi
-
-echo "::: Writing size of gravity.list to debug log..."
-echo "#######################################" >> ${DEBUG_LOG}
-echo "############ gravity.list #############" >> ${DEBUG_LOG}
-echo "#######################################" >> ${DEBUG_LOG}
-if [ -e "$GRAVITYFILE" ]
-then
-	wc -l "$GRAVITYFILE" >> ${DEBUG_LOG}
-	echo >> ${DEBUG_LOG}
-else
-	echo "No gravity.list file found!" >> ${DEBUG_LOG}
-	printf ":::\tNo gravity.list file found\n"
-fi
-
-
-### Pi-hole application specific logging ###
-echo "::: Writing whitelist to debug log..."
-echo "#######################################" >> ${DEBUG_LOG}
-echo "############## Whitelist ##############" >> ${DEBUG_LOG}
-echo "#######################################" >> ${DEBUG_LOG}
-if [ -e "$WHITELISTFILE" ]
-then
-	cat "$WHITELISTFILE" >> ${DEBUG_LOG}
-	echo >> ${DEBUG_LOG}
-else
-	echo "No whitelist.txt file found!" >> ${DEBUG_LOG}
-	printf ":::\tNo whitelist.txt file found!\n"
-fi
-
-echo "::: Writing blacklist to debug log..."
-echo "#######################################" >> ${DEBUG_LOG}
-echo "############## Blacklist ##############" >> ${DEBUG_LOG}
-echo "#######################################" >> ${DEBUG_LOG}
-if [ -e "$BLACKLISTFILE" ]
-then
-	cat "$BLACKLISTFILE" >> ${DEBUG_LOG}
-	echo >> ${DEBUG_LOG}
-else
-	echo "No blacklist.txt file found!" >> ${DEBUG_LOG}
-	printf ":::\tNo blacklist.txt file found!\n"
-fi
-
-echo "::: Writing adlists.list to debug log..."
-echo "#######################################" >> ${DEBUG_LOG}
-echo "############ adlists.list #############" >> ${DEBUG_LOG}
-echo "#######################################" >> ${DEBUG_LOG}
-if [ -e "$ADLISTSFILE" ]
-then
-  while read -r line; do
-    if [ ! -z "$line" ]; then
-		  [[ "$line" =~ ^#.*$ ]] && continue
-			echo "$line" >> ${DEBUG_LOG}
-	fi
-	done < "$ADLISTSFILE"
-	echo >> ${DEBUG_LOG}
-else
-	echo "No adlists.list file found... using adlists.default!" >> ${DEBUG_LOG}
-	printf ":::\tNo adlists.list file found... using adlists.default!\n"
-fi
-
+countdown() {
+  local tuvix
+  tuvix=${TIMEOUT}
+  printf "::: Logging will automatically teminate in %s seconds\n" "${TIMEOUT}"
+  while [ $tuvix -ge 1 ]
+  do
+    printf ":::\t%s seconds left. " "${tuvix}"
+    if [[ -z "${WEBCALL}" ]]; then
+      printf "\r"
+    else
+      printf "\n"
+    fi
+    sleep 5
+    tuvix=$(( tuvix - 5 ))
+  done
+}
 
 # Continuously append the pihole.log file to the pihole_debug.log file
-function dumpPiHoleLog {
+dumpPiHoleLog() {
 	trap '{ echo -e "\n::: Finishing debug write from interrupt... Quitting!" ; exit 1; }' INT
-	echo -e "::: Writing current Pi-hole traffic to debug log...\n:::\tTry loading any/all sites that you are having trouble with now... \n:::\t(Press ctrl+C to finish)"
-	echo "#######################################" >> ${DEBUG_LOG}
-	echo "############# pihole.log ##############" >> ${DEBUG_LOG}
-	echo "#######################################" >> ${DEBUG_LOG}
-	if [ -e "$PIHOLELOG" ]
-	then
-		while true; do
-			tail -f "$PIHOLELOG" >> ${DEBUG_LOG}
-			echo >> ${DEBUG_LOG}
-		done
+	echo "::: "
+	echo "::: --= User Action Required =--"
+	echo -e "::: Try loading a site that you are having trouble with now from a client web browser.. \n:::\t(Press CTRL+C to finish logging.)"
+	header_write "pihole.log"
+	if [ -e "${PIHOLELOG}" ]; then
+	# Dummy process to use for flagging down tail to terminate
+	  countdown &
+		tail -n0 -f --pid=$! "${PIHOLELOG}" >&4
 	else
-		echo "No pihole.log file found!" >> ${DEBUG_LOG}
+		log_write "No pihole.log file found!"
 		printf ":::\tNo pihole.log file found!\n"
 	fi
 }
 
 # Anything to be done after capturing of pihole.log terminates
-function finalWork {
-        echo "::: Finshed debugging!"
-    echo "::: The debug log can be uploaded to Termbin.com for easier sharing."
-        read -r -p "::: Would you like to upload the log? [y/N] " response
-    case ${response} in
-        [yY][eE][sS]|[yY])
-            TERMBIN=$(cat /var/log/pihole_debug.log | nc termbin.com 9999)
-            ;;
-        *)
-            echo "::: Log will NOT be uploaded to Termbin."
-            ;;
-    esac
+finalWork() {
+  local tricorder
+	echo "::: Finshed debugging!"
 
-        # Check if termbin.com is reachable. When it's not, point to local log instead
-        if [ -n "$TERMBIN" ]
-        then
-                echo "::: Debug log can be found at : $TERMBIN"
-        else
-                echo "::: Debug log can be found at : /var/log/pihole_debug.log"
-        fi
+  # Ensure the file exists, create if not, clear if exists.
+  truncate --size=0 "${DEBUG_LOG}"
+  chmod 644 ${DEBUG_LOG}
+  chown "$USER":pihole ${DEBUG_LOG}
+  # copy working temp file to final log location
+  cat /proc/$$/fd/3 >> "${DEBUG_LOG}"
+  # Straight dump of tailing the logs, can sanitize later if needed.
+  cat /proc/$$/fd/4 >> "${DEBUG_LOG}"
+
+	echo "::: The debug log can be uploaded to tricorder.pi-hole.net for sharing with developers only."
+	if [[ "${AUTOMATED}" ]]; then
+	  echo "::: Debug script running in automated mode, uploading log to tricorder..."
+	  tricorder=$(cat /var/log/pihole_debug.log | nc tricorder.pi-hole.net 9999)
+	else
+	  read -r -p "::: Would you like to upload the log? [y/N] " response
+	  case ${response} in
+		  [yY][eE][sS]|[yY])
+			  tricorder=$(cat /var/log/pihole_debug.log | nc tricorder.pi-hole.net 9999)
+			  ;;
+		  *)
+			  echo "::: Log will NOT be uploaded to tricorder."
+			  ;;
+	  esac
+  fi
+	# Check if tricorder.pi-hole.net is reachable and provide token.
+	if [ -n "${tricorder}" ]; then
+		echo "::: ---=== Your debug token is : ${tricorder} Please make a note of it. ===---"
+		echo "::: Contact the Pi-hole team with your token for assistance."
+		echo "::: Thank you."
+	else
+		echo "::: There was an error uploading your debug log."
+		echo "::: Please try again or contact the Pi-hole team for assistance."
+	fi
+		echo "::: A local copy of the Debug log can be found at : /var/log/pihole_debug.log"
 }
 
+### END FUNCTIONS ###
+# Create temporary file for log
+TEMPLOG=$(mktemp /tmp/pihole_temp.XXXXXX)
+# Open handle 3 for templog
+exec 3>"$TEMPLOG"
+# Delete templog, but allow for addressing via file handle.
+rm "$TEMPLOG"
+
+# Create temporary file for logdump using file handle 4
+DUMPLOG=$(mktemp /tmp/pihole_temp.XXXXXX)
+exec 4>"$DUMPLOG"
+rm "$DUMPLOG"
+
+# Gather version of required packages / repositories
+version_check || echo "REQUIRED FILES MISSING"
+# Check for newer setupVars storage file
+source_file "/etc/pihole/setupVars.conf"
+# Gather information about the running distribution
+distro_check || echo "Distro Check soft fail"
+# Gather processor type
+processor_check || echo "Processor Check soft fail"
+
+ip_check 6 ${IPV6_ADDRESS}
+ip_check 4 ${IPV4_ADDRESS}
+
+daemon_check lighttpd http
+daemon_check dnsmasq domain
+daemon_check pihole-FTL 4711
+checkProcesses
+
+# Check local/IP/Google for IPv4 Resolution
+testResolver 4 "${IPV4_ADDRESS%/*}"
+# If IPv6 enabled, check resolution
+if [[ "${IPV6_ADDRESS}" ]]; then
+  testResolver 6 "${IPV6_ADDRESS%/*}"
+fi
+# Poll dnsmasq Pi-hole specific queries
+testChaos
+
+debugLighttpd
+
+files_check "${DNSMASQFILE}"
+dir_check "${DNSMASQCONFDIR}"
+files_check "${WHITELISTFILE}"
+files_check "${BLACKLISTFILE}"
+files_check "${ADLISTFILE}"
+
+
+header_write "Analyzing gravity.list"
+
+	gravity_length=$(grep -c ^ "${GRAVITYFILE}") \
+	&& log_write "${GRAVITYFILE} is ${gravity_length} lines long." \
+	|| log_echo "Warning: No gravity.list file found!"
+
+header_write "Analyzing pihole.log"
+
+  pihole_length=$(grep -c ^ "${PIHOLELOG}") \
+  && log_write "${PIHOLELOG} is ${pihole_length} lines long." \
+  || log_echo "Warning: No pihole.log file found!"
+
+  pihole_size=$(du -h "${PIHOLELOG}" | awk '{ print $1 }') \
+  && log_write "${PIHOLELOG} is ${pihole_size}." \
+  || log_echo "Warning: No pihole.log file found!"
+
+header_write "Analyzing pihole-FTL.log"
+
+  FTL_length=$(grep -c ^ "${FTLLOG}") \
+  && log_write "${FTLLOG} is ${FTL_length} lines long." \
+  || log_echo "Warning: No pihole-FTL.log file found!"
+
+  FTL_size=$(du -h "${FTLLOG}" | awk '{ print $1 }') \
+  && log_write "${FTLLOG} is ${FTL_size}." \
+  || log_echo "Warning: No pihole-FTL.log file found!"
+
+tail -n50 "${FTLLOG}" >&3
+
 trap finalWork EXIT
 
 ### Method calls for additional logging ###

advanced/Scripts/piholeLogFlush.sh

@@ -1,15 +1,45 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
-# Flushes /var/log/pihole.log
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
 #
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
+# Flushes Pi-hole's log file
+#
+# 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 ..."
-echo " " > /var/log/pihole.log
-echo "... done!"
+if [[ "$@" != *"quiet"* ]]; then
+  echo -n "::: 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
+fi
+
+if [[ "$@" != *"quiet"* ]]; then
+  echo "... done!"
+fi

advanced/Scripts/setupLCD.sh

@@ -1,57 +1,42 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
 # Automatically configures the Pi to use the 2.8 LCD screen to display stats on it (also works over ssh)
 #
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+
 
 ############ FUNCTIONS ###########
-# Run this script as root or under sudo
-echo ":::"
-if [[ $EUID -eq 0 ]];then
-	echo "::: You are root."
-else
-	echo "::: sudo will be used."
-  # Check if it is actually installed
-  # If it isn't, exit because the install cannot complete
-  if [ -x "$(command -v sudo)" ];then
-		export SUDO="sudo"
-  else
-		echo "::: Please install sudo or run this script as root."
-    exit 1
-  fi
-fi
 
 # Borrowed from adafruit-pitft-helper < borrowed from raspi-config
 # https://github.com/adafruit/Adafruit-PiTFT-Helper/blob/master/adafruit-pitft-helper#L324-L334
 getInitSys() {
-  if command -v systemctl > /dev/null && systemctl | grep -q '\-\.mount'; then
-    SYSTEMD=1
-  elif [ -f /etc/init.d/cron ] && [ ! -h /etc/init.d/cron ]; then
-    SYSTEMD=0
-  else
-    echo "Unrecognised init system"
-    return 1
-  fi
+	if command -v systemctl > /dev/null && systemctl | grep -q '\-\.mount'; then
+		SYSTEMD=1
+	elif [ -f /etc/init.d/cron ] && [ ! -h /etc/init.d/cron ]; then
+		SYSTEMD=0
+	else
+		echo "Unrecognised init system"
+		return 1
+	fi
 }
 
 # Borrowed from adafruit-pitft-helper:
 # https://github.com/adafruit/Adafruit-PiTFT-Helper/blob/master/adafruit-pitft-helper#L274-L285
 autoLoginPiToConsole() {
-  if [ -e /etc/init.d/lightdm ]; then
-    if [ ${SYSTEMD} -eq 1 ]; then
-      ${SUDO} systemctl set-default multi-user.target
-      ${SUDO} ln -fs /etc/systemd/system/autologin@.service /etc/systemd/system/getty.target.wants/getty@tty1.service
-    else
-      ${SUDO} update-rc.d lightdm disable 2
-      ${SUDO} sed /etc/inittab -i -e "s/1:2345:respawn:\/sbin\/getty --noclear 38400 tty1/1:2345:respawn:\/bin\/login -f pi tty1 <\/dev\/tty1 >\/dev\/tty1 2>&1/"
-      fi
-  fi
+	if [ -e /etc/init.d/lightdm ]; then
+		if [ ${SYSTEMD} -eq 1 ]; then
+			systemctl set-default multi-user.target
+			ln -fs /etc/systemd/system/autologin@.service /etc/systemd/system/getty.target.wants/getty@tty1.service
+		else
+			update-rc.d lightdm disable 2
+			sed /etc/inittab -i -e "s/1:2345:respawn:\/sbin\/getty --noclear 38400 tty1/1:2345:respawn:\/bin\/login -f pi tty1 <\/dev\/tty1 >\/dev\/tty1 2>&1/"
+		fi
+	fi
 }
 
 ######### SCRIPT ###########
@@ -66,23 +51,23 @@ echo /usr/local/bin/chronometer.sh >> /home/pi/.bashrc
 
 # Set up the LCD screen based on Adafruits instuctions:
 # https://learn.adafruit.com/adafruit-pitft-28-inch-resistive-touchscreen-display-raspberry-pi/easy-install
-curl -SLs https://apt.adafruit.com/add-pin | ${SUDO} bash
-${SUDO} apt-get -y install raspberrypi-bootloader
-${SUDO} apt-get -y install adafruit-pitft-helper
-${SUDO} adafruit-pitft-helper -t 28r
+curl -SLs https://apt.adafruit.com/add-pin | bash
+apt-get -y install raspberrypi-bootloader
+apt-get -y install adafruit-pitft-helper
+adafruit-pitft-helper -t 28r
 
 # Download the cmdline.txt file that prevents the screen from going blank after a period of time
-${SUDO} mv /boot/cmdline.txt /boot/cmdline.orig
-${SUDO} curl -o /boot/cmdline.txt https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/cmdline.txt
+mv /boot/cmdline.txt /boot/cmdline.orig
+curl -o /boot/cmdline.txt https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/cmdline.txt
 
 # Back up the original file and download the new one
-${SUDO} mv /etc/default/console-setup /etc/default/console-setup.orig
-${SUDO} curl -o /etc/default/console-setup https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/console-setup
+mv /etc/default/console-setup /etc/default/console-setup.orig
+curl -o /etc/default/console-setup https://raw.githubusercontent.com/pi-hole/pi-hole/master/advanced/console-setup
 
 # Instantly apply the font change to the LCD screen
-${SUDO} setupcon
+setupcon
 
-${SUDO} reboot
+reboot
 
 # Start showing the stats on the screen by running the command on another tty:
 # http://unix.stackexchange.com/questions/170063/start-a-process-on-a-different-tty

advanced/Scripts/update.sh

@@ -0,0 +1,232 @@
+#!/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.
+#
+# Check Pi-hole core and admin pages versions and determine what
+# upgrade (if any) is required. Automatically updates and reinstalls
+# application if update is detected.
+#
+# 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
+
+# Have to ignore the following rule as spaces in paths are not supported by ShellCheck
+#shellcheck disable=SC1090
+source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
+
+# is_repo() sourced from basic-install.sh
+# make_repo() sourced from basic-install.sh
+# update_repo() source from basic-install.sh
+# getGitFiles() sourced from basic-install.sh
+
+GitCheckUpdateAvail() {
+  local directory="${1}"
+  curdir=$PWD
+  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}")"
+
+  # The suffix @{upstream} to a branchname
+  # (short form <branchname>@{u}) refers
+  # to the branch that the branch specified
+  # by branchname is set to build on top of#
+  # (configured with branch.<name>.remote and
+  # branch.<name>.merge). A missing branchname
+  # defaults to the current one.
+  REMOTE="$(git rev-parse "@{upstream}")"
+
+  if [[ ${#LOCAL} == 0 ]]; then
+    echo "::: Error: Local revision could not be obtained, ask Pi-hole support."
+    echo "::: Additional debugging output:"
+    git status
+    exit
+  fi
+  if [[ ${#REMOTE} == 0 ]]; then
+    echo "::: Error: Remote revision could not be obtained, ask Pi-hole support."
+    echo "::: Additional debugging output:"
+    git status
+    exit
+  fi
+
+  # Change back to original directory
+  cd "${curdir}" || exit
+
+  if [[ "${LOCAL}" != "${REMOTE}" ]]; then
+    # Local branch is behind remote branch -> Update
+    return 0
+  else
+    # Local branch is up-to-date or in a situation
+    # where this updater cannot be used (like on a
+    # branch that exists only locally)
+    return 1
+  fi
+}
+
+FTLcheckUpdate() {
+
+	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
+	else
+		return 1
+	fi
+}
+
+main() {
+  local pihole_version_current
+  local web_version_current
+  #shellcheck disable=1090,2154
+  source "${setupVars}"
+
+  #This is unlikely
+  if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
+    echo "::: Critical Error: Core Pi-hole repo is missing from system!"
+    echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
+    exit 1;
+  fi
+
+  echo "::: Checking for updates..."
+
+  if GitCheckUpdateAvail "${PI_HOLE_FILES_DIR}" ; then
+    core_update=true
+    echo "::: Pi-hole Core:   update available"
+  else
+    core_update=false
+    echo "::: Pi-hole Core:   up to date"
+  fi
+
+  if FTLcheckUpdate ; then
+    FTL_update=true
+    echo "::: FTL:            update available"
+  else
+    FTL_update=false
+    echo "::: FTL:            up to date"
+  fi
+
+  # Logic: Don't update FTL when there is a core update available
+  # since the core update will run the installer which will itself
+  # re-install (i.e. update) FTL
+  if ${FTL_update} && ! ${core_update}; then
+    echo ":::"
+    echo "::: FTL out of date"
+    FTLdetect
+    echo ":::"
+  fi
+
+  if [[ ${INSTALL_WEB} == true ]]; then
+    if ! is_repo "${ADMIN_INTERFACE_DIR}" ; then
+      echo "::: Critical Error: Web Admin repo is missing from system!"
+      echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
+      exit 1;
+    fi
+
+    if GitCheckUpdateAvail "${ADMIN_INTERFACE_DIR}" ; then
+      web_update=true
+      echo "::: Web Interface:  update available"
+    else
+      web_update=false
+      echo "::: Web Interface:  up to date"
+    fi
+
+    # Logic
+    # If Core up to date AND web up to date:
+    #            Do nothing
+    # If Core up to date AND web NOT up to date:
+    #            Pull web repo
+    # If Core NOT up to date AND web up to date:
+    #            pull pihole repo, run install --unattended -- reconfigure
+    # if Core NOT up to date AND web NOT up to date:
+    #            pull pihole repo run install --unattended
+
+    if ! ${core_update} && ! ${web_update} ; then
+      if ! ${FTL_update} ; then
+        echo ":::"
+        echo "::: Everything is up to date!"
+        exit 0
+      fi
+
+    elif ! ${core_update} && ${web_update} ; then
+      echo ":::"
+      echo "::: Pi-hole Web Admin files out of date"
+      getGitFiles "${ADMIN_INTERFACE_DIR}" "${ADMIN_INTERFACE_GIT_URL}"
+
+    elif ${core_update} && ! ${web_update} ; then
+      echo ":::"
+      echo "::: Pi-hole core files out of date"
+      getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
+      ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
+
+    elif ${core_update} && ${web_update} ; then
+      echo ":::"
+      echo "::: Updating Pi-hole core and web admin files"
+      getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
+      ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
+    else
+      echo "*** Update script has malfunctioned, fallthrough reached. Please contact support"
+      exit 1
+    fi
+  else # Web Admin not installed, so only verify if core is up to date
+    if ! ${core_update}; then
+      if ! ${FTL_update} ; then
+        echo ":::"
+        echo "::: Everything is up to date!"
+        exit 0
+      fi
+    else
+      echo ":::"
+      echo "::: Pi-hole core files out of date"
+      getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
+      ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
+    fi
+  fi
+
+  if [[ "${web_update}" == true ]]; then
+    web_version_current="$(/usr/local/bin/pihole version --admin --current)"
+    echo ":::"
+    echo "::: Web Admin version is now at ${web_version_current/* v/v}}"
+    echo "::: If you had made any changes in '/var/www/html/admin/', they have been stashed using 'git stash'"
+  fi
+
+  if [[ "${core_update}" == true ]]; then
+    pihole_version_current="$(/usr/local/bin/pihole version --pihole --current)"
+    echo ":::"
+    echo "::: Pi-hole version is now at ${pihole_version_current/* v/v}}"
+    echo "::: If you had made any changes in '/etc/.pihole/', they have been stashed using 'git stash'"
+  fi
+
+  if [[ ${FTL_update} == true ]]; then
+    FTL_version_current="$(/usr/local/bin/pihole version --ftl --current)"
+    echo ":::"
+    echo "::: FTL version is now at ${FTL_version_current/* v/v}}"
+    start_service pihole-FTL
+    enable_service pihole-FTL
+  fi
+
+
+  echo ""
+  exit 0
+
+}
+
+main

advanced/Scripts/version.sh

@@ -1,20 +1,168 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
-# Whitelists domains
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
 #
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
+# Show version numbers
+#
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
 
-piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
-webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
+# Variables
+DEFAULT="-1"
+COREGITDIR="/etc/.pihole/"
+WEBGITDIR="/var/www/html/admin/"
 
-piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
-webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+getLocalVersion() {
+  # FTL requires a different method
+  if [[ "$1" == "FTL" ]]; then
+    pihole-FTL version
+    return 0
+  fi
 
-echo "::: Pi-hole version is $piholeVersion (Latest version is $piholeVersionLatest)"
-echo "::: Web-Admin version is $webVersion (Latest version is $webVersionLatest)"
+  # Get the tagged version of the local repository
+  local directory="${1}"
+  local version
+
+  cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
+  version=$(git describe --tags --always || echo "$DEFAULT")
+  if [[ "${version}" =~ ^v ]]; then
+    echo "${version}"
+  elif [[ "${version}" == "${DEFAULT}" ]]; then
+    echo "ERROR"
+    return 1
+  else
+    echo "Untagged"
+  fi
+  return 0
+}
+
+getLocalHash() {
+  # Local FTL hash does not exist on filesystem
+  if [[ "$1" == "FTL" ]]; then
+    echo "N/A"
+    return 0
+  fi
+  
+  # Get the short hash of the local repository
+  local directory="${1}"
+  local hash
+
+  cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
+  hash=$(git rev-parse --short HEAD || echo "$DEFAULT")
+  if [[ "${hash}" == "${DEFAULT}" ]]; then
+    echo "ERROR"
+    return 1
+  else
+    echo "${hash}"
+  fi
+  return 0
+}
+
+getRemoteHash(){
+  # Remote FTL hash is not applicable
+  if [[ "$1" == "FTL" ]]; then
+    echo "N/A"
+    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" | \
+            awk -F: '$1 ~/tag_name/ { print $2 }' | \
+            tr -cd '[[:alnum:]]._-')
+  if [[ "${version}" =~ ^v ]]; then
+    echo "${version}"
+  else
+    echo "ERROR"
+    return 1
+  fi
+  return 0
+}
+
+versionOutput() {
+  [[ "$1" == "pi-hole" ]] && GITDIR=$COREGITDIR
+  [[ "$1" == "AdminLTE" ]] && GITDIR=$WEBGITDIR
+  [[ "$1" == "FTL" ]] && GITDIR="FTL"
+  
+  [[ "$2" == "-c" ]] || [[ "$2" == "--current" ]] || [[ -z "$2" ]] && current=$(getLocalVersion $GITDIR)
+  [[ "$2" == "-l" ]] || [[ "$2" == "--latest" ]] || [[ -z "$2" ]] && latest=$(getRemoteVersion "$1")
+  if [[ "$2" == "-h" ]] || [[ "$2" == "--hash" ]]; then
+    [[ "$3" == "-c" ]] || [[ "$3" == "--current" ]] || [[ -z "$3" ]] && curHash=$(getLocalHash "$GITDIR")
+    [[ "$3" == "-l" ]] || [[ "$3" == "--latest" ]] || [[ -z "$3" ]] && latHash=$(getRemoteHash "$1" "$(cd "$GITDIR" 2> /dev/null && git rev-parse --abbrev-ref HEAD)")
+  fi
+
+  if [[ -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"
+}
+
+errorOutput() {
+  echo "  Invalid Option! Try 'pihole -v --help' for more information."
+  exit 1
+}
+  
+defaultOutput() {
+  versionOutput "pi-hole" "$@"
+  versionOutput "AdminLTE" "$@"
+  versionOutput "FTL" "$@"
+}
+
+helpFunc() {
+  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
+}
+
+case "${1}" in
+  "-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

@@ -0,0 +1,465 @@
+#!/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.
+#
+# Web interface settings
+#
+# 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"
+
+helpFunc() {
+  echo "Usage: pihole -a [options]
+Example: pihole -a -p password
+Set options for the Admin Console
+
+Options:
+  -f, flush           Flush the Pi-hole log
+  -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
+  -h, --help          Show this help dialog
+  -i, interface       Specify dnsmasq's interface listening behavior
+                        Add '-h' for more info on interface usage" 
+	exit 0
+}
+
+add_setting() {
+	echo "${1}=${2}" >> "${setupVars}"
+}
+
+delete_setting() {
+	sed -i "/${1}/d" "${setupVars}"
+}
+
+change_setting() {
+	delete_setting "${1}"
+	add_setting "${1}" "${2}"
+}
+
+add_dnsmasq_setting() {
+	if [[ "${2}" != "" ]]; then
+		echo "${1}=${2}" >> "${dnsmasqconfig}"
+	else
+		echo "${1}" >> "${dnsmasqconfig}"
+	fi
+}
+
+delete_dnsmasq_setting() {
+	sed -i "/${1}/d" "${dnsmasqconfig}"
+}
+
+SetTemperatureUnit() {
+	change_setting "TEMPERATUREUNIT" "${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}
+}
+
+SetWebPassword() {
+	if [ "${SUDO_USER}" == "www-data" ]; then
+		echo "Security measure: user www-data is not allowed to change webUI password!"
+		echo "Exiting"
+		exit 1
+	fi
+
+	if [ "${SUDO_USER}" == "lighttpd" ]; then
+		echo "Security measure: user lighttpd is not allowed to change webUI password!"
+		echo "Exiting"
+		exit 1
+	fi
+
+  if (( ${#args[2]} > 0 )) ; then
+    readonly PASSWORD="${args[2]}"
+    readonly CONFIRM="${PASSWORD}"
+  else
+    read -s -p "Enter New Password (Blank for no password): " PASSWORD
+    echo ""
+
+    if [ "${PASSWORD}" == "" ]; then
+      change_setting "WEBPASSWORD" ""
+      echo "Password Removed"
+      exit 0
+    fi
+
+    read -s -p "Confirm Password: " CONFIRM
+    echo ""
+  fi
+
+	if [ "${PASSWORD}" == "${CONFIRM}" ] ; then
+		hash=$(HashPassword ${PASSWORD})
+		# Save hash to file
+		change_setting "WEBPASSWORD" "${hash}"
+		echo "New password set"
+	else
+		echo "Passwords don't match. Your password has not been changed"
+		exit 1
+	fi
+}
+
+ProcessDNSSettings() {
+	source "${setupVars}"
+
+	delete_dnsmasq_setting "server"
+
+	COUNTER=1
+	while [[ 1 ]]; do
+		var=PIHOLE_DNS_${COUNTER}
+		if [ -z "${!var}" ]; then
+			break;
+		fi
+		add_dnsmasq_setting "server" "${!var}"
+		let COUNTER=COUNTER+1
+	done
+
+	delete_dnsmasq_setting "domain-needed"
+
+	if [[ "${DNS_FQDN_REQUIRED}" == true ]]; then
+		add_dnsmasq_setting "domain-needed"
+	fi
+
+	delete_dnsmasq_setting "bogus-priv"
+
+	if [[ "${DNS_BOGUS_PRIV}" == true ]]; then
+		add_dnsmasq_setting "bogus-priv"
+	fi
+
+	delete_dnsmasq_setting "dnssec"
+	delete_dnsmasq_setting "trust-anchor="
+
+	if [[ "${DNSSEC}" == true ]]; then
+		echo "dnssec
+trust-anchor=.,19036,8,2,49AAC11D7B6F6446702E54A1607371607A1A41855200FD2CE1CDDE32F24E8FB5
+" >> "${dnsmasqconfig}"
+	fi
+
+	delete_dnsmasq_setting "host-record"
+
+	if [ ! -z "${HOSTRECORD}" ]; then
+		add_dnsmasq_setting "host-record" "${HOSTRECORD}"
+	fi
+
+	# Setup interface listening behavior of dnsmasq
+	delete_dnsmasq_setting "interface"
+	delete_dnsmasq_setting "local-service"
+
+	if [[ "${DNSMASQ_LISTENING}" == "all" ]]; then
+		# Listen on all interfaces, permit all origins
+		add_dnsmasq_setting "except-interface" "nonexisting"
+	elif [[ "${DNSMASQ_LISTENING}" == "local" ]]; then
+		# Listen only on all interfaces, but only local subnets
+		add_dnsmasq_setting "local-service"
+	else
+		# Listen only on one interface
+		add_dnsmasq_setting "interface" "${PIHOLE_INTERFACE}"
+	fi
+
+}
+
+SetDNSServers() {
+	# Save setting to file
+	delete_setting "PIHOLE_DNS"
+	IFS=',' read -r -a array <<< "${args[2]}"
+	for index in "${!array[@]}"
+	do
+		add_setting "PIHOLE_DNS_$((index+1))" "${array[index]}"
+	done
+
+	if [[ "${args[3]}" == "domain-needed" ]]; then
+		change_setting "DNS_FQDN_REQUIRED" "true"
+	else
+		change_setting "DNS_FQDN_REQUIRED" "false"
+	fi
+
+	if [[ "${args[4]}" == "bogus-priv" ]]; then
+		change_setting "DNS_BOGUS_PRIV" "true"
+	else
+		change_setting "DNS_BOGUS_PRIV" "false"
+	fi
+
+	if [[ "${args[5]}" == "dnssec" ]]; then
+		change_setting "DNSSEC" "true"
+	else
+		change_setting "DNSSEC" "false"
+	fi
+
+	ProcessDNSSettings
+
+	# Restart dnsmasq to load new configuration
+	RestartDNS
+}
+
+SetExcludeDomains() {
+	change_setting "API_EXCLUDE_DOMAINS" "${args[2]}"
+}
+
+SetExcludeClients() {
+	change_setting "API_EXCLUDE_CLIENTS" "${args[2]}"
+}
+
+Reboot() {
+	nohup bash -c "sleep 5; reboot" &> /dev/null </dev/null &
+}
+
+RestartDNS() {
+	if [ -x "$(command -v systemctl)" ]; then
+		systemctl restart dnsmasq &> /dev/null
+	else
+		service dnsmasq restart &> /dev/null
+	fi
+}
+
+SetQueryLogOptions() {
+	change_setting "API_QUERY_LOG_SHOW" "${args[2]}"
+}
+
+ProcessDHCPSettings() {
+	source "${setupVars}"
+
+	if [[ "${DHCP_ACTIVE}" == "true" ]]; then
+    interface=$(grep 'PIHOLE_INTERFACE=' /etc/pihole/setupVars.conf | sed "s/.*=//")
+
+    # Use eth0 as fallback interface
+    if [ -z ${interface} ]; then
+      interface="eth0"
+    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="24h"
+      change_setting "DHCP_LEASETIME" "${leasetime}"
+    else
+      leasetime="${DHCP_LEASETIME}h"
+    fi
+
+    # 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             #
+###############################################################################
+dhcp-authoritative
+dhcp-range=${DHCP_START},${DHCP_END},${leasetime}
+dhcp-option=option:router,${DHCP_ROUTER}
+dhcp-leasefile=/etc/pihole/dhcp.leases
+#quiet-dhcp
+" > "${dhcpconfig}"
+
+  if [[ "${PIHOLE_DOMAIN}" != "none" ]]; then
+    echo "domain=${PIHOLE_DOMAIN}" >> "${dhcpconfig}"
+  fi
+
+    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
+
+	else
+		rm "${dhcpconfig}" &> /dev/null
+	fi
+}
+
+EnableDHCP() {
+	change_setting "DHCP_ACTIVE" "true"
+	change_setting "DHCP_START" "${args[2]}"
+	change_setting "DHCP_END" "${args[3]}"
+	change_setting "DHCP_ROUTER" "${args[4]}"
+	change_setting "DHCP_LEASETIME" "${args[5]}"
+	change_setting "PIHOLE_DOMAIN" "${args[6]}"
+	change_setting "DHCP_IPv6" "${args[7]}"
+
+	# Remove possible old setting from file
+	delete_dnsmasq_setting "dhcp-"
+	delete_dnsmasq_setting "quiet-dhcp"
+
+	ProcessDHCPSettings
+
+	RestartDNS
+}
+
+DisableDHCP() {
+	change_setting "DHCP_ACTIVE" "false"
+
+	# Remove possible old setting from file
+	delete_dnsmasq_setting "dhcp-"
+	delete_dnsmasq_setting "quiet-dhcp"
+
+	ProcessDHCPSettings
+
+	RestartDNS
+}
+
+SetWebUILayout() {
+	change_setting "WEBUIBOXEDLAYOUT" "${args[2]}"
+}
+
+CustomizeAdLists() {
+  list="/etc/pihole/adlists.list"
+
+	if [[ "${args[2]}" == "enable" ]]; then
+		sed -i "\\@${args[3]}@s/^#http/http/g" "${list}"
+	elif [[ "${args[2]}" == "disable" ]]; then
+		sed -i "\\@${args[3]}@s/^http/#http/g" "${list}"
+	elif [[ "${args[2]}" == "add" ]]; then
+		echo "${args[3]}" >> ${list}
+	elif [[ "${args[2]}" == "del" ]]; then
+	  var=$(echo "${args[3]}" | sed 's/\//\\\//g')
+	  sed -i "/${var}/Id" "${list}"
+	else
+		echo "Not permitted"
+		return 1
+  fi
+}
+
+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]}"
+
+	if [[ "${typ}" == "forward" ]]; then
+		change_setting "API_GET_UPSTREAM_DNS_HOSTNAME" "${state}"
+	elif [[ "${typ}" == "clients" ]]; then
+		change_setting "API_GET_CLIENT_HOSTNAME" "${state}"
+	fi
+}
+
+AddDHCPStaticAddress() {
+	mac="${args[2]}"
+	ip="${args[3]}"
+	host="${args[4]}"
+
+	if [[ "${ip}" == "noip" ]]; then
+		# Static host name
+		echo "dhcp-host=${mac},${host}" >> "${dhcpstaticconfig}"
+	elif [[ "${host}" == "nohost" ]]; then
+		# Static IP
+		echo "dhcp-host=${mac},${ip}" >> "${dhcpstaticconfig}"
+	else
+		# Full info given
+		echo "dhcp-host=${mac},${ip},${host}" >> "${dhcpstaticconfig}"
+	fi
+}
+
+RemoveDHCPStaticAddress() {
+	mac="${args[2]}"
+	sed -i "/dhcp-host=${mac}.*/d" "${dhcpstaticconfig}"
+}
+
+SetHostRecord() {
+	if [ -n "${args[3]}" ]; then
+		change_setting "HOSTRECORD" "${args[2]},${args[3]}"
+		echo "Setting host record for ${args[2]} -> ${args[3]}"
+	else
+		change_setting "HOSTRECORD" ""
+		echo "Removing host record"
+	fi
+
+	ProcessDNSSettings
+
+	# Restart dnsmasq to load new configuration
+	RestartDNS
+}
+
+SetListeningMode() {
+	source "${setupVars}"
+  
+  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 "Listening on all interfaces, permiting all origins, hope you have 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)"
+		change_setting "DNSMASQ_LISTENING" "local"
+	else
+		echo "Listening only on interface ${PIHOLE_INTERFACE}"
+		change_setting "DNSMASQ_LISTENING" "single"
+	fi
+
+	# Don't restart DNS server yet because other settings
+	# will be applied afterwards if "-web" is set
+	if [[ "${args[3]}" != "-web" ]]; then
+		ProcessDNSSettings
+		# Restart dnsmasq to load new configuration
+		RestartDNS
+	fi
+}
+
+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() {
+	args=("$@")
+
+	case "${args[1]}" in
+		"-p" | "password"   ) SetWebPassword;;
+		"-c" | "celsius"    ) unit="C"; SetTemperatureUnit;;
+		"-f" | "fahrenheit" ) unit="F"; SetTemperatureUnit;;
+		"-k" | "kelvin"     ) unit="K"; SetTemperatureUnit;;
+		"setdns"            ) SetDNSServers;;
+		"setexcludedomains" ) SetExcludeDomains;;
+		"setexcludeclients" ) SetExcludeClients;;
+		"reboot"            ) Reboot;;
+		"restartdns"        ) RestartDNS;;
+		"setquerylog"       ) SetQueryLogOptions;;
+		"enabledhcp"        ) EnableDHCP;;
+		"disabledhcp"       ) DisableDHCP;;
+		"layout"            ) SetWebUILayout;;
+		"-h" | "--help"     ) helpFunc;;
+		"privacymode"       ) SetPrivacyMode;;
+		"resolve"           ) ResolutionSettings;;
+		"addstaticdhcp"     ) AddDHCPStaticAddress;;
+		"removestaticdhcp"  ) RemoveDHCPStaticAddress;;
+		"hostrecord"        ) SetHostRecord;;
+		"-i" | "interface"  ) SetListeningMode "$@";;
+		"-t" | "teleporter" ) Teleporter;;
+		"adlist"            ) CustomizeAdLists;;
+		*                   ) helpFunc;;
+	esac
+
+	shift
+
+	if [[ $# = 0 ]]; then
+		helpFunc
+	fi
+}

advanced/Scripts/whitelist.sh

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

advanced/bash-completion/pihole

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

advanced/blockingpage.css

@@ -0,0 +1,136 @@
+/* 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; }
+
+/* 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; }
+
+footer, pre, td { font-family: monospace; padding-left: 15px; }
+/*body, header { background: #E1E1E1; }*/
+
+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;
+}
+
+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);
+}
+
+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 {
+	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;
+}
+
+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; }
+
+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;
+}
+
+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;
+}
+
+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);
+}
+
+.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); }
+
+.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); }
+
+/* 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; }
+
+footer { font-size: 0.8em; text-align: center; width: 87%; margin: 4px auto; }

advanced/dphys-swapfile

@@ -1,12 +0,0 @@
-# Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
-# Swap file config
-#
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
-
-CONF_SWAPSIZE=500

advanced/index.html

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

advanced/index.php

@@ -0,0 +1,224 @@
+<?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 */
+
+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;
+}
+
+$uri = escapeshellcmd($_SERVER['REQUEST_URI']);
+$serverName = escapeshellcmd($_SERVER['SERVER_NAME']);
+
+// 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)
+$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'];
+
+$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);
+
+// 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();
+}
+
+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;
+}
+
+// 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();
+}
+
+// Get Pi-hole version
+$piHoleVersion = exec('cd /etc/.pihole/ && git describe --tags --abbrev=0');
+
+// Don't show the URI if it is the root directory
+if($uri == "/")
+{
+	$uri = "";
+}
+
+?>
+<!DOCTYPE html>
+<html>
+<head>
+	<meta charset='UTF-8'/>
+	<title>Website Blocked</title>
+	<link rel='stylesheet' href='http://pi.hole/pihole/blockingpage.css'/>
+	<link rel='shortcut icon' href='http://pi.hole/admin/img/favicon.png' type='image/png'/>
+	<meta name='viewport' content='width=device-width,initial-scale=1.0,maximum-scale=1.0, user-scalable=no'/>
+	<meta name='robots' content='noindex,nofollow'/>
+</head>
+<body id="body">
+<header>
+	<h1><a href='/'>Website Blocked</a></h1>
+</header>
+<main>
+	<div>Access to the following site has been blocked:<br/>
+	<span class='pre msg'><?php echo $serverName.$uri; ?></span></div>
+	<div>If you have an ongoing use for this website, please ask the owner of the Pi-hole in your network to have it whitelisted.</div>
+	<input id="domain" type="hidden" value="<?php echo $serverName; ?>">
+	<input id="quiet" type="hidden" value="yes">
+	<button id="btnSearch" class="buttons blocked" type="button" style="visibility: hidden;"></button>
+	This page is blocked because it is explicitly contained within the following block list(s):
+	<pre id="output" style="width: 100%; height: 100%;" hidden="true"></pre><br/>
+	<div class='buttons blocked'>
+		<a class='safe33' href='javascript:history.back()'>Go back</a>
+		<a class='safe33' id="whitelisting">Whitelist this page</a>
+		<a class='safe33' href='javascript:window.close()'>Close window</a>
+	</div>
+		<div style="width: 98%; text-align: center; padding: 10px;" hidden="true" id="whitelistingform">
+			<p>Note that whitelisting domains which are blocked using the wildcard method won't work.</p>
+			<p>Password required!</p><br/>
+		<form>
+			<input name="list" type="hidden" value="white"><br/>
+			Domain:<br/>
+			<input name="domain" value="<?php echo $serverName ?>" disabled><br/><br/>
+			Password:<br/>
+			<input type="password" id="pw" name="pw"><br/><br/>
+			<button class="buttons33 safe" id="btnAdd" type="button">Whitelist</button>
+		</form><br/>
+		<pre id="whitelistingoutput" style="width: 100%; height: 100%; padding: 5px;" hidden="true"></pre><br/>
+		</div>
+</main>
+<footer>Generated <?php echo date('D g:i A, M d'); ?> by Pi-hole <?php echo $piHoleVersion; ?></footer>
+<script src="http://pi.hole/admin/scripts/vendor/jquery.min.js"></script>
+<script>
+// Create event for when the output is appended to
+(function($) {
+    var origAppend = $.fn.append;
+
+    $.fn.append = function () {
+        return origAppend.apply(this, arguments).trigger("append");
+    };
+})(jQuery);
+</script>
+<script src="http://pi.hole/admin/scripts/pi-hole/js/queryads.js"></script>
+<script>
+function inIframe () {
+    try {
+        return window.self !== window.top;
+    } catch (e) {
+        return true;
+    }
+}
+
+// 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")) {
+        add();
+    }
+});
+
+// Handle buttons
+$("#btnAdd").on("click", function() {
+    add();
+});
+</script>
+</body>
+</html>

advanced/lighttpd.conf.debian

@@ -1,17 +1,26 @@
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
 # lighttpd config for Pi-hole
 #
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
+# 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:              #
+#                         /etc/lighttpd/external.conf                         #
+###############################################################################
 
 server.modules = (
 	"mod_access",
 	"mod_accesslog",
+	"mod_auth",
 	"mod_expire",
 	"mod_compress",
 	"mod_redirect",
@@ -20,15 +29,15 @@ server.modules = (
 )
 
 server.document-root        = "/var/www/html"
-server.error-handler-404	= "pihole/index.html"
+server.error-handler-404    = "pihole/index.php"
 server.upload-dirs          = ( "/var/cache/lighttpd/uploads" )
 server.errorlog             = "/var/log/lighttpd/error.log"
 server.pid-file             = "/var/run/lighttpd.pid"
 server.username             = "www-data"
 server.groupname            = "www-data"
 server.port                 = 80
-accesslog.filename			= "/var/log/lighttpd/access.log"
-accesslog.format			= "%{%s}t|%V|%r|%s|%b"
+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" )
@@ -52,10 +61,21 @@ $HTTP["url"] =~ "^/admin/" {
     )
 }
 
+# Rewite js requests, must be out of $HTTP block due to bug #2526
+url.rewrite = ( "^(?!/admin/).*\.js$"  => "pihole/index.js"   )
+
 # If the URL does not start with /admin, then it is a query for an ad domain
 $HTTP["url"] =~ "^(?!/admin)/.*" {
     # Create a response header for debugging using curl -I
     setenv.add-response-header = ( "X-Pi-hole" => "A black hole for Internet advertisements." )
-    # rewrite only js requests
-    url.rewrite = ("(.*).js" => "pihole/index.js")
 }
+
+# Entering just "pi.hole" into a browser redirects to "pi.hole/admin/"
+$HTTP["host"] == "pi.hole" {
+    $HTTP["url"] == "/" {
+        url.redirect = ( "" => "/admin/" )
+    }
+}
+
+# Add user chosen options held in external file
+include_shell "cat external.conf 2>/dev/null"

advanced/lighttpd.conf.fedora

@@ -1,16 +1,25 @@
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
 # lighttpd config for Pi-hole
 #
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
+# 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:              #
+#                         /etc/lighttpd/external.conf                         #
+###############################################################################
 
 server.modules = (
 	"mod_access",
+	"mod_auth",
 	"mod_fastcgi",
 	"mod_accesslog",
 	"mod_expire",
@@ -21,15 +30,15 @@ server.modules = (
 )
 
 server.document-root        = "/var/www/html"
-server.error-handler-404	= "pihole/index.html"
+server.error-handler-404    = "pihole/index.php"
 server.upload-dirs          = ( "/var/cache/lighttpd/uploads" )
 server.errorlog             = "/var/log/lighttpd/error.log"
 server.pid-file             = "/var/run/lighttpd.pid"
 server.username             = "lighttpd"
 server.groupname            = "lighttpd"
 server.port                 = 80
-accesslog.filename			= "/var/log/lighttpd/access.log"
-accesslog.format			= "%{%s}t|%V|%r|%s|%b"
+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" )
@@ -46,7 +55,8 @@ mimetype.assign   = ( ".png"  => "image/png",
                       ".css" => "text/css; charset=utf-8",
                       ".js" => "application/javascript",
                       ".json" => "application/json",
-                      ".txt"  => "text/plain" )
+                      ".txt"  => "text/plain",
+                      ".svg"  => "image/svg+xml" )
 
 # default listening port for IPv6 falls back to the IPv4 port
 #include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
@@ -68,10 +78,21 @@ $HTTP["url"] =~ "^/admin/" {
 	setenv.add-response-header = ( "X-Pi-hole" => "The Pi-hole Web interface is working!" )
 }
 
+# Rewite js requests, must be out of $HTTP block due to bug #2526
+url.rewrite = ( "^(?!/admin/).*\.js$"  => "pihole/index.js"   )
+
 # If the URL does not start with /admin, then it is a query for an ad domain
 $HTTP["url"] =~ "^(?!/admin)/.*" {
 	# Create a response header for debugging using curl -I
 	setenv.add-response-header = ( "X-Pi-hole" => "A black hole for Internet advertisements." )
-        # rewrite only js requests
-        url.rewrite = ("(.*).js" => "pihole/index.js")
 }
+
+# Entering just "pi.hole" into a browser redirects to "pi.hole/admin/"
+$HTTP["host"] == "pi.hole" {
+    $HTTP["url"] == "/" {
+        url.redirect = ( "" => "/admin/" )
+    }
+}
+
+# Add user chosen options held in external file
+include_shell "cat external.conf 2>/dev/null"

advanced/logrotate

@@ -0,0 +1,21 @@
+/var/log/pihole.log {
+	# su #
+	daily
+	copytruncate
+	rotate 5
+	compress
+	delaycompress
+	notifempty
+	nomail
+}
+
+/var/log/pihole-FTL.log {
+	# su #
+	weekly
+	copytruncate
+	rotate 3
+	compress
+	delaycompress
+	notifempty
+	nomail
+}

advanced/pihole-FTL.service

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

advanced/pihole.cron

@@ -1,25 +1,30 @@
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
 # Updates ad sources every week
 #
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+#
+#
+#
+# This file is under source-control of the Pi-hole installation and update
+# scripts, any changes made to this file will be overwritten when the softare
+# is updated or re-installed. Please make any changes to the appropriate crontab
+# or other cron file snippets.
 
 # Pi-hole: Update the ad sources once a week on Sunday at 01:59
 #          Download any updates from the adlists
-59 1    * * 7   root    /usr/local/bin/pihole updateGravity
+59 1    * * 7   root    PATH="$PATH:/usr/local/bin/" pihole updateGravity
 
 # Pi-hole: Update Pi-hole! Uncomment to enable auto update
-#30 2    * * 7   root    /usr/local/bin/pihole updatePihole
+#30 2    * * 7   root    PATH="$PATH:/usr/local/bin/" pihole updatePihole
 
-# Pi-hole: Parse the log file before it is flushed and save the stats to a database
-#          This will be used for a historical view of your Pi-hole's performance
-#50 23  * * *   root    /usr/local/bin/dailyLog.sh # note: this is outdated
+# Pi-hole: Flush the log daily at 00:00
+#          The flush script will use logrotate if available
+#          parameter "once": logrotate only once (default is twice)
+#          parameter "quiet": don't print messages
+00 00   * * *   root    PATH="$PATH:/usr/local/bin/" pihole flush once quiet
 
-# Pi-hole: Flush the log daily at 00:00 so it doesn't get out of control
-#          Stats will be viewable in the Web interface thanks to the cron job above
-00 00   * * *   root    /usr/local/bin/pihole flush
+@reboot root /usr/sbin/logrotate /etc/pihole/logrotate

advanced/pihole.sudo

@@ -1,12 +1,9 @@
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
 # Allows the WebUI to use Pi-hole commands
 #
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
-
-www-data ALL=NOPASSWD: /usr/local/bin/pihole
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+#

advanced/selinux/pihole.te

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

automated install/uninstall.sh

@@ -1,39 +1,39 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
 # Completely uninstalls Pi-hole
 #
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+
 
 # Must be root to uninstall
-if [[ $EUID -eq 0 ]];then
+if [[ ${EUID} -eq 0 ]]; then
 	echo "::: You are root."
 else
 	echo "::: Sudo will be used for the uninstall."
-  # Check if it is actually installed
-  # If it isn't, exit because the unnstall cannot complete
-  if [ -x "$(command -v sudo)" ];then
+	# Check if it is actually installed
+	# If it isn't, exit because the unnstall cannot complete
+	if [ -x "$(command -v sudo)" ]; then
 		export SUDO="sudo"
-  else
-    echo "::: Please install sudo or run this as root."
-    exit 1
-  fi
+	else
+		echo "::: Please install sudo or run this as root."
+		exit 1
+	fi
 fi
 
 # Compatability
-if [ -x "$(command -v rpm)" ];then
+if [ -x "$(command -v rpm)" ]; then
 	# Fedora Family
-	if [ -x "$(command -v dnf)" ];then
+	if [ -x "$(command -v dnf)" ]; then
 		PKG_MANAGER="dnf"
 	else
 		PKG_MANAGER="yum"
 	fi
-	PKG_REMOVE="$PKG_MANAGER remove -y"
+	PKG_REMOVE="${PKG_MANAGER} remove -y"
 	PIHOLE_DEPS=( bind-utils bc dnsmasq lighttpd lighttpd-fastcgi php-common git curl unzip wget findutils )
 	package_check() {
 		rpm -qa | grep ^$1- > /dev/null
@@ -41,10 +41,10 @@ if [ -x "$(command -v rpm)" ];then
 	package_cleanup() {
 		${SUDO} ${PKG_MANAGER} -y autoremove
 	}
-elif [ -x "$(command -v apt-get)" ];then
+elif [ -x "$(command -v apt-get)" ]; then
 	# Debian Family
 	PKG_MANAGER="apt-get"
-	PKG_REMOVE="$PKG_MANAGER -y remove --purge"
+	PKG_REMOVE="${PKG_MANAGER} -y remove --purge"
 	PIHOLE_DEPS=( dnsutils bc dnsmasq lighttpd php5-common git curl unzip wget )
 	package_check() {
 		dpkg-query -W -f='${Status}' "$1" 2>/dev/null | grep -c "ok installed"
@@ -58,37 +58,36 @@ else
 	exit
 fi
 
-spinner()
-{
-    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"
+spinner() {
+	local pid=$1
+	local delay=0.50
+	local spinstr='/-\|'
+	while [ "$(ps a | awk '{print $1}' | grep "${pid}")" ]; do
+		local temp=${spinstr#?}
+		printf " [%c]  " "${spinstr}"
+		local spinstr=${temp}${spinstr%"$temp}"}
+		sleep ${delay}
+		printf "\b\b\b\b\b\b"
+	done
+	printf "    \b\b\b\b"
 }
 
-function removeAndPurge {
+removeAndPurge() {
 	# Purge dependencies
-echo ":::"
+	echo ":::"
 	for i in "${PIHOLE_DEPS[@]}"; do
 		package_check ${i} > /dev/null
 		if [ $? -eq 0 ]; then
 			while true; do
-				read -rp "::: Do you wish to remove $i from your system? [y/n]: " yn
+				read -rp "::: Do you wish to remove ${i} from your system? [y/n]: " yn
 				case ${yn} in
-					[Yy]* ) printf ":::\tRemoving %s..." "$i"; ${SUDO} ${PKG_REMOVE} "$i" &> /dev/null & spinner $!; printf "done!\n"; break;;
-					[Nn]* ) printf ":::\tSkipping %s" "$i\n"; break;;
+					[Yy]* ) printf ":::\tRemoving %s..." "${i}"; ${SUDO} ${PKG_REMOVE} "${i}" &> /dev/null & spinner $!; printf "done!\n"; break;;
+					[Nn]* ) printf ":::\tSkipping %s\n" "${i}"; break;;
 					* ) printf "::: You must answer yes or no!\n";;
 				esac
 			done
 		else
-			printf ":::\tPackage %s not installed... Not removing.\n" "$i"
+			printf ":::\tPackage %s not installed... Not removing.\n" "${i}"
 		fi
 	done
 
@@ -104,7 +103,7 @@ echo ":::"
 	removeNoPurge
 }
 
-function removeNoPurge {
+removeNoPurge() {
 	echo ":::"
 	# Only web directories/files that are created by pihole should be removed.
 	echo "::: Removing the Pi-hole Web server files..."
@@ -137,7 +136,7 @@ function removeNoPurge {
 	fi
 
 	echo "::: Removing config files and scripts..."
-	package_check ${i} > /dev/null
+	package_check lighttpd > /dev/null
 	if [ $? -eq 1 ]; then
 		${SUDO} rm -rf /etc/lighttpd/ &> /dev/null
 	else
@@ -156,10 +155,16 @@ function removeNoPurge {
 	${SUDO} rm /etc/bash_completion.d/pihole &> /dev/null
 	${SUDO} rm /etc/sudoers.d/pihole &> /dev/null
 
+	# If the pihole user exists, then remove
+	if id "pihole" >/dev/null 2>&1; then
+        	echo "::: Removing pihole user..."
+		${SUDO} userdel -r pihole
+	fi
+
 	echo ":::"
 	printf "::: Finished removing PiHole from your system. Sorry to see you go!\n"
 	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 -L https://install.pi-hole.net | bash\n:::\n::: at any time!\n:::\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"
 }
 
@@ -170,7 +175,7 @@ while true; do
 	read -rp "::: Do you wish to purge PiHole's dependencies from your OS? (You will be prompted for each package) [y/n]: " yn
 	case ${yn} in
 		[Yy]* ) removeAndPurge; break;;
-	
+
 		[Nn]* ) removeNoPurge; break;;
 	esac
 done

autotest

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

gravity.sh

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

pihole

@@ -1,201 +1,429 @@
 #!/bin/bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
-# Network-wide ad blocking via your Raspberry Pi
-# http://pi-hole.net
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
+# Network-wide ad blocking via your own hardware.
+#
 # Controller for all pihole scripts and functions.
 #
-# Pi-hole is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
+# This file is copyright under the latest version of the EUPL.
+# Please see LICENSE file for your rights under this license.
+
+readonly PI_HOLE_SCRIPT_DIR="/opt/pihole"
+readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
 
 # Must be root to use this tool
 if [[ ! $EUID -eq 0 ]];then
-    #echo "::: You are root."
-#else
-    #echo "::: Sudo will be used for this tool."
-  # Check if it is actually installed
-  # If it isn't, exit because the pihole cannot be invoked without privileges.
-  if [ -x "$(command -v sudo)" ];then
-        export SUDO="sudo"
+  if [[ -x "$(command -v sudo)" ]]; then
+    exec sudo bash "$0" "$@"
+    exit $?
   else
-    echo "::: Please install sudo or run this as root."
+    echo "::: sudo is needed to run pihole commands.  Please run this script as root or install sudo."
     exit 1
   fi
 fi
 
-function whitelistFunc {
-    shift
-    ${SUDO} /opt/pihole/whitelist.sh "$@"
-    exit 1
+webpageFunc() {
+  source /opt/pihole/webpage.sh
+  main "$@"
+  exit 0
 }
 
-function blacklistFunc {
-    shift
-    ${SUDO} /opt/pihole/blacklist.sh "$@"
-    exit 1
+whitelistFunc() {
+ "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
+  exit 0
 }
 
-function debugFunc {
-    ${SUDO} /opt/pihole/piholeDebug.sh
-    exit 1
+blacklistFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
+  exit 0
 }
 
-function flushFunc {
-    ${SUDO} /opt/pihole/piholeLogFlush.sh
-    exit 1
+wildcardFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
+  exit 0
 }
 
+debugFunc() {
+  local automated
+  local web
 
-function updatePiholeFunc {
+  # Pull off the `debug` leaving passed call augmentation flags in $1
+  shift
+  if [[ "$@" == *"-a"* ]]; then
+    automated="true"
+  fi
+  if [[ "$@" == *"-w"* ]]; then
+    web="true"
+  fi
 
-    if [ ! -d "/etc/.pihole" ]; then #This is unlikely
-        echo "::: Critical Error: Pi-Hole repo missing from system!"
-        echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
-        exit 1;
-    fi
-    if [ ! -d "/var/www/html/admin" ]; then #This is unlikely
-        echo "::: Critical Error: Pi-Hole repo missing from system!"
-        echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
-        exit 1;
-    fi
-
-    echo "::: Checking for updates..."
-    piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
-    piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
-
-    webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
-    webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
-
-    echo "::: Pi-hole version is $piholeVersion (Latest version is $piholeVersionLatest)"
-    echo "::: Web Admin version is $webVersion (Latest version is $webVersionLatest)"
-    echo ":::"
-
-    if [[ ${piholeVersion} == ${piholeVersionLatest} ]] ; then
-        echo "::: Pi-hole Base files are already up to date! Version: ${piholeVersionLatest}"
-        echo "::: No need to update!"
-        echo ":::"
-
-        if [[ ${webVersion} == ${webVersionLatest} ]] ; then
-            echo "::: Web Admin files are already up to date!"
-            echo "::: No need to update!"
-            echo ":::"
-        else
-            echo "::: An Update is available for the Web Admin!"
-            echo ":::"
-            echo "::: Fetching latest changes from GitHub..."
-            cd /var/www/html/admin
-            ${SUDO} git pull origin master
-            echo ":::"
-            echo "::: Pi-hole Web Admin has been updated to ${webVersion}"
-            echo "::: See https://changes.pi-hole.net for details"
-        fi
-    else
-        echo -n "::: An update is available for "
-        if [[ ${webVersion} == ${webVersionLatest} ]] ; then
-            echo " Pi-Hole!"
-        else
-            echo " Pi-Hole base files and the Web Admin. Both will be updated!"
-        fi
-
-        echo "::: Fetching latest changes from GitHub..."
-        cd /etc/.pihole
-        ${SUDO} git pull origin master
-        ${SUDO} /etc/.pihole/automated\ install/basic-install.sh pihole
-
-        echo ":::"
-        echo "::: Pi-hole has been updated to version ${piholeVersionLatest}"
-        if [[ ${webVersion} != ${webVersionLatest} ]] ; then
-            echo "::: Web Admin has been updated to version ${webVersionLatest}"
-        fi
-        echo ":::"
-        echo "::: See https://changes.pi-hole.net for details"
-    fi
-
-    exit 1
+  AUTOMATED=${automated:-} WEBCALL=${web:-} "${PI_HOLE_SCRIPT_DIR}"/piholeDebug.sh
+  exit 0
 }
 
-function updateGravityFunc {
-    ${SUDO} /opt/pihole/gravity.sh "$@"
-    exit 1
+flushFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/piholeLogFlush.sh "$@"
+  exit 0
 }
 
-function setupLCDFunction {
-    ${SUDO} /opt/pihole/setupLCD.sh
-    exit 1
+updatePiholeFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/update.sh
+  exit 0
 }
 
-function queryFunc {
-    domain=$2
-    for list in /etc/pihole/list.*
-    do
-        count=$(grep ${domain} $list | wc -l)
-        echo "::: ${list} (${count} results)"
-        if [[ ${count} > 0 ]]; then
-            grep ${domain} ${list}
-        fi
-        echo ""
+reconfigurePiholeFunc() {
+  /etc/.pihole/automated\ install/basic-install.sh --reconfigure
+  exit 0;
+}
+
+updateGravityFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/gravity.sh "$@"
+  exit 0
+}
+
+scanList(){
+  domain="${1}"
+  list="${2}"
+  method="${3}"
+  if [[ ${method} == "-exact" ]] ; then
+    grep -i -E "(^|\s)${domain}($|\s)" "${list}"
+  else
+    grep -i "${domain}" "${list}"
+  fi
+}
+
+processWildcards() {
+  IFS="." read -r -a array <<< "${1}"
+  for (( i=${#array[@]}-1; i>=0; i-- )); do
+    ar=""
+    for (( j=${#array[@]}-1; j>${#array[@]}-i-2; j-- )); do
+      if [[ $j == $((${#array[@]}-1)) ]]; then
+        ar="${array[$j]}"
+      else
+        ar="${array[$j]}.${ar}"
+      fi
     done
-    exit 1
+    echo "${ar}"
+  done
 }
 
-function chronometerFunc {
-    shift
-    ${SUDO} /opt/pihole/chronometer.sh "$@"
-    exit 1
+queryFunc() {
+  domain="${2}"
+  method="${3}"
+  lists=( /etc/pihole/list.* /etc/pihole/blacklist.txt)
+  for list in ${lists[@]}; do
+    if [ -e "${list}" ]; then
+      result=$(scanList ${domain} ${list} ${method})
+      # Remove empty lines before couting number of results
+      count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
+      echo "::: ${list} (${count} results)"
+      if [[ ${count} > 0 ]]; then
+        echo "${result}"
+      fi
+      echo ""
+    else
+      echo "::: ${list} does not exist"
+      echo ""
+    fi
+  done
+
+  # Scan for possible wildcard matches
+  if [ -e "${wildcardlist}" ]; then
+    local wildcards=($(processWildcards "${domain}"))
+    for domain in ${wildcards[@]}; do
+      result=$(scanList "\/${domain}\/" ${wildcardlist})
+      # Remove empty lines before couting number of results
+      count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
+      if [[ ${count} > 0 ]]; then
+        echo "::: Wildcard blocking ${domain} (${count} results)"
+        echo "${result}"
+        echo ""
+      fi
+    done
+  fi
+  exit 0
+}
+
+chronometerFunc() {
+  shift
+  "${PI_HOLE_SCRIPT_DIR}"/chronometer.sh "$@"
+  exit 0
 }
 
 
-function uninstallFunc {
-    ${SUDO} /opt/pihole/uninstall.sh
-    exit 1
+uninstallFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/uninstall.sh
+  exit 0
 }
 
-function versionFunc {
-    ${SUDO} /opt/pihole/version.sh
-    exit 1
+versionFunc() {
+  shift
+  "${PI_HOLE_SCRIPT_DIR}"/version.sh "$@"
+  exit 0
 }
 
-function helpFunc {
-    echo "::: Control all PiHole specific functions!"
-    echo ":::"
-    echo "::: Usage: pihole [options]"
-    echo ":::		Add -h after -w (whitelist), -b (blacklist), or -c (chronometer)  for more information on usage"
-    echo ":::"
-    echo "::: Options:"
-    echo ":::  -w, whitelist            Whitelist domains"
-    echo ":::  -b, blacklist            Blacklist domains"
-    echo ":::  -d, debug                Start a debugging session if having trouble"
-    echo ":::  -f, flush                Flush the pihole.log file"
-    echo ":::  -up, updatePihole        Update Pi-hole"
-    echo ":::  -g, updateGravity        Update the list of ad-serving domains"
-    echo ":::  -s, setupLCD             Automatically configures the Pi to use the 2.8 LCD screen to display stats on it"
-    echo ":::  -c, chronometer          Calculates stats and displays to an LCD"
-    echo ":::  -h, help                 Show this help dialog"
-    echo ":::  -v, version              Show current versions"
-    echo ":::  -q, query                Query the adlists for a specific domain"
-    echo ":::  uninstall                Uninstall Pi-Hole from your system :(!"
+restartDNS() {
+  dnsmasqPid=$(pidof dnsmasq)
+  if [[ "${dnsmasqPid}" ]]; then
+    # Service already running - reload config
+    if [[ -x "$(command -v systemctl)" ]]; then
+      systemctl restart dnsmasq
+    else
+      service dnsmasq restart
+    fi
+  else
+    # Service not running, start it up
+    if [[ -x "$(command -v systemctl)" ]]; then
+      systemctl start dnsmasq
+    else
+      service dnsmasq start
+    fi
+  fi
+}
+
+piholeEnable() {
+  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
+    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
+    echo "::: Blocking has been disabled!"
+    if [[ $# > 1 ]]; then
+      if [[ "${2}" == *"s"* ]]; then
+        tt=${2%"s"}
+        echo "::: Blocking will be re-enabled in ${tt} seconds"
+        nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
+      elif [[ "${2}" == *"m"* ]]; then
+        tt=${2%"m"}
+        echo "::: Blocking will be re-enabled in ${tt} minutes"
+        tt=$((${tt}*60))
+        nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
+      else
+        echo "::: Unknown format for delayed reactivation of the blocking!"
+        echo "::: Example:"
+        echo ":::    pihole disable 5s    -    will disable blocking for 5 seconds"
+        echo ":::    pihole disable 7m    -    will disable blocking for 7 minutes"
+        echo "::: Blocking will not automatically be re-enabled!"
+      fi
+    fi
+  else
+    # Enable Pi-hole
+    echo "::: Blocking has been enabled!"
+    sed -i 's/^#addn-hosts/addn-hosts/' /etc/dnsmasq.d/01-pihole.conf
+    if [[ -e "/etc/pihole/wildcard.list" ]]; then
+      mv "/etc/pihole/wildcard.list" "$wildcardlist"
+    fi
+  fi
+  restartDNS
+}
+
+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
+
+Options:
+  on                  Enable the Pi-hole log at /var/log/pihole.log
+  off                 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
+    sed -i 's/^#log-queries/log-queries/' /etc/dnsmasq.d/01-pihole.conf
+    sed -i 's/^QUERY_LOGGING=false/QUERY_LOGGING=true/' /etc/pihole/setupVars.conf
+    echo "::: Logging has been enabled!"
+  else
+    echo "::: Invalid option passed, please pass 'on' or 'off'"
     exit 1
+  fi
+  restartDNS
+}
+
+piholeStatus() {
+  if [[ "$(netstat -plnt | grep -c ':53 ')" -gt "0" ]]; then
+    if [[ "${1}" != "web" ]]; then
+      echo "::: DNS service is running"
+    fi
+  else
+    if [[ "${1}" == "web" ]]; then
+      echo "-1";
+    else
+      echo "::: DNS service is NOT running"
+    fi
+    return
+  fi
+
+  if [[ "$(grep -i "^#addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf)" ]]; then
+    # List is commented out
+    if [[ "${1}" == "web" ]]; then
+      echo 0;
+    else
+      echo "::: Pi-hole blocking is Disabled";
+    fi
+  elif [[ "$(grep -i "^addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf)" ]]; then
+    # List set
+    if [[ "${1}" == "web" ]]; then
+      echo 1;
+    else
+      echo "::: Pi-hole blocking is Enabled";
+    fi
+  else
+    # Addn-host not found
+    if [[ "${1}" == "web" ]]; then
+      echo 99
+    else
+      echo ":::  No hosts file linked to dnsmasq, adding it in enabled state"
+    fi
+    # Add addn-host= to dnsmasq
+    echo "addn-hosts=/etc/pihole/gravity.list" >> /etc/dnsmasq.d/01-pihole.conf
+    restartDNS
+  fi
+}
+
+tailFunc() {
+  echo "Press Ctrl-C to exit"
+  tail -F /var/log/pihole.log
+  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
+
+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 "Please do not call Tricorder directly."
+    exit 1
+  fi
+
+  if ! timeout 2 nc -z tricorder.pi-hole.net 9998 &> /dev/null; then
+    echo "Unable to connect to Pi-hole's Tricorder server."
+    exit 1
+  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 "Your debug log will be transmitted unencrypted via plain-text"
+    echo "There is a possibility that this could be intercepted by a third party"
+    echo "If you wish to cancel, press Ctrl-C to exit within 10 seconds"
+    secs="10"
+    while [[ "$secs" -gt "0" ]]; do
+       echo -ne "."
+       sleep 1
+       : $((secs--))
+    done
+    echo " "
+    nc tricorder.pi-hole.net 9999 < /dev/stdin
+    exit "$?"
+  fi
+}
+
+helpFunc() {
+  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 '-exact' AFTER a specified domain for exact match
+  -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
 }
 
 if [[ $# = 0 ]]; then
-    helpFunc
+  helpFunc
 fi
 
 # Handle redirecting to specific functions based on arguments
-case "$1" in
-"-w" | "whitelist"			) whitelistFunc "$@";;
-"-b" | "blacklist"			) blacklistFunc "$@";;
-"-d" | "debug"				) debugFunc;;
-"-f" | "flush"				) flushFunc;;
-"-up" | "updatePihole"      ) updatePiholeFunc;;
-"-g" | "updateGravity"		) updateGravityFunc "$@";;
-"-s" | "setupLCD"			) setupLCDFunction;;
-"-c" | "chronometer"		) chronometerFunc "$@";;
-"-h" | "help"				) helpFunc;;
-"-v" | "version"            ) versionFunc;;
-"-q" | "query"              ) queryFunc "$@";;
-"uninstall"					) uninstallFunc;;
-*                    		) helpFunc;;
+case "${1}" in
+  "-w" | "whitelist"            ) whitelistFunc "$@";;
+  "-b" | "blacklist"            ) blacklistFunc "$@";;
+  "-wild" | "wildcard"          ) wildcardFunc "$@";;
+  "-d" | "debug"                ) debugFunc "$@";;
+  "-f" | "flush"                ) flushFunc "$@";;
+  "-up" | "updatePihole"        ) updatePiholeFunc;;
+  "-r"  | "reconfigure"         ) reconfigurePiholeFunc;;
+  "-g" | "updateGravity"        ) updateGravityFunc "$@";;
+  "-c" | "chronometer"          ) chronometerFunc "$@";;
+  "-h" | "help"                 ) helpFunc;;
+  "-v" | "version"              ) versionFunc "$@";;
+  "-q" | "query"                ) queryFunc "$@";;
+  "-l" | "logging"              ) piholeLogging "$@";;
+  "uninstall"                   ) uninstallFunc;;
+  "enable"                      ) piholeEnable 1;;
+  "disable"                     ) piholeEnable 0 "$2";;
+  "status"                      ) piholeStatus "$2";;
+  "restartdns"                  ) restartDNS;;
+  "-a" | "admin"                ) webpageFunc "$@";;
+  "-t" | "tail"                 ) tailFunc;;
+  "checkout"                    ) piholeCheckoutFunc "$@";;
+  "tricorder"                   ) tricorderFunc;;
+  *                             ) helpFunc;;
 esac

requirements.txt

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

test/centos.Dockerfile

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

test/conftest.py

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

test/debian.Dockerfile

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

test/test_000_build_containers.py

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

test/test_automated_install.py

@@ -0,0 +1,506 @@
+import pytest
+from textwrap import dedent
+
+SETUPVARS = {
+    'PIHOLE_INTERFACE' : 'eth99',
+    'IPV4_ADDRESS' : '1.1.1.1',
+    'IPV6_ADDRESS' : 'FE80::240:D0FF:FE48:4672',
+    'PIHOLE_DNS_1' : '4.2.2.1',
+    'PIHOLE_DNS_2' : '4.2.2.2'
+}
+
+def test_setupVars_are_sourced_to_global_scope(Pihole):
+    ''' currently update_dialogs sources setupVars with a dot,
+    then various other functions use the variables.
+    This confirms the sourced variables are in scope between functions '''
+    setup_var_file = 'cat <<EOF> /etc/pihole/setupVars.conf\n'
+    for k,v in SETUPVARS.iteritems():
+        setup_var_file += "{}={}\n".format(k, v)
+    setup_var_file += "EOF\n"
+    Pihole.run(setup_var_file)
+
+    script = dedent('''\
+    set -e
+    printSetupVars() {
+        # Currently debug test function only
+        echo "Outputting sourced variables"
+        echo "PIHOLE_INTERFACE=${PIHOLE_INTERFACE}"
+        echo "IPV4_ADDRESS=${IPV4_ADDRESS}"
+        echo "IPV6_ADDRESS=${IPV6_ADDRESS}"
+        echo "PIHOLE_DNS_1=${PIHOLE_DNS_1}"
+        echo "PIHOLE_DNS_2=${PIHOLE_DNS_2}"
+    }
+    update_dialogs() {
+        . /etc/pihole/setupVars.conf
+    }
+    update_dialogs
+    printSetupVars
+    ''')
+
+    output = run_script(Pihole, script).stdout
+
+    for k,v in SETUPVARS.iteritems():
+        assert "{}={}".format(k, v) in output
+
+def test_setupVars_saved_to_file(Pihole):
+    ''' confirm saved settings are written to a file for future updates to re-use '''
+    set_setup_vars = '\n'  # dedent works better with this and padding matching script below
+    for k,v in SETUPVARS.iteritems():
+        set_setup_vars += "    {}={}\n".format(k, v)
+    Pihole.run(set_setup_vars).stdout
+
+    script = dedent('''\
+    set -e
+    echo start
+    TERM=xterm
+    source /opt/pihole/basic-install.sh
+    {}
+    finalExports
+    cat /etc/pihole/setupVars.conf
+    '''.format(set_setup_vars))
+
+    output = run_script(Pihole, script).stdout
+
+    for k,v in SETUPVARS.iteritems():
+        assert "{}={}".format(k, v) in output
+
+def test_configureFirewall_firewalld_running_no_errors(Pihole):
+    ''' confirms firewalld rules are applied when firewallD is running '''
+    # firewallD returns 'running' as status
+    mock_command('firewall-cmd', {'*':('running', 0)}, Pihole)
+    # Whiptail dialog returns Ok for user prompt
+    mock_command('whiptail', {'*':('', 0)}, Pihole)
+    configureFirewall = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    configureFirewall
+    ''')
+    expected_stdout = 'Configuring FirewallD for httpd and dnsmasq.'
+    assert expected_stdout in configureFirewall.stdout
+    firewall_calls = Pihole.run('cat /var/log/firewall-cmd').stdout
+    assert 'firewall-cmd --state' in firewall_calls
+    assert 'firewall-cmd --permanent --add-service=http --add-service=dns' in firewall_calls
+    assert 'firewall-cmd --reload' in firewall_calls
+
+def test_configureFirewall_firewalld_disabled_no_errors(Pihole):
+    ''' confirms firewalld rules are not applied when firewallD is not running '''
+    # firewallD returns non-running status
+    mock_command('firewall-cmd', {'*':('not running', '1')}, Pihole)
+    configureFirewall = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    configureFirewall
+    ''')
+    expected_stdout = 'No active firewall detected.. skipping firewall configuration.'
+    assert expected_stdout in configureFirewall.stdout
+
+def test_configureFirewall_firewalld_enabled_declined_no_errors(Pihole):
+    ''' confirms firewalld rules are not applied when firewallD is running, user declines ruleset '''
+    # firewallD returns running status
+    mock_command('firewall-cmd', {'*':('running', 0)}, Pihole)
+    # Whiptail dialog returns Cancel for user prompt
+    mock_command('whiptail', {'*':('', 1)}, Pihole)
+    configureFirewall = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    configureFirewall
+    ''')
+    expected_stdout = 'Not installing firewall rulesets.'
+    assert expected_stdout in configureFirewall.stdout
+
+def test_configureFirewall_no_firewall(Pihole):
+    ''' confirms firewall skipped no daemon is running '''
+    configureFirewall = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    configureFirewall
+    ''')
+    expected_stdout = 'No active firewall detected'
+    assert expected_stdout in configureFirewall.stdout
+
+def test_configureFirewall_IPTables_enabled_declined_no_errors(Pihole):
+    ''' confirms IPTables rules are not applied when IPTables is running, user declines ruleset '''
+    # iptables command exists
+    mock_command('iptables', {'*':('', '0')}, Pihole)
+    # modinfo returns always true (ip_tables module check)
+    mock_command('modinfo', {'*':('', '0')}, Pihole)
+    # Whiptail dialog returns Cancel for user prompt
+    mock_command('whiptail', {'*':('', '1')}, Pihole)
+    configureFirewall = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    configureFirewall
+    ''')
+    expected_stdout = 'Not installing firewall rulesets.'
+    assert expected_stdout in configureFirewall.stdout
+
+def test_configureFirewall_IPTables_enabled_rules_exist_no_errors(Pihole):
+    ''' confirms IPTables rules are not applied when IPTables is running and rules exist '''
+    # iptables command exists and returns 0 on calls (should return 0 on iptables -C)
+    mock_command('iptables', {'-S':('-P INPUT DENY', '0')}, Pihole)
+    # modinfo returns always true (ip_tables module check)
+    mock_command('modinfo', {'*':('', '0')}, Pihole)
+    # Whiptail dialog returns Cancel for user prompt
+    mock_command('whiptail', {'*':('', '0')}, Pihole)
+    configureFirewall = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    configureFirewall
+    ''')
+    expected_stdout = 'Installing new IPTables firewall rulesets'
+    assert expected_stdout in configureFirewall.stdout
+    firewall_calls = Pihole.run('cat /var/log/iptables').stdout
+    assert 'iptables -I INPUT 1 -p tcp -m tcp --dport 80 -j ACCEPT' not in firewall_calls
+    assert 'iptables -I INPUT 1 -p tcp -m tcp --dport 53 -j ACCEPT' not in firewall_calls
+    assert 'iptables -I INPUT 1 -p udp -m udp --dport 53 -j ACCEPT' not in firewall_calls
+
+def test_configureFirewall_IPTables_enabled_not_exist_no_errors(Pihole):
+    ''' confirms IPTables rules are applied when IPTables is running and rules do not exist '''
+    # iptables command and returns 0 on calls (should return 1 on iptables -C)
+    mock_command('iptables', {'-S':('-P INPUT DENY', '0'), '-C':('', 1), '-I':('', 0)}, Pihole)
+    # modinfo returns always true (ip_tables module check)
+    mock_command('modinfo', {'*':('', '0')}, Pihole)
+    # Whiptail dialog returns Cancel for user prompt
+    mock_command('whiptail', {'*':('', '0')}, Pihole)
+    configureFirewall = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    configureFirewall
+    ''')
+    expected_stdout = 'Installing new IPTables firewall rulesets'
+    assert expected_stdout in configureFirewall.stdout
+    firewall_calls = Pihole.run('cat /var/log/iptables').stdout
+    assert 'iptables -I INPUT 1 -p tcp -m tcp --dport 80 -j ACCEPT' in firewall_calls
+    assert 'iptables -I INPUT 1 -p tcp -m tcp --dport 53 -j ACCEPT' in firewall_calls
+    assert 'iptables -I INPUT 1 -p udp -m udp --dport 53 -j ACCEPT' in firewall_calls
+
+def test_installPiholeWeb_fresh_install_no_errors(Pihole):
+    ''' confirms all web page assets from Core repo are installed on a fresh build '''
+    installWeb = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    installPiholeWeb
+    ''')
+    assert 'Installing pihole custom index page...' in installWeb.stdout
+    assert 'No default index.lighttpd.html file found... not backing up' 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):
+    ''' confirms package cache was updated without any errors'''
+    updateCache = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    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
+
+def test_update_package_cache_failure_no_errors(Pihole):
+    ''' confirms package cache was not updated'''
+    mock_command('apt-get', {'update':('', '1')}, Pihole)
+    updateCache = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    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
+
+def test_FTL_detect_aarch64_no_errors(Pihole):
+    ''' confirms only aarch64 package is downloaded for FTL engine '''
+    # mock uname to return aarch64 platform
+    mock_command('uname', {'-m':('aarch64', '0')}, Pihole)
+    # mock ldd to respond with aarch64 shared library
+    mock_command('ldd', {'/bin/ls':('/lib/ld-linux-aarch64.so.1', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    FTLdetect
+    ''')
+    expected_stdout = 'Detected ARM-aarch64 architecture'
+    assert expected_stdout in detectPlatform.stdout
+
+def test_FTL_detect_armv6l_no_errors(Pihole):
+    ''' confirms only armv6l package is downloaded for FTL engine '''
+    # mock uname to return armv6l platform
+    mock_command('uname', {'-m':('armv6l', '0')}, Pihole)
+    # mock ldd to respond with aarch64 shared library
+    mock_command('ldd', {'/bin/ls':('/lib/ld-linux-armhf.so.3', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    FTLdetect
+    ''')
+    expected_stdout = 'Detected ARM-hf architecture (armv6 or lower)'
+    assert expected_stdout in detectPlatform.stdout
+
+def test_FTL_detect_armv7l_no_errors(Pihole):
+    ''' confirms only armv7l package is downloaded for FTL engine '''
+    # mock uname to return armv7l platform
+    mock_command('uname', {'-m':('armv7l', '0')}, Pihole)
+    # mock ldd to respond with aarch64 shared library
+    mock_command('ldd', {'/bin/ls':('/lib/ld-linux-armhf.so.3', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    FTLdetect
+    ''')
+    expected_stdout = 'Detected ARM-hf architecture (armv7+)'
+    assert expected_stdout in detectPlatform.stdout
+
+def test_FTL_detect_x86_64_no_errors(Pihole):
+    ''' confirms only x86_64 package is downloaded for FTL engine '''
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    FTLdetect
+    ''')
+    expected_stdout = 'Detected x86_64 architecture'
+    assert expected_stdout in detectPlatform.stdout
+
+def test_FTL_detect_unknown_no_errors(Pihole):
+    ''' confirms only generic package is downloaded for FTL engine '''
+    # mock uname to return generic platform
+    mock_command('uname', {'-m':('mips', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    FTLdetect
+    ''')
+    expected_stdout = 'Not able to detect architecture (unknown: mips)'
+    assert expected_stdout in detectPlatform.stdout
+
+def test_FTL_download_aarch64_no_errors(Pihole):
+    ''' confirms only aarch64 package is downloaded for FTL engine '''
+    # mock uname to return generic platform
+    download_binary = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    FTLinstall pihole-FTL-aarch64-linux-gnu
+    ''')
+    expected_stdout = 'done'
+    assert expected_stdout in download_binary.stdout
+    assert 'failed' not in download_binary.stdout
+
+def test_FTL_download_unknown_fails_no_errors(Pihole):
+    ''' confirms unknown binary is not downloaded for FTL engine '''
+    # mock uname to return generic platform
+    download_binary = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    FTLinstall pihole-FTL-mips
+    ''')
+    expected_stdout = 'failed'
+    assert expected_stdout in download_binary.stdout
+    assert 'done' not in download_binary.stdout
+
+def test_FTL_binary_installed_and_responsive_no_errors(Pihole):
+    ''' confirms FTL binary is copied and functional in installed location '''
+    installed_binary = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    FTLdetect
+    pihole-FTL version
+    ''')
+    expected_stdout = 'v'
+    assert expected_stdout in installed_binary.stdout
+
+# def test_FTL_support_files_installed(Pihole):
+#     ''' confirms FTL support files are installed '''
+#     support_files = Pihole.run('''
+#     source /opt/pihole/basic-install.sh
+#     FTLdetect
+#     stat -c '%a %n' /var/log/pihole-FTL.log
+#     stat -c '%a %n' /run/pihole-FTL.port
+#     stat -c '%a %n' /run/pihole-FTL.pid
+#     ls -lac /run
+#     ''')
+#     assert '644 /run/pihole-FTL.port' in support_files.stdout
+#     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 = 'Found neither IPv6 ULA nor GUA address, blocking IPv6 ads 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 '''
+    full_script_path = '/usr/local/bin/{}'.format(script)
+    mock_script = dedent('''\
+    #!/bin/bash -e
+    echo "\$0 \$@" >> /var/log/{script}
+    case "\$1" 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 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
+    return result

test/test_shellcheck.py

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