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

@@ -35,4 +35,4 @@ GitHub.Tests.Integration/Resources/*  binary
 
 
 # Catch all for anything we forgot. Add rules if you get CRLF -> LF warnings.
-* text=auto
+* text eol=lf

.github/ISSUE_TEMPLATE.md

@@ -2,14 +2,14 @@
 
 - [] 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)).
+- [] The issue I am reporting isn't a duplicate (see [FAQs](https://github.com/pi-hole/pi-hole/wiki/FAQs), [closed issues](https://github.com/pi-hole/pi-hole/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), and [open issues](https://github.com/pi-hole/pi-hole/issues)).
 
 **How familiar are you with the codebase?:**
 
 _{replace this text with a number from 1 to 10, with 1 being not familiar, and 10 being very familiar}_
 
 ---
-**[FEATURE REQUEST | QUESTION | OTHER]:**
+**[BUG REPORT | OTHER]:**
 
 Please [submit your feature request here](https://discourse.pi-hole.net/c/feature-requests), so it is votable by the community.  It's also easier for us to track.
 

.gitignore

@@ -4,4 +4,3 @@
 __pycache__
 .cache
 .pullapprove.yml
-

.idea/codeStyleSettings.xml

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

.pullapprove.yml

@@ -1,7 +1,7 @@
 version: 2
 
 always_pending:
-  title_regex: '(WIP|wip)'  
+  title_regex: '(WIP|wip)'
   labels:
     - wip
   explanation: 'This PR is a work in progress...'
@@ -10,7 +10,7 @@ group_defaults:
   reset_on_push:
     enabled: true
   reject_value: -2
-  approve_regex: '^(Approved|:shipit:|:\+1:|Engage)'
+  approve_regex: '^(Approved|:shipit:|:\+1:|Engage|:taco:)'
   reject_regex: '^(Rejected|:-1:|Borg)'
   author_approval:
     auto: true
@@ -22,17 +22,17 @@ groups:
       enabled: true
     conditions:
       branches:
-        - development        
+        - development
     required: 2
     teams:
       - approvers
-  
+
   master:
     approve_by_comment:
       enabled: true
     conditions:
       branches:
         - master
-    required: -1
+    required: 4
     teams:
-      - admin
+      - approvers

CONTRIBUTING.md

@@ -35,4 +35,5 @@ When requesting or submitting new features, first consider whether it might be u
 - 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
+Copyright (C) 2017 Pi-hole, LLC (https://pi-hole.net)
-                       Version 2, June 1991
+Pi-hole Core
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+This software is licensed under the European Union Public License (EUPL)
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+The license is available in the 22 official languages of the EU. The English version is included here.
- Everyone is permitted to copy and distribute verbatim copies
+Please see https://joinup.ec.europa.eu/community/eupl/og_page/eupl for official translations of the other languages.
- of this license document, but changing it is not allowed.
 
-                            Preamble
+This license applies to the whole project EXCEPT:
 
-  The licenses for most software are designed to take away your
+ - any commits made to the master branch prior to the release of version 3.0
-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.
 
-  When we speak of free software, we are referring to freedom, not
+The licenses that existed prior to this change have remained intact.
-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.
 
-  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.
+EUROPEAN UNION PUBLIC LICENCE v. 1.2
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
 
-  For example, if you distribute copies of such a program, whether
+EUPL © the European Union 2007, 2016
-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.
 
-  We protect your rights with two steps: (1) copyright the software, and
+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).
-(2) offer you this license which gives you legal permission to copy,
+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:
-distribute and/or modify the software.
+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
+1. Definitions
-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.
 
-  Finally, any free program is threatened constantly by software
+In this Licence, the following terms have the following meaning:
-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.
 
-  The precise terms and conditions for copying, distribution and
+- The Licence: this Licence.
-modification follow.
+- 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
+2. Scope of the rights granted by the Licence
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
-  0. This License applies to any program or other work which contains
+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:
-a notice placed by the copyright holder saying it may be distributed
+- use the Work in any circumstance and for all usage,
-under the terms of this General Public License.  The "Program", below,
+- reproduce the Work,
-refers to any such program or work, and a "work based on the Program"
+- modify the Work, and make Derivative Works based upon the Work,
-means either the Program or any derivative work under copyright law:
+- 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,
-that is to say, a work containing the Program or a portion of it,
+- distribute the Work or copies thereof,
-either verbatim or with modifications and/or translated into another
+- lend and rent the Work or copies thereof,
-language.  (Hereinafter, translation is included without limitation in
+- sublicense rights in the Work or copies thereof.
-the term "modification".)  Each licensee is addressed as "you".
+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
+3. Communication of the Source Code
-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.
 
-  1. You may copy and distribute verbatim copies of the Program's
+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.
-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.
 
-You may charge a fee for the physical act of transferring a copy, and
+4. Limitations on copyright
-you may at your option offer warranty protection in exchange for a fee.
 
-  2. You may modify your copy or copies of the Program or any portion
+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.
-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:
 
-    a) You must cause the modified files to carry prominent notices
+5. Obligations of the Licensee
-    stating that you changed the files and the date of any change.
 
-    b) You must cause any work that you distribute or publish, that in
+The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those obligations are the following:
-    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.
 
-    c) If the modified program normally reads commands interactively
+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.
-    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.)
 
-These requirements apply to the modified work as a whole.  If
+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.
-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.
 
-Thus, it is not the intent of this section to claim rights or contest
+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.
-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.
 
-In addition, mere aggregation of another work not based on the Program
+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.
-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.
 
-  3. You may copy and distribute the Program (or a work based on it,
+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.
-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:
 
-    a) Accompany it with the complete corresponding machine-readable
+6. Chain of Authorship
-    source code, which must be distributed under the terms of Sections
-    1 and 2 above on a medium customarily used for software interchange; or,
 
-    b) Accompany it with a written offer, valid for at least three
+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.
-    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,
 
-    c) Accompany it with the information you received as to the offer
+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.
-    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.)
 
-The source code for a work means the preferred form of the work for
+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.
-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.
 
-If distribution of executable or object code is made by offering
+7. Disclaimer of Warranty
-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.
 
-  4. You may not copy, modify, sublicense, or distribute the Program
+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.
-except as expressly provided under this License.  Any attempt
+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.
-otherwise to copy, modify, sublicense or distribute the Program is
+This disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work.
-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.
 
-  5. You are not required to accept this License, since you have not
+8. Disclaimer of Liability
-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.
 
-  6. Each time you redistribute the Program (or any work based on the
+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.
-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.
 
-  7. If, as a consequence of a court judgment or allegation of patent
+9. Additional agreements
-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.
 
-If any portion of this section is held invalid or unenforceable under
+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.
-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.
 
-It is not the purpose of this section to induce you to infringe any
+10. Acceptance of the Licence
-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.
 
-This section is intended to make thoroughly clear what is believed to
+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.
-be a consequence of the rest of this License.
+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
+11. Information to the public
-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.
 
-  9. The Free Software Foundation may publish revised and/or new versions
+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.
-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.
 
-Each version is given a distinguishing version number.  If the Program
+12. Termination of the Licence
-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.
 
-  10. If you wish to incorporate parts of the Program into other free
+The Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms of the Licence.
-programs whose distribution conditions are different, write to the author
+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.
-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.
 
-                            NO WARRANTY
+13. Miscellaneous
 
-  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the Work.
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+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.
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+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.
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+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.
-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.
 
-  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+14. Jurisdiction
-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.
 
-                     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
+Without prejudice to specific agreement between parties,
-possible use to the public, the best way to achieve this is to make it
+- 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,
-free software which everyone can redistribute and change under these terms.
+- 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}
+Appendix
-    Copyright (C) {year}  {fullname}
 
-    This program is free software; you can redistribute it and/or modify
+Compatible Licences according to Article 5 EUPL are:
-    it under the terms of the GNU General Public License as published by
+- GNU General Public License (GPL) v. 2, v. 3
-    the Free Software Foundation; either version 2 of the License, or
+- GNU Affero General Public License (AGPL) v. 3
-    (at your option) any later version.
+- Open Software License (OSL) v. 2.1, v. 3.0
-
+- Eclipse Public License (EPL) v. 1.0
-    This program is distributed in the hope that it will be useful,
+- CeCILL v. 2.0, v. 2.1
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
+- Mozilla Public Licence (MPL) v. 2
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
-    GNU General Public License for more details.
+- 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
-    You should have received a copy of the GNU General Public License along
+- Québec Free and Open-Source Licence - Reciprocity (LiLiQ-R) or Strong Reciprocity (LiLiQ-R+)
-    with this program; if not, write to the Free Software Foundation, Inc.,
+- 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.
-    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+-  All other changes or additions to this Appendix require the production of a new EUPL version.
-
-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.

README.md

@@ -5,12 +5,12 @@
 </p>
 
 <p align="center">
-<a href=https://discourse.pi-hole.net><img src="https://assets.pi-hole.net/static/Vortex_text.png" width=210></a>
+<a href=https://discourse.pi-hole.net><img src="https://assets.pi-hole.net/static/Vortex_with_text_and_TM.png" width=210></a>
 </p>
 
 ## The multi-platform, network-wide ad blocker
 
-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.
+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.
 
 - Web Browsers
 - Cell Phones
@@ -53,11 +53,11 @@ wget -O basic-install.sh https://install.pi-hole.net
 bash basic-install.sh
 ```
 
-Once installed, [configure your router to have **DHCP clients use the Pi as their DNS server**](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245) and then any device that connects to your network will have ads blocked without any further configuration. Alternatively, you can manually set each device to [use the Raspberry Pi as its DNS server](http://pi-hole.net/faq/how-do-i-use-the-pi-hole-as-my-dns-server/).
+Once installed, [configure your router to have **DHCP clients use the Pi as their DNS server**](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245) and then any device that connects to your network will have ads blocked without any further configuration. Alternatively, you can manually set each device to use Pi-hole™ as their DNS server.
 
-## What is Pi-hole and how do I install it?
+## 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/global.png"></a>
+<a href=https://www.youtube.com/watch?v=vKWjx1AQYgs><img src="https://assets.pi-hole.net/static/video-explainer.png"></a>
 </p>
 
 
@@ -73,7 +73,7 @@ Once installed, [configure your router to have **DHCP clients use the Pi as thei
 
 ## 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
 
@@ -83,7 +83,7 @@ The [gravity.sh](https://github.com/pi-hole/pi-hole/blob/master/gravity.sh) does
 
 #### Other Operating Systems
 
-The automated install is only for a clean install of a Debian family or Fedora based system, such as the Raspberry Pi. However, this script will work for most UNIX-like systems, some with some slight **modifications** that we can help you work through. If you can install `dnsmasq` and a Webserver, it should work OK. If there are other platforms you'd like supported, let us know.
+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
 
@@ -91,13 +91,31 @@ The [Web interface](https://github.com/pi-hole/AdminLTE#pi-hole-admin-dashboard)
 
 `http://192.168.1.x/admin/index.php` or `http://pi.hole/admin`
 
-![Pi-hole Advanced Stats Dashboard](https://assets.pi-hole.net/static/dashboard.png)
+![Pi-hole Advanced Stats Dashboard](https://assets.pi-hole.net/static/dashboard212.png)
 
 ### Whitelist and blacklist
 
 Domains can be whitelisted and blacklisted using either the web interface or the command line. See [the wiki page](https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting) for more details
 <p align="center">
-<a href=https://github.com/pi-hole/pi-hole/wiki/Whitelisting-and-Blacklisting><img src="https://assets.pi-hole.net/static/controlpanel.png"></a>
+<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
@@ -117,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://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)
@@ -135,7 +154,9 @@ You can view [real-time stats](http://pi-hole.net/faq/install-the-real-time-lcd-
 -   [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 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
 

adlists.default

@@ -1,53 +1,23 @@
-## Pi-hole ad-list default sources. Updated 29/10/2016 #########################
-#                                                                              #
-#  To make changes to this file:                                               #
-#    1. run `cp /etc/pihole/adlists.default /etc/pihole/adlists.list`          #
-#    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:
+##MalwareDomains
-http://mirror1.malwaredomains.com/files/justdomains
+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://pilotfiber.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
-
-# 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

@@ -22,9 +22,12 @@
 
 addn-hosts=/etc/pihole/gravity.list
 addn-hosts=/etc/pihole/local.list
+addn-hosts=/etc/pihole/black.list
 
 domain-needed
 
+localise-queries
+
 bogus-priv
 
 no-resolv

advanced/Scripts/chronometer.sh

@@ -1,95 +1,435 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # Calculates stats and displays to an LCD
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
 
+# 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##############################################################################################################
+    # Test if connection is open
-piLog="/var/log/pihole.log"
+    if { "true" >&3; } 2> /dev/null; then
-gravity="/etc/pihole/gravity.list"
+      # Send command to FTL
+      echo -e ">$1" >&3
 
-. /etc/pihole/setupVars.conf
+      # Read input
+      read -r -t 1 LINE <&3
+      until [[ ! $? ]] || [[ "$LINE" == *"EOM"* ]]; do
+         echo "$LINE" >&1
+         read -r -t 1 LINE <&3
+      done
 
-# Borrowed/modified from https://gist.github.com/cjus/1047794
+      # Close connection
-function GetJSONValue {
+      exec 3>&-
-    retVal=$(echo $1 | sed 's/\\\\\//\//g' | \
+      exec 3<&-
-                       sed 's/[{}]//g' | \
+   fi
-                       awk -v k="text" '{n=split($0,a,","); for (i=1; i<=n; i++) print a[i]}' | \
+  else
-                       sed 's/\"\:\"/\|/g' | \
+    echo -e "${COL_LIGHT_RED}FTL offline${COL_NC}"
-                       sed 's/[\,]/ /g' | \
+  fi
-                       sed 's/\"//g' | \
-                       grep -w $2)
-    echo ${retVal##*|}
 }
 
-outputJSON() {
+# Print spaces to align right-side content
-	json=$(curl -s -X GET http://127.0.0.1/admin/api.php?summaryRaw)
+printFunc() {
-	echo ${json}
+  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
 }
 
-normalChrono() {
+# Perform on first Chrono run (not for JSON formatted string)
-	for (( ; ; )); do
+get_init_stats() {
-		clear
+  LC_NUMERIC=C
-		# Displays a colorful Pi-hole logo
+  calcFunc(){ awk "BEGIN {print $*}"; }
-		echo " ___ _     _        _"
-		echo "| _ (_)___| |_  ___| |___"
-		echo "|  _/ |___| ' \/ _ \ / -_)"
-		echo "|_| |_|   |_||_\___/_\___|"
-		echo ""
-		echo "        ${IPV4_ADDRESS}"
-		echo ""
-		uptime | cut -d' ' -f11-
-		#uptime -p	#Doesn't work on all versions of uptime
-		uptime | awk -F'( |,|:)+' '{if ($7=="min") m=$6; else {if ($7~/^day/) {d=$6;h=$8;m=$9} else {h=$6;m=$7}}} {print d+0,"days,",h+0,"hours,",m+0,"minutes."}'
-		echo "-------------------------------"
-		# 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;}'
 
-		json=$(curl -s -X GET http://127.0.0.1/admin/api.php?summaryRaw)
+  # 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";
+  }
 
-    domains=$(printf "%'.f" $(GetJSONValue ${json} "domains_being_blocked")) #add commas in
+  # Convert seconds to human-readable format
-    queries=$(printf "%'.f" $(GetJSONValue ${json} "dns_queries_today"))
+  hrSecs() { 
-    blocked=$(printf "%'.f" $(GetJSONValue ${json} "ads_blocked_today"))
+    day=$(( $1/60/60/24 )); hrs=$(( $1/3600%24 )); mins=$(( ($1%3600)/60 )); secs=$(( $1%60 ))
-    LC_NUMERIC=C percentage=$(printf "%0.2f\n" $(GetJSONValue ${json} "ads_percentage_today")) #2 decimal places
+    [[ "$day" -ge "2" ]] && plu="s"
+    [[ "$day" -ge "1" ]] && days="$day day${plu}, " || days=""
+    printf "%s%02d:%02d:%02d\n" "$days" "$hrs" "$mins" "$secs"
+  }
 
-		echo "Blocking:      ${domains}"
+  # Set Colour Codes
-		echo "Queries:       ${queries}"
+  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
 
-		echo "Pi-holed:      ${blocked} (${percentage}%)"
+  # 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
 
-		sleep 5
+  # Get core count
-	done
+  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
 }
 
-displayHelp() {
+get_sys_stats() {
-	cat << EOM
+  local ph_ver_raw
-::: Displays stats about your piHole!
+  local cpu_raw
-:::
+  local ram_raw
-::: Usage: sudo pihole -c [optional:-j]
+  local disk_raw
-::: Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds
+
-:::
+  # Update every 12 refreshes (Def: every 60s)
-::: Options:
+  count=$((count+1))
-:::  -j, --json		output stats as JSON formatted string
+  if [[ "$count" == "1" ]] || (( "$count" % 12 == 0 )); then
-:::  -h, --help		display this help text
+    [[ -n "$setupVars" ]] && source "$setupVars"
-EOM
+    
-    exit 0
+    
+    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
+}
+
+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
+}
+
+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}"
+
+    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
+}
+
+jsonFunc() {
+  get_ftl_stats "json"
+  echo "{\"domains_being_blocked\":${domains_being_blocked_raw},\"dns_queries_today\":${dns_queries_today_raw},\"ads_blocked_today\":${ads_blocked_today_raw},\"ads_percentage_today\":${ads_percentage_today_raw}}"
+}
+
+helpFunc() {
+    if [[ "$1" == "?" ]]; then
+      echo "Unknown option. Please view 'pihole -c --help' for more information"
+    else
+      echo "Usage: pihole -c [options]
+Example: 'pihole -c -j'
+Calculates stats and displays to an LCD
+    
+Options:
+  -j, --json          Output stats as JSON formatted string
+  -r, --refresh       Set update frequency (in seconds)
+  -e, --exit          Output stats and exit witout refreshing
+  -h, --help          Display this help text"
+  fi
+  
+  exit 0
 }
 
 if [[ $# = 0 ]]; then
-	normalChrono
+  chronoFunc
 fi
 
 for var in "$@"; do
-	case "$var" in
+  case "$var" in
-		"-j" | "--json"  ) outputJSON;;
+    "-j" | "--json"    ) jsonFunc;;
-		"-h" | "--help"  ) displayHelp;;
+    "-h" | "--help"    ) helpFunc;;
-		*                ) exit 1;;
+    "-r" | "--refresh" ) chronoFunc "$2";;
-	esac
+    "-e" | "--exit"    ) chronoFunc "exit";;
+    *                  ) helpFunc "?";;
+  esac
 done

advanced/Scripts/list.sh

@@ -1,16 +1,14 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
-# Whitelists and blacklists domains
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# Whitelist and blacklist domains
-# it under the terms of the GNU General Public License as published by
+#
-# the Free Software Foundation, either version 2 of the License, or
+# This file is copyright under the latest version of the EUPL.
-# (at your option) any later version.
+# Please see LICENSE file for your rights under this license.
 
-#globals
+# Globals
 basename=pihole
 piholeDir=/etc/${basename}
 whitelist=${piholeDir}/whitelist.txt
@@ -27,119 +25,118 @@ 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
 
-    if [[ ${listMain} == ${whitelist} ]]; then
+    echo "Usage: pihole -${param} [options] <domain> <domain2 ...>
-        letter="w"
+Example: 'pihole -${param} site.com', or 'pihole -${param} site1.com site2.com'
-        word="white"
+${type^}list one or more domains
-    else
-        letter="b"
-        word="black"
-    fi
 
-	cat << EOM
+Options:
-::: Immediately ${word}lists one or more domains in the hosts file
+  -d, --delmode       Remove domain(s) from the ${type}list
-:::
+  -nr, --noreload     Update ${type}list without refreshing dnsmasq
-::: Usage: pihole -${letter} domain1 [domain2 ...]
+  -q, --quiet         Make output less verbose
-:::
+  -h, --help          Show this help dialog
-::: Options:
+  -l, --list          Display all your ${type}listed domains"
-:::  -d, --delmode			Remove domains from the ${word}list
+
-:::  -nr, --noreload		Update ${word}list without refreshing dnsmasq
+  exit 0
-:::  -q, --quiet			output is less verbose
-:::  -h, --help				Show this help dialog
-:::  -l, --list				Display your ${word}listed domains
-EOM
-if [[ "${letter}" == "b" ]]; then
-	echo ":::  -wild, --wildcard		Add whitecard entry (only blacklist)"
-fi
-	exit 0
 }
 
 EscapeRegexp() {
-    # This way we may safely insert an arbitrary
+  # This way we may safely insert an arbitrary
-    # string in our regular expressions
+  # string in our regular expressions
-    # Also remove leading "." if present
+  # Also remove leading "." if present
-    echo $* | sed 's/^\.*//' | sed "s/[]\.|$(){}?+*^]/\\\\&/g" | sed "s/\\//\\\\\//g"
+  echo $* | sed 's/^\.*//' | sed "s/[]\.|$(){}?+*^]/\\\\&/g" | sed "s/\\//\\\\\//g"
 }
 
-HandleOther(){
+HandleOther() {
-	# First, convert everything to lowercase
+  # First, convert everything to lowercase
-	domain=$(sed -e "y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/" <<< "$1")
+  domain=$(sed -e "y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/" <<< "$1")
 
-	#check validity of domain
+  # Check validity of domain
-	validDomain=$(echo "${domain}" | perl -lne 'print if /^(?!.*[^a-z0-9-\.].*)\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)*[a-z]{2,63}\b/')
+  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
+  if [[ -z "${validDomain}" ]]; then
-		echo "::: $1 is not a valid argument or domain name"
+    echo "::: $1 is not a valid argument or domain name"
-	else
+  else
-		domList=("${domList[@]}" ${validDomain})
+    domList=("${domList[@]}" ${validDomain})
-	fi
+  fi
 }
 
 PoplistFile() {
-	#check whitelist file exists, and if not, create it
+  # Check whitelist file exists, and if not, create it
-	if [[ ! -f ${whitelist} ]]; then
+  if [[ ! -f ${whitelist} ]]; then
-		touch ${whitelist}
+    touch ${whitelist}
-	fi
+  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
+  for dom in "${domList[@]}"; do
-		if ${addmode}; then
+      # 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
-			AddDomain "${dom}" "${listMain}"
+    if ${addmode}; then
-			RemoveDomain "${dom}" "${listAlt}"
+      AddDomain "${dom}" "${listMain}"
-		else
+      RemoveDomain "${dom}" "${listAlt}"
-			RemoveDomain "${dom}" "${listMain}"
+      if [[ "${listMain}" == "${whitelist}" || "${listMain}" == "${blacklist}" ]]; then
-		fi
+        RemoveDomain "${dom}" "${wildcardlist}"
-	done
+      fi
+    else
+      RemoveDomain "${dom}" "${listMain}"
+    fi
+  done
 }
 
 AddDomain() {
-	list="$2"
+  list="$2"
-    domain=$(EscapeRegexp "$1")
+  domain=$(EscapeRegexp "$1")
 
-    if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
+  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
 
-		bool=true
+    if [[ "${bool}" == false ]]; then
-		#Is the domain in the list we want to add it to?
+      # Domain not found in the whitelist file, add it!
-		grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
+      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}
 
-		if [[ "${bool}" == false ]]; then
+    bool=true
-		  #domain not found in the whitelist file, add it!
+    # Is the domain in the list?
-		  if [[ "${verbose}" == true ]]; then
+    grep -e "address=\/${domain}\/" "${wildcardlist}" > /dev/null 2>&1 || bool=false
-			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
+    if [[ "${bool}" == false ]]; then
-
+      if [[ "${verbose}" == true ]]; then
-		source "${piholeDir}/setupVars.conf"
+      echo "::: Adding $1 to wildcard blacklist..."
-		#Remove the /* from the end of the IPv4addr.
+      fi
-		IPV4_ADDRESS=${IPV4_ADDRESS%/*}
+      reload=true
-		IPV6_ADDRESS=${IPV6_ADDRESS}
+      echo "address=/$1/${IPV4_ADDRESS}" >> "${wildcardlist}"
-
+      if [[ "${#IPV6_ADDRESS}" > 0 ]]; then
-		bool=true
+        echo "address=/$1/${IPV6_ADDRESS}" >> "${wildcardlist}"
-		#Is the domain in the list?
+      fi
-		grep -e "address=\/${domain}\/" "${wildcardlist}" > /dev/null 2>&1 || bool=false
+    else
-
+      if [[ "${verbose}" == true ]]; then
-		if [[ "${bool}" == false ]]; then
+        echo "::: ${1} already exists in wildcard blacklist, no need to add!"
-		  if [[ "${verbose}" == true ]]; then
+      fi
-			echo "::: Adding $1 to wildcard blacklist..."
+    fi
-		  fi
+  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() {
@@ -147,86 +144,82 @@ RemoveDomain() {
     domain=$(EscapeRegexp "$1")
 
     if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
-
+      bool=true
-        bool=true
+      # Is it in the list? Logic follows that if its whitelisted it should not be blacklisted and vice versa
-        #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
-        grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
+      if [[ "${bool}" == true ]]; then
-        if [[ "${bool}" == true ]]; then
+        # Remove it from the other one
-            # Remove it from the other one
+        echo "::: Removing $1 from $list..."
-            echo "::: Removing $1 from $list..."
+        # /I flag: search case-insensitive
-            # /I flag: search case-insensitive
+        sed -i "/${domain}/Id" "${list}"
-            sed -i "/${domain}/Id" "${list}"
+        reload=true
-            reload=true
+      else
-        else
+        if [[ "${verbose}" == true ]]; then
-            if [[ "${verbose}" == true ]]; then
+          echo "::: ${1} does not exist in ${list}, no need to remove!"
-                echo "::: ${1} does not exist in ${list}, no need to remove!"
-            fi
         fi
-
+      fi
     elif [[ "${list}" == "${wildcardlist}" ]]; then
-
+      bool=true
-        bool=true
+      # Is it in the list?
-        #Is it in the list?
+      grep -e "address=\/${domain}\/" "${wildcardlist}" > /dev/null 2>&1 || bool=false
-        grep -e "address=\/${domain}\/" "${wildcardlist}" > /dev/null 2>&1 || bool=false
+      if [[ "${bool}" == true ]]; then
-        if [[ "${bool}" == true ]]; then
+        # Remove it from the other one
-            # Remove it from the other one
+        echo "::: Removing $1 from $list..."
-            echo "::: Removing $1 from $list..."
+        # /I flag: search case-insensitive
-            # /I flag: search case-insensitive
+        sed -i "/address=\/${domain}/Id" "${list}"
-            sed -i "/address=\/${domain}/Id" "${list}"
+        reload=true
-            reload=true
+      else
-        else
+        if [[ "${verbose}" == true ]]; then
-            if [[ "${verbose}" == true ]]; then
+          echo "::: ${1} does not exist in ${list}, no need to remove!"
-                echo "::: ${1} does not exist in ${list}, no need to remove!"
-            fi
         fi
+      fi
     fi
 }
 
 Reload() {
-	# Reload hosts file
+  # Reload hosts file
-	pihole -g -sd
+  pihole -g -sd
 }
 
 Displaylist() {
-    if [[ ${listMain} == ${whitelist} ]]; then
+  if [[ "${listMain}" == "${whitelist}" ]]; then
-        string="gravity resistant domains"
+    string="gravity resistant domains"
-    else
+  else
-        string="domains caught in the sinkhole"
+    string="domains caught in the sinkhole"
-    fi
+  fi
-	verbose=false
+  verbose=false
-	echo -e " Displaying $string \n"
+  echo -e "Displaying $string:\n"
-	count=1
+  count=1
-	while IFS= read -r RD; do
+  while IFS= read -r RD; do
-		echo "${count}: ${RD}"
+    echo "${count}: ${RD}"
-		count=$((count+1))
+    count=$((count+1))
-	done < "${listMain}"
+  done < "${listMain}"
-	exit 0;
+  exit 0;
 }
 
 for var in "$@"; do
-	case "${var}" in
+  case "${var}" in
-	    "-w" | "whitelist"   ) listMain="${whitelist}"; listAlt="${blacklist}";;
+    "-w" | "whitelist"   ) listMain="${whitelist}"; listAlt="${blacklist}";;
-	    "-b" | "blacklist"   ) listMain="${blacklist}"; listAlt="${whitelist}";;
+    "-b" | "blacklist"   ) listMain="${blacklist}"; listAlt="${whitelist}";;
-		"-wild" | "wildcard" ) listMain="${wildcardlist}";;
+    "-wild" | "wildcard" ) listMain="${wildcardlist}";;
-		"-nr"| "--noreload"  ) reload=false;;
+    "-nr"| "--noreload"  ) reload=false;;
-		"-d" | "--delmode"   ) addmode=false;;
+    "-d" | "--delmode"   ) addmode=false;;
-		"-f" | "--force"     ) force=true;;
+    "-f" | "--force"     ) force=true;;
-		"-q" | "--quiet"     ) verbose=false;;
+    "-q" | "--quiet"     ) verbose=false;;
-		"-h" | "--help"      ) helpFunc;;
+    "-h" | "--help"      ) helpFunc;;
-		"-l" | "--list"      ) Displaylist;;
+    "-l" | "--list"      ) Displaylist;;
-		*                    ) HandleOther "${var}";;
+    *                    ) HandleOther "${var}";;
-	esac
+  esac
 done
 
 shift
 
 if [[ $# = 0 ]]; then
-	helpFunc
+  helpFunc
 fi
 
 PoplistFile
 
 if ${reload}; then
-	Reload
+  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,14 +1,14 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # Generates pihole_debug.log to be used for troubleshooting.
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
+
-# (at your option) any later version.
+
 
 set -o pipefail
 
@@ -16,7 +16,7 @@ set -o pipefail
 VARSFILE="/etc/pihole/setupVars.conf"
 DEBUG_LOG="/var/log/pihole_debug.log"
 DNSMASQFILE="/etc/dnsmasq.conf"
-DNSMASQCONFFILE="/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"
@@ -24,9 +24,11 @@ WHITELISTFILE="/etc/pihole/whitelist.txt"
 BLACKLISTFILE="/etc/pihole/blacklist.txt"
 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"
 
-IPV6_READY=false
 TIMEOUT=60
 # Header info and introduction
 cat << EOM
@@ -35,23 +37,18 @@ cat << EOM
 ::: This process collects information from your Pi-hole, and optionally uploads
 ::: it to a unique and random directory on tricorder.pi-hole.net.
 :::
-::: NOTE: All log files auto-delete after 24 hours and ONLY the Pi-hole developers
+::: 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
 
-# Ensure the file exists, create if not, clear if exists.
-truncate --size=0 "${DEBUG_LOG}"
-chmod 644 ${DEBUG_LOG}
-chown "$USER":pihole ${DEBUG_LOG}
-
 source ${VARSFILE}
 
 ### Private functions exist here ###
 log_write() {
-    echo "${1}" >> "${DEBUG_LOG}"
+    echo "${@}" >&3
 }
 
 log_echo() {
@@ -76,14 +73,14 @@ log_echo() {
 
 header_write() {
   log_echo ""
-  log_echo "${1}"
+  log_echo "---= ${1}"
   log_write ""
 }
 
 file_parse() {
     while read -r line; do
 		  if [ ! -z "${line}" ]; then
-			  [[ "${line}" =~ ^#.*$  || ! "${line}" ]] && continue
+			  [[ "${line}" =~ ^#.*$  || ! "${line}" || "${line}" == "WEBPASSWORD="* ]] && continue
 				log_write "${line}"
 			fi
 		done < "${1}"
@@ -112,35 +109,86 @@ 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
 
-	local pi_hole_ver="$(cd /etc/.pihole/ && git describe --tags --abbrev=0)" \
+  cd "${PIHOLEGITDIR}" &> /dev/null || \
-	&& log_echo -r "Pi-hole: $pi_hole_ver" || (log_echo "Pi-hole git repository not detected." && error_found=1)
+    { status="Pi-hole git directory not found."; error_found=1; }
-	local admin_ver="$(cd /var/www/html/admin && git describe --tags --abbrev=0)" \
+  if git status &> /dev/null; then
-	&& log_echo -r "WebUI: $admin_ver" || (log_echo "Pi-hole Admin Pages git repository not detected." && error_found=1)
+    pi_hole_ver=$(git describe --tags --abbrev=0)
-	local light_ver="$(lighttpd -v |& head -n1 | cut -d " " -f1)" \
+    pi_hole_branch=$(git rev-parse --abbrev-ref HEAD)
-	&& log_echo -r "${light_ver}" || (log_echo "lighttpd not installed." && error_found=1)
+    pi_hole_commit=$(git describe --long --dirty --tags --always)
-	local php_ver="$(php -v |& head -n1)" \
+    log_echo -r "Pi-hole: ${pi_hole_ver:-Untagged} (${pi_hole_branch:-Detached}:${pi_hole_commit})"
-	&& log_echo -r "${php_ver}" || (log_echo "PHP not installed." && error_found=1)
+  else
+    status=${status:-"Pi-hole repository damaged."}
+    error_found=1
+  fi
+  if [[ "${status}" ]]; then
+    log_echo "${status}"
+    unset status
+  fi
 
-	(local pi_hole_branch="$(cd /etc/.pihole/ && git rev-parse --abbrev-ref HEAD)" && log_echo -r "Pi-hole branch:  ${pi_hole_branch}") || log_echo "Unable to obtain Pi-hole branch"
+  cd "${ADMINGITDIR}" || \
-	(local pi_hole_rev="$(cd /etc/.pihole/ && git describe --long --dirty --tags)" && log_echo -r "Pi-hole rev:     ${pi_hole_rev}") || log_echo "Unable to obtain Pi-hole revision"
+    { 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
 
-	(local admin_branch="$(cd /var/www/html/admin && git rev-parse --abbrev-ref HEAD)" && log_echo -r "AdminLTE branch: ${admin_branch}") || log_echo "Unable to obtain AdminLTE branch"
+	if light_ver=$(lighttpd -v |& head -n1 | cut -d " " -f1); then
-	(local admin_rev="$(cd /var/www/html/admin && git describe --long --dirty --tags)" && log_echo -r "AdminLTE rev:    ${admin_rev}") || log_echo "Unable to obtain AdminLTE revision"
+	  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 ":::       File exists"
+     echo -n ":::       File exists, parsing..."
      file_parse "${search_file}"
+     echo "done"
      return 0
-	else
+  else
     log_echo "${1} not found!"
     return 1
   fi
@@ -168,72 +216,70 @@ processor_check() {
 
 ipv6_check() {
   # Check if system is IPv6 enabled, for use in other functions
-  if [[ $IPv6_address ]]; then
+  if [[ $IPV6_ADDRESS ]]; then
-    ls /proc/net/if_inet6 &>/dev/null && IPV6_READY=true
+    ls /proc/net/if_inet6 &>/dev/null
     return 0
   else
     return 1
   fi
 }
 
-
 ip_check() {
-	header_write "IP Address Information"
+  local protocol=${1}
-	# Get the current interface for Internet traffic
+  local gravity=${2}
-
+  header_write "Checking IPv${protocol} Stack"
-	# Check if IPv6 enabled
-	local IPv6_interface
-	local IPv4_interface
-	ipv6_check &&	IPv6_interface=${piholeInterface:-$(ip -6 r | grep default | cut -d ' ' -f 5)}
-	# If declared in setupVars.conf use it, otherwise defer to default
-	# http://stackoverflow.com/questions/2013547/assigning-default-values-to-shell-variables-with-a-single-command-in-bash
-  IPv4_interface=${piholeInterface:-$(ip r | grep default | cut -d ' ' -f 5)}
-
-
-  if [[ IPV6_READY ]]; then
-    local IPv6_addr_list="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet6") print $(i+1) }')" \
-	  && (log_write "${IPv6_addr_list}" && echo ":::       IPv6 addresses located") \
-	  || log_echo "No IPv6 addresses found."
-
-    local IPv6_def_gateway=$(ip -6 r | grep default | cut -d ' ' -f 3)
-    if [[ $? = 0 ]] && [[ -n ${IPv6_def_gateway} ]]; then
-      echo -n ":::        Pinging default IPv6 gateway: "
-      local IPv6_def_gateway_check="$(ping6 -q -W 3 -c 3 -n "${IPv6_def_gateway}" -I "${IPv6_interface}"| tail -n3)" \
-      && echo "Gateway Responded." \
-      || echo "Gateway did not respond."
-      block_parse "${IPv6_def_gateway_check}"
-
-      echo -n ":::        Pinging Internet via IPv6: "
-      local IPv6_inet_check=$(ping6 -q -W 3 -c 3 -n 2001:4860:4860::8888 -I "${IPv6_interface}"| tail -n3) \
-      && echo "Query responded." \
-      || echo "Query did not respond."
-      block_parse "${IPv6_inet_check}"
-    else
-      log_echo="No IPv6 Gateway Detected"
-    fi
-
-local IPv4_addr_list="$(ip a | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "inet") print $(i+1) }')" \
-	&& (block_parse "${IPv4_addr_list}" && echo ":::       IPv4 addresses located")\
-	|| log_echo "No IPv4 addresses found."
-
-	local IPv4_def_gateway=$(ip r | grep default | cut -d ' ' -f 3)
-	if [[ $? = 0 ]]; then
-		echo -n ":::        Pinging default IPv4 gateway: "
-		local IPv4_def_gateway_check="$(ping -q -w 3 -c 3 -n "${IPv4_def_gateway}"  -I "${IPv4_interface}" | tail -n3)" \
-		&& echo "Gateway responded." \
-		|| echo "Gateway did not respond."
-		block_parse "${IPv4_def_gateway_check}"
-
-		echo -n ":::        Pinging Internet via IPv4: "
-		local IPv4_inet_check="$(ping -q -w 5 -c 3 -n 8.8.8.8 -I "${IPv4_interface}" | tail -n3)" \
-		&& echo "Query responded." \
-		|| echo "Query did not respond."
-		block_parse "${IPv4_inet_check}"
-	fi
 
+  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
+      log_echo "Gateway responded."
+      log_write "${ping_gateway}"
+    fi
+    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
+      log_echo "Query responded."
+      log_write "${ping_inet}"
+    fi
+  else
+    log_echo "        No gateway detected."
+  fi
+  return 0
+}
+
 port_check() {
   local lsof_value
 
@@ -256,62 +302,78 @@ daemon_check() {
 }
 
 testResolver() {
-	header_write "Resolver Functions Check"
+  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"
+	url=$(shuf -n 1 "${GRAVITYFILE}" | awk -F ' ' '{ print $2 }')
-	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
 
-	log_write "Resolution of ${TESTURL} from Pi-hole:"
+	testurl="${url:-doubleclick.com}"
-	LOCALDIG=$(dig "${TESTURL}" @127.0.0.1)
+
-	if [[ $? = 0 ]]; then
+
-		log_write "${LOCALDIG}"
+	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
-		log_write "Failed to resolve ${TESTURL} on Pi-hole"
+		log_write "Failed to resolve ${testurl} on Pi-hole (${l_addr})"
+	fi
+	log_write ""
+
+	log_write "Resolution of ${testurl} from Pi-hole (${IP}):"
+	if piholedig=$(dig -"${protocol}" "${testurl}" @"${IP}" +short "${r_type}"); then
+		log_write "${piholedig}"
+	else
+		log_write "Failed to resolve ${testurl} on Pi-hole (${IP})"
 	fi
 	log_write ""
 
 
-	log_write "Resolution of ${TESTURL} from 8.8.8.8:"
+	log_write "Resolution of ${testurl} from ${g_addr}:"
-	REMOTEDIG=$(dig "${TESTURL}" @8.8.8.8)
+	if remotedig=$(dig -"${protocol}" "${testurl}" @${g_addr} +short "${r_type}"); then
-	if [[ $? = 0 ]]; then
+		log_write "${remotedig:-NXDOMAIN}"
-		log_write "${REMOTEDIG}"
 	else
-		log_write "Failed to resolve ${TESTURL} on 8.8.8.8"
+		log_write "Failed to resolve ${testurl} on upstream server ${g_addr}"
 	fi
 	log_write ""
-
-	log_write "Pi-hole dnsmasq specific records lookups"
-	log_write "Cache Size:"
-	dig +short chaos txt cachesize.bind >> ${DEBUG_LOG}
-	log_write "Upstream Servers:"
-	dig +short chaos txt servers.bind >> ${DEBUG_LOG}
-	log_write ""
 }
 
+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 and dnsmasq..."
+	echo ":::     Logging status of lighttpd, dnsmasq and pihole-FTL..."
-	PROCESSES=( lighttpd dnsmasq )
+	PROCESSES=( lighttpd dnsmasq pihole-FTL )
 	for i in "${PROCESSES[@]}"; do
-		log_write ""
+		log_write "Status for ${i} daemon:"
-		log_write "${i}"
+		log_write $(systemctl is-active "${i}")
-		log_write " processes status:"
-		systemctl -l status "${i}" >> "${DEBUG_LOG}"
 	done
 	log_write ""
 }
@@ -324,16 +386,92 @@ debugLighttpd() {
 }
 
 countdown() {
+  local tuvix
   tuvix=${TIMEOUT}
-  printf "::: Logging will automatically teminate in ${TIMEOUT} seconds\n"
+  printf "::: Logging will automatically teminate in %s seconds\n" "${TIMEOUT}"
   while [ $tuvix -ge 1 ]
   do
-    printf ":::\t${tuvix} seconds left. \r"
+    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
+dumpPiHoleLog() {
+	trap '{ echo -e "\n::: Finishing debug write from interrupt... Quitting!" ; exit 1; }' INT
+	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
+		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
+finalWork() {
+  local tricorder
+	echo "::: Finshed debugging!"
+
+  # 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"
@@ -344,16 +482,27 @@ distro_check || echo "Distro Check soft fail"
 # Gather processor type
 processor_check || echo "Processor Check soft fail"
 
-ip_check
+ip_check 6 ${IPV6_ADDRESS}
+ip_check 4 ${IPV4_ADDRESS}
 
 daemon_check lighttpd http
 daemon_check dnsmasq domain
+daemon_check pihole-FTL 4711
 checkProcesses
-testResolver
+
+# 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}"
-files_check "${DNSMASQCONFFILE}"
+dir_check "${DNSMASQCONFDIR}"
 files_check "${WHITELISTFILE}"
 files_check "${BLACKLISTFILE}"
 files_check "${ADLISTFILE}"
@@ -375,50 +524,17 @@ header_write "Analyzing pihole.log"
   && log_write "${PIHOLELOG} is ${pihole_size}." \
   || log_echo "Warning: No pihole.log file found!"
 
+header_write "Analyzing pihole-FTL.log"
 
-# Continuously append the pihole.log file to the pihole_debug.log file
+  FTL_length=$(grep -c ^ "${FTLLOG}") \
-dumpPiHoleLog() {
+  && log_write "${FTLLOG} is ${FTL_length} lines long." \
-	trap '{ echo -e "\n::: Finishing debug write from interrupt... Quitting!" ; exit 1; }' INT
+  || log_echo "Warning: No pihole-FTL.log file found!"
-	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}" >> ${DEBUG_LOG}
-	else
-		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
+  FTL_size=$(du -h "${FTLLOG}" | awk '{ print $1 }') \
-finalWork() {
+  && log_write "${FTLLOG} is ${FTL_size}." \
-  local tricorder
+  || log_echo "Warning: No pihole-FTL.log file found!"
-	echo "::: Finshed debugging!"
-	echo "::: The debug log can be uploaded to tricorder.pi-hole.net for sharing with developers only."
-	read -r -p "::: Would you like to upload the log? [y/N] " response
-	case ${response} in
-		[yY][eE][sS]|[yY])
-			tricorder=$(cat /var/log/pihole_debug.log | nc tricorder.pi-hole.net 9999)
-			;;
-		*)
-			echo "::: Log will NOT be uploaded to tricorder."
-			;;
-	esac
 
-	# Check if tricorder.pi-hole.net is reachable and provide token.
+tail -n50 "${FTLLOG}" >&3
-	if [ -n "${tricorder}" ]; then
-		echo "::: Your debug token is : ${tricorder}"
-		echo "::: Please contact the Pi-hole team with your token for assistance."
-		echo "::: Thank you."
-	else
-		echo "::: There was an error uploading your debug log."
-		echo "::: Please try again or contact the Pi-hole team for assistance."
-	fi
-		echo "::: A local copy of the Debug log can be found at : /var/log/pihole_debug.log"
-}
 
 trap finalWork EXIT
 

advanced/Scripts/piholeLogFlush.sh

@@ -1,20 +1,45 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
-# Flushes /var/log/pihole.log
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# Flushes Pi-hole's log file
-# it under the terms of the GNU General Public License as published by
+#
-# the Free Software Foundation, either version 2 of the License, or
+# This file is copyright under the latest version of the EUPL.
-# (at your option) any later version.
+# Please see LICENSE file for your rights under this license.
 
-echo -n "::: Flushing /var/log/pihole.log ..."
+if [[ "$@" != *"quiet"* ]]; then
-# Test if logrotate is available on this system
+  echo -n "::: Flushing /var/log/pihole.log ..."
-if command -v /usr/sbin/logrotate &> /dev/null; then
+fi
-  /usr/sbin/logrotate --force /etc/pihole/logrotate
+if [[ "$@" == *"once"* ]]; then
-else
+  # Nightly logrotation
-  echo " " > /var/log/pihole.log
+  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
-echo "... done!"

advanced/Scripts/setupLCD.sh

@@ -1,14 +1,14 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # 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
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
+
-# (at your option) any later version.
+
 
 ############ FUNCTIONS ###########
 

advanced/Scripts/update.sh

@@ -1,16 +1,16 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # Check Pi-hole core and admin pages versions and determine what
 # upgrade (if any) is required. Automatically updates and reinstalls
 # application if update is detected.
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
+
-# (at your option) any later version.
+
 
 # Variables
 
@@ -19,82 +19,29 @@ readonly ADMIN_INTERFACE_DIR="/var/www/html/admin"
 readonly PI_HOLE_GIT_URL="https://github.com/pi-hole/pi-hole.git"
 readonly PI_HOLE_FILES_DIR="/etc/.pihole"
 
-is_repo() {
+# shellcheck disable=SC2034
-  # Use git to check if directory is currently under VCS, return the value
+PH_TEST=true
-  local directory="${1}"
-  local curdir
-  local rc
 
-  curdir="${PWD}"
+# Have to ignore the following rule as spaces in paths are not supported by ShellCheck
-  cd "${directory}" &> /dev/null || return 1
+#shellcheck disable=SC1090
-  git status --short &> /dev/null
+source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
-  rc=$?
-  cd "${curdir}" &> /dev/null || return 1
-  return "${rc}"
-}
 
-prep_repo() {
+# is_repo() sourced from basic-install.sh
-  # Prepare directory for local repository building
+# make_repo() sourced from basic-install.sh
-  local directory="${1}"
+# update_repo() source from basic-install.sh
-
+# getGitFiles() sourced from basic-install.sh
-  rm -rf "${directory}" &> /dev/null
-  return
-}
-
-make_repo() {
-  # Remove the non-repod interface and clone the interface
-  local remoteRepo="${2}"
-  local directory="${1}"
-
-  (prep_repo "${directory}" && git clone -q --depth 1 "${remoteRepo}" "${directory}")
-     return
-}
-
-update_repo() {
-  local directory="${1}"
-  local curdir
-
-  curdir="${PWD}"
-  cd "${directory}" &> /dev/null || return 1
-  # Pull the latest commits
-  # Stash all files not tracked for later retrieval
-  git stash --all --quiet
-  # Force a clean working directory for cloning
-  git clean --force -d
-  # Fetch latest changes and apply
-  git pull --quiet
-  cd "${curdir}" &> /dev/null || return 1
-}
-
-getGitFiles() {
-  # Setup git repos for directory and repository passed
-  # as arguments 1 and 2
-  local directory="${1}"
-  local remoteRepo="${2}"
-  echo ":::"
-  echo "::: Checking for existing repository..."
-  if is_repo "${directory}"; then
-    echo -n ":::     Updating repository in ${directory}..."
-    update_repo "${directory}" || (echo "*** Error: Could not update local repository. Contact support."; exit 1)
-    echo " done!"
-  else
-    echo -n ":::    Cloning ${remoteRepo} into ${directory}..."
-    make_repo "${directory}" "${remoteRepo}" || (echo "Unable to clone repository, please contact support"; exit 1)
-    echo " done!"
-  fi
-}
 
 GitCheckUpdateAvail() {
   local directory="${1}"
-  curdir=$PWD;
+  curdir=$PWD
-  cd "${directory}"
+  cd "${directory}" || return
 
   # Fetch latest changes in this repo
   git fetch --quiet origin
 
   # @ alone is a shortcut for HEAD. Older versions of git
   # need @{0}
-  LOCAL="$(git rev-parse @{0})"
+  LOCAL="$(git rev-parse "@{0}")"
 
   # The suffix @{upstream} to a branchname
   # (short form <branchname>@{u}) refers
@@ -103,24 +50,24 @@ GitCheckUpdateAvail() {
   # (configured with branch.<name>.remote and
   # branch.<name>.merge). A missing branchname
   # defaults to the current one.
-  REMOTE="$(git rev-parse @{upstream})"
+  REMOTE="$(git rev-parse "@{upstream}")"
-
-  # Change back to original directory
-  cd "${curdir}"
 
   if [[ ${#LOCAL} == 0 ]]; then
-    echo "::: Error: Local revision could not be optained, ask Pi-hole support."
+    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 optained, ask Pi-hole support."
+    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
@@ -132,13 +79,29 @@ GitCheckUpdateAvail() {
   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}" || ! is_repo "${ADMIN_INTERFACE_DIR}" ; then
+  if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
-    echo "::: Critical Error: One or more Pi-Hole repos are missing from system!"
+    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
@@ -153,64 +116,114 @@ main() {
     echo "::: Pi-hole Core:   up to date"
   fi
 
-  if GitCheckUpdateAvail "${ADMIN_INTERFACE_DIR}" ; then
+  if FTLcheckUpdate ; then
-    web_update=true
+    FTL_update=true
-    echo "::: Web Interface:  update available"
+    echo "::: FTL:            update available"
   else
-    web_update=false
+    FTL_update=false
-    echo "::: Web Interface:  up to date"
+    echo "::: FTL:            up to date"
   fi
 
-  # Logic
+  # Logic: Don't update FTL when there is a core update available
-  # If Core up to date AND web up to date:
+  # since the core update will run the installer which will itself
-  #            Do nothing
+  # re-install (i.e. update) FTL
-  # If Core up to date AND web NOT up to date:
+  if ${FTL_update} && ! ${core_update}; then
-  #            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
     echo ":::"
-    echo "::: Everything is up to date!"
+    echo "::: FTL out of date"
-    exit 0
+    FTLdetect
-
-  elif ! ${core_update} && ${web_update} ; then
     echo ":::"
-    echo "::: Pi-hole Web Admin files out of date"
+  fi
-    getGitFiles "${ADMIN_INTERFACE_DIR}" "${ADMIN_INTERFACE_GIT_URL}"
 
-  elif ${core_update} && ! ${web_update} ; then
+  if [[ ${INSTALL_WEB} == true ]]; then
-    echo ":::"
+    if ! is_repo "${ADMIN_INTERFACE_DIR}" ; then
-    echo "::: Pi-hole core files out of date"
+      echo "::: Critical Error: Web Admin repo is missing from system!"
-    getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
+      echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
-    /etc/.pihole/automated\ install/basic-install.sh --reconfigure --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
+      exit 1;
+    fi
 
-  elif ${core_update} && ${web_update} ; then
+    if GitCheckUpdateAvail "${ADMIN_INTERFACE_DIR}" ; then
-    echo ":::"
+      web_update=true
-    echo "::: Updating Everything"
+      echo "::: Web Interface:  update available"
-    getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
+    else
-    /etc/.pihole/automated\ install/basic-install.sh --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
+      web_update=false
-  else
+      echo "::: Web Interface:  up to date"
-    echo "*** Update script has malfunctioned, fallthrough reached. Please contact support"
+    fi
-    exit 1
+
+    # 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}"
+    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}"
+    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
 

advanced/Scripts/version.sh

@@ -1,102 +1,168 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
-# shows version numbers
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# Show version numbers
-# it under the terms of the GNU General Public License as published by
+#
-# the Free Software Foundation, either version 2 of the License, or
+# This file is copyright under the latest version of the EUPL.
-# (at your option) any later version.
+# Please see LICENSE file for your rights under this license.
-
-# Flags:
-latest=false
-current=false
 
+# Variables
 DEFAULT="-1"
+COREGITDIR="/etc/.pihole/"
+WEBGITDIR="/var/www/html/admin/"
 
-normalOutput() {
+getLocalVersion() {
-	piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
+  # FTL requires a different method
-	webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
+  if [[ "$1" == "FTL" ]]; then
+    pihole-FTL version
+    return 0
+  fi
 
-	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/",$//')
+  # Get the tagged version of the local repository
-	webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+  local directory="${1}"
+  local version
 
-	echo "::: Pi-hole version is ${piholeVersion} (Latest version is ${piholeVersionLatest:-${DEFAULT}})"
+  cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
-	echo "::: Web-Admin version is ${webVersion} (Latest version is ${webVersionLatest:-${DEFAULT}})"
+  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
 }
 
-webOutput() {
+getLocalHash() {
-	for var in "$@"; do
+  # Local FTL hash does not exist on filesystem
-		case "${var}" in
+  if [[ "$1" == "FTL" ]]; then
-			"-l" | "--latest"    ) latest=true;;
+    echo "N/A"
-			"-c" | "--current"   ) current=true;;
+    return 0
-			*                    ) echo "::: Invalid Option!"; exit 1;
+  fi
-		esac
+  
-	done
+  # Get the short hash of the local repository
+  local directory="${1}"
+  local hash
 
-	if [[ "${latest}" == true && "${current}" == false ]]; then
+  cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
-		webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+  hash=$(git rev-parse --short HEAD || echo "$DEFAULT")
-		echo "${webVersionLatest:--1}"
+  if [[ "${hash}" == "${DEFAULT}" ]]; then
-	elif [[ "${latest}" == false && "${current}" == true ]]; then
+    echo "ERROR"
-		webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
+    return 1
-		echo "${webVersion}"
+  else
-	else
+    echo "${hash}"
-		webVersion=$(cd /var/www/html/admin/ && git describe --tags --abbrev=0)
+  fi
-		webVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+  return 0
-		echo "::: Web-Admin version is ${webVersion} (Latest version is ${webVersionLatest:-${DEFAULT}})"
-	fi
 }
 
-coreOutput() {
+getRemoteHash(){
-	for var in "$@"; do
+  # Remote FTL hash is not applicable
-		case "${var}" in
+  if [[ "$1" == "FTL" ]]; then
-			"-l" | "--latest"    ) latest=true;;
+    echo "N/A"
-			"-c" | "--current"   ) current=true;;
+    return 0
-			*                    ) echo "::: Invalid Option!"; exit 1;
+  fi
-		esac
-	done
 
-	if [[ "${latest}" == true && "${current}" == false ]]; then
+  local daemon="${1}"
-		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/",$//')
+  local branch="${2}"
-		echo "${piholeVersionLatest:--1}"
+
-	elif [[ "${latest}" == false && "${current}" == true ]]; then
+  hash=$(git ls-remote --heads "https://github.com/pi-hole/${daemon}" | \
-		piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
+         awk -v bra="$branch" '$0~bra {print substr($0,0,8);exit}')
-		echo "${piholeVersion}"
+  if [[ -n "$hash" ]]; then
-	else
+    echo "$hash"
-		piholeVersion=$(cd /etc/.pihole/ && git describe --tags --abbrev=0)
+  else
-		piholeVersionLatest=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/releases/latest | grep -Po '"tag_name":.*?[^\\]",' |  perl -pe 's/"tag_name": "//; s/^"//; s/",$//')
+    echo "ERROR"
-		echo "::: Pi-hole version is ${piholeVersion} (Latest version is ${piholeVersionLatest:-${DEFAULT}})"
+    return 1
-	fi
+  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() {
-	cat << EOM
+  echo "Usage: pihole -v [repo | option] [option]
-:::
+Example: 'pihole -v -p -l'
-::: Show Pi-hole/Web Admin versions
+Show Pi-hole, Admin Console & FTL versions
-:::
+
-::: Usage: pihole -v [ -a | -p ] [ -l | -c ]
+Repositories:
-:::
+  -p, --pihole         Only retrieve info regarding Pi-hole repository
-::: Options:
+  -a, --admin          Only retrieve info regarding AdminLTE repository
-:::  -a, --admin          Show both current and latest versions of web admin
+  -f, --ftl            Only retrieve info regarding FTL repository
-:::  -p, --pihole         Show both current and latest versions of Pi-hole core files
+  
-:::  -l, --latest         (Only after -a | -p) Return only latest version
+Options:
-:::  -c, --current        (Only after -a | -p) Return only current version
+  -c, --current        Return the current version
-:::  -h, --help           Show this help dialog
+  -l, --latest         Return the latest version
-:::
+  --hash               Return the Github hash from your local repositories
-EOM
+  -h, --help           Show this help dialog"
-	exit 0
+  exit 0
 }
 
-if [[ $# = 0 ]]; then
+case "${1}" in
-	normalOutput
+  "-p" | "--pihole"    ) shift; versionOutput "pi-hole" "$@";;
-fi
+  "-a" | "--admin"     ) shift; versionOutput "AdminLTE" "$@";;
-
+  "-f" | "--ftl"       ) shift; versionOutput "FTL" "$@";;
-for var in "$@"; do
+  "-h" | "--help"      ) helpFunc;;
-	case "${var}" in
+  *                    ) defaultOutput "$@";;
-	"-a" | "--admin"     ) shift; webOutput "$@";;
+esac
-	"-p" | "--pihole"    ) shift; coreOutput "$@" ;;
-	"-h" | "--help"      ) helpFunc;;
-	esac
-done

advanced/Scripts/webpage.sh

@@ -1,31 +1,33 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# Network-wide ad blocking via your Raspberry Pi
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# http://pi-hole.net
+# Network-wide ad blocking via your own hardware.
+#
 # Web interface settings
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
 
 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() {
-	cat << EOM
+  echo "Usage: pihole -a [options]
-::: Set admin options for the web interface of pihole
+Example: pihole -a -p password
-:::
+Set options for the Admin Console
-::: Usage: pihole -a [options]
+
-:::
+Options:
-::: Options:
+  -f, flush           Flush the Pi-hole log
-:::  -p, password		Set web interface password, an empty input will remove any previously set password
+  -p, password        Set Admin Console password
-:::  -c, celsius		Set Celsius temperature unit
+  -c, celsius         Set Celsius as preferred temperature unit
-:::  -f, fahrenheit		Set Fahrenheit temperature unit
+  -f, fahrenheit      Set Fahrenheit as preferred temperature unit
-:::  -k, kelvin			Set Kelvin temperature unit
+  -k, kelvin          Set Kelvin as preferred temperature unit
-:::  -h, --help			Show this help dialog
+  -h, --help          Show this help dialog
-EOM
+  -i, interface       Specify dnsmasq's interface listening behavior
+                        Add '-h' for more info on interface usage" 
 	exit 0
 }
 
@@ -54,14 +56,18 @@ delete_dnsmasq_setting() {
 	sed -i "/${1}/d" "${dnsmasqconfig}"
 }
 
-SetTemperatureUnit(){
+SetTemperatureUnit() {
-
 	change_setting "TEMPERATUREUNIT" "${unit}"
-
 }
 
-SetWebPassword(){
+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"
@@ -74,19 +80,32 @@ SetWebPassword(){
 		exit 1
 	fi
 
-	# Set password only if there is one to be set
+  if (( ${#args[2]} > 0 )) ; then
-	if (( ${#args[2]} > 0 )) ; then
+    readonly PASSWORD="${args[2]}"
-		# Compute password hash twice to avoid rainbow table vulnerability
+    readonly CONFIRM="${PASSWORD}"
-		hash=$(echo -n ${args[2]} | sha256sum | sed 's/\s.*$//')
+  else
-		hash=$(echo -n ${hash} | sha256sum | sed 's/\s.*$//')
+    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
-		change_setting "WEBPASSWORD" ""
+		echo "Passwords don't match. Your password has not been changed"
-		echo "Password removed"
+		exit 1
 	fi
-
 }
 
 ProcessDNSSettings() {
@@ -125,10 +144,30 @@ trust-anchor=.,19036,8,2,49AAC11D7B6F6446702E54A1607371607A1A41855200FD2CE1CDDE3
 " >> "${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(){
+SetDNSServers() {
-
 	# Save setting to file
 	delete_setting "PIHOLE_DNS"
 	IFS=',' read -r -a array <<< "${args[2]}"
@@ -159,72 +198,59 @@ SetDNSServers(){
 
 	# Restart dnsmasq to load new configuration
 	RestartDNS
-
 }
 
-SetExcludeDomains(){
+SetExcludeDomains() {
-
 	change_setting "API_EXCLUDE_DOMAINS" "${args[2]}"
-
 }
 
-SetExcludeClients(){
+SetExcludeClients() {
-
 	change_setting "API_EXCLUDE_CLIENTS" "${args[2]}"
-
 }
 
-Reboot(){
+Reboot() {
-
 	nohup bash -c "sleep 5; reboot" &> /dev/null </dev/null &
-
 }
 
-RestartDNS(){
+RestartDNS() {
-
 	if [ -x "$(command -v systemctl)" ]; then
 		systemctl restart dnsmasq &> /dev/null
 	else
 		service dnsmasq restart &> /dev/null
 	fi
-
 }
 
-SetQueryLogOptions(){
+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/.*=//")
 
-	interface=$(grep 'PIHOLE_INTERFACE=' /etc/pihole/setupVars.conf | sed "s/.*=//")
+    # Use eth0 as fallback interface
+    if [ -z ${interface} ]; then
+      interface="eth0"
+    fi
 
-	# Use eth0 as fallback interface
+    if [[ "${PIHOLE_DOMAIN}" == "" ]]; then
-	if [ -z ${interface} ]; then
+      PIHOLE_DOMAIN="local"
-		interface="eth0"
+      change_setting "PIHOLE_DOMAIN" "${PIHOLE_DOMAIN}"
-	fi
+    fi
 
-	if [[ "${PIHOLE_DOMAIN}" == "" ]]; then
+    if [[ "${DHCP_LEASETIME}" == "0" ]]; then
-		PIHOLE_DOMAIN="local"
+      leasetime="infinite"
-		change_setting "PIHOLE_DOMAIN" "${PIHOLE_DOMAIN}"
+    elif [[ "${DHCP_LEASETIME}" == "" ]]; then
-	fi
+      leasetime="24h"
+      change_setting "DHCP_LEASETIME" "${leasetime}"
+    else
+      leasetime="${DHCP_LEASETIME}h"
+    fi
 
-	if [[ "${DHCP_LEASETIME}" == "0" ]]; then
+    # Write settings to file
-		leasetime="infinite"
+    echo "###############################################################################
-	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             #
 ###############################################################################
@@ -235,26 +261,25 @@ dhcp-leasefile=/etc/pihole/dhcp.leases
 #quiet-dhcp
 " > "${dhcpconfig}"
 
-if [[ "${PIHOLE_DOMAIN}" != "none" ]]; then
+  if [[ "${PIHOLE_DOMAIN}" != "none" ]]; then
-	echo "domain=${PIHOLE_DOMAIN}" >> "${dhcpconfig}"
+    echo "domain=${PIHOLE_DOMAIN}" >> "${dhcpconfig}"
-fi
+  fi
 
-	if [[ "${DHCP_IPv6}" == "true" ]]; then
+    if [[ "${DHCP_IPv6}" == "true" ]]; then
-echo "#quiet-dhcp6
+  echo "#quiet-dhcp6
 #enable-ra
 dhcp-option=option6:dns-server,[::]
 dhcp-range=::100,::1ff,constructor:${interface},ra-names,slaac,${leasetime}
 ra-param=*,0,0
 " >> "${dhcpconfig}"
-	fi
+    fi
 
 	else
 		rm "${dhcpconfig}" &> /dev/null
 	fi
 }
 
-EnableDHCP(){
+EnableDHCP() {
-
 	change_setting "DHCP_ACTIVE" "true"
 	change_setting "DHCP_START" "${args[2]}"
 	change_setting "DHCP_END" "${args[3]}"
@@ -272,8 +297,7 @@ EnableDHCP(){
 	RestartDNS
 }
 
-DisableDHCP(){
+DisableDHCP() {
-
 	change_setting "DHCP_ACTIVE" "false"
 
 	# Remove possible old setting from file
@@ -285,24 +309,37 @@ DisableDHCP(){
 	RestartDNS
 }
 
-SetWebUILayout(){
+SetWebUILayout() {
-
 	change_setting "WEBUIBOXEDLAYOUT" "${args[2]}"
-
 }
 
-SetPrivacyMode(){
+CustomizeAdLists() {
+  list="/etc/pihole/adlists.list"
 
-	if [[ "${args[2]}" == "true" ]] ; then
+	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]}"
 
@@ -313,8 +350,85 @@ ResolutionSettings() {
 	fi
 }
 
-main() {
+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
@@ -334,6 +448,12 @@ main() {
 		"-h" | "--help"     ) helpFunc;;
 		"privacymode"       ) SetPrivacyMode;;
 		"resolve"           ) ResolutionSettings;;
+		"addstaticdhcp"     ) AddDHCPStaticAddress;;
+		"removestaticdhcp"  ) RemoveDHCPStaticAddress;;
+		"hostrecord"        ) SetHostRecord;;
+		"-i" | "interface"  ) SetListeningMode "$@";;
+		"-t" | "teleporter" ) Teleporter;;
+		"adlist"            ) CustomizeAdLists;;
 		*                   ) helpFunc;;
 	esac
 
@@ -342,5 +462,4 @@ main() {
 	if [[ $# = 0 ]]; then
 		helpFunc
 	fi
-
 }

advanced/bash-completion/pihole

@@ -3,7 +3,7 @@ _pihole() {
 	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"
+	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

advanced/index.php

@@ -1,15 +1,55 @@
 <?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 */
+/* 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
@@ -37,7 +77,7 @@ if (!$showPage)
 	die();
 }
 
-// Get Pi-Hole version
+// 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
@@ -48,6 +88,7 @@ if($uri == "/")
 
 ?>
 <!DOCTYPE html>
+<html>
 <head>
 	<meta charset='UTF-8'/>
 	<title>Website Blocked</title>
@@ -144,7 +185,7 @@ function add() {
 	}
 
 	$.ajax({
-		url: "admin/scripts/pi-hole/php/add.php",
+		url: "/admin/scripts/pi-hole/php/add.php",
 		method: "post",
 		data: {"domain":domain.val(), "list":"white", "pw":pw.val()},
 		success: function(response) {

advanced/lighttpd.conf.debian

@@ -1,13 +1,21 @@
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # lighttpd config for Pi-hole
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
+
-# (at your option) any later version.
+
+
+###############################################################################
+#     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",
@@ -21,15 +29,15 @@ server.modules = (
 )
 
 server.document-root        = "/var/www/html"
-server.error-handler-404	= "pihole/index.php"
+server.error-handler-404    = "pihole/index.php"
 server.upload-dirs          = ( "/var/cache/lighttpd/uploads" )
 server.errorlog             = "/var/log/lighttpd/error.log"
 server.pid-file             = "/var/run/lighttpd.pid"
 server.username             = "www-data"
 server.groupname            = "www-data"
 server.port                 = 80
-accesslog.filename			= "/var/log/lighttpd/access.log"
+accesslog.filename          = "/var/log/lighttpd/access.log"
-accesslog.format			= "%{%s}t|%V|%r|%s|%b"
+accesslog.format            = "%{%s}t|%V|%r|%s|%b"
 
 
 index-file.names            = ( "index.php", "index.html", "index.lighttpd.html" )
@@ -62,5 +70,12 @@ $HTTP["url"] =~ "^(?!/admin)/.*" {
     setenv.add-response-header = ( "X-Pi-hole" => "A black hole for Internet advertisements." )
 }
 
+# Entering just "pi.hole" into a browser redirects to "pi.hole/admin/"
+$HTTP["host"] == "pi.hole" {
+    $HTTP["url"] == "/" {
+        url.redirect = ( "" => "/admin/" )
+    }
+}
+
 # Add user chosen options held in external file
 include_shell "cat external.conf 2>/dev/null"

advanced/lighttpd.conf.fedora

@@ -1,13 +1,21 @@
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # lighttpd config for Pi-hole
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
+
-# (at your option) any later version.
+
+
+###############################################################################
+#     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",
@@ -22,15 +30,15 @@ server.modules = (
 )
 
 server.document-root        = "/var/www/html"
-server.error-handler-404	= "pihole/index.php"
+server.error-handler-404    = "pihole/index.php"
 server.upload-dirs          = ( "/var/cache/lighttpd/uploads" )
 server.errorlog             = "/var/log/lighttpd/error.log"
 server.pid-file             = "/var/run/lighttpd.pid"
 server.username             = "lighttpd"
 server.groupname            = "lighttpd"
 server.port                 = 80
-accesslog.filename			= "/var/log/lighttpd/access.log"
+accesslog.filename          = "/var/log/lighttpd/access.log"
-accesslog.format			= "%{%s}t|%V|%r|%s|%b"
+accesslog.format            = "%{%s}t|%V|%r|%s|%b"
 
 
 index-file.names            = ( "index.php", "index.html", "index.lighttpd.html" )
@@ -79,5 +87,12 @@ $HTTP["url"] =~ "^(?!/admin)/.*" {
 	setenv.add-response-header = ( "X-Pi-hole" => "A black hole for Internet advertisements." )
 }
 
+# Entering just "pi.hole" into a browser redirects to "pi.hole/admin/"
+$HTTP["host"] == "pi.hole" {
+    $HTTP["url"] == "/" {
+        url.redirect = ( "" => "/admin/" )
+    }
+}
+
 # Add user chosen options held in external file
 include_shell "cat external.conf 2>/dev/null"

advanced/logrotate

@@ -1,4 +1,5 @@
 /var/log/pihole.log {
+	# su #
 	daily
 	copytruncate
 	rotate 5
@@ -7,3 +8,14 @@
 	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,13 +1,13 @@
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # Updates ad sources every week
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
+#
-# (at your option) any later version.
+#
 #
 # This file is under source-control of the Pi-hole installation and update
 # scripts, any changes made to this file will be overwritten when the softare
@@ -21,9 +21,10 @@
 # Pi-hole: Update Pi-hole! Uncomment to enable auto update
 #30 2    * * 7   root    PATH="$PATH:/usr/local/bin/" pihole updatePihole
 
-# Pi-hole: Flush the log daily at 00:00 so it doesn't get out of control
+# Pi-hole: Flush the log daily at 00:00
-#          Stats will be viewable in the Web interface thanks to the cron job above
 #          The flush script will use logrotate if available
-00 00   * * *   root    PATH="$PATH:/usr/local/bin/" pihole flush
+#          parameter "once": logrotate only once (default is twice)
+#          parameter "quiet": don't print messages
+00 00   * * *   root    PATH="$PATH:/usr/local/bin/" pihole flush once quiet
 
 @reboot root /usr/sbin/logrotate /etc/pihole/logrotate

advanced/pihole.sudo

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

automated install/basic-install.sh

@@ -1,14 +1,14 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # Installs Pi-hole
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
+
-# (at your option) any later version.
+
 
 # pi-hole.net/donate
 #
@@ -34,6 +34,8 @@ useUpdateVars=false
 IPV4_ADDRESS=""
 IPV6_ADDRESS=""
 QUERY_LOGGING=true
+INSTALL_WEB=true
+
 
 # Find the rows and columns will default to 80x24 is it can not be detected
 screen_size=$(stty size 2>/dev/null || echo 24 80)
@@ -52,6 +54,32 @@ skipSpaceCheck=false
 reconfigure=false
 runUnattended=false
 
+show_ascii_berry() {
+  echo "
+        .;;,.
+        .ccccc:,.
+         :cccclll:.      ..,,
+          :ccccclll.   ;ooodc
+           'ccll:;ll .oooodc
+             .;cll.;;looo:.
+                 .. ','.
+                .',,,,,,'.
+              .',,,,,,,,,,.
+            .',,,,,,,,,,,,....
+          ....''',,,,,,,'.......
+        .........  ....  .........
+        ..........      ..........
+        ..........      ..........
+        .........  ....  .........
+          ........,,,,,,,'......
+            ....',,,,,,,,,,,,.
+               .',,,,,,,,,'.
+                .',,,,,,'.
+                  ..'''.
+"
+}
+
+
 # Compatibility
 distro_check() {
 if command -v apt-get &> /dev/null; then
@@ -63,27 +91,39 @@ if command -v apt-get &> /dev/null; then
   # grep -c will return 1 retVal on 0 matches, block this throwing the set -e with an OR TRUE
   PKG_COUNT="${PKG_MANAGER} -s -o Debug::NoLocking=true upgrade | grep -c ^Inst || true"
   # #########################################
-  # fixes for dependancy differences
+  # fixes for dependency differences
   # Debian 7 doesn't have iproute2 use iproute
   if ${PKG_MANAGER} install --dry-run iproute2 > /dev/null 2>&1; then
     iproute_pkg="iproute2"
   else
     iproute_pkg="iproute"
   fi
-  # Prefer the php metapackage if it's there, fall back on the php5 pacakges
+  # Prefer the php metapackage if it's there, fall back on the php5 packages
   if ${PKG_MANAGER} install --dry-run php > /dev/null 2>&1; then
     phpVer="php"
   else
     phpVer="php5"
   fi
   # #########################################
-  INSTALLER_DEPS=(apt-utils debconf dhcpcd5 git whiptail)
+  INSTALLER_DEPS=(apt-utils dialog debconf dhcpcd5 git ${iproute_pkg} whiptail)
-  PIHOLE_DEPS=(bc cron curl dnsmasq dnsutils ${iproute_pkg} iputils-ping lighttpd lsof netcat ${phpVer}-common ${phpVer}-cgi sudo unzip wget)
+  PIHOLE_DEPS=(bc cron curl dnsmasq dnsutils iputils-ping lsof netcat sudo unzip wget)
+  PIHOLE_WEB_DEPS=(lighttpd ${phpVer}-common ${phpVer}-cgi)
   LIGHTTPD_USER="www-data"
   LIGHTTPD_GROUP="www-data"
   LIGHTTPD_CFG="lighttpd.conf.debian"
   DNSMASQ_USER="dnsmasq"
 
+  test_dpkg_lock() {
+    i=0
+    while fuser /var/lib/dpkg/lock >/dev/null 2>&1 ; do
+      sleep 0.5
+      ((i=i+1))
+    done
+    # Always return success, since we only return if there is no
+    # lock (anymore)
+    return 0
+  }
+
 elif command -v rpm &> /dev/null; then
   # Fedora Family
   if command -v dnf &> /dev/null; then
@@ -96,9 +136,9 @@ elif command -v rpm &> /dev/null; then
   UPDATE_PKG_CACHE=":"
   PKG_INSTALL=(${PKG_MANAGER} install -y)
   PKG_COUNT="${PKG_MANAGER} check-update | egrep '(.i686|.x86|.noarch|.arm|.src)' | wc -l"
-  INSTALLER_DEPS=(git iproute net-tools newt procps-ng)
+  INSTALLER_DEPS=(dialog git iproute net-tools newt procps-ng)
-  PIHOLE_DEPS=(bc bind-utils cronie curl dnsmasq findutils lighttpd lighttpd-fastcgi nmap-ncat php php-common php-cli sudo unzip wget)
+  PIHOLE_DEPS=(bc bind-utils cronie curl dnsmasq findutils nmap-ncat sudo unzip wget)
-
+  PIHOLE_WEB_DEPS=(lighttpd lighttpd-fastcgi php php-common php-cli)
   if ! grep -q 'Fedora' /etc/redhat-release; then
     INSTALLER_DEPS=("${INSTALLER_DEPS[@]}" "epel-release");
   fi
@@ -149,15 +189,17 @@ make_repo() {
 
 update_repo() {
   local directory="${1}"
+  local curdir
 
+  curdir="${PWD}"
+  cd "${directory}" &> /dev/null || return 1
   # Pull the latest commits
   echo -n ":::    Updating repo in ${1}..."
-  if [[ -d "${directory}" ]]; then
+  git stash --all --quiet &> /dev/null || true # Okay for stash failure
-    cd "${directory}"
+  git clean --force -d || true # Okay for already clean directory
-    git stash -q &> /dev/null || true # Okay for stash failure
+  git pull --quiet &> /dev/null || return $?
-    git pull -q &> /dev/null || return $?
+  echo " done!"
-    echo " done!"
+  cd "${curdir}" &> /dev/null || return 1
-  fi
   return 0
 }
 
@@ -169,13 +211,25 @@ getGitFiles() {
   echo ":::"
   echo "::: Checking for existing repository..."
   if is_repo "${directory}"; then
-    update_repo "${directory}" || return 1
+    update_repo "${directory}" || { echo "*** Error: Could not update local repository. Contact support."; exit 1; }
+    echo " done!"
   else
-    make_repo "${directory}" "${remoteRepo}" || return 1
+    make_repo "${directory}" "${remoteRepo}" || { echo "Unable to clone repository, please contact support"; exit 1; }
+    echo " done!"
   fi
   return 0
 }
 
+resetRepo() {
+  local directory="${1}"
+
+  cd "${directory}" &> /dev/null || return 1
+  echo -n ":::    Resetting repo in ${1}..."
+  git reset --hard &> /dev/null || return $?
+  echo " done!"
+  return 0
+}
+
 find_IPv4_information() {
   local route
   # Find IP used to route to outside world
@@ -189,7 +243,7 @@ find_IPv4_information() {
 
 get_available_interfaces() {
   # Get available UP interfaces.
-  availableInterfaces=$(ip -o link | grep -v "state DOWN\|lo" | awk '{print $2}' | cut -d':' -f1 | cut -d'@' -f1)
+  availableInterfaces=$(ip --oneline link show up | grep -v "lo" | awk '{print $2}' | cut -d':' -f1 | cut -d'@' -f1)
 }
 
 welcomeDialogs() {
@@ -224,7 +278,7 @@ verifyFreeDiskSpace() {
   # - Insufficient free disk space
   elif [[ ${existing_free_kilobytes} -lt ${required_free_kilobytes} ]]; then
     echo "::: Insufficient Disk Space!"
-    echo "::: Your system appears to be low on disk space. pi-hole recommends a minimum of $required_free_kilobytes KiloBytes."
+    echo "::: Your system appears to be low on disk space. Pi-hole recommends a minimum of $required_free_kilobytes KiloBytes."
     echo "::: You only have ${existing_free_kilobytes} KiloBytes free."
     echo "::: If this is a new install you may need to expand your disk."
     echo "::: Try running 'sudo raspi-config', and choose the 'expand file system option'"
@@ -273,16 +327,44 @@ chooseInterface() {
   fi
 }
 
+# See https://github.com/pi-hole/pi-hole/issues/1473#issuecomment-301745953
+testIPv6() {
+  first="$(cut -f1 -d":" <<< "$1")"
+  value1=$(((0x$first)/256))
+  value2=$(((0x$first)%256))
+  ((($value1&254)==252)) && echo "ULA" || true
+  ((($value1&112)==32)) && echo "GUA" || true
+  ((($value1==254) && (($value2&192)==128))) && echo "Link-local" || true
+}
+
 useIPv6dialog() {
-  # Show the IPv6 address used for blocking
+  # Determine the IPv6 address used for blocking
-  IPV6_ADDRESS=$(ip -6 route get 2001:4860:4860::8888 | grep -v "unreachable" | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
+  IPV6_ADDRESSES=($(ip -6 address | grep 'scope global' | awk '{print $2}'))
+
+  # Determine type of found IPv6 addresses
+  for i in "${IPV6_ADDRESSES[@]}"; do
+    result=$(testIPv6 "$i")
+    [[ "${result}" == "ULA" ]] && ULA_ADDRESS="${i%/*}"
+    [[ "${result}" == "GUA" ]] && GUA_ADDRESS="${i%/*}"
+  done
+
+  # Determine which address to be used: Prefer ULA over GUA or don't use any if none found
+  if [[ ! -z "${ULA_ADDRESS}" ]]; then
+    IPV6_ADDRESS="${ULA_ADDRESS}"
+    echo "::: Found IPv6 ULA address, using it for blocking IPv6 ads"
+  elif [[ ! -z "${GUA_ADDRESS}" ]]; then
+    echo "::: Found IPv6 GUA address, using it for blocking IPv6 ads"
+    IPV6_ADDRESS="${GUA_ADDRESS}"
+  else
+    echo "::: Found neither IPv6 ULA nor GUA address, blocking IPv6 ads will not be enabled"
+    IPV6_ADDRESS=""
+  fi
 
   if [[ ! -z "${IPV6_ADDRESS}" ]]; then
     whiptail --msgbox --backtitle "IPv6..." --title "IPv6 Supported" "$IPV6_ADDRESS will be used to block ads." ${r} ${c}
   fi
 }
 
-
 use4andor6() {
   local useIPv4
   local useIPv6
@@ -361,10 +443,10 @@ It is also possible to use a DHCP reservation, but if you are going to do that,
 
 setDHCPCD() {
   # Append these lines to dhcpcd.conf to enable a static IP
-  echo "## interface ${PIHOLE_INTERFACE}
+  echo "interface ${PIHOLE_INTERFACE}
   static ip_address=${IPV4_ADDRESS}
   static routers=${IPv4gw}
-  static domain_name_servers=${IPv4gw}" | tee -a /etc/dhcpcd.conf >/dev/null
+  static domain_name_servers=127.0.0.1" | tee -a /etc/dhcpcd.conf >/dev/null
 }
 
 setStaticIPv4() {
@@ -394,7 +476,7 @@ setStaticIPv4() {
       cp "${IFCFG_FILE}" "${IFCFG_FILE}".pihole.orig
       # Build Interface configuration file:
       {
-        echo "# Configured via Pi-Hole installer"
+        echo "# Configured via Pi-hole installer"
         echo "DEVICE=$PIHOLE_INTERFACE"
         echo "BOOTPROTO=none"
         echo "ONBOOT=yes"
@@ -444,6 +526,7 @@ setDNS() {
       Level3 ""
       Norton ""
       Comodo ""
+      DNSWatch ""
       Custom "")
   DNSchoices=$(whiptail --separate-output --menu "Select Upstream DNS Provider. To use your own, select Custom." ${r} ${c} 6 \
     "${DNSChooseOptions[@]}" 2>&1 >/dev/tty) || \
@@ -474,6 +557,11 @@ setDNS() {
       PIHOLE_DNS_1="8.26.56.26"
       PIHOLE_DNS_2="8.20.247.20"
       ;;
+    DNSWatch)
+      echo "::: Using DNS.WATCH servers."
+      PIHOLE_DNS_1="84.200.69.80"
+      PIHOLE_DNS_2="84.200.70.40"
+      ;;
     Custom)
       until [[ ${DNSSettingsCorrect} = True ]]; do
       strInvalid="Invalid"
@@ -542,20 +630,41 @@ setLogging() {
     esac
 }
 
+setAdminFlag() {
+  local WebToggleCommand
+  local WebChooseOptions
+  local WebChoices
+
+  WebToggleCommand=(whiptail --separate-output --radiolist "Do you wish to install the web admin interface?" ${r} ${c} 6)
+  WebChooseOptions=("On (Recommended)" "" on
+      Off "" off)
+  WebChoices=$("${WebToggleCommand[@]}" "${WebChooseOptions[@]}" 2>&1 >/dev/tty) || (echo "::: Cancel selected. Exiting..." && exit 1)
+    case ${WebChoices} in
+      "On (Recommended)")
+        echo "::: Web Interface On."
+        INSTALL_WEB=true
+        ;;
+      Off)
+        echo "::: Web Interface off."
+        INSTALL_WEB=false
+        ;;
+    esac
+}
+
 
 version_check_dnsmasq() {
   # Check if /etc/dnsmasq.conf is from pihole.  If so replace with an original and install new in .d directory
   local dnsmasq_conf="/etc/dnsmasq.conf"
   local dnsmasq_conf_orig="/etc/dnsmasq.conf.orig"
   local dnsmasq_pihole_id_string="addn-hosts=/etc/pihole/gravity.list"
-  local dnsmasq_original_config="/etc/.pihole/advanced/dnsmasq.conf.original"
+  local dnsmasq_original_config="${PI_HOLE_LOCAL_REPO}/advanced/dnsmasq.conf.original"
-  local dnsmasq_pihole_01_snippet="/etc/.pihole/advanced/01-pihole.conf"
+  local dnsmasq_pihole_01_snippet="${PI_HOLE_LOCAL_REPO}/advanced/01-pihole.conf"
   local dnsmasq_pihole_01_location="/etc/dnsmasq.d/01-pihole.conf"
 
   if [ -f ${dnsmasq_conf} ]; then
     echo -n ":::    Existing dnsmasq.conf found..."
     if grep -q ${dnsmasq_pihole_id_string} ${dnsmasq_conf}; then
-      echo " it is from a previous pi-hole install."
+      echo " it is from a previous Pi-hole install."
       echo -n ":::    Backing up dnsmasq.conf to dnsmasq.conf.orig..."
       mv -f ${dnsmasq_conf} ${dnsmasq_conf_orig}
       echo " done."
@@ -563,7 +672,7 @@ version_check_dnsmasq() {
       cp ${dnsmasq_original_config} ${dnsmasq_conf}
       echo " done."
     else
-      echo " it is not a pi-hole file, leaving alone!"
+      echo " it is not a Pi-hole file, leaving alone!"
     fi
   else
     echo -n ":::    No dnsmasq.conf found.. restoring default dnsmasq.conf..."
@@ -635,23 +744,27 @@ installScripts() {
 }
 
 installConfigs() {
-  # Install the configs from /etc/.pihole to their various locations
+  # Install the configs from PI_HOLE_LOCAL_REPO to their various locations
   echo ":::"
-  echo "::: Installing configs..."
+  echo "::: Installing configs from ${PI_HOLE_LOCAL_REPO}..."
   version_check_dnsmasq
-  if [ ! -d "/etc/lighttpd" ]; then
+
-    mkdir /etc/lighttpd
+  #Only mess with lighttpd configs if user has chosen to install web interface
-    chown "${USER}":root /etc/lighttpd
+  if [[ ${INSTALL_WEB} == true ]]; then
-  elif [ -f "/etc/lighttpd/lighttpd.conf" ]; then
+    if [ ! -d "/etc/lighttpd" ]; then
-    mv /etc/lighttpd/lighttpd.conf /etc/lighttpd/lighttpd.conf.orig
+      mkdir /etc/lighttpd
+      chown "${USER}":root /etc/lighttpd
+    elif [ -f "/etc/lighttpd/lighttpd.conf" ]; then
+      mv /etc/lighttpd/lighttpd.conf /etc/lighttpd/lighttpd.conf.orig
+    fi
+    cp ${PI_HOLE_LOCAL_REPO}/advanced/${LIGHTTPD_CFG} /etc/lighttpd/lighttpd.conf
+    mkdir -p /var/run/lighttpd
+    chown ${LIGHTTPD_USER}:${LIGHTTPD_GROUP} /var/run/lighttpd
+    mkdir -p /var/cache/lighttpd/compress
+    chown ${LIGHTTPD_USER}:${LIGHTTPD_GROUP} /var/cache/lighttpd/compress
+    mkdir -p /var/cache/lighttpd/uploads
+    chown ${LIGHTTPD_USER}:${LIGHTTPD_GROUP} /var/cache/lighttpd/uploads
   fi
-  cp /etc/.pihole/advanced/${LIGHTTPD_CFG} /etc/lighttpd/lighttpd.conf
-  mkdir -p /var/run/lighttpd
-  chown ${LIGHTTPD_USER}:${LIGHTTPD_GROUP} /var/run/lighttpd
-  mkdir -p /var/cache/lighttpd/compress
-  chown ${LIGHTTPD_USER}:${LIGHTTPD_GROUP} /var/cache/lighttpd/compress
-  mkdir -p /var/cache/lighttpd/uploads
-  chown ${LIGHTTPD_USER}:${LIGHTTPD_GROUP} /var/cache/lighttpd/uploads
 }
 
 stop_service() {
@@ -692,7 +805,7 @@ enable_service() {
   echo " done."
 }
 
-update_pacakge_cache() {
+update_package_cache() {
   #Running apt-get update/upgrade with minimal output can cause some issues with
   #requiring user input (e.g password for phpmyadmin see #218)
 
@@ -701,8 +814,12 @@ update_pacakge_cache() {
 
   echo ":::"
   echo -n "::: Updating local cache of available packages..."
-  ${UPDATE_PKG_CACHE} &> /dev/null
+  if eval "${UPDATE_PKG_CACHE}" &> /dev/null; then
-  echo " done!"
+    echo " done!"
+  else
+    echo -en "\n!!! ERROR - Unable to update package cache. Please try \"${UPDATE_PKG_CACHE}\""
+    return 1
+  fi
 }
 
 notify_package_updates_available() {
@@ -718,7 +835,7 @@ notify_package_updates_available() {
       echo "::: Your system is up to date! Continuing with Pi-hole installation..."
     else
       echo "::: There are ${updatesToInstall} updates available for your system!"
-      echo "::: We recommend you update your OS after installing Pi-Hole! "
+      echo "::: We recommend you update your OS after installing Pi-hole! "
       echo ":::"
     fi
   else
@@ -748,6 +865,7 @@ install_dependent_packages() {
       fi
     done
     if [[ ${#installArray[@]} -gt 0 ]]; then
+      test_dpkg_lock
       debconf-apt-progress -- "${PKG_INSTALL[@]}" "${installArray[@]}"
       return
     fi
@@ -794,7 +912,7 @@ installPiholeWeb() {
       echo ":::     Existing index.php detected, not overwriting"
     else
       echo -n ":::     index.php missing, replacing... "
-      cp /etc/.pihole/advanced/index.php /var/www/html/pihole/
+      cp ${PI_HOLE_LOCAL_REPO}/advanced/index.php /var/www/html/pihole/
       echo " done!"
     fi
 
@@ -802,7 +920,7 @@ installPiholeWeb() {
       echo ":::     Existing index.js detected, not overwriting"
     else
       echo -n ":::     index.js missing, replacing... "
-      cp /etc/.pihole/advanced/index.js /var/www/html/pihole/
+      cp ${PI_HOLE_LOCAL_REPO}/advanced/index.js /var/www/html/pihole/
       echo " done!"
     fi
 
@@ -810,14 +928,14 @@ installPiholeWeb() {
       echo ":::     Existing blockingpage.css detected, not overwriting"
     else
       echo -n ":::     blockingpage.css missing, replacing... "
-      cp /etc/.pihole/advanced/blockingpage.css /var/www/html/pihole
+      cp ${PI_HOLE_LOCAL_REPO}/advanced/blockingpage.css /var/www/html/pihole
       echo " done!"
     fi
 
   else
     echo ":::     Creating directory for blocking page"
     install -d /var/www/html/pihole
-    install -D /etc/.pihole/advanced/{index,blockingpage}.* /var/www/html/pihole/
+    install -D ${PI_HOLE_LOCAL_REPO}/advanced/{index,blockingpage}.* /var/www/html/pihole/
     if [ -f /var/www/html/index.lighttpd.html ]; then
       mv /var/www/html/index.lighttpd.html /var/www/html/index.lighttpd.orig
     else
@@ -830,7 +948,7 @@ installPiholeWeb() {
   echo ":::"
   echo -n "::: Installing sudoer file..."
   mkdir -p /etc/sudoers.d/
-  cp /etc/.pihole/advanced/pihole.sudo /etc/sudoers.d/pihole
+  cp ${PI_HOLE_LOCAL_REPO}/advanced/pihole.sudo /etc/sudoers.d/pihole
   # Add lighttpd user (OS dependent) to sudoers file
   echo "${LIGHTTPD_USER} ALL=NOPASSWD: /usr/local/bin/pihole" >> /etc/sudoers.d/pihole
 
@@ -848,7 +966,7 @@ installCron() {
   # Install the cron job
   echo ":::"
   echo -n "::: Installing latest Cron script..."
-  cp /etc/.pihole/advanced/pihole.cron /etc/cron.d/pihole
+  cp ${PI_HOLE_LOCAL_REPO}/advanced/pihole.cron /etc/cron.d/pihole
   echo " done!"
 }
 
@@ -862,7 +980,7 @@ runGravity() {
   fi
   # Test if /etc/pihole/adlists.default exists
   if [[ ! -e /etc/pihole/adlists.default ]]; then
-    cp /etc/.pihole/adlists.default /etc/pihole/adlists.default
+    cp ${PI_HOLE_LOCAL_REPO}/adlists.default /etc/pihole/adlists.default
   fi
   echo "::: Running gravity.sh"
   { /opt/pihole/gravity.sh; }
@@ -885,7 +1003,7 @@ configureFirewall() {
     whiptail --title "Firewall in use" --yesno "We have detected a running firewall\n\nPi-hole currently requires HTTP and DNS port access.\n\n\n\nInstall Pi-hole default firewall rules?" ${r} ${c} || \
     { echo -e ":::\n::: Not installing firewall rulesets."; return 0; }
     echo -e ":::\n:::\n Configuring FirewallD for httpd and dnsmasq."
-    firewall-cmd --permanent --add-port=80/tcp --add-port=53/tcp --add-port=53/udp
+    firewall-cmd --permanent --add-service=http --add-service=dns
     firewall-cmd --reload
     return 0
   # Check for proper kernel modules to prevent failure
@@ -900,6 +1018,7 @@ configureFirewall() {
       iptables -C INPUT -p tcp -m tcp --dport 80 -j ACCEPT &> /dev/null || iptables -I INPUT 1 -p tcp -m tcp --dport 80 -j ACCEPT
       iptables -C INPUT -p tcp -m tcp --dport 53 -j ACCEPT &> /dev/null || iptables -I INPUT 1 -p tcp -m tcp --dport 53 -j ACCEPT
       iptables -C INPUT -p udp -m udp --dport 53 -j ACCEPT &> /dev/null || iptables -I INPUT 1 -p udp -m udp --dport 53 -j ACCEPT
+      iptables -C INPUT -p tcp -m tcp --dport 4711:4720 -i lo -j ACCEPT &> /dev/null || iptables -I INPUT 1 -p tcp -m tcp --dport 4711:4720 -i lo -j ACCEPT
       return 0
     fi
   else
@@ -910,9 +1029,20 @@ configureFirewall() {
 }
 
 finalExports() {
+
+  if [[ ${INSTALL_WEB} == false ]]; then
+    #No web interface installed, and therefore no block page set IPV4/6 to 0.0.0.0 and ::/0
+    if [ ${IPV4_ADDRESS} ]; then
+      IPV4_ADDRESS="0.0.0.0"
+    fi
+    if [ ${IPV6_ADDRESS} ]; then
+      IPV6_ADDRESS="::/0"
+    fi
+  fi
+
   # Update variables in setupVars.conf file
   if [ -e "${setupVars}" ]; then
-    sed -i.update.bak '/PIHOLE_INTERFACE/d;/IPV4_ADDRESS/d;/IPV6_ADDRESS/d;/PIHOLE_DNS_1/d;/PIHOLE_DNS_2/d;/QUERY_LOGGING/d;' "${setupVars}"
+    sed -i.update.bak '/PIHOLE_INTERFACE/d;/IPV4_ADDRESS/d;/IPV6_ADDRESS/d;/PIHOLE_DNS_1/d;/PIHOLE_DNS_2/d;/QUERY_LOGGING/d;/INSTALL_WEB/d;' "${setupVars}"
   fi
     {
   echo "PIHOLE_INTERFACE=${PIHOLE_INTERFACE}"
@@ -921,11 +1051,12 @@ finalExports() {
   echo "PIHOLE_DNS_1=${PIHOLE_DNS_1}"
   echo "PIHOLE_DNS_2=${PIHOLE_DNS_2}"
   echo "QUERY_LOGGING=${QUERY_LOGGING}"
+  echo "INSTALL_WEB=${INSTALL_WEB}"
     }>> "${setupVars}"
 
   # Look for DNS server settings which would have to be reapplied
   source "${setupVars}"
-  source "/etc/.pihole/advanced/Scripts/webpage.sh"
+  source "${PI_HOLE_LOCAL_REPO}/advanced/Scripts/webpage.sh"
 
   if [[ "${DNS_FQDN_REQUIRED}" != "" ]] ; then
     ProcessDNSSettings
@@ -940,7 +1071,7 @@ installLogrotate() {
   # Install the logrotate script
   echo ":::"
   echo -n "::: Installing latest logrotate script..."
-  cp /etc/.pihole/advanced/logrotate /etc/pihole/logrotate
+  cp ${PI_HOLE_LOCAL_REPO}/advanced/logrotate /etc/pihole/logrotate
   # Different operating systems have different user / group
   # settings for logrotate that makes it impossible to create
   # a static logrotate file that will work with e.g.
@@ -949,7 +1080,7 @@ installLogrotate() {
   # the local properties of the /var/log directory
   logusergroup="$(stat -c '%U %G' /var/log)"
   if [[ ! -z $logusergroup ]]; then
-    echo "su ${logusergroup}" >> /etc/pihole/logrotate
+    sed -i "s/# su #/su ${logusergroup}/g;" /etc/pihole/logrotate
   fi
   echo " done!"
 }
@@ -957,26 +1088,32 @@ installLogrotate() {
 installPihole() {
   # Install base files and web interface
   create_pihole_user
-  if [ ! -d "/var/www/html" ]; then
+
-    mkdir -p /var/www/html
+  if [[ ${INSTALL_WEB} == true ]]; then
-  fi
+    if [ ! -d "/var/www/html" ]; then
-  chown ${LIGHTTPD_USER}:${LIGHTTPD_GROUP} /var/www/html
+      mkdir -p /var/www/html
-  chmod 775 /var/www/html
+    fi
-  usermod -a -G ${LIGHTTPD_GROUP} pihole
+    chown ${LIGHTTPD_USER}:${LIGHTTPD_GROUP} /var/www/html
-  if [ -x "$(command -v lighty-enable-mod)" ]; then
+    chmod 775 /var/www/html
-    lighty-enable-mod fastcgi fastcgi-php > /dev/null || true
+    usermod -a -G ${LIGHTTPD_GROUP} pihole
-  else
+    if [ -x "$(command -v lighty-enable-mod)" ]; then
-    printf "\n:::\tWarning: 'lighty-enable-mod' utility not found. Please ensure fastcgi is enabled if you experience issues.\n"
+      lighty-enable-mod fastcgi fastcgi-php > /dev/null || true
+    else
+      printf "\n:::\tWarning: 'lighty-enable-mod' utility not found. Please ensure fastcgi is enabled if you experience issues.\n"
+    fi
   fi
   installScripts
   installConfigs
   CreateLogFile
-  installPiholeWeb
+  if [[ ${INSTALL_WEB} == true ]]; then
+    installPiholeWeb
+  fi
   installCron
   installLogrotate
+  FTLdetect || echo "::: FTL Engine not installed."
   configureFirewall
   finalExports
-  runGravity
+  #runGravity
 }
 
 accountForRefactor() {
@@ -996,17 +1133,18 @@ accountForRefactor() {
 
 updatePihole() {
   accountForRefactor
-  # Source ${setupVars} for use in the rest of the functions.
-  source ${setupVars}
   # Install base files and web interface
   installScripts
   installConfigs
   CreateLogFile
-  installPiholeWeb
+  if [[ ${INSTALL_WEB} == true ]]; then
+    installPiholeWeb
+  fi
   installCron
   installLogrotate
+  FTLdetect || echo "::: FTL Engine not installed."
   finalExports #re-export setupVars.conf to account for any new vars added in new versions
-  runGravity
+  #runGravity
 }
 
 
@@ -1028,6 +1166,21 @@ checkSelinux() {
 }
 
 displayFinalMessage() {
+
+  if [[ ${#1} -gt 0 ]] ; then
+    pwstring="$1"
+  elif [[ $(grep 'WEBPASSWORD' -c /etc/pihole/setupVars.conf) -gt 0 ]]; then
+    pwstring="unchanged"
+  else
+    pwstring="NOT SET"
+  fi
+
+   if [[ ${INSTALL_WEB} == true ]]; then
+       additional="View the web interface at http://pi.hole/admin or http://${IPV4_ADDRESS%/*}/admin
+
+Your Admin Webpage login password is ${pwstring}"
+   fi
+
   # Final completion message to user
   whiptail --msgbox --backtitle "Make it so." --title "Installation Complete!" "Configure your devices to use the Pi-hole as their DNS server using:
 
@@ -1037,9 +1190,8 @@ IPv6:	${IPV6_ADDRESS:-"Not Configured"}
 If you set a new IP address, you should restart the Pi.
 
 The install log is in /etc/pihole.
-View the web interface at http://pi.hole/admin or http://${IPV4_ADDRESS%/*}/admin
 
-Your Admin Webpage login password is ${1:-"NOT SET"}" ${r} ${c}
+${additional}" ${r} ${c}
 }
 
 update_dialogs() {
@@ -1073,10 +1225,128 @@ update_dialogs() {
     esac
 }
 
+clone_or_update_repos() {
+  if [[ "${reconfigure}" == true ]]; then
+    echo "::: --reconfigure passed to install script. Resetting changes to local repos"
+    resetRepo ${PI_HOLE_LOCAL_REPO} || \
+      { echo "!!! Unable to reset ${PI_HOLE_LOCAL_REPO}, unable to continue."; \
+        exit 1; \
+      }
+    if [[ ${INSTALL_WEB} == true ]]; then
+      resetRepo ${webInterfaceDir} || \
+        { echo "!!! Unable to reset ${webInterfaceDir}, unable to continue."; \
+          exit 1; \
+        }
+    fi
+  else
+    # Get Git files for Core and Admin
+    getGitFiles ${PI_HOLE_LOCAL_REPO} ${piholeGitUrl} || \
+      { echo "!!! Unable to clone ${piholeGitUrl} into ${PI_HOLE_LOCAL_REPO}, unable to continue."; \
+        exit 1; \
+      }
+
+    if [[ ${INSTALL_WEB} == true ]]; then
+      getGitFiles ${webInterfaceDir} ${webInterfaceGitUrl} || \
+      { echo "!!! Unable to clone ${webInterfaceGitUrl} into ${webInterfaceDir}, unable to continue."; \
+        exit 1; \
+      }
+    fi
+  fi
+}
+
+FTLinstall() {
+  # Download and install FTL binary
+  local binary="${1}"
+  local latesttag
+  local orig_dir
+  echo -n ":::  Installing FTL... "
+
+  orig_dir="${PWD}"
+  latesttag=$(curl -sI https://github.com/pi-hole/FTL/releases/latest | grep "Location" | awk -F '/' '{print $NF}')
+  # Tags should always start with v, check for that.
+  if [[ ! "${latesttag}" == v* ]]; then
+    echo "failed (error in getting latest release location from GitHub)"
+    return 1
+  fi
+  if curl -sSL --fail "https://github.com/pi-hole/FTL/releases/download/${latesttag%$'\r'}/${binary}" -o "/tmp/${binary}"; then
+    # Get sha1 of the binary we just downloaded for verification.
+    curl -sSL --fail "https://github.com/pi-hole/FTL/releases/download/${latesttag%$'\r'}/${binary}.sha1" -o "/tmp/${binary}.sha1"
+    # Check if we just downloaded text, or a binary file.
+    cd /tmp
+    if sha1sum --status --quiet -c "${binary}".sha1; then
+      echo -n "transferred... "
+      stop_service pihole-FTL &> /dev/null
+      install -T -m 0755 /tmp/${binary} /usr/bin/pihole-FTL
+      rm /tmp/${binary} /tmp/${binary}.sha1
+      cd "${orig_dir}"
+      install -T -m 0755 "${PI_HOLE_LOCAL_REPO}/advanced/pihole-FTL.service" "/etc/init.d/pihole-FTL"
+      echo "done."
+      return 0
+    else
+      echo "failed (download of binary from Github failed)"
+      cd "${orig_dir}"
+      return 1
+    fi
+  else
+    cd "${orig_dir}"
+    echo "failed (URL not found.)"
+  fi
+}
+
+FTLdetect() {
+  # Detect suitable FTL binary platform
+  echo ":::"
+  echo "::: Downloading latest version of FTL..."
+
+  local machine
+  local binary
+
+  machine=$(uname -m)
+
+  if [[ $machine == arm* || $machine == *aarch* ]]; then
+    # ARM
+    local rev=$(uname -m | sed "s/[^0-9]//g;")
+    local lib=$(ldd /bin/ls | grep -E '^\s*/lib' | awk '{ print $1 }')
+    if [[ "$lib" == "/lib/ld-linux-aarch64.so.1" ]]; then
+      echo ":::  Detected ARM-aarch64 architecture"
+      binary="pihole-FTL-aarch64-linux-gnu"
+    elif [[ "$lib" == "/lib/ld-linux-armhf.so.3" ]]; then
+      if [ "$rev" -gt "6" ]; then
+        echo ":::  Detected ARM-hf architecture (armv7+)"
+        binary="pihole-FTL-arm-linux-gnueabihf"
+      else
+        echo ":::  Detected ARM-hf architecture (armv6 or lower)"
+        echo ":::  Using ARM binary"
+        binary="pihole-FTL-arm-linux-gnueabi"
+      fi
+    else
+      echo ":::  Detected ARM architecture"
+      binary="pihole-FTL-arm-linux-gnueabi"
+    fi
+  elif [[ $machine == x86_64 ]]; then
+    # 64bit
+    echo ":::  Detected x86_64 architecture"
+    binary="pihole-FTL-linux-x86_64"
+  else
+    # Something else - we try to use 32bit executable and warn the user
+    if [[ ! $machine == i686 ]]; then
+      echo ":::  Not able to detect architecture (unknown: ${machine}), trying 32bit executable"
+      echo ":::  Contact Pi-hole support if you experience problems (like FTL not running)"
+    else
+      echo ":::  Detected 32bit (i686) architecture"
+    fi
+    binary="pihole-FTL-linux-x86_32"
+  fi
+
+  FTLinstall "${binary}" || return 1
+
+}
+
 main() {
 
   ######## FIRST CHECK ########
   # Must be root to install
+  show_ascii_berry
   echo ":::"
   if [[ ${EUID} -eq 0 ]]; then
     echo "::: You are root."
@@ -1127,7 +1397,7 @@ main() {
   fi
 
   # Update package cache
-  update_pacakge_cache
+  update_package_cache || exit 1
 
   # Notify user of package availability
   notify_package_updates_available
@@ -1138,28 +1408,17 @@ main() {
    # Check if SELinux is Enforcing
   checkSelinux
 
-  if [[ "${reconfigure}" == true ]]; then
-    echo "::: --reconfigure passed to install script. Not downloading/updating local repos"
-  else
-    # Get Git files for Core and Admin
-    getGitFiles ${PI_HOLE_LOCAL_REPO} ${piholeGitUrl} || \
-      { echo "!!! Unable to clone ${piholeGitUrl} into ${PI_HOLE_LOCAL_REPO}, unable to continue."; \
-        exit 1; \
-      }
-    getGitFiles ${webInterfaceDir} ${webInterfaceGitUrl} || \
-      { echo "!!! Unable to clone ${webInterfaceGitUrl} into ${webInterfaceDir}, unable to continue."; \
-        exit 1; \
-      }
-  fi
 
   if [[ ${useUpdateVars} == false ]]; then
     # Display welcome dialogs
     welcomeDialogs
     # Create directory for Pi-hole storage
     mkdir -p /etc/pihole/
-    # Stop resolver and webserver while installing proceses
+
     stop_service dnsmasq
-    stop_service lighttpd
+    if [[ ${INSTALL_WEB} == true ]]; then
+      stop_service lighttpd
+    fi
     # Determine available interfaces
     get_available_interfaces
     # Find interfaces and let the user choose one
@@ -1168,17 +1427,38 @@ main() {
     setDNS
     # Let the user decide if they want to block ads over IPv4 and/or IPv6
     use4andor6
+    # Let the user decide if they want the web interface to be installed automatically
+    setAdminFlag
     # Let the user decide if they want query logging enabled...
     setLogging
+    # Clone/Update the repos
+    clone_or_update_repos
+
+       # Install packages used by the Pi-hole
+    if [[ ${INSTALL_WEB} == true ]]; then
+      DEPS=("${PIHOLE_DEPS[@]}" "${PIHOLE_WEB_DEPS[@]}")
+    else
+      DEPS=("${PIHOLE_DEPS[@]}")
+    fi
+    install_dependent_packages DEPS[@]
 
-    # Install packages used by the Pi-hole
-    install_dependent_packages PIHOLE_DEPS[@]
 
     # Install and log everything to a file
     installPihole | tee ${tmpLog}
   else
-    # update packages used by the Pi-hole
+    # Clone/Update the repos
-    install_dependent_packages PIHOLE_DEPS[@]
+    clone_or_update_repos
+
+    # Source ${setupVars} for use in the rest of the functions.
+    source ${setupVars}
+
+    # Install packages used by the Pi-hole
+    if [[ ${INSTALL_WEB} == true ]]; then
+      DEPS=("${PIHOLE_DEPS[@]}" "${PIHOLE_WEB_DEPS[@]}")
+    else
+      DEPS=("${PIHOLE_DEPS[@]}")
+    fi
+    install_dependent_packages DEPS[@]
 
     updatePihole | tee ${tmpLog}
   fi
@@ -1186,25 +1466,37 @@ main() {
   # Move the log file into /etc/pihole for storage
   mv ${tmpLog} ${instalLogLoc}
 
-  # Add password to web UI if there is none
+  if [[ ${INSTALL_WEB} == true ]]; then
-  pw=""
+    # Add password to web UI if there is none
-  if [[ $(grep 'WEBPASSWORD' -c /etc/pihole/setupVars.conf) == 0 ]] ; then
+    pw=""
-      pw=$(tr -dc _A-Z-a-z-0-9 < /dev/urandom | head -c 8)
+    if [[ $(grep 'WEBPASSWORD' -c /etc/pihole/setupVars.conf) == 0 ]] ; then
-      /usr/local/bin/pihole -a -p "${pw}"
+        pw=$(tr -dc _A-Z-a-z-0-9 < /dev/urandom | head -c 8)
-  fi
+        . /opt/pihole/webpage.sh
-
+        echo "WEBPASSWORD=$(HashPassword ${pw})" >> ${setupVars}
-  if [[ "${useUpdateVars}" == false ]]; then
+    fi
-      displayFinalMessage "${pw}"
   fi
 
   echo "::: Restarting services..."
   # Start services
   start_service dnsmasq
   enable_service dnsmasq
-  start_service lighttpd
+
-  enable_service lighttpd
+  if [[ ${INSTALL_WEB} == true ]]; then
+    start_service lighttpd
+    enable_service lighttpd
+  fi
+
+  runGravity
+
+  start_service pihole-FTL
+  enable_service pihole-FTL
+
   echo "::: done."
 
+  if [[ "${useUpdateVars}" == false ]]; then
+      displayFinalMessage "${pw}"
+  fi
+
   echo ":::"
   if [[ "${useUpdateVars}" == false ]]; then
     echo "::: Installation Complete! Configure your devices to use the Pi-hole as their DNS server using:"
@@ -1212,23 +1504,27 @@ main() {
     echo ":::     ${IPV6_ADDRESS}"
     echo ":::"
     echo "::: If you set a new IP address, you should restart the Pi."
-    echo "::: View the web interface at http://pi.hole/admin or http://${IPV4_ADDRESS%/*}/admin"
+    if [[ ${INSTALL_WEB} == true ]]; then
+      echo "::: View the web interface at http://pi.hole/admin or http://${IPV4_ADDRESS%/*}/admin"
+    fi
   else
     echo "::: Update complete!"
   fi
-
+  if [[ ${INSTALL_WEB} == true ]]; then
-  if (( ${#pw} > 0 )) ; then
+    if (( ${#pw} > 0 )) ; then
-    echo ":::"
+  echo ":::"
-    echo "::: Note: As security measure a password has been installed for your web interface"
+      echo "::: Note: As security measure a password has been installed for your web interface"
-    echo "::: The currently set password is"
+      echo "::: The currently set password is"
-    echo ":::                                ${pw}"
+      echo ":::                                ${pw}"
-    echo ":::"
+      echo ":::"
-    echo "::: You can always change it using"
+      echo "::: You can always change it using"
-    echo ":::                                pihole -a -p new_password"
+      echo ":::                                pihole -a -p"
+    fi
   fi
 
   echo ":::"
-  echo "::: The install log is located at: /etc/pihole/install.log"
+  echo "::: The install log is located at: /etc/pihole/install.log
+  "
 }
 
 if [[ "${PH_TEST}" != true ]] ; then

automated install/uninstall.sh

@@ -1,14 +1,14 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # Completely uninstalls Pi-hole
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
+
-# (at your option) any later version.
+
 
 # Must be root to uninstall
 if [[ ${EUID} -eq 0 ]]; then
@@ -154,7 +154,7 @@ removeNoPurge() {
 	${SUDO} rm /usr/local/bin/pihole &> /dev/null
 	${SUDO} rm /etc/bash_completion.d/pihole &> /dev/null
 	${SUDO} rm /etc/sudoers.d/pihole &> /dev/null
-	
+
 	# If the pihole user exists, then remove
 	if id "pihole" >/dev/null 2>&1; then
         	echo "::: Removing pihole user..."
@@ -164,7 +164,7 @@ removeNoPurge() {
 	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"
 }
 
@@ -175,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

gravity.sh

@@ -1,14 +1,14 @@
 #!/usr/bin/env bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # 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
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
+
-# (at your option) any later version.
+
 
 # Run this script as root or under sudo
 echo ":::"
@@ -26,12 +26,15 @@ EOM
 	exit 0
 }
 
+PIHOLE_COMMAND="/usr/local/bin/pihole"
 
 adListFile=/etc/pihole/adlists.list
-adListDefault=/etc/pihole/adlists.default
+adListDefault=/etc/pihole/adlists.default #being deprecated
-whitelistScript="pihole -w"
+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
 setupVars=/etc/pihole/setupVars.conf
@@ -43,14 +46,15 @@ else
 	exit 1
 fi
 
-#Remove the /* from the end of the IPv4addr.
+#Remove the /* from the end of the IP addresses
 IPV4_ADDRESS=${IPV4_ADDRESS%/*}
-IPV6_ADDRESS=${IPV6_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
@@ -69,36 +73,34 @@ fi
 ###########################
 # collapse - begin formation of pihole
 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.
+  echo -n "::: Pulling source lists into range..."
-	if [ -f ${adListFile} ]; then
+  sources=()
-		#custom file found, use this instead of default
+  while IFS= read -r line || [[ -n "$line" ]]; do
-		echo -n "::: Custom adList file detected. Reading..."
+    #Do not read commented out or blank lines
-		sources=()
+    if [[ ${line} = \#* ]] || [[ ! ${line} ]]; then
-		while IFS= read -r line || [[ -n "$line" ]]; do
+      echo "" > /dev/null
-			#Do not read commented out or blank lines
+    else
-			if [[ ${line} = \#* ]] || [[ ! ${line} ]]; then
+      sources+=(${line})
-				echo "" > /dev/null
+    fi
-			else
+  done < ${adListFile}
-				sources+=(${line})
+  echo " done!"
-			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 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 < ${adListDefault}
-		echo " done!"
-	fi
 }
 
 # patternCheck - check to see if curl downloaded any new files.
@@ -167,6 +169,10 @@ gravity_transport() {
 	# 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
@@ -182,22 +188,26 @@ gravity_spinup() {
 		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"
 
 		# 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")
+		    "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"
 		    ;;
 
-            # Default is a simple request
+		    # Default is a simple request
-            *) cmd_ext=""
+		    *) cmd_ext=""
         esac
         if [[ "${skipDownload}" == false ]]; then
             echo -n "::: Getting $domain list..."
@@ -226,15 +236,28 @@ gravity_Blacklist() {
 	if [[ -f "${blacklistFile}" ]]; then
 	    numBlacklisted=$(wc -l < "${blacklistFile}")
 	    plural=; [[ "$numBlacklisted" != "1" ]] && plural=s
-	    echo -n "::: Blacklisting $numBlacklisted domain${plural}..."
+	    echo "::: Exact blocked domain${plural}: $numBlacklisted"
-	    cat ${blacklistFile} >> ${piholeDir}/${eventHorizon}
-	    echo " done!"
 	else
 	    echo "::: Nothing to blacklist!"
 	fi
 
 }
 
+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 ":::"
@@ -275,9 +298,25 @@ gravity_unique() {
 	echo "::: $numberOf unique domains trapped in the event horizon."
 }
 
-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 -n "::: Formatting domains into a HOSTS file..."
 
 	if [[ -f /etc/hostname ]]; then
 		hostname=$(</etc/hostname)
@@ -286,33 +325,32 @@ gravity_hostFormat() {
 	else
 		echo "::: Error: Unable to determine fully qualified domain name of host"
 	fi
-  # Check vars from setupVars.conf to see if we're using IPv4, IPv6, Or both.
-  if [[ -n "${IPV4_ADDRESS}" && -n "${IPV6_ADDRESS}" ]];then
 
-      echo -e "${IPV4_ADDRESS} ${hostname}\n${IPV6_ADDRESS} ${hostname}\n${IPV4_ADDRESS} pi.hole\n${IPV6_ADDRESS} pi.hole" > ${localList}
+	echo -e "${hostname}\npi.hole" > "${localList}.tmp"
-      # Both IPv4 and IPv6
+	# Copy the file over as /etc/pihole/local.list so dnsmasq can use it
-      cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPV4_ADDRESS" -v ipv6addr="$IPV6_ADDRESS" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc}
+	rm "${localList}"
-
+	gravity_doHostFormat "${localList}.tmp" "${localList}"
-  elif [[ -n "${IPV4_ADDRESS}" && -z "${IPV6_ADDRESS}" ]];then
+	rm "${localList}.tmp"
-
+}
-      echo -e "${IPV4_ADDRESS} ${hostname}\n${IPV4_ADDRESS} pi.hole" > ${localList}
-      # Only IPv4
-      cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPV4_ADDRESS" '{sub(/\r$/,""); print ipv4addr" "$0}' >> ${piholeDir}/${accretionDisc}
-
-  elif [[ -z "${IPV4_ADDRESS}" && -n "${IPV6_ADDRESS}" ]];then
-
-      echo -e "${IPV6_ADDRESS} ${hostname}\n${IPV6_ADDRESS} pi.hole" > ${localList}
-      # Only IPv6
-      cat ${piholeDir}/${eventHorizon} | awk -v ipv6addr="$IPV6_ADDRESS" '{sub(/\r$/,""); print ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc}
-
-  elif [[ -z "${IPV4_ADDRESS}" && -z "${IPV6_ADDRESS}" ]];then
-      echo "::: No IP Values found! Please run 'pihole -r' and choose reconfigure to restore values"
-      exit 1
-  fi
 
+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}"
-	echo " done!"
+}
+
+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
@@ -353,11 +391,6 @@ gravity_advanced() {
 }
 
 gravity_reload() {
-	#Clear no longer needed files...
-	echo ":::"
-	echo -n "::: Cleaning up un-needed files..."
-	rm ${piholeDir}/pihole.*.txt
-	echo " done!"
 
 	# Reload hosts file
 	echo ":::"
@@ -369,7 +402,7 @@ gravity_reload() {
 	#Now replace the line in dnsmasq file
 #	sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf
 
-	pihole restartdns
+	"${PIHOLE_COMMAND}" restartdns
 	echo " done!"
 }
 
@@ -378,6 +411,7 @@ for var in "$@"; do
 		"-f" | "--force"     ) forceGrav=true;;
 		"-h" | "--help"      ) helpFunc;;
 		"-sd" | "--skip-download"    ) skipDownload=true;;
+		"-b" | "--blacklist-only"    ) blackListOnly=true;;
 	esac
 done
 
@@ -387,23 +421,39 @@ if [[ "${forceGrav}" == true ]]; then
 	echo " done!"
 fi
 
-#Overwrite adlists.default from /etc/.pihole in case any changes have been made. Changes should be saved in /etc/adlists.list
+if [[ ! "${blackListOnly}" == true ]]; then
-cp /etc/.pihole/adlists.default /etc/pihole/adlists.default
+  gravity_collapse
-gravity_collapse
+  gravity_spinup
-gravity_spinup
+  if [[ "${skipDownload}" == false ]]; then
-if [[ "${skipDownload}" == false ]]; then
     gravity_Schwarzchild
     gravity_advanced
-else
+  else
     echo "::: Using cached Event Horizon list..."
     numberOf=$(wc -l < ${piholeDir}/${preEventHorizon})
-	echo "::: $numberOf unique domains trapped in the event horizon."
+    echo "::: $numberOf unique domains trapped in the event horizon."
+  fi
+  gravity_Whitelist
 fi
-gravity_Whitelist
 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_hostFormat
 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 status
+"${PIHOLE_COMMAND}" status

pihole

@@ -1,20 +1,19 @@
 #!/bin/bash
 # Pi-hole: A black hole for Internet advertisements
-# (c) 2015, 2016 by Jacob Salmela
+# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
-# Network-wide ad blocking via your Raspberry Pi
+# Network-wide ad blocking via your own hardware.
-# http://pi-hole.net
+#
 # Controller for all pihole scripts and functions.
 #
-# Pi-hole is free software: you can redistribute it and/or modify
+# This file is copyright under the latest version of the EUPL.
-# it under the terms of the GNU General Public License as published by
+# Please see LICENSE file for your rights under this license.
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
 
-PI_HOLE_SCRIPT_DIR="/opt/pihole"
+readonly PI_HOLE_SCRIPT_DIR="/opt/pihole"
 readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
+
 # Must be root to use this tool
 if [[ ! $EUID -eq 0 ]];then
-  if [ -x "$(command -v sudo)" ];then
+  if [[ -x "$(command -v sudo)" ]]; then
     exec sudo bash "$0" "$@"
     exit $?
   else
@@ -45,12 +44,24 @@ wildcardFunc() {
 }
 
 debugFunc() {
-  "${PI_HOLE_SCRIPT_DIR}"/piholeDebug.sh
+  local automated
+  local web
+
+  # Pull off the `debug` leaving passed call augmentation flags in $1
+  shift
+  if [[ "$@" == *"-a"* ]]; then
+    automated="true"
+  fi
+  if [[ "$@" == *"-w"* ]]; then
+    web="true"
+  fi
+
+  AUTOMATED=${automated:-} WEBCALL=${web:-} "${PI_HOLE_SCRIPT_DIR}"/piholeDebug.sh
   exit 0
 }
 
 flushFunc() {
-  "${PI_HOLE_SCRIPT_DIR}"/piholeLogFlush.sh
+  "${PI_HOLE_SCRIPT_DIR}"/piholeLogFlush.sh "$@"
   exit 0
 }
 
@@ -116,17 +127,19 @@ queryFunc() {
   done
 
   # Scan for possible wildcard matches
-  local wildcards=($(processWildcards "${domain}"))
+  if [ -e "${wildcardlist}" ]; then
-  for domain in ${wildcards[@]}; do
+    local wildcards=($(processWildcards "${domain}"))
-    result=$(scanList "\/${domain}\/" ${wildcardlist})
+    for domain in ${wildcards[@]}; do
-    # Remove empty lines before couting number of results
+      result=$(scanList "\/${domain}\/" ${wildcardlist})
-    count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
+      # Remove empty lines before couting number of results
-    if [[ ${count} > 0 ]]; then
+      count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
-      echo "::: Wildcard blocking ${domain} (${count} results)"
+      if [[ ${count} > 0 ]]; then
-      echo "${result}"
+        echo "::: Wildcard blocking ${domain} (${count} results)"
-      echo ""
+        echo "${result}"
-    fi
+        echo ""
-  done
+      fi
+    done
+  fi
   exit 0
 }
 
@@ -150,16 +163,16 @@ versionFunc() {
 
 restartDNS() {
   dnsmasqPid=$(pidof dnsmasq)
-  if [[ ${dnsmasqPid} ]]; then
+  if [[ "${dnsmasqPid}" ]]; then
-    # service already running - reload config
+    # Service already running - reload config
-    if [ -x "$(command -v systemctl)" ]; then
+    if [[ -x "$(command -v systemctl)" ]]; then
       systemctl restart dnsmasq
     else
       service dnsmasq restart
     fi
   else
-    # service not running, start it up
+    # Service not running, start it up
-    if [ -x "$(command -v systemctl)" ]; then
+    if [[ -x "$(command -v systemctl)" ]]; then
       systemctl start dnsmasq
     else
       service dnsmasq start
@@ -168,16 +181,29 @@ restartDNS() {
 }
 
 piholeEnable() {
-  if [[ "${1}" == "0" ]] ; then
+  if [[ "${2}" == "-h" ]] || [[ "${2}" == "--help" ]]; then
-    #Disable Pihole
+    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 [[ $# > 1 ]]; then
-      if [[ ${2} == *"s"* ]] ; 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
+      elif [[ "${2}" == *"m"* ]]; then
         tt=${2%"m"}
         echo "::: Blocking will be re-enabled in ${tt} minutes"
         tt=$((${tt}*60))
@@ -191,24 +217,35 @@ piholeEnable() {
       fi
     fi
   else
-    #Enable pihole
+    # 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
 
-  if [[ "${1}" == "off" ]] ; then
+Options:
-    #Disable Logging
+  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
+  elif [[ "${1}" == "on" ]]; then
-    #Enable logging
+    # 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!"
@@ -220,12 +257,12 @@ piholeLogging() {
 }
 
 piholeStatus() {
-  if [[ $(netstat -plnt | grep -c ':53 ') > 0 ]]; then
+  if [[ "$(netstat -plnt | grep -c ':53 ')" -gt "0" ]]; then
-    if [[ "${1}" != "web" ]] ; then
+    if [[ "${1}" != "web" ]]; then
       echo "::: DNS service is running"
     fi
   else
-    if [[ "${1}" == "web" ]] ; then
+    if [[ "${1}" == "web" ]]; then
       echo "-1";
     else
       echo "::: DNS service is NOT running"
@@ -233,28 +270,28 @@ piholeStatus() {
     return
   fi
 
-  if [[ $(grep -i "^#addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf) ]] ; then
+  if [[ "$(grep -i "^#addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf)" ]]; then
-    #list is commented out
+    # List is commented out
-    if [[ "${1}" == "web" ]] ; then
+    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
+  elif [[ "$(grep -i "^addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf)" ]]; then
-    #list set
+    # List set
-    if [[ "${1}" == "web" ]] ; then
+    if [[ "${1}" == "web" ]]; then
       echo 1;
     else
       echo "::: Pi-hole blocking is Enabled";
     fi
   else
-    #addn-host not found
+    # Addn-host not found
-    if [[ "${1}" == "web" ]] ; then
+    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
+    # Add addn-host= to dnsmasq
     echo "addn-hosts=/etc/pihole/gravity.list" >> /etc/dnsmasq.d/01-pihole.conf
     restartDNS
   fi
@@ -266,37 +303,97 @@ tailFunc() {
   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() {
-	cat << EOM
+  echo "Usage: pihole [options]
-::: Control all PiHole specific functions!
+Example: 'pihole -w -h'
-:::
+Add '-h' after specific commands for more information on usage
-::: Usage: pihole [options]
+
-:::		Add -h after -w (whitelist), -b (blacklist), -c (chronometer), or -a (admin)  for more information on usage
+Whitelist/Blacklist Options:
-:::
+  -w, whitelist       Whitelist domain(s)
-::: Options:
+  -b, blacklist       Blacklist domain(s)
-:::  -w, whitelist            Whitelist domains
+  -wild, wildcard     Blacklist domain(s), and all its subdomains
-:::  -b, blacklist            Blacklist domains
+                        Add '-h' for more info on whitelist/blacklist usage
-:::  -d, debug                Start a debugging session if having trouble
+
-:::  -f, flush                Flush the pihole.log file
+Debugging Options:
-:::  -t, tail                 Output the last lines of the pihole.log file. Lines are appended as the file grows
+  -d, debug           Start a debugging session
-:::  -up, updatePihole        Update Pi-hole
+                        Add '-a' to enable automated debugging
-:::  -r, reconfigure          Reconfigure or Repair Pi-hole
+  -f, flush           Flush the Pi-hole log
-:::  -g, updateGravity        Update the list of ad-serving domains
+  -r, reconfigure     Reconfigure or Repair Pi-hole subsystems
-:::  -c, chronometer          Calculates stats and displays to an LCD
+  -t, tail            View the live output of the Pi-hole log
-:::  -h, help                 Show this help dialog
+
-:::  -v, version              Show current versions
+Options:
-:::  -q, query                Query the adlists for a specific domain
+  -a, admin           Admin Console options
-:::                           Use pihole -q domain -exact if you want to see exact matches only
+                        Add '-h' for more info on admin console usage
-:::  -l, logging              Enable or Disable logging (pass 'on' or 'off')
+  -c, chronometer     Calculates stats and displays to an LCD
-:::  -a, admin                Admin webpage options
+                        Add '-h' for more info on chronometer usage
-:::  uninstall                Uninstall Pi-Hole from your system :(!
+  -g, updateGravity   Update the list of ad-serving domains
-:::  status                   Is Pi-Hole Enabled or Disabled
+  -h, --help, help    Show this help dialog
-:::  enable                   Enable Pi-Hole DNS Blocking
+  -l, logging         Specify whether the Pi-hole log should be used
-:::  disable                  Disable Pi-Hole DNS Blocking
+                        Add '-h' for more info on logging usage
-:::                           Blocking can also be disabled only temporarily, e.g.,
+  -q, query           Query the adlists for a specified domain
-:::                           pihole disable 5m - will disable blocking for 5 minutes
+                        Add '-exact' AFTER a specified domain for exact match
-:::  restartdns               Restart dnsmasq
+  -up, updatePihole   Update Pi-hole subsystems
-EOM
+  -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
 }
 
@@ -309,8 +406,8 @@ case "${1}" in
   "-w" | "whitelist"            ) whitelistFunc "$@";;
   "-b" | "blacklist"            ) blacklistFunc "$@";;
   "-wild" | "wildcard"          ) wildcardFunc "$@";;
-  "-d" | "debug"                ) debugFunc;;
+  "-d" | "debug"                ) debugFunc "$@";;
-  "-f" | "flush"                ) flushFunc;;
+  "-f" | "flush"                ) flushFunc "$@";;
   "-up" | "updatePihole"        ) updatePiholeFunc;;
   "-r"  | "reconfigure"         ) reconfigurePiholeFunc;;
   "-g" | "updateGravity"        ) updateGravityFunc "$@";;
@@ -321,10 +418,12 @@ case "${1}" in
   "-l" | "logging"              ) piholeLogging "$@";;
   "uninstall"                   ) uninstallFunc;;
   "enable"                      ) piholeEnable 1;;
-  "disable"                     ) piholeEnable 0 $2;;
+  "disable"                     ) piholeEnable 0 "$2";;
   "status"                      ) piholeStatus "$2";;
   "restartdns"                  ) restartDNS;;
   "-a" | "admin"                ) webpageFunc "$@";;
   "-t" | "tail"                 ) tailFunc;;
+  "checkout"                    ) piholeCheckoutFunc "$@";;
+  "tricorder"                   ) tricorderFunc;;
   *                             ) helpFunc;;
 esac

test/debian.Dockerfile

@@ -1,4 +1,4 @@
-FROM debian:jessie
+FROM buildpack-deps:jessie-scm
 
 ENV GITDIR /etc/.pihole
 ENV SCRIPTDIR /opt/pihole

test/test_automated_install.py

@@ -78,7 +78,7 @@ def test_configureFirewall_firewalld_running_no_errors(Pihole):
     assert expected_stdout in configureFirewall.stdout
     firewall_calls = Pihole.run('cat /var/log/firewall-cmd').stdout
     assert 'firewall-cmd --state' in firewall_calls
-    assert 'firewall-cmd --permanent --add-port=80/tcp --add-port=53/tcp --add-port=53/udp' 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):
@@ -274,6 +274,189 @@ def test_installPiholeWeb_already_populated_no_errors(Pihole):
     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 '''
@@ -296,6 +479,27 @@ def mock_command(script, args, container):
     chmod +x {script}
     rm -f /var/log/{scriptlog}'''.format(script=full_script_path, content=mock_script, scriptlog=script))
 
+def mock_command_2(script, args, container):
+    ''' Allows for setup of commands we don't really want to have to run for real in unit tests '''
+    full_script_path = '/usr/local/bin/{}'.format(script)
+    mock_script = dedent('''\
+    #!/bin/bash -e
+    echo "\$0 \$@" >> /var/log/{script}
+    case "\$1 \$2" in'''.format(script=script))
+    for k, v in args.iteritems():
+        case = dedent('''
+        \"{arg}\")
+        echo \"{res}\"
+        exit {retcode}
+        ;;'''.format(arg=k, res=v[0], retcode=v[1]))
+        mock_script += case
+    mock_script += dedent('''
+    esac''')
+    container.run('''
+    cat <<EOF> {script}\n{content}\nEOF
+    chmod +x {script}
+    rm -f /var/log/{scriptlog}'''.format(script=full_script_path, content=mock_script, scriptlog=script))
+
 def run_script(Pihole, script):
     result = Pihole.run(script)
     assert result.rc == 0

test/test_shellcheck.py

@@ -7,7 +7,7 @@ run_local = testinfra.get_backend(
 
 def test_scripts_pass_shellcheck():
     ''' Make sure shellcheck does not find anything wrong with our shell scripts '''
-    shellcheck = "find . -type f \( -name 'update.sh' -o -name 'piholeDebug.sh' \) | while read file; do shellcheck \"$file\"; done;"
+    shellcheck = "find . -type f -name 'update.sh' | while read file; do shellcheck -x \"$file\" -e SC1090,SC1091; done;"
     results = run_local(shellcheck)
     print results.stdout
     assert '' == results.stdout