[Staging] 3.1 (#1502)

* Fix handling of wildcard help text

* Rewrite help text for better handling of params

* Replace misleading letter variable

* stash changes on branch switch, else it fails if any changes have been made.

* Make changes according to comment in #1384

* Update queryFunc()

* Allow scanList() to search files using a wildcard by removing quotes wrapped around `${list}`
* scanList() will not provide a domain ouput on each string if exact is specified (`grep -l`)
* Remove unused processWildcards() function
* Return a message if no domain is specified
* IDN domains are converted to punycode when running a `pihole -q` search if the `python` package is available, otherwise will revert to current behaviour
* Scan Blacklist & Wildcards first, exiting from search if a match is found (Fixes #1330)
* Use one `grep` subshell to search for all "*.domains" lists at once (opposed to looping to get every matching file name, and then spawning a `grep` instance for every matching file)
* queryFunc() will not return "(0 results)" output from files where no match is found
* Sort results based off list number
* Return a message if no results are found

* Update basic-install.sh

* Update block page. Allow for setupVars setting of CUSTOMBLOCKPAGE (bool) to prevent it being overwritten

* simplify

* further simplify

* fix inteliJ IDEA complaints

* even further simplify

* tidy up output

* revert line, looks tidyer

* clarify

* Revert "Ensure any changes to blocking page are updated."

* We test for dpkg lock on line 830 directly, no need for the check also
in the template section.

Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>

* Display FTL version & version.sh rewrite

While testing to make sure `pihole -v` would output `pihole-FTL version`, I noticed some options didn't work how I expected them to. For example, if I use `pihole -v -p`, I would expect to see the version output of Pi-hole Core. Instead, I'm informed that it's an invalid option.

I've had the following things in mind while rewriting this:
  * I'm operating under the assumption that FTL is only installed if the Admin Console is (Line 113 exit 0)
  * I have modified the help text to only output with `pihole -v --help`
  * I have modified all output to be more similar to the output style of `grep` and `curl` (Ditching ":::")

Testing output:
```
w3k@MCT:~$ pihole -v
  Pi-hole version is v3.0.1-14-ga928cd3 (Latest: v3.0.1)
  Admin Console version is v3.0-9-g3760482 (Latest: v3.0.1)
  FTL version is v2.6.2 (Latest: v2.6.2)
w3k@MCT:~$ pihole -v -c
  Current Pi-hole version is v3.0.1-14-ga928cd3
  Current Admin Console version is v3.0-9-g3760482
  Current FTL version is v2.6.2
w3k@MCT:~$ pihole -v -l
  Latest Pi-hole version is v3.0.1
  Latest Admin Console version is v3.0.1
  Latest FTL version is v2.6.2
w3k@MCT:~$ pihole -v -p --hash
  Current Pi-hole hash is a928cd3
w3k@MCT:~$ pihole -v -a --hash
  Current Admin Console hash is 3760482
w3k@MCT:~$ pihole -v --help
Usage: pihole -v [REPO | OPTION] [OPTION]
Show Pi-hole, Web Admin & FTL versions
  <Shows all Repositories and Options>
w3k@MCT:~$ pihole -v -foo
  Invalid Option!
```

* Update -h to work as --hash

Also provide error output as per https://github.com/pi-hole/pi-hole/pull/1447#issuecomment-300600093

* Perform EXACT searches on HOSTS lists correctly

`\s` on the end may be overkill, but it is the existing scanList() behaviour.

* Fixed indentation

* Minimise string duplication & other minor changes

Instead of duplicating output strings, rewrite core/web/ftlOutput() into one neat versionOutput().

* Modified syntax to be valid for Shellcheck

* Log and echo gateway responses

* Update queryFunc() to search Whitelist

If there is a match in Whitelist/Blacklist/Wildcards, `[ ! -t 1 ]` will cause the search to end if the terminal is closed when the script is called. This has the intended effect of allowing a user to search for a W/B/W domain (as well as all the adlists it's found in) using `pihole -q` via Terminal, but the script will stop searching after a W/B/W match when called by the block page.

* Wrap in double brackets

* Provide remote hashes for version.sh

 * Provide remote hashes for comparison
 * Use double braces for all conditions (for consistency)
 * Suppress potential "cd" error output
 * Provide "not applicable" output upon any hash request for FTL

* whitelist on website blocked doesnt work (#1452)

Since Pi-hole redirects ad domains to itself, accessing the script via de.ign.com is the same as pi.hole in this case. The fix should be as simple as adding a / before admin on this line.

* Solve piholeLogFlush.sh having to be issued 2 x to clear logs (#1460)

Simplified the command -v syntax, and added a sleep 3 timer to the first execution of the log rotation. The second execution was being issued while the first was still running, thus it would fail and you would have to issue the "Flush Logs" command a second time.

* Use `echo "ABC" | pihole tricorder` to upload to Pi-hole's medical tricorder. Uses SSL if available.

* Update list.sh

I believe this has feature parity with `sed /foo/ Id` but also supports busybox, and my alpine docker ;)

* Document `sed` substitution for user readability

Comment the oneliner with explanations of what each step does.

* Update Help Output (#1467)



* File consistency

* Tabs to 2 spaces
* Corrected indenting
* Double braced conditionals
* Quoted variables within conditionals

* Standardise core help text

* Added help text for disable command
* Added help text for logging command

* Clean up

* Fixed certain new lines and spaces

* Sync with development branch

* Formatting consistency

* Tabs to 2 spaces
* Corrected indenting
* Double braced conditionals
* Quoted variables within conditionals
* Fixed certain newlines and spaces

* Admin help text

* Added help text for interface command

* Sync with development branch

* Formatting consistency

* Tabs to 2 spaces
* Fixed some wording
* Fixed certain spaces

* Formatting consistency

* Minor wording changes
* Tabs to 2 spaces
* Corrected indenting
* Double braced conditionals
* Quoted variables within conditionals
* Fixed certain newlines and spaces

* Blacklist help text

* Formatting consistency

* Tabs to 2 spaces
* Corrected indenting

* Cronometer help text

* Formatting consistency

* Fixed certain newlines and spaces
* Corrected indenting

* Checkout warning alteration

* Add checkout help text

* Corrected help output

* Show help for "pihole -a -i --help"

* Fix "pihole disable --help" and "pihole -l --help"

* Show help for "pihole -v -h" 

* Indent output text
* Minor help text change

* Show help for "pihole checkout --help"

* Tricorder: Insecure Opt-out

* Check to see if Tricorder is being called directly
* Provide opt-out for insecure transmission of debug log
* Remove mention of internal function from help menu

* 🌮 is the new :shipit: squirrel

* Wording changes and bug fix

* Fix wildcard help text

* -wild is not a valid option since we're already using -wild

* Fix logrotation: manual flushing should be done twice, but automated rotation at midnight should only be done *once*!

* Print echos only when manual flushing is requested

* Add "quiet" mode + update comments in the cron file

* Confirm Tricorder is online

* Scan port 9998 to confirm the availability of "tricorder.pi-hole.net"
* Exit codes for upload process

* Formatting consistency

* Add link to Windows DNS Swapper

See #1400

* Install loopback firewall rules for FTL (#1419)

* Install loopback firewall rules for FTL

* FirewallD FTL ports

Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>

* Remove firewallD FTL local rules.

Local rules should not be blocked in firewallD, not requred for internal service FTD>

* Reinstate https rules, and delete FTL rules

Fixes earlier commit.

* Retrieve local repos on repair (#1481)

* Retrieve local repos on repair

* Change conditional to check for repair
* Change wording of Update/Reconfigure message
* Fixed indenting

* Perform "git reset --hard" on reconfigure

* Change directory before trying to reset repository. Fixes #1489

* No need to `cd $PWD` as it doesn't affect flow of caller script.

Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>

* Refine output of password status in basic-install.sh:displayFinalMessage(). Fixes #1488 (#1490)

* Rewrite Chronometer to output more stats

* Fix output IPv4 addr when removing CIDR notation (#1498)

* Move wildcards file if blocking is disabled (#1495)

* Move wildcards file if blocking is diabled

* Delete newline

* Roll back merge #1417 (#1494)

* Update ISSUE_TEMPLATE.md

* Remove Question option

* Prefer ULA over GUA addresses [IPv6] (#1508)

* On installs with GUA and ULA's we should prefer ULA's as it's been demonstrated that GUA's can and often are rotated by ISPs. Fixes #1473

* Add test for link-local address detection

* Add ULA-only and GUA-only tests

* Add test_IPv6_GUA_ULA_test and test_IPv6_ULA_GUA_test

* Add ""

* Add mock_command_2 command that can mock a command with more than one argument (as "ip -6 address") and result multiple lines of results

* Make mock_command_2 more similar to the original mock_command

* Correct comments

* Fixed remaining comments

* Fixed one last comment...

* Fixed a comment...

* Add weekly logrotation of FTL's log (#1509)

* Update LICENSE of the project to EUPL v1.2

* Make clear that NO is the default if the user just hits return (#1514)

* Add tricorderFunc back as usable function (#1515)

As per #1464

* Don't update FTL when there is a core update (as this will update FTL a second time). Fixes #1516

* Add FTL tests to the test suite (#1510)

* Add first version of FTL tests

* Wait one second to allow FTL to start up and analyze our mock log

* Add test_FTL_telnet_statistics

* Added test_FTL_telnet_top_clients

* Add test_FTL_telnet_top_domains

* Revert "Add FTL tests to the test suite (#1510)" (#1519)

This reverts commit cf6a1ac9ad.

* Trim version output when update is successful (#1527)

* Change ownership of /etc/pihole to user/group pihole. Fixes #1529 (#1530)

* Delete temporary files after installing the FTL binary. Fixes #1525

* Change from admin to approvers teams

* Introduce new file black.list for blacklist content

* Add "pihole -g -b" to *only* update black.list (saves a bunch of time when adding/changing only blacklisted files - won'tdownload lal lists, but only processes the blacklist and restars dnsmasq)

* Remove useless cat

* Improve displayed messages and overall logic

* Disable black.list on "pihole disable"

* cp + rm === mv (well, almost)

.github/ISSUE_TEMPLATE.md

@@ -9,7 +9,7 @@
 _{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.
 

.pullapprove.yml

@@ -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
@@ -35,4 +35,4 @@ groups:
         - master
     required: 4
     teams:
-      - admin
+      - approvers

LICENSE

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

README.md

@@ -156,6 +156,7 @@ You can view [real-time stats](https://discourse.pi-hole.net/t/how-do-i-view-my-
 -   [Let your blink1 device blink when Pi-hole filters ads](https://gist.github.com/elpatron68/ec0b4c582e5abf604885ac1e068d233f)
 -   [Pi-hole Prometheus exporter](https://github.com/nlamirault/pihole_exporter): a [Prometheus](https://prometheus.io/) exporter for Pi-hole
 -   [Pi-hole Droid - open source Android client](https://github.com/friimaind/pi-hole-droid)
+-   [Windows DNS Swapper](https://github.com/roots84/DNS-Swapper), see [#1400](https://github.com/pi-hole/pi-hole/issues/1400)
 
 ## Coverage
 

advanced/01-pihole.conf

@@ -22,6 +22,7 @@
 
 addn-hosts=/etc/pihole/gravity.list
 addn-hosts=/etc/pihole/local.list
+addn-hosts=/etc/pihole/black.list
 
 domain-needed
 

advanced/Scripts/chronometer.sh

@@ -8,101 +8,428 @@
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
-#Functions##############################################################################################################
+# Retrieve stats from FTL engine
-piLog="/var/log/pihole.log"
+pihole-FTL() {
-gravity="/etc/pihole/gravity.list"
+  ftl_port=$(cat /var/run/pihole-FTL.port 2> /dev/null)
-
+  if [[ -n "$ftl_port" ]]; then
-. /etc/pihole/setupVars.conf
-
-function GetFTLData {
     # Open connection to FTL
-    exec 3<>/dev/tcp/localhost/"$(cat /var/run/pihole-FTL.port)"
+    exec 3<>"/dev/tcp/localhost/$ftl_port"
 
     # Test if connection is open
-    if { >&3; } 2> /dev/null; then
+    if { "true" >&3; } 2> /dev/null; then
-       # Send command to FTL
+      # Send command to FTL
-       echo -e ">$1" >&3
+      echo -e ">$1" >&3
 
-       # Read input
+      # Read input
-       read -r -t 1 LINE <&3
+      read -r -t 1 LINE <&3
-       until [ ! $? ] || [[ "$LINE" == *"EOM"* ]]; do
+      until [[ ! $? ]] || [[ "$LINE" == *"EOM"* ]]; do
-           echo "$LINE" >&1
+         echo "$LINE" >&1
-           read -r -t 1 LINE <&3
+         read -r -t 1 LINE <&3
-       done
+      done
 
-       # Close connection
+      # Close connection
-       exec 3>&-
+      exec 3>&-
-       exec 3<&-
+      exec 3<&-
    fi
+  else
+    echo -e "${COL_LIGHT_RED}FTL offline${COL_NC}"
+  fi
 }
 
-outputJSON() {
+# Print spaces to align right-side content
-	get_summary_data
+printFunc() {
-	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}}"
+  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
 }
 
-get_summary_data() {
+# Perform on first Chrono run (not for JSON formatted string)
-	local summary=$(GetFTLData "stats")
+get_init_stats() {
-	domains_being_blocked_raw=$(grep "domains_being_blocked" <<< "${summary}" | grep -Eo "[0-9]+$")
+  LC_NUMERIC=C
-	domains_being_blocked=$(printf "%'.f" ${domains_being_blocked_raw})
+  calcFunc(){ awk "BEGIN {print $*}"; }
-	dns_queries_today_raw=$(grep "dns_queries_today" <<< "$summary" | grep -Eo "[0-9]+$")
+
-	dns_queries_today=$(printf "%'.f" ${dns_queries_today_raw})
+  # Convert bytes to human-readable format
-	ads_blocked_today_raw=$(grep "ads_blocked_today" <<< "$summary" | grep -Eo "[0-9]+$")
+  hrBytes() {
-	ads_blocked_today=$(printf "%'.f" ${ads_blocked_today_raw})
+    awk '{
-	ads_percentage_today_raw=$(grep "ads_percentage_today" <<< "$summary" | grep -Eo "[0-9.]+$")
+      num=$1;
-	LC_NUMERIC=C ads_percentage_today=$(printf "%'.f" ${ads_percentage_today_raw})
+      if(num==0) {
+        print "0 B"
+      } else {
+        xxx=(num<0?-num:num)
+        sss=(num<0?-1:1)
+        split("B KB MB GB TB PB",type)
+        for(i=5;yyy < 1;i--) {
+          yyy=xxx / (2^(10*i))
+        }
+        printf "%.0f " type[i+2], yyy*sss
+      }
+    }' <<< "$1";
+  }
+
+  # Convert seconds to human-readable format
+  hrSecs() { 
+    day=$(( $1/60/60/24 )); hrs=$(( $1/3600%24 )); mins=$(( ($1%3600)/60 )); secs=$(( $1%60 ))
+    [[ "$day" -ge "2" ]] && plu="s"
+    [[ "$day" -ge "1" ]] && days="$day day${plu}, " || days=""
+    printf "%s%02d:%02d:%02d\n" "$days" "$hrs" "$mins" "$secs"
+  }
+
+  # Set Colour Codes
+  coltable="/opt/pihole/COL_TABLE"
+  if [[ -f "${coltable}" ]]; then
+    source ${coltable}
+  else
+    COL_NC=''
+    COL_DARK_GRAY=''
+    COL_LIGHT_GREEN=''
+    COL_LIGHT_BLUE=''
+    COL_LIGHT_RED=''
+    COL_YELLOW=''
+    COL_LIGHT_RED=''
+    COL_URG_RED=''
+  fi
+
+  # Get RPi model number, or OS distro info
+  if command -v vcgencmd &> /dev/null; then
+    sys_rev=$(awk '/Revision/ {print $3}' < /proc/cpuinfo)
+    case "$sys_rev" in
+      000[2-6]) sys_model=" 1, Model B";; # 256MB
+      000[7-9]) sys_model=" 1, Model A" ;; # 256MB
+      000d|000e|000f) sys_model=" 1, Model B";; # 512MB
+      0010|0013) sys_model=" 1, Model B+";; # 512MB
+      0012|0015) sys_model=" 1, Model A+";; # 256MB
+      a0104[0-1]|a21041|a22042) sys_model=" 2, Model B";; # 1GB
+      900021) sys_model=" 1, Model A+";; # 512MB
+      900032) sys_model=" 1, Model B+";; # 512MB
+      90009[2-3]|920093) sys_model=" Zero";; # 512MB
+      9000c1) sys_model=" Zero W";; # 512MB
+      a02082|a[2-3]2082) sys_model=" 3, Model B";; # 1GB
+      *) sys_model="" ;;
+    esac
+    sys_type="Raspberry Pi$sys_model"
+  else
+    source "/etc/os-release"
+    CODENAME=$(sed 's/[()]//g' <<< "${VERSION/* /}")
+    sys_type="${NAME/ */} ${CODENAME^} $VERSION_ID"
+  fi
+
+  # Get core count
+  sys_cores=$(grep -c "^processor" /proc/cpuinfo)
+  [[ "$sys_cores" -ne 1 ]] && sys_cores_plu="cores" || sys_cores_plu="core"
+
+  # Test existence of clock speed file for ARM CPU
+  if [[ -f "/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq" ]]; then
+    scaling_freq_file="/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq"
+  fi
+
+  # Test existence of temperature file
+  if [[ -f "/sys/class/thermal/thermal_zone0/temp" ]]; then
+    temp_file="/sys/class/thermal/thermal_zone0/temp"
+  elif [[ -f "/sys/class/hwmon/hwmon0/temp1_input" ]]; then 
+    temp_file="/sys/class/hwmon/hwmon0/temp1_input"
+  else
+    temp_file=""
+  fi
+
+  # Test existence of setupVars config
+  if [[ -f "/etc/pihole/setupVars.conf" ]]; then
+    setupVars="/etc/pihole/setupVars.conf"
+  fi
 }
 
-normalChrono() {
+get_sys_stats() {
-	for (( ; ; )); do
+  local ph_ver_raw
-		get_summary_data
+  local cpu_raw
-		domain=$(GetFTLData recentBlocked)
+  local ram_raw
-		clear
+  local disk_raw
-		# Displays a colorful Pi-hole logo
-		echo " ___ _     _        _"
-		echo "| _ (_)___| |_  ___| |___"
-		echo "|  _/ |___| ' \/ _ \ / -_)"
-		echo "|_| |_|   |_||_\___/_\___|"
-		echo ""
-		echo "        ${IPV4_ADDRESS}"
-		echo ""
-		uptime | cut -d' ' -f11-
-		#uptime -p	#Doesn't work on all versions of uptime
-		uptime | awk -F'( |,|:)+' '{if ($7=="min") m=$6; else {if ($7~/^day/) {d=$6;h=$8;m=$9} else {h=$6;m=$7}}} {print d+0,"days,",h+0,"hours,",m+0,"minutes."}'
-		echo "-------------------------------"
-		echo "Recently blocked:"
-		echo "  $domain"
 
-		echo "Blocking:      ${domains_being_blocked}"
+  # Update every 12 refreshes (Def: every 60s)
-		echo "Queries:       ${dns_queries_today}"
+  count=$((count+1))
-		echo "Pi-holed:      ${ads_blocked_today} (${ads_percentage_today}%)"
+  if [[ "$count" == "1" ]] || (( "$count" % 12 == 0 )); then
-
+    [[ -n "$setupVars" ]] && source "$setupVars"
-		sleep 5
+    
-	done
+    
+    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
 }
 
-displayHelp() {
+get_ftl_stats() {
-	cat << EOM
+  local stats_raw
-::: Displays stats about your piHole!
+  
-:::
+  stats_raw=($(pihole-FTL "stats"))
-::: Usage: sudo pihole -c [optional:-j]
+  domains_being_blocked_raw="${stats_raw[1]}"
-::: Note: If no option is passed, then stats are displayed on screen, updated every 5 seconds
+  dns_queries_today_raw="${stats_raw[3]}"
-:::
+  ads_blocked_today_raw="${stats_raw[5]}"
-::: Options:
+  ads_percentage_today_raw="${stats_raw[7]}"
-:::  -j, --json		output stats as JSON formatted string
+
-:::  -h, --help		display this help text
+  # Only retrieve these stats when not called from jsonFunc
-EOM
+  if [[ -z "$1" ]]; then
-    exit 0
+    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

@@ -3,14 +3,12 @@
 # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
 # Network-wide ad blocking via your own hardware.
 #
-# Whitelists and blacklists domains
+# Whitelist and blacklist domains
 #
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
-
+# Globals
-
-#globals
 basename=pihole
 piholeDir=/etc/${basename}
 whitelist=${piholeDir}/whitelist.txt
@@ -27,122 +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 wildcard 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-\.].*)^((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9-]+\.)*[a-z]{2,63}/')
+  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}"
-			if [[ "${listMain}" == "${whitelist}" || "${listMain}" == "${blacklist}" ]]; then
+      RemoveDomain "${dom}" "${listAlt}"
-			  RemoveDomain "${dom}" "${wildcardlist}"
+      if [[ "${listMain}" == "${whitelist}" || "${listMain}" == "${blacklist}" ]]; then
-			fi
+        RemoveDomain "${dom}" "${wildcardlist}"
-		else
+      fi
-			RemoveDomain "${dom}" "${listMain}"
+    else
-		fi
+      RemoveDomain "${dom}" "${listMain}"
-	done
+    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() {
@@ -150,85 +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

@@ -3,7 +3,7 @@
 # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
 # Network-wide ad blocking via your own hardware.
 #
-# Checkout other branches than master
+# Switch Pi-hole subsystems to a different Github branch
 #
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
@@ -18,9 +18,12 @@ PH_TEST="true" source "${PI_HOLE_FILES_DIR}/automated install/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}"
@@ -35,7 +38,7 @@ fully_fetch_repo() {
   return 0
 }
 
-get_available_branches(){
+get_available_branches() {
   # Return available branches
   local directory="${1}"
 
@@ -54,6 +57,8 @@ fetch_checkout_pull_branch() {
   # 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
 }
@@ -79,23 +84,23 @@ checkout_pull_branch() {
 }
 
 warning1() {
-  echo "::: Note that changing the branch is a severe change of your Pi-hole system."
+  echo "  Please note that changing branches severely alters your Pi-hole subsystems"
-  echo "::: This is not supported unless one of the developers explicitly asks you to do this!"
+  echo "  Features that work on the master branch, may not on a development branch"
-  read -r -p "::: Have you read and understood this? [y/N] " response
+  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."
+    echo "::: Continuing with branch change."
     return 0
     ;;
   *)
-    echo "::: Aborting."
+    echo "::: Branch change has been cancelled."
     return 1
     ;;
   esac
 }
 
-checkout()
+checkout() {
-{
   local corebranches
   local webbranches
 
@@ -192,11 +197,10 @@ checkout()
   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
+      exit 0
     else
-     echo "Unable to complete update, contact Pi-hole"
+      echo "Unable to complete update, contact Pi-hole"
-     exit 1
+      exit 1
     fi
   fi
 }
-

advanced/Scripts/piholeDebug.sh

@@ -260,18 +260,18 @@ ip_ping_check() {
   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
-     echo "Gateway did not respond."
+     log_echo "Gateway did not respond."
      return 1
     else
-      echo "Gateway responded."
+      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
-      echo "Query did not respond."
+      log_echo "Query did not respond."
       return 1
     else
-      echo "Query responded."
+      log_echo "Query responded."
       log_write "${ping_inet}"
     fi
   else

advanced/Scripts/piholeLogFlush.sh

@@ -8,17 +8,38 @@
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
-echo -n "::: Flushing /var/log/pihole.log ..."
+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
-  # Flush twice to move all data out of sight of FTL
+if [[ "$@" == *"once"* ]]; then
-  /usr/sbin/logrotate --force /etc/pihole/logrotate
+  # Nightly logrotation
-  /usr/sbin/logrotate --force /etc/pihole/logrotate
+  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
-  # Flush both pihole.log and pihole.log.1 (if existing)
+  # Manual flushing
-  echo " " > /var/log/pihole.log
+  if command -v /usr/sbin/logrotate >/dev/null; then
-  if [ -f /var/log/pihole.log.1 ]; then
+    # Logrotate twice to move all data out of sight of FTL
-    echo " " > /var/log/pihole.log.1
+    /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
-echo "... done!"
+
+if [[ "$@" != *"quiet"* ]]; then
+  echo "... done!"
+fi

advanced/Scripts/update.sh

@@ -117,7 +117,10 @@ main() {
     echo "::: FTL:            up to date"
   fi
 
-  if ${FTL_update}; then
+  # Logic: Don't update FTL when there is a core update available
+  # since the core update will run the installer which will itself
+  # re-install (i.e. update) FTL
+  if ${FTL_update} && ! ${core_update}; then
     echo ":::"
     echo "::: FTL out of date"
     FTLdetect
@@ -194,21 +197,21 @@ main() {
   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/bin/pihole-FTL tag)"
+    FTL_version_current="$(/usr/local/bin/pihole version --ftl --current)"
     echo ":::"
-    echo "::: FTL version is now at ${FTL_version_current}"
+    echo "::: FTL version is now at ${FTL_version_current/* v/v}}"
     start_service pihole-FTL
     enable_service pihole-FTL
   fi

advanced/Scripts/version.sh

@@ -3,24 +3,29 @@
 # (c) 2017 Pi-hole, LLC (https://pi-hole.net)
 # Network-wide ad blocking via your own hardware.
 #
-# shows version numbers
+# Show version numbers
 #
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
 # Variables
 DEFAULT="-1"
-PHGITDIR="/etc/.pihole/"
+COREGITDIR="/etc/.pihole/"
 WEBGITDIR="/var/www/html/admin/"
 
 getLocalVersion() {
+  # FTL requires a different method
+  if [[ "$1" == "FTL" ]]; then
+    pihole-FTL version
+    return 0
+  fi
+
   # Get the tagged version of the local repository
   local directory="${1}"
   local version
 
-  cd "${directory}" || { echo "${DEFAULT}"; return 1; }
+  cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
-  version=$(git describe --tags --always || \
+  version=$(git describe --tags --always || echo "$DEFAULT")
-            echo "${DEFAULT}")
   if [[ "${version}" =~ ^v ]]; then
     echo "${version}"
   elif [[ "${version}" == "${DEFAULT}" ]]; then
@@ -33,13 +38,18 @@ getLocalVersion() {
 }
 
 getLocalHash() {
+  # Local FTL hash does not exist on filesystem
+  if [[ "$1" == "FTL" ]]; then
+    echo "N/A"
+    return 0
+  fi
+  
   # Get the short hash of the local repository
   local directory="${1}"
   local hash
 
-  cd "${directory}" || { echo "${DEFAULT}"; return 1; }
+  cd "${directory}" 2> /dev/null || { echo "${DEFAULT}"; return 1; }
-  hash=$(git rev-parse --short HEAD || \
+  hash=$(git rev-parse --short HEAD || echo "$DEFAULT")
-         echo "${DEFAULT}")
   if [[ "${hash}" == "${DEFAULT}" ]]; then
     echo "ERROR"
     return 1
@@ -49,12 +59,33 @@ getLocalHash() {
   return 0
 }
 
+getRemoteHash(){
+  # Remote FTL hash is not applicable
+  if [[ "$1" == "FTL" ]]; then
+    echo "N/A"
+    return 0
+  fi
+
+  local daemon="${1}"
+  local branch="${2}"
+
+  hash=$(git ls-remote --heads "https://github.com/pi-hole/${daemon}" | \
+         awk -v bra="$branch" '$0~bra {print substr($0,0,8);exit}')
+  if [[ -n "$hash" ]]; then
+    echo "$hash"
+  else
+    echo "ERROR"
+    return 1
+  fi
+  return 0
+}
+
 getRemoteVersion(){
   # Get the version from the remote origin
   local daemon="${1}"
   local version
 
-  version=$(curl --silent --fail https://api.github.com/repos/pi-hole/${daemon}/releases/latest | \
+  version=$(curl --silent --fail "https://api.github.com/repos/pi-hole/${daemon}/releases/latest" | \
             awk -F: '$1 ~/tag_name/ { print $2 }' | \
             tr -cd '[[:alnum:]]._-')
   if [[ "${version}" =~ ^v ]]; then
@@ -66,72 +97,72 @@ getRemoteVersion(){
   return 0
 }
 
-#PHHASHLATEST=$(curl -s https://api.github.com/repos/pi-hole/pi-hole/commits/master | \
+versionOutput() {
-#                   grep sha | \
+  [[ "$1" == "pi-hole" ]] && GITDIR=$COREGITDIR
-#                   head -n1 | \
+  [[ "$1" == "AdminLTE" ]] && GITDIR=$WEBGITDIR
-#                   awk -F ' ' '{ print $2 }' | \
+  [[ "$1" == "FTL" ]] && GITDIR="FTL"
-#                   tr -cd '[[:alnum:]]._-')
+  
-
+  [[ "$2" == "-c" ]] || [[ "$2" == "--current" ]] || [[ -z "$2" ]] && current=$(getLocalVersion $GITDIR)
-#WEBHASHLATEST=$(curl -s https://api.github.com/repos/pi-hole/AdminLTE/commits/master | \
+  [[ "$2" == "-l" ]] || [[ "$2" == "--latest" ]] || [[ -z "$2" ]] && latest=$(getRemoteVersion "$1")
-#                   grep sha | \
+  if [[ "$2" == "-h" ]] || [[ "$2" == "--hash" ]]; then
-#                   head -n1 | \
+    [[ "$3" == "-c" ]] || [[ "$3" == "--current" ]] || [[ -z "$3" ]] && curHash=$(getLocalHash "$GITDIR")
-#                   awk -F ' ' '{ print $2 }' | \
+    [[ "$3" == "-l" ]] || [[ "$3" == "--latest" ]] || [[ -z "$3" ]] && latHash=$(getRemoteHash "$1" "$(cd "$GITDIR" 2> /dev/null && git rev-parse --abbrev-ref HEAD)")
-#                   tr -cd '[[:alnum:]]._-')
-
-
-normalOutput() {
-	echo "::: Pi-hole version is $(getLocalVersion "${PHGITDIR}") (Latest version is $(getRemoteVersion pi-hole))"
-	if [ -d "${WEBGITDIR}" ]; then
-		echo "::: Web-Admin version is $(getLocalVersion "${WEBGITDIR}") (Latest version is $(getRemoteVersion AdminLTE))"
-	fi
-}
-
-webOutput() {
-  if [ -d "${WEBGITDIR}" ]; then
-    case "${1}" in
-      "-l" | "--latest"    ) echo $(getRemoteVersion AdminLTE);;
-      "-c" | "--current"   ) echo $(getLocalVersion "${WEBGITDIR}");;
-      "-h" | "--hash"      ) echo $(getLocalHash "${WEBGITDIR}");;
-      *                    ) echo "::: Invalid Option!"; exit 1;
-    esac
-  else
-    echo "::: Web interface not installed!"; exit 1;
   fi
+
+  if [[ -n "$current" ]] && [[ -n "$latest" ]]; then
+    output="${1^} version is $current (Latest: $latest)"
+  elif [[ -n "$current" ]] && [[ -z "$latest" ]]; then
+    output="Current ${1^} version is $current"
+  elif [[ -z "$current" ]] && [[ -n "$latest" ]]; then
+    output="Latest ${1^} version is $latest"
+  elif [[ "$curHash" == "N/A" ]] || [[ "$latHash" == "N/A" ]]; then
+    output="${1^} hash is not applicable"
+  elif [[ -n "$curHash" ]] && [[ -n "$latHash" ]]; then
+    output="${1^} hash is $curHash (Latest: $latHash)"
+  elif [[ -n "$curHash" ]] && [[ -z "$latHash" ]]; then
+    output="Current ${1^} hash is $curHash"
+  elif [[ -z "$curHash" ]] && [[ -n "$latHash" ]]; then
+    output="Latest ${1^} hash is $latHash"
+  else
+    errorOutput
+  fi
+
+  [[ -n "$output" ]] && echo "  $output"
 }
 
-coreOutput() {
+errorOutput() {
-  case "${1}" in
+  echo "  Invalid Option! Try 'pihole -v --help' for more information."
-    "-l" | "--latest"    ) echo $(getRemoteVersion pi-hole);;
+  exit 1
-    "-c" | "--current"   ) echo $(getLocalVersion "${PHGITDIR}");;
+}
-    "-h" | "--hash"      ) echo $(getLocalHash "${PHGITDIR}");;
+  
-    *                    ) echo "::: Invalid Option!"; exit 1;
+defaultOutput() {
-  esac
+  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
-	normalOutput
-fi
-
 case "${1}" in
-  "-a" | "--admin"     ) shift; webOutput "$@";;
+  "-p" | "--pihole"    ) shift; versionOutput "pi-hole" "$@";;
-  "-p" | "--pihole"    ) shift; coreOutput "$@" ;;
+  "-a" | "--admin"     ) shift; versionOutput "AdminLTE" "$@";;
+  "-f" | "--ftl"       ) shift; versionOutput "FTL" "$@";;
   "-h" | "--help"      ) helpFunc;;
+  *                    ) defaultOutput "$@";;
 esac

advanced/Scripts/webpage.sh

@@ -8,7 +8,6 @@
 # This file is copyright under the latest version of the EUPL.
 # Please see LICENSE file for your rights under this license.
 
-
 readonly setupVars="/etc/pihole/setupVars.conf"
 readonly dnsmasqconfig="/etc/dnsmasq.d/01-pihole.conf"
 readonly dhcpconfig="/etc/dnsmasq.d/02-pihole-dhcp.conf"
@@ -16,23 +15,19 @@ readonly dhcpconfig="/etc/dnsmasq.d/02-pihole-dhcp.conf"
 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
-:::  -i, interface		Setup interface listening behavior of dnsmasq
+  -i, interface       Specify dnsmasq's interface listening behavior
-:::               		pihole -a -i local  : Listen on all interfaces, but allow only queries from
+                        Add '-h' for more info on interface usage" 
-:::               		                      devices that are at most one hop away (local devices)
-:::               		pihole -a -i single : Listen only on one interface (see PIHOLE_INTERFACE)
-:::               		pihole -a -i all    : Listen on all interfaces, permit all origins
-EOM
 	exit 0
 }
 
@@ -61,21 +56,18 @@ delete_dnsmasq_setting() {
 	sed -i "/${1}/d" "${dnsmasqconfig}"
 }
 
-SetTemperatureUnit(){
+SetTemperatureUnit() {
-
 	change_setting "TEMPERATUREUNIT" "${unit}"
-
 }
 
-HashPassword(){
+HashPassword() {
-    # Compute password hash twice to avoid rainbow table vulnerability
+  # Compute password hash twice to avoid rainbow table vulnerability
-    return=$(echo -n ${1} | sha256sum | sed 's/\s.*$//')
+  return=$(echo -n ${1} | sha256sum | sed 's/\s.*$//')
-		return=$(echo -n ${return} | sha256sum | sed 's/\s.*$//')
+  return=$(echo -n ${return} | sha256sum | sed 's/\s.*$//')
-		echo ${return}
+  echo ${return}
 }
 
-SetWebPassword(){
+SetWebPassword() {
-
 	if [ "${SUDO_USER}" == "www-data" ]; then
 		echo "Security measure: user www-data is not allowed to change webUI password!"
 		echo "Exiting"
@@ -175,8 +167,7 @@ trust-anchor=.,19036,8,2,49AAC11D7B6F6446702E54A1607371607A1A41855200FD2CE1CDDE3
 
 }
 
-SetDNSServers(){
+SetDNSServers() {
-
 	# Save setting to file
 	delete_setting "PIHOLE_DNS"
 	IFS=',' read -r -a array <<< "${args[2]}"
@@ -207,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             #
 ###############################################################################
@@ -283,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]}"
@@ -320,8 +297,7 @@ EnableDHCP(){
 	RestartDNS
 }
 
-DisableDHCP(){
+DisableDHCP() {
-
 	change_setting "DHCP_ACTIVE" "false"
 
 	# Remove possible old setting from file
@@ -333,23 +309,20 @@ DisableDHCP(){
 	RestartDNS
 }
 
-SetWebUILayout(){
+SetWebUILayout() {
-
 	change_setting "WEBUIBOXEDLAYOUT" "${args[2]}"
-
 }
 
 CustomizeAdLists() {
-
   list="/etc/pihole/adlists.list"
 
-	if [[ "${args[2]}" == "enable" ]] ; then
+	if [[ "${args[2]}" == "enable" ]]; then
 		sed -i "\\@${args[3]}@s/^#http/http/g" "${list}"
-	elif [[ "${args[2]}" == "disable" ]] ; then
+	elif [[ "${args[2]}" == "disable" ]]; then
 		sed -i "\\@${args[3]}@s/^http/#http/g" "${list}"
-	elif [[ "${args[2]}" == "add" ]] ; then
+	elif [[ "${args[2]}" == "add" ]]; then
 		echo "${args[3]}" >> ${list}
-	elif [[ "${args[2]}" == "del" ]] ; then
+	elif [[ "${args[2]}" == "del" ]]; then
 	  var=$(echo "${args[3]}" | sed 's/\//\\\//g')
 	  sed -i "/${var}/Id" "${list}"
 	else
@@ -358,18 +331,15 @@ CustomizeAdLists() {
   fi
 }
 
-SetPrivacyMode(){
+SetPrivacyMode() {
-
+	if [[ "${args[2]}" == "true" ]]; then
-	if [[ "${args[2]}" == "true" ]] ; then
 		change_setting "API_PRIVACY_MODE" "true"
 	else
 		change_setting "API_PRIVACY_MODE" "false"
 	fi
-
 }
 
 ResolutionSettings() {
-
 	typ="${args[2]}"
 	state="${args[3]}"
 
@@ -378,11 +348,9 @@ ResolutionSettings() {
 	elif [[ "${typ}" == "clients" ]]; then
 		change_setting "API_GET_CLIENT_HOSTNAME" "${state}"
 	fi
-
 }
 
 AddDHCPStaticAddress() {
-
 	mac="${args[2]}"
 	ip="${args[3]}"
 	host="${args[4]}"
@@ -397,18 +365,14 @@ AddDHCPStaticAddress() {
 		# Full info given
 		echo "dhcp-host=${mac},${ip},${host}" >> "${dhcpstaticconfig}"
 	fi
-
 }
 
 RemoveDHCPStaticAddress() {
-
 	mac="${args[2]}"
 	sed -i "/dhcp-host=${mac}.*/d" "${dhcpstaticconfig}"
-
 }
 
-SetHostRecord(){
+SetHostRecord() {
-
 	if [ -n "${args[3]}" ]; then
 		change_setting "HOSTRECORD" "${args[2]},${args[3]}"
 		echo "Setting host record for ${args[2]} -> ${args[3]}"
@@ -421,17 +385,28 @@ SetHostRecord(){
 
 	# Restart dnsmasq to load new configuration
 	RestartDNS
-
 }
 
-SetListeningMode(){
+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
 
-	if [[ "${args[2]}" == "all" ]] ; then
+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
+	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
@@ -446,17 +421,14 @@ SetListeningMode(){
 		# Restart dnsmasq to load new configuration
 		RestartDNS
 	fi
-
 }
 
-Teleporter()
+Teleporter() {
-{
 	local datetimestamp=$(date "+%Y-%m-%d_%H-%M-%S")
 	php /var/www/html/admin/scripts/pi-hole/php/teleporter.php > "pi-hole-teleporter_${datetimestamp}.zip"
 }
 
 main() {
-
 	args=("$@")
 
 	case "${args[1]}" in
@@ -479,7 +451,7 @@ main() {
 		"addstaticdhcp"     ) AddDHCPStaticAddress;;
 		"removestaticdhcp"  ) RemoveDHCPStaticAddress;;
 		"hostrecord"        ) SetHostRecord;;
-		"-i" | "interface"  ) SetListeningMode;;
+		"-i" | "interface"  ) SetListeningMode "$@";;
 		"-t" | "teleporter" ) Teleporter;;
 		"adlist"            ) CustomizeAdLists;;
 		*                   ) helpFunc;;
@@ -490,5 +462,4 @@ main() {
 	if [[ $# = 0 ]]; then
 		helpFunc
 	fi
-
 }

advanced/index.php

@@ -185,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/logrotate

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

advanced/pihole-FTL.service

@@ -26,7 +26,7 @@ start() {
     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
+    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

advanced/pihole.cron

@@ -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

automated install/basic-install.sh

@@ -86,7 +86,7 @@ if command -v apt-get &> /dev/null; then
   #Debian Family
   #############################################
   PKG_MANAGER="apt-get"
-  UPDATE_PKG_CACHE="test_dpkg_lock; ${PKG_MANAGER} update"
+  UPDATE_PKG_CACHE="${PKG_MANAGER} update"
   PKG_INSTALL=(${PKG_MANAGER} --yes --no-install-recommends install)
   # 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"
@@ -220,6 +220,16 @@ getGitFiles() {
   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
@@ -317,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
@@ -408,7 +446,7 @@ setDHCPCD() {
   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() {
@@ -980,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
@@ -1041,7 +1080,7 @@ installLogrotate() {
   # the local properties of the /var/log directory
   logusergroup="$(stat -c '%U %G' /var/log)"
   if [[ ! -z $logusergroup ]]; then
-    sed -i "s/# su #/su ${logusergroup}/" /etc/pihole/logrotate
+    sed -i "s/# su #/su ${logusergroup}/g;" /etc/pihole/logrotate
   fi
   echo " done!"
 }
@@ -1128,10 +1167,18 @@ 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 ${1:-"NOT SET"}"
+Your Admin Webpage login password is ${pwstring}"
    fi
 
   # Final completion message to user
@@ -1179,22 +1226,32 @@ update_dialogs() {
 }
 
 clone_or_update_repos() {
-if [[ "${reconfigure}" == true ]]; then
+  if [[ "${reconfigure}" == true ]]; then
-      echo "::: --reconfigure passed to install script. Not downloading/updating local repos"
+    echo "::: --reconfigure passed to install script. Resetting changes to local repos"
-    else
+    resetRepo ${PI_HOLE_LOCAL_REPO} || \
-      # Get Git files for Core and Admin
+      { echo "!!! Unable to reset ${PI_HOLE_LOCAL_REPO}, unable to continue."; \
-      getGitFiles ${PI_HOLE_LOCAL_REPO} ${piholeGitUrl} || \
+        exit 1; \
-        { echo "!!! Unable to clone ${piholeGitUrl} into ${PI_HOLE_LOCAL_REPO}, unable to continue."; \
+      }
+    if [[ ${INSTALL_WEB} == true ]]; then
+      resetRepo ${webInterfaceDir} || \
+        { echo "!!! Unable to reset ${webInterfaceDir}, 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
+  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() {
@@ -1220,6 +1277,7 @@ FTLinstall() {
       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."

gravity.sh

@@ -54,6 +54,7 @@ IPV6_ADDRESS=${IPV6_ADDRESS}
 basename=pihole
 piholeDir=/etc/${basename}
 adList=${piholeDir}/gravity.list
+blackList=${piholeDir}/black.list
 localList=${piholeDir}/local.list
 justDomainsExtension=domains
 matterAndLight=${basename}.0.matterandlight.txt
@@ -235,9 +236,7 @@ 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
@@ -299,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)
@@ -310,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
@@ -377,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 ":::"
@@ -402,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
 
@@ -411,22 +421,39 @@ if [[ "${forceGrav}" == true ]]; then
 	echo " done!"
 fi
 
-gravity_collapse
+if [[ ! "${blackListOnly}" == true ]]; then
-gravity_spinup
+  gravity_collapse
-if [[ "${skipDownload}" == false ]]; then
+  gravity_spinup
+  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
 
-gravity_hostFormat
+echo -n "::: Formatting domains into a HOSTS file..."
+if [[ ! "${blackListOnly}" == true ]]; then
+  gravity_hostFormatLocal
+  gravity_hostFormatGravity
+fi
+gravity_hostFormatBlack
+echo " done!"
+
 gravity_blackbody
 
+if [[ ! "${blackListOnly}" == true ]]; then
+  #Clear no longer needed files...
+  echo ":::"
+  echo -n "::: Cleaning up un-needed files..."
+  rm ${piholeDir}/pihole.*.txt
+  echo " done!"
+fi
+
 gravity_reload
 "${PIHOLE_COMMAND}" status

pihole

@@ -9,11 +9,11 @@
 # Please see LICENSE file for your rights under this license.
 
 readonly PI_HOLE_SCRIPT_DIR="/opt/pihole"
-
 readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
+
 # Must be root to use this tool
 if [[ ! $EUID -eq 0 ]];then
-  if [ -x "$(command -v sudo)" ];then
+  if [[ -x "$(command -v sudo)" ]]; then
     exec sudo bash "$0" "$@"
     exit $?
   else
@@ -61,7 +61,7 @@ debugFunc() {
 }
 
 flushFunc() {
-  "${PI_HOLE_SCRIPT_DIR}"/piholeLogFlush.sh
+  "${PI_HOLE_SCRIPT_DIR}"/piholeLogFlush.sh "$@"
   exit 0
 }
 
@@ -163,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
@@ -181,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))
@@ -204,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!"
@@ -233,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"
@@ -246,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
@@ -280,46 +304,96 @@ tailFunc() {
 }
 
 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 Pi-hole 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 domain(s)
+  -wild, wildcard     Blacklist domain(s), and all its subdomains
-:::  -b, blacklist            Blacklist domain(s) (exact match)
+                        Add '-h' for more info on whitelist/blacklist usage
-:::  -wild, wildcard          Blacklist whole domain(s) (wildcard)
+
-:::  -d, debug                Start a debugging session
+Debugging Options:
-:::                             Automated debugging can be enabled with '-a'.
+  -d, debug           Start a debugging session
-:::                             'pihole -d -a'
+                        Add '-a' to enable automated debugging
-:::  -f, flush                Flush the 'pihole.log' file
+  -f, flush           Flush the Pi-hole log
-:::  -t, tail                 Output the last lines of the 'pihole.log' file. Lines are appended as the file grows
+  -r, reconfigure     Reconfigure or Repair Pi-hole subsystems
-:::  -up, updatePihole        Update Pi-hole components
+  -t, tail            View the live output of the Pi-hole log
-:::  -r, reconfigure          Reconfigure or Repair Pi-hole
+
-:::  -g, updateGravity        Update the list of ad-serving domains
+Options:
-:::  -c, chronometer          Calculates stats and displays to an LCD
+  -a, admin           Admin Console options
-:::  -h, help                 Show this help dialog
+                        Add '-h' for more info on admin console usage
-:::  -v, version              Show installed versions of Pi-hole and Web-Admin
+  -c, chronometer     Calculates stats and displays to an LCD
-:::  -q, query                Query the adlists for a specific domain
+                        Add '-h' for more info on chronometer usage
-:::                             'pihole -q domain -exact' shows exact matches only
+  -g, updateGravity   Update the list of ad-serving domains
-:::  -l, logging              Enable or Disable logging (pass 'on' or 'off')
+  -h, --help, help    Show this help dialog
-:::  -a, admin                Admin webpage options
+  -l, logging         Specify whether the Pi-hole log should be used
-:::  uninstall                Uninstall Pi-hole from your system! :(
+                        Add '-h' for more info on logging usage
-:::  status                   Display if Pi-hole is Enabled or Disabled
+  -q, query           Query the adlists for a specified domain
-:::  enable                   Enable Pi-hole DNS Blocking
+                        Add '-exact' AFTER a specified domain for exact match
-:::  disable                  Disable Pi-hole DNS Blocking
+  -up, updatePihole   Update Pi-hole subsystems
-:::                             Blocking can also be disabled only temporarily, e.g.,
+  -v, version         Show installed versions of Pi-hole, Admin Console & FTL
-:::                             'pihole disable 5m' - will disable blocking for 5 minutes
+                        Add '-h' for more info on version usage
-:::  restartdns               Restart dnsmasq
+  uninstall           Uninstall Pi-hole from your system
-:::  checkout                 Check out different branches
+  status              Display the running status of Pi-hole subsystems
-EOM
+  enable              Enable Pi-hole subsystems
+  disable             Disable Pi-hole subsystems
+                        Add '-h' for more info on disable usage
+  restartdns          Restart Pi-hole subsystems
+  checkout            Switch Pi-hole subsystems to a different Github branch
+                        Add '-h' for more info on checkout usage";
   exit 0
 }
 
@@ -333,7 +407,7 @@ case "${1}" in
   "-b" | "blacklist"            ) blacklistFunc "$@";;
   "-wild" | "wildcard"          ) wildcardFunc "$@";;
   "-d" | "debug"                ) debugFunc "$@";;
-  "-f" | "flush"                ) flushFunc;;
+  "-f" | "flush"                ) flushFunc "$@";;
   "-up" | "updatePihole"        ) updatePiholeFunc;;
   "-r"  | "reconfigure"         ) reconfigurePiholeFunc;;
   "-g" | "updateGravity"        ) updateGravityFunc "$@";;
@@ -344,11 +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/test_automated_install.py

@@ -402,6 +402,61 @@ def test_FTL_binary_installed_and_responsive_no_errors(Pihole):
 #     assert '644 /run/pihole-FTL.pid' in support_files.stdout
 #     assert '644 /var/log/pihole-FTL.log' in support_files.stdout
 
+def test_IPv6_only_link_local(Pihole):
+    ''' confirms IPv6 blocking is disabled for Link-local address '''
+    # mock ip -6 address to return Link-local address
+    mock_command_2('ip', {'-6 address':('inet6 fe80::d210:52fa:fe00:7ad7/64 scope link', '0')}, Pihole)
+    detectPlatform = Pihole.run('''
+    source /opt/pihole/basic-install.sh
+    useIPv6dialog
+    ''')
+    expected_stdout = '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 '''
@@ -424,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