mirror of
https://github.com/pi-hole/pi-hole.git
synced 2024-12-24 13:50:17 +00:00
Merge branch 'development' of https://github.com/pi-hole/pi-hole into revamp/debug
merge in development to avoid shellcheck from travis
This commit is contained in:
Jacob Salmela
commit
cb65907e60
20 changed files with 1944 additions and 996 deletions
2
.github/ISSUE_TEMPLATE.md
vendored
2
.github/ISSUE_TEMPLATE.md
vendored
|
|
@ -9,7 +9,7 @@
|
||||||
_{replace this text with a number from 1 to 10, with 1 being not familiar, and 10 being very familiar}_
|
_{replace this text with a number from 1 to 10, with 1 being not familiar, and 10 being very familiar}_
|
||||||
|
|
||||||
---
|
---
|
||||||
**[FEATURE REQUEST | QUESTION | OTHER]:**
|
**[BUG REPORT | OTHER]:**
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|
|
||||||
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -3,17 +3,17 @@
|
||||||
***Please submit all pull requests against the `development` branch. Failure to do so will delay or deny your request***
|
***Please submit all pull requests against the `development` branch. Failure to do so will delay or deny your request***
|
||||||
|
|
||||||
- [] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md).
|
- [] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md).
|
||||||
- [] I have checked that [another pull request](https://github.com/pi-hole/pi-hole/pulls) for this purpose does not exist.
|
- [] I have written tests and verified that they fail without my change.
|
||||||
- [] I have considered, and confirmed that this submission will be valuable to others.
|
- [] I have squashed any insignificant commits.
|
||||||
- [] I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
|
- [] This change has comments for package types, values, functions, and non-obvious lines of code.
|
||||||
- [] I give this submission freely, and claim no ownership to its content.
|
- [] I am willing to help maintain this change if there are issues with it later.
|
||||||
|
- [] I give this submission freely and claim no ownership. It is compatible with the EUPL 1.2 license.
|
||||||
|
- [] I have Signed Off all commits. (`git commit --signoff`)
|
||||||
|
|
||||||
**How familiar are you with the codebase?:**
|
***Please explain what you have done and wish to accomplish with this Pull Request***
|
||||||
|
|
||||||
_{replace this text with a number from 1 to 10, with 1 being not familiar, and 10 being very familiar}_
|
1. What does this change do, exactly?
|
||||||
|
|
||||||
---
|
2. Please link to the relevant issues.
|
||||||
_{replace this line with your pull request content}_
|
|
||||||
|
|
||||||
|
3. Which documentation changes (if any) need to be made because of this PR?
|
||||||
_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._
|
|
||||||
|
|
|
||||||
|
|
@ -35,4 +35,4 @@ groups:
|
||||||
- master
|
- master
|
||||||
required: 4
|
required: 4
|
||||||
teams:
|
teams:
|
||||||
- admin
|
- approvers
|
||||||
|
|
|
||||||
119
LICENSE
119
LICENSE
|
|
@ -12,81 +12,63 @@ This license applies to the whole project EXCEPT:
|
||||||
The licenses that existed prior to this change have remained intact.
|
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
|
1. Definitions
|
||||||
|
|
||||||
In this Licence, the following terms have the following meaning:
|
In this Licence, the following terms have the following meaning:
|
||||||
|
|
||||||
- The Licence: this Licence.
|
- 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.
|
- 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 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 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.
|
- 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
|
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,
|
- use the Work in any circumstance and for all usage,
|
||||||
- reproduce the Work,
|
- 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,
|
- 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,
|
- distribute the Work or copies thereof,
|
||||||
- lend and rent 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.
|
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.
|
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
|
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
|
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
|
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:
|
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.
|
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
|
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.
|
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
|
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
|
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
|
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
|
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
|
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.
|
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.
|
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
|
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.
|
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
|
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
|
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
|
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
|
- 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.
|
||||||
|
|
|
||||||
|
|
@ -21,6 +21,7 @@
|
||||||
###############################################################################
|
###############################################################################
|
||||||
|
|
||||||
addn-hosts=/etc/pihole/gravity.list
|
addn-hosts=/etc/pihole/gravity.list
|
||||||
|
addn-hosts=/etc/pihole/black.list
|
||||||
addn-hosts=/etc/pihole/local.list
|
addn-hosts=/etc/pihole/local.list
|
||||||
|
|
||||||
domain-needed
|
domain-needed
|
||||||
|
|
|
||||||
28
advanced/Scripts/COL_TABLE
Normal file
28
advanced/Scripts/COL_TABLE
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
if [[ -t 1 ]] && [[ $(tput colors) -ge 8 ]]; then
|
||||||
|
COL_NC='[0m'
|
||||||
|
COL_WHITE='[1;37m'
|
||||||
|
COL_BLACK='[0;30m'
|
||||||
|
COL_BLUE='[0;34m'
|
||||||
|
COL_LIGHT_BLUE='[1;34m'
|
||||||
|
COL_GREEN='[0;32m'
|
||||||
|
COL_LIGHT_GREEN='[1;32m'
|
||||||
|
COL_CYAN='[0;36m'
|
||||||
|
COL_LIGHT_CYAN='[1;36m'
|
||||||
|
COL_RED='[0;31m'
|
||||||
|
COL_LIGHT_RED='[1;31m'
|
||||||
|
COL_URG_RED='[39;41m'
|
||||||
|
COL_PURPLE='[0;35m'
|
||||||
|
COL_LIGHT_PURPLE='[1;35m'
|
||||||
|
COL_BROWN='[0;33m'
|
||||||
|
COL_YELLOW='[1;33m'
|
||||||
|
COL_GRAY='[0;30m'
|
||||||
|
COL_LIGHT_GRAY='[0;37m'
|
||||||
|
COL_DARK_GRAY='[1;30m'
|
||||||
|
fi
|
||||||
|
|
||||||
|
TICK="[${COL_LIGHT_GREEN}✓${COL_NC}]"
|
||||||
|
CROSS="[${COL_LIGHT_RED}✗${COL_NC}]"
|
||||||
|
INFO="[i]"
|
||||||
|
QST="[?]"
|
||||||
|
DONE="${COL_LIGHT_GREEN} done!${COL_NC}"
|
||||||
|
OVER="\r\033[K"
|
||||||
|
|
@ -7,99 +7,562 @@
|
||||||
#
|
#
|
||||||
# This file is copyright under the latest version of the EUPL.
|
# This file is copyright under the latest version of the EUPL.
|
||||||
# Please see LICENSE file for your rights under this license.
|
# Please see LICENSE file for your rights under this license.
|
||||||
|
LC_NUMERIC=C
|
||||||
|
|
||||||
# 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
|
||||||
|
# Open connection to FTL
|
||||||
|
exec 3<>"/dev/tcp/localhost/$ftl_port"
|
||||||
|
|
||||||
. /etc/pihole/setupVars.conf
|
# Test if connection is open
|
||||||
|
if { "true" >&3; } 2> /dev/null; then
|
||||||
|
# Send command to FTL
|
||||||
|
echo -e ">$1" >&3
|
||||||
|
|
||||||
function GetFTLData {
|
# Read input
|
||||||
# Open connection to FTL
|
read -r -t 1 LINE <&3
|
||||||
exec 3<>/dev/tcp/localhost/"$(cat /var/run/pihole-FTL.port)"
|
until [[ ! $? ]] || [[ "$LINE" == *"EOM"* ]]; do
|
||||||
|
echo "$LINE" >&1
|
||||||
|
read -r -t 1 LINE <&3
|
||||||
|
done
|
||||||
|
|
||||||
# Test if connection is open
|
# Close connection
|
||||||
if { >&3; } 2> /dev/null; then
|
exec 3>&-
|
||||||
# Send command to FTL
|
exec 3<&-
|
||||||
echo -e ">$1" >&3
|
fi
|
||||||
|
else
|
||||||
# Read input
|
echo "0"
|
||||||
read -r -t 1 LINE <&3
|
|
||||||
until [ ! $? ] || [[ "$LINE" == *"EOM"* ]]; do
|
|
||||||
echo "$LINE" >&1
|
|
||||||
read -r -t 1 LINE <&3
|
|
||||||
done
|
|
||||||
|
|
||||||
# Close connection
|
|
||||||
exec 3>&-
|
|
||||||
exec 3<&-
|
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
outputJSON() {
|
# Print spaces to align right-side additional text
|
||||||
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}}"
|
local text_last
|
||||||
|
|
||||||
|
title="$1"
|
||||||
|
title_len="${#title}"
|
||||||
|
|
||||||
|
text_main="$2"
|
||||||
|
text_main_nocol="$text_main"
|
||||||
|
if [[ "${text_main:0:1}" == "" ]]; then
|
||||||
|
text_main_nocol=$(sed 's/\[[0-9;]\{1,5\}m//g' <<< "$text_main")
|
||||||
|
fi
|
||||||
|
text_main_len="${#text_main_nocol}"
|
||||||
|
|
||||||
|
text_addn="$3"
|
||||||
|
if [[ "$text_addn" == "last" ]]; then
|
||||||
|
text_addn=""
|
||||||
|
text_last="true"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If there is additional text, define max length of text_main
|
||||||
|
if [[ -n "$text_addn" ]]; then
|
||||||
|
case "$scr_cols" in
|
||||||
|
[0-9]|1[0-9]|2[0-9]|3[0-9]|4[0-4]) text_main_max_len="9";;
|
||||||
|
4[5-9]) text_main_max_len="14";;
|
||||||
|
*) text_main_max_len="19";;
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
|
[[ -z "$text_addn" ]] && text_main_max_len="$(( scr_cols - title_len ))"
|
||||||
|
|
||||||
|
# Remove excess characters from main text
|
||||||
|
if [[ "$text_main_len" -gt "$text_main_max_len" ]]; then
|
||||||
|
# Trim text without colours
|
||||||
|
text_main_trim="${text_main_nocol:0:$text_main_max_len}"
|
||||||
|
# Replace with trimmed text
|
||||||
|
text_main="${text_main/$text_main_nocol/$text_main_trim}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Determine amount of spaces for each line
|
||||||
|
if [[ -n "$text_last" ]]; then
|
||||||
|
# Move cursor to end of screen
|
||||||
|
spc_num=$(( scr_cols - ( title_len + text_main_len ) ))
|
||||||
|
else
|
||||||
|
spc_num=$(( text_main_max_len - text_main_len ))
|
||||||
|
fi
|
||||||
|
|
||||||
|
[[ "$spc_num" -le 0 ]] && spc_num="0"
|
||||||
|
spc=$(printf "%${spc_num}s")
|
||||||
|
#spc="${spc// /.}" # Debug: Visualise spaces
|
||||||
|
|
||||||
|
printf "%s%s$spc" "$title" "$text_main"
|
||||||
|
|
||||||
|
if [[ -n "$text_addn" ]]; then
|
||||||
|
printf "%s(%s)%s\n" "$COL_NC$COL_DARK_GRAY" "$text_addn" "$COL_NC"
|
||||||
|
else
|
||||||
|
# Do not print trailing newline on final line
|
||||||
|
[[ -z "$text_last" ]] && printf "%s\n" "$COL_NC"
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
get_summary_data() {
|
# 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]+$")
|
calcFunc(){ awk "BEGIN {print $*}" 2> /dev/null; }
|
||||||
domains_being_blocked=$(printf "%'.f" ${domains_being_blocked_raw})
|
|
||||||
dns_queries_today_raw=$(grep "dns_queries_today" <<< "$summary" | grep -Eo "[0-9]+$")
|
# Convert bytes to human-readable format
|
||||||
dns_queries_today=$(printf "%'.f" ${dns_queries_today_raw})
|
hrBytes() {
|
||||||
ads_blocked_today_raw=$(grep "ads_blocked_today" <<< "$summary" | grep -Eo "[0-9]+$")
|
awk '{
|
||||||
ads_blocked_today=$(printf "%'.f" ${ads_blocked_today_raw})
|
num=$1;
|
||||||
ads_percentage_today_raw=$(grep "ads_percentage_today" <<< "$summary" | grep -Eo "[0-9.]+$")
|
if(num==0) {
|
||||||
LC_NUMERIC=C ads_percentage_today=$(printf "%'.f" ${ads_percentage_today_raw})
|
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="[0m"
|
||||||
|
COL_DARK_GRAY="[1;30m"
|
||||||
|
COL_LIGHT_GREEN="[1;32m"
|
||||||
|
COL_LIGHT_BLUE="[1;34m"
|
||||||
|
COL_LIGHT_RED="[1;31m"
|
||||||
|
COL_YELLOW="[1;33m"
|
||||||
|
COL_LIGHT_RED="[1;31m"
|
||||||
|
COL_URG_RED="[39;41m"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Get RPi throttle state (RPi 3B only) & model number, or OS distro info
|
||||||
|
if command -v vcgencmd &> /dev/null; then
|
||||||
|
local sys_throttle_raw
|
||||||
|
local sys_rev_raw
|
||||||
|
|
||||||
|
sys_throttle_raw=$(vgt=$(sudo vcgencmd get_throttled); echo "${vgt##*x}")
|
||||||
|
|
||||||
|
# Active Throttle Notice: http://bit.ly/2gnunOo
|
||||||
|
if [[ "$sys_throttle_raw" != "0" ]]; then
|
||||||
|
case "$sys_throttle_raw" in
|
||||||
|
*0001) thr_type="${COL_YELLOW}Under Voltage";;
|
||||||
|
*0002) thr_type="${COL_LIGHT_BLUE}Arm Freq Cap";;
|
||||||
|
*0003) thr_type="${COL_YELLOW}UV${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_BLUE}AFC";;
|
||||||
|
*0004) thr_type="${COL_LIGHT_RED}Throttled";;
|
||||||
|
*0005) thr_type="${COL_YELLOW}UV${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_RED}TT";;
|
||||||
|
*0006) thr_type="${COL_LIGHT_BLUE}AFC${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_RED}TT";;
|
||||||
|
*0007) thr_type="${COL_YELLOW}UV${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_BLUE}AFC${COL_DARK_GRAY},${COL_NC} ${COL_LIGHT_RED}TT";;
|
||||||
|
esac
|
||||||
|
[[ -n "$thr_type" ]] && sys_throttle="$thr_type${COL_DARK_GRAY}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
sys_rev_raw=$(awk '/Revision/ {print $3}' < /proc/cpuinfo)
|
||||||
|
case "$sys_rev_raw" in
|
||||||
|
000[2-6]) sys_model=" 1, Model B";; # 256MB
|
||||||
|
000[7-9]) sys_model=" 1, Model A";; # 256MB
|
||||||
|
000d|000e|000f) sys_model=" 1, Model B";; # 512MB
|
||||||
|
0010|0013) sys_model=" 1, Model B+";; # 512MB
|
||||||
|
0012|0015) sys_model=" 1, Model A+";; # 256MB
|
||||||
|
a0104[0-1]|a21041|a22042) sys_model=" 2, Model B";; # 1GB
|
||||||
|
900021) sys_model=" 1, Model A+";; # 512MB
|
||||||
|
900032) sys_model=" 1, Model B+";; # 512MB
|
||||||
|
90009[2-3]|920093) sys_model=" Zero";; # 512MB
|
||||||
|
9000c1) sys_model=" Zero W";; # 512MB
|
||||||
|
a02082|a[2-3]2082) sys_model=" 3, Model B";; # 1GB
|
||||||
|
*) sys_model="";;
|
||||||
|
esac
|
||||||
|
sys_type="Raspberry Pi$sys_model"
|
||||||
|
else
|
||||||
|
source "/etc/os-release"
|
||||||
|
CODENAME=$(sed 's/[()]//g' <<< "${VERSION/* /}")
|
||||||
|
sys_type="${NAME/ */} ${CODENAME^} $VERSION_ID"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Get core count
|
||||||
|
sys_cores=$(grep -c "^processor" /proc/cpuinfo)
|
||||||
|
|
||||||
|
# Test existence of clock speed file for ARM CPU
|
||||||
|
if [[ -f "/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq" ]]; then
|
||||||
|
scaling_freq_file="/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Test existence of temperature file
|
||||||
|
if [[ -f "/sys/class/thermal/thermal_zone0/temp" ]]; then
|
||||||
|
temp_file="/sys/class/thermal/thermal_zone0/temp"
|
||||||
|
elif [[ -f "/sys/class/hwmon/hwmon0/temp1_input" ]]; then
|
||||||
|
temp_file="/sys/class/hwmon/hwmon0/temp1_input"
|
||||||
|
else
|
||||||
|
temp_file=""
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Test existence of setupVars config
|
||||||
|
if [[ -f "/etc/pihole/setupVars.conf" ]]; then
|
||||||
|
setupVars="/etc/pihole/setupVars.conf"
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
normalChrono() {
|
get_sys_stats() {
|
||||||
|
local ph_ver_raw
|
||||||
|
local cpu_raw
|
||||||
|
local ram_raw
|
||||||
|
local disk_raw
|
||||||
|
|
||||||
|
# Update every 12 refreshes (Def: every 60s)
|
||||||
|
count=$((count+1))
|
||||||
|
if [[ "$count" == "1" ]] || (( "$count" % 12 == 0 )); then
|
||||||
|
# Do not source setupVars if file does not exist
|
||||||
|
[[ -n "$setupVars" ]] && source "$setupVars"
|
||||||
|
|
||||||
|
mapfile -t ph_ver_raw < <(pihole -v -c 2> /dev/null | sed -n 's/^.* v/v/p')
|
||||||
|
if [[ -n "${ph_ver_raw[0]}" ]]; then
|
||||||
|
ph_core_ver="${ph_ver_raw[0]}"
|
||||||
|
ph_lte_ver="${ph_ver_raw[1]}"
|
||||||
|
ph_ftl_ver="${ph_ver_raw[2]}"
|
||||||
|
else
|
||||||
|
ph_core_ver="-1"
|
||||||
|
fi
|
||||||
|
|
||||||
|
sys_name=$(hostname)
|
||||||
|
|
||||||
|
[[ -n "$TEMPERATUREUNIT" ]] && temp_unit="$TEMPERATUREUNIT" || temp_unit="c"
|
||||||
|
|
||||||
|
# Get storage stats for partition mounted on /
|
||||||
|
read -r -a disk_raw <<< "$(df -B1 / 2> /dev/null | awk 'END{ print $3,$2,$5 }')"
|
||||||
|
disk_used="${disk_raw[0]}"
|
||||||
|
disk_total="${disk_raw[1]}"
|
||||||
|
disk_perc="${disk_raw[2]}"
|
||||||
|
|
||||||
|
net_gateway=$(route -n | awk '$4 == "UG" {print $2;exit}')
|
||||||
|
|
||||||
|
# Get DHCP stats, if feature is enabled
|
||||||
|
if [[ "$DHCP_ACTIVE" == "true" ]]; then
|
||||||
|
ph_dhcp_max=$(( ${DHCP_END##*.} - ${DHCP_START##*.} + 1 ))
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Get DNS server count
|
||||||
|
dns_count="0"
|
||||||
|
[[ -n "${PIHOLE_DNS_1}" ]] && dns_count=$((dns_count+1))
|
||||||
|
[[ -n "${PIHOLE_DNS_2}" ]] && dns_count=$((dns_count+1))
|
||||||
|
[[ -n "${PIHOLE_DNS_3}" ]] && dns_count=$((dns_count+1))
|
||||||
|
[[ -n "${PIHOLE_DNS_4}" ]] && dns_count=$((dns_count+1))
|
||||||
|
[[ -n "${PIHOLE_DNS_5}" ]] && dns_count=$((dns_count+1))
|
||||||
|
[[ -n "${PIHOLE_DNS_6}" ]] && dns_count=$((dns_count+1))
|
||||||
|
[[ -n "${PIHOLE_DNS_7}" ]] && dns_count=$((dns_count+1))
|
||||||
|
[[ -n "${PIHOLE_DNS_8}" ]] && dns_count=$((dns_count+1))
|
||||||
|
[[ -n "${PIHOLE_DNS_9}" ]] && dns_count="$dns_count+"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Get screen size
|
||||||
|
read -r -a scr_size <<< "$(stty size 2>/dev/null || echo 24 80)"
|
||||||
|
scr_lines="${scr_size[0]}"
|
||||||
|
scr_cols="${scr_size[1]}"
|
||||||
|
|
||||||
|
# Determine Chronometer size behaviour
|
||||||
|
if [[ "$scr_cols" -ge 58 ]]; then
|
||||||
|
chrono_width="large"
|
||||||
|
elif [[ "$scr_cols" -gt 40 ]]; then
|
||||||
|
chrono_width="medium"
|
||||||
|
else
|
||||||
|
chrono_width="small"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Determine max length of divider string
|
||||||
|
scr_line_len=$(( scr_cols - 2 ))
|
||||||
|
[[ "$scr_line_len" -ge 58 ]] && scr_line_len="58"
|
||||||
|
scr_line_str=$(printf "%${scr_line_len}s")
|
||||||
|
scr_line_str="${scr_line_str// /—}"
|
||||||
|
|
||||||
|
sys_uptime=$(hrSecs "$(cut -d. -f1 /proc/uptime)")
|
||||||
|
sys_loadavg=$(cut -d " " -f1,2,3 /proc/loadavg)
|
||||||
|
|
||||||
|
# Get CPU usage, only counting processes over 1% as active
|
||||||
|
cpu_raw=$(ps -eo pcpu,rss --no-headers | grep -E -v " 0")
|
||||||
|
cpu_tasks=$(wc -l <<< "$cpu_raw")
|
||||||
|
cpu_taskact=$(sed -r "/(^ 0.)/d" <<< "$cpu_raw" | wc -l)
|
||||||
|
cpu_perc=$(awk '{sum+=$1} END {printf "%.0f\n", sum/'"$sys_cores"'}' <<< "$cpu_raw")
|
||||||
|
|
||||||
|
# Get CPU clock speed
|
||||||
|
if [[ -n "$scaling_freq_file" ]]; then
|
||||||
|
cpu_mhz=$(( $(< /sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq) / 1000 ))
|
||||||
|
else
|
||||||
|
cpu_mhz=$(lscpu | awk -F ":" '/MHz/ {print $2;exit}')
|
||||||
|
cpu_mhz=$(printf "%.0f" "${cpu_mhz//[[:space:]]/}")
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Determine whether to display CPU clock speed as MHz or GHz
|
||||||
|
if [[ -n "$cpu_mhz" ]]; then
|
||||||
|
[[ "$cpu_mhz" -le "999" ]] && cpu_freq="$cpu_mhz MHz" || cpu_freq="$(calcFunc "$cpu_mhz"/1000) GHz"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Determine colour for temperature
|
||||||
|
if [[ -n "$temp_file" ]]; then
|
||||||
|
if [[ "$temp_unit" == "C" ]]; then
|
||||||
|
cpu_temp=$(printf "%.0fc\n" "$(calcFunc "$(< $temp_file) / 1000")")
|
||||||
|
|
||||||
|
case "${cpu_temp::-1}" in
|
||||||
|
-*|[0-9]|[1-3][0-9]) cpu_col="$COL_LIGHT_BLUE";;
|
||||||
|
4[0-9]) cpu_col="";;
|
||||||
|
5[0-9]) cpu_col="$COL_YELLOW";;
|
||||||
|
6[0-9]) cpu_col="$COL_LIGHT_RED";;
|
||||||
|
*) cpu_col="$COL_URG_RED";;
|
||||||
|
esac
|
||||||
|
|
||||||
|
# $COL_NC$COL_DARK_GRAY is needed for $COL_URG_RED
|
||||||
|
cpu_temp_str=" @ $cpu_col$cpu_temp$COL_NC$COL_DARK_GRAY"
|
||||||
|
|
||||||
|
elif [[ "$temp_unit" == "F" ]]; then
|
||||||
|
cpu_temp=$(printf "%.0ff\n" "$(calcFunc "($(< $temp_file) / 1000) * 9 / 5 + 32")")
|
||||||
|
|
||||||
|
case "${cpu_temp::-1}" in
|
||||||
|
-*|[0-9]|[0-9][0-9]) cpu_col="$COL_LIGHT_BLUE";;
|
||||||
|
1[0-1][0-9]) cpu_col="";;
|
||||||
|
1[2-3][0-9]) cpu_col="$COL_YELLOW";;
|
||||||
|
1[4-5][0-9]) cpu_col="$COL_LIGHT_RED";;
|
||||||
|
*) cpu_col="$COL_URG_RED";;
|
||||||
|
esac
|
||||||
|
|
||||||
|
cpu_temp_str=" @ $cpu_col$cpu_temp$COL_NC$COL_DARK_GRAY"
|
||||||
|
|
||||||
|
else
|
||||||
|
cpu_temp_str=$(printf " @ %.0fk\n" "$(calcFunc "($(< $temp_file) / 1000) + 273.15")")
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
cpu_temp_str=""
|
||||||
|
fi
|
||||||
|
|
||||||
|
read -r -a ram_raw <<< "$(awk '/MemTotal:/{total=$2} /MemFree:/{free=$2} /Buffers:/{buffers=$2} /^Cached:/{cached=$2} END {printf "%.0f %.0f %.0f", (total-free-buffers-cached)*100/total, (total-free-buffers-cached)*1024, total*1024}' /proc/meminfo)"
|
||||||
|
ram_perc="${ram_raw[0]}"
|
||||||
|
ram_used="${ram_raw[1]}"
|
||||||
|
ram_total="${ram_raw[2]}"
|
||||||
|
|
||||||
|
if [[ "$(pihole status web 2> /dev/null)" == "1" ]]; then
|
||||||
|
ph_status="${COL_LIGHT_GREEN}Active"
|
||||||
|
else
|
||||||
|
ph_status="${COL_LIGHT_RED}Offline"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ "$DHCP_ACTIVE" == "true" ]]; then
|
||||||
|
local ph_dhcp_range
|
||||||
|
|
||||||
|
ph_dhcp_range=$(seq -s "|" -f "${DHCP_START%.*}.%g" "${DHCP_START##*.}" "${DHCP_END##*.}")
|
||||||
|
|
||||||
|
# Count dynamic leases from available range, and not static leases
|
||||||
|
ph_dhcp_num=$(grep -cE "$ph_dhcp_range" "/etc/pihole/dhcp.leases")
|
||||||
|
ph_dhcp_percent=$(( ph_dhcp_num * 100 / ph_dhcp_max ))
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
get_ftl_stats() {
|
||||||
|
local stats_raw
|
||||||
|
|
||||||
|
mapfile -t stats_raw < <(pihole-FTL "stats")
|
||||||
|
domains_being_blocked_raw="${stats_raw[1]#* }"
|
||||||
|
dns_queries_today_raw="${stats_raw[3]#* }"
|
||||||
|
ads_blocked_today_raw="${stats_raw[5]#* }"
|
||||||
|
ads_percentage_today_raw="${stats_raw[7]#* }"
|
||||||
|
queries_forwarded_raw="${stats_raw[11]#* }"
|
||||||
|
queries_cached_raw="${stats_raw[13]#* }"
|
||||||
|
|
||||||
|
# Only retrieve these stats when not called from jsonFunc
|
||||||
|
if [[ -z "$1" ]]; then
|
||||||
|
local top_ad_raw
|
||||||
|
local top_domain_raw
|
||||||
|
local top_client_raw
|
||||||
|
|
||||||
|
domains_being_blocked=$(printf "%.0f\n" "${domains_being_blocked_raw}")
|
||||||
|
dns_queries_today=$(printf "%.0f\n" "${dns_queries_today_raw}")
|
||||||
|
ads_blocked_today=$(printf "%.0f\n" "${ads_blocked_today_raw}")
|
||||||
|
ads_percentage_today=$(printf "%'.0f\n" "${ads_percentage_today_raw}")
|
||||||
|
queries_cached_percentage=$(printf "%.0f\n" "$(calcFunc "$queries_cached_raw * 100 / ( $queries_forwarded_raw + $queries_cached_raw )")")
|
||||||
|
recent_blocked=$(pihole-FTL recentBlocked)
|
||||||
|
read -r -a top_ad_raw <<< "$(pihole-FTL "top-ads (1)")"
|
||||||
|
read -r -a top_domain_raw <<< "$(pihole-FTL "top-domains (1)")"
|
||||||
|
read -r -a top_client_raw <<< "$(pihole-FTL "top-clients (1)")"
|
||||||
|
|
||||||
|
top_ad="${top_ad_raw[2]}"
|
||||||
|
top_domain="${top_domain_raw[2]}"
|
||||||
|
if [[ "${top_client_raw[3]}" ]]; then
|
||||||
|
top_client="${top_client_raw[3]}"
|
||||||
|
else
|
||||||
|
top_client="${top_client_raw[2]}"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
get_strings() {
|
||||||
|
# Expand or contract strings depending on screen size
|
||||||
|
if [[ "$chrono_width" == "large" ]]; then
|
||||||
|
phc_str=" ${COL_DARK_GRAY}Pi-hole"
|
||||||
|
lte_str=" ${COL_DARK_GRAY}Admin"
|
||||||
|
ftl_str=" ${COL_DARK_GRAY}FTL"
|
||||||
|
api_str="${COL_LIGHT_RED}API Offline"
|
||||||
|
|
||||||
|
host_info="$sys_type"
|
||||||
|
sys_info="$sys_throttle"
|
||||||
|
sys_info2="Active: $cpu_taskact of $cpu_tasks tasks"
|
||||||
|
used_str="Used: "
|
||||||
|
leased_str="Leased: "
|
||||||
|
domains_being_blocked=$(printf "%'.0f" "$domains_being_blocked")
|
||||||
|
ph_info="Blocking: $domains_being_blocked sites"
|
||||||
|
total_str="Total: "
|
||||||
|
else
|
||||||
|
phc_str=" ${COL_DARK_GRAY}PH"
|
||||||
|
lte_str=" ${COL_DARK_GRAY}Web"
|
||||||
|
ftl_str=" ${COL_DARK_GRAY}FTL"
|
||||||
|
api_str="${COL_LIGHT_RED}API Down"
|
||||||
|
ph_info="$domains_being_blocked blocked"
|
||||||
|
fi
|
||||||
|
|
||||||
|
[[ "$sys_cores" -ne 1 ]] && sys_cores_txt="${sys_cores}x "
|
||||||
|
cpu_info="$sys_cores_txt$cpu_freq$cpu_temp_str"
|
||||||
|
ram_info="$used_str$(hrBytes "$ram_used") of $(hrBytes "$ram_total")"
|
||||||
|
disk_info="$used_str$(hrBytes "$disk_used") of $(hrBytes "$disk_total")"
|
||||||
|
|
||||||
|
lan_info="Gateway: $net_gateway"
|
||||||
|
dhcp_info="$leased_str$ph_dhcp_num of $ph_dhcp_max"
|
||||||
|
|
||||||
|
ads_info="$total_str$ads_blocked_today of $dns_queries_today"
|
||||||
|
dns_info="$dns_count DNS servers"
|
||||||
|
|
||||||
|
[[ "$recent_blocked" == "0" ]] && recent_blocked="${COL_LIGHT_RED}FTL offline${COL_NC}"
|
||||||
|
}
|
||||||
|
|
||||||
|
chronoFunc() {
|
||||||
|
get_init_stats
|
||||||
|
|
||||||
for (( ; ; )); do
|
for (( ; ; )); do
|
||||||
get_summary_data
|
get_sys_stats
|
||||||
domain=$(GetFTLData recentBlocked)
|
get_ftl_stats
|
||||||
|
get_strings
|
||||||
|
|
||||||
|
# Strip excess development version numbers
|
||||||
|
if [[ "$ph_core_ver" != "-1" ]]; then
|
||||||
|
phc_ver_str="$phc_str: ${ph_core_ver%-*}${COL_NC}"
|
||||||
|
lte_ver_str="$lte_str: ${ph_lte_ver%-*}${COL_NC}"
|
||||||
|
ftl_ver_str="$ftl_str: ${ph_ftl_ver%-*}${COL_NC}"
|
||||||
|
else
|
||||||
|
phc_ver_str="$phc_str: $api_str${COL_NC}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Get refresh number
|
||||||
|
if [[ "$*" == *"-r"* ]]; then
|
||||||
|
num="$*"
|
||||||
|
num="${num/*-r /}"
|
||||||
|
num="${num/ */}"
|
||||||
|
num_str="Refresh set for every $num seconds"
|
||||||
|
else
|
||||||
|
num_str=""
|
||||||
|
fi
|
||||||
|
|
||||||
clear
|
clear
|
||||||
# Displays a colorful Pi-hole logo
|
|
||||||
echo " [0;1;35;95m_[0;1;31;91m__[0m [0;1;33;93m_[0m [0;1;34;94m_[0m [0;1;36;96m_[0m"
|
|
||||||
echo "[0;1;31;91m|[0m [0;1;33;93m_[0m [0;1;32;92m(_[0;1;36;96m)_[0;1;34;94m__[0;1;35;95m|[0m [0;1;31;91m|_[0m [0;1;32;92m__[0;1;36;96m_|[0m [0;1;34;94m|[0;1;35;95m__[0;1;31;91m_[0m"
|
|
||||||
echo "[0;1;33;93m|[0m [0;1;32;92m_[0;1;36;96m/[0m [0;1;34;94m|_[0;1;35;95m__[0;1;31;91m|[0m [0;1;33;93m'[0m [0;1;32;92m\/[0m [0;1;36;96m_[0m [0;1;34;94m\[0m [0;1;35;95m/[0m [0;1;31;91m-[0;1;33;93m_)[0m"
|
|
||||||
echo "[0;1;32;92m|_[0;1;36;96m|[0m [0;1;34;94m|_[0;1;35;95m|[0m [0;1;33;93m|_[0;1;32;92m||[0;1;36;96m_\[0;1;34;94m__[0;1;35;95m_/[0;1;31;91m_\[0;1;33;93m__[0;1;32;92m_|[0m"
|
|
||||||
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}"
|
# Remove exit message heading on third refresh
|
||||||
echo "Queries: ${dns_queries_today}"
|
if [[ "$count" -le 2 ]] && [[ "$*" != *"-e"* ]]; then
|
||||||
echo "Pi-holed: ${ads_blocked_today} (${ads_percentage_today}%)"
|
echo -e " ${COL_LIGHT_GREEN}Pi-hole Chronometer${COL_NC}
|
||||||
|
$num_str
|
||||||
|
${COL_LIGHT_RED}Press Ctrl-C to exit${COL_NC}
|
||||||
|
${COL_DARK_GRAY}$scr_line_str${COL_NC}"
|
||||||
|
else
|
||||||
|
echo -e "[0;1;31;91m|¯[0;1;33;93m¯[0;1;32;92m¯[0;1;32;92m(¯[0;1;36;96m)[0;1;34;94m_[0;1;35;95m|[0;1;33;93m¯[0;1;31;91m|_ [0;1;32;92m__[0;1;36;96m_|[0;1;31;91m¯[0;1;34;94m|[0;1;35;95m__[0;1;31;91m_[0m$phc_ver_str
|
||||||
|
[0;1;33;93m| ¯[0;1;32;92m_[0;1;36;96m/¯[0;1;34;94m|[0;1;35;95m_[0;1;31;91m| [0;1;33;93m' [0;1;32;92m\/ [0;1;36;96m_ [0;1;34;94m\ [0;1;35;95m/ [0;1;31;91m-[0;1;33;93m_)[0m$lte_ver_str
|
||||||
|
[0;1;32;92m|_[0;1;36;96m| [0;1;34;94m|_[0;1;35;95m| [0;1;33;93m|_[0;1;32;92m||[0;1;36;96m_\[0;1;34;94m__[0;1;35;95m_/[0;1;31;91m_\[0;1;33;93m__[0;1;32;92m_|[0m$ftl_ver_str
|
||||||
|
${COL_DARK_GRAY}$scr_line_str${COL_NC}"
|
||||||
|
fi
|
||||||
|
|
||||||
sleep 5
|
printFunc " Hostname: " "$sys_name" "$host_info"
|
||||||
|
printFunc " Uptime: " "$sys_uptime" "$sys_info"
|
||||||
|
printFunc " Task Load: " "$sys_loadavg" "$sys_info2"
|
||||||
|
printFunc " CPU usage: " "$cpu_perc%" "$cpu_info"
|
||||||
|
printFunc " RAM usage: " "$ram_perc%" "$ram_info"
|
||||||
|
printFunc " HDD usage: " "$disk_perc" "$disk_info"
|
||||||
|
|
||||||
|
if [[ "$scr_lines" -gt 17 ]] && [[ "$chrono_width" != "small" ]]; then
|
||||||
|
printFunc " LAN addr: " "${IPV4_ADDRESS/\/*/}" "$lan_info"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ "$DHCP_ACTIVE" == "true" ]]; then
|
||||||
|
printFunc "DHCP usage: " "$ph_dhcp_percent%" "$dhcp_info"
|
||||||
|
fi
|
||||||
|
|
||||||
|
printFunc " Pi-hole: " "$ph_status" "$ph_info"
|
||||||
|
printFunc " Ads Today: " "$ads_percentage_today%" "$ads_info"
|
||||||
|
printFunc "Local Qrys: " "$queries_cached_percentage%" "$dns_info"
|
||||||
|
|
||||||
|
printFunc " Blocked: " "$recent_blocked"
|
||||||
|
printFunc "Top Advert: " "$top_ad"
|
||||||
|
|
||||||
|
# Provide more stats on screens with more lines
|
||||||
|
if [[ "$scr_lines" -eq 17 ]]; then
|
||||||
|
if [[ "$DHCP_ACTIVE" == "true" ]]; then
|
||||||
|
printFunc "Top Domain: " "$top_domain" "last"
|
||||||
|
else
|
||||||
|
print_client="true"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
print_client="true"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -n "$print_client" ]]; then
|
||||||
|
printFunc "Top Domain: " "$top_domain"
|
||||||
|
printFunc "Top Client: " "$top_client" "last"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Handle exit/refresh options
|
||||||
|
if [[ "$*" == *"-e"* ]]; then
|
||||||
|
exit 0
|
||||||
|
else
|
||||||
|
if [[ "$*" == *"-r"* ]]; then
|
||||||
|
sleep "$num"
|
||||||
|
else
|
||||||
|
sleep 5
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
displayHelp() {
|
jsonFunc() {
|
||||||
echo "Usage: pihole -c [options]
|
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'
|
Example: 'pihole -c -j'
|
||||||
Calculates stats and displays to an LCD
|
Calculates stats and displays to an LCD
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-j, --json Output stats as JSON formatted string
|
-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"
|
-h, --help Display this help text"
|
||||||
|
fi
|
||||||
|
|
||||||
exit 0
|
exit 0
|
||||||
}
|
}
|
||||||
|
|
||||||
if [[ $# = 0 ]]; then
|
if [[ $# = 0 ]]; then
|
||||||
normalChrono
|
chronoFunc
|
||||||
fi
|
fi
|
||||||
|
|
||||||
for var in "$@"; do
|
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 "$@";;
|
||||||
|
"-e" | "--exit" ) chronoFunc "$@";;
|
||||||
|
* ) helpFunc "?";;
|
||||||
esac
|
esac
|
||||||
done
|
done
|
||||||
|
|
|
||||||
|
|
@ -24,6 +24,10 @@ domToRemoveList=()
|
||||||
listMain=""
|
listMain=""
|
||||||
listAlt=""
|
listAlt=""
|
||||||
|
|
||||||
|
colfile="/opt/pihole/COL_TABLE"
|
||||||
|
source ${colfile}
|
||||||
|
|
||||||
|
|
||||||
helpFunc() {
|
helpFunc() {
|
||||||
if [[ "${listMain}" == "${whitelist}" ]]; then
|
if [[ "${listMain}" == "${whitelist}" ]]; then
|
||||||
param="w"
|
param="w"
|
||||||
|
|
@ -58,14 +62,18 @@ EscapeRegexp() {
|
||||||
}
|
}
|
||||||
|
|
||||||
HandleOther() {
|
HandleOther() {
|
||||||
# First, convert everything to lowercase
|
# Convert to lowercase
|
||||||
domain=$(sed -e "y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/" <<< "$1")
|
domain="${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=$(perl -lne 'print if /^((-|_)*[a-z\d]((-|_)*[a-z\d])*(-|_)*)(\.(-|_)*([a-z\d]((-|_)*[a-z\d])*))*$/' <<< "${domain}") # Valid chars check
|
||||||
|
validDomain=$(perl -lne 'print if /^.{1,253}$/' <<< "${validDomain}") # Overall length check
|
||||||
|
validDomain=$(perl -lne 'print if /^[^\.]{1,63}(\.[^\.]{1,63})*$/' <<< "${validDomain}") # Length of each label
|
||||||
|
|
||||||
if [[ -z "${validDomain}" ]]; then
|
if [[ -z "${validDomain}" ]]; then
|
||||||
echo "::: $1 is not a valid argument or domain name"
|
echo -e " ${CROSS} $1 is not a valid argument or domain name!"
|
||||||
else
|
else
|
||||||
|
echo -e " ${TICK} $1 is a valid domain name!"
|
||||||
domList=("${domList[@]}" ${validDomain})
|
domList=("${domList[@]}" ${validDomain})
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
@ -94,6 +102,10 @@ AddDomain() {
|
||||||
list="$2"
|
list="$2"
|
||||||
domain=$(EscapeRegexp "$1")
|
domain=$(EscapeRegexp "$1")
|
||||||
|
|
||||||
|
[[ "${list}" == "${whitelist}" ]] && listname="whitelist"
|
||||||
|
[[ "${list}" == "${blacklist}" ]] && listname="blacklist"
|
||||||
|
[[ "${list}" == "${wildcardlist}" ]] && listname="wildcard blacklist"
|
||||||
|
|
||||||
if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
|
if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
|
||||||
bool=true
|
bool=true
|
||||||
# Is the domain in the list we want to add it to?
|
# Is the domain in the list we want to add it to?
|
||||||
|
|
@ -102,21 +114,21 @@ AddDomain() {
|
||||||
if [[ "${bool}" == false ]]; then
|
if [[ "${bool}" == false ]]; then
|
||||||
# Domain not found in the whitelist file, add it!
|
# Domain not found in the whitelist file, add it!
|
||||||
if [[ "${verbose}" == true ]]; then
|
if [[ "${verbose}" == true ]]; then
|
||||||
echo "::: Adding $1 to $list..."
|
echo -e " ${INFO} Adding $1 to $listname..."
|
||||||
fi
|
fi
|
||||||
reload=true
|
reload=true
|
||||||
# Add it to the list we want to add it to
|
# Add it to the list we want to add it to
|
||||||
echo "$1" >> "${list}"
|
echo "$1" >> "${list}"
|
||||||
else
|
else
|
||||||
if [[ "${verbose}" == true ]]; then
|
if [[ "${verbose}" == true ]]; then
|
||||||
echo "::: ${1} already exists in ${list}, no need to add!"
|
echo -e " ${INFO} ${1} already exists in ${listname}, no need to add!"
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
elif [[ "${list}" == "${wildcardlist}" ]]; then
|
elif [[ "${list}" == "${wildcardlist}" ]]; then
|
||||||
source "${piholeDir}/setupVars.conf"
|
source "${piholeDir}/setupVars.conf"
|
||||||
# Remove the /* from the end of the IPv4addr.
|
# Remove the /* from the end of the IP addresses
|
||||||
IPV4_ADDRESS=${IPV4_ADDRESS%/*}
|
IPV4_ADDRESS=${IPV4_ADDRESS%/*}
|
||||||
IPV6_ADDRESS=${IPV6_ADDRESS}
|
IPV6_ADDRESS=${IPV6_ADDRESS%/*}
|
||||||
|
|
||||||
bool=true
|
bool=true
|
||||||
# Is the domain in the list?
|
# Is the domain in the list?
|
||||||
|
|
@ -124,7 +136,7 @@ AddDomain() {
|
||||||
|
|
||||||
if [[ "${bool}" == false ]]; then
|
if [[ "${bool}" == false ]]; then
|
||||||
if [[ "${verbose}" == true ]]; then
|
if [[ "${verbose}" == true ]]; then
|
||||||
echo "::: Adding $1 to wildcard blacklist..."
|
echo -e " ${INFO} Adding $1 to wildcard blacklist..."
|
||||||
fi
|
fi
|
||||||
reload=true
|
reload=true
|
||||||
echo "address=/$1/${IPV4_ADDRESS}" >> "${wildcardlist}"
|
echo "address=/$1/${IPV4_ADDRESS}" >> "${wildcardlist}"
|
||||||
|
|
@ -133,67 +145,78 @@ AddDomain() {
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
if [[ "${verbose}" == true ]]; then
|
if [[ "${verbose}" == true ]]; then
|
||||||
echo "::: ${1} already exists in wildcard blacklist, no need to add!"
|
echo -e " ${INFO} ${1} already exists in wildcard blacklist, no need to add!"
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
RemoveDomain() {
|
RemoveDomain() {
|
||||||
list="$2"
|
list="$2"
|
||||||
domain=$(EscapeRegexp "$1")
|
domain=$(EscapeRegexp "$1")
|
||||||
|
|
||||||
if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
|
[[ "${list}" == "${whitelist}" ]] && listname="whitelist"
|
||||||
bool=true
|
[[ "${list}" == "${blacklist}" ]] && listname="blacklist"
|
||||||
# Is it in the list? Logic follows that if its whitelisted it should not be blacklisted and vice versa
|
[[ "${list}" == "${wildcardlist}" ]] && listname="wildcard blacklist"
|
||||||
grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
|
|
||||||
if [[ "${bool}" == true ]]; then
|
if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
|
||||||
# Remove it from the other one
|
bool=true
|
||||||
echo "::: Removing $1 from $list..."
|
# Is it in the list? Logic follows that if its whitelisted it should not be blacklisted and vice versa
|
||||||
# /I flag: search case-insensitive
|
grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
|
||||||
sed -i "/${domain}/Id" "${list}"
|
if [[ "${bool}" == true ]]; then
|
||||||
reload=true
|
# Remove it from the other one
|
||||||
else
|
echo -e " ${INFO} Removing $1 from $listname..."
|
||||||
if [[ "${verbose}" == true ]]; then
|
# /I flag: search case-insensitive
|
||||||
echo "::: ${1} does not exist in ${list}, no need to remove!"
|
sed -i "/${domain}/Id" "${list}"
|
||||||
fi
|
reload=true
|
||||||
fi
|
else
|
||||||
elif [[ "${list}" == "${wildcardlist}" ]]; then
|
if [[ "${verbose}" == true ]]; then
|
||||||
bool=true
|
echo -e " ${INFO} ${1} does not exist in ${listname}, no need to remove!"
|
||||||
# Is it in the list?
|
|
||||||
grep -e "address=\/${domain}\/" "${wildcardlist}" > /dev/null 2>&1 || bool=false
|
|
||||||
if [[ "${bool}" == true ]]; then
|
|
||||||
# Remove it from the other one
|
|
||||||
echo "::: Removing $1 from $list..."
|
|
||||||
# /I flag: search case-insensitive
|
|
||||||
sed -i "/address=\/${domain}/Id" "${list}"
|
|
||||||
reload=true
|
|
||||||
else
|
|
||||||
if [[ "${verbose}" == true ]]; then
|
|
||||||
echo "::: ${1} does not exist in ${list}, no need to remove!"
|
|
||||||
fi
|
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
elif [[ "${list}" == "${wildcardlist}" ]]; then
|
||||||
|
bool=true
|
||||||
|
# Is it in the list?
|
||||||
|
grep -e "address=\/${domain}\/" "${wildcardlist}" > /dev/null 2>&1 || bool=false
|
||||||
|
if [[ "${bool}" == true ]]; then
|
||||||
|
# Remove it from the other one
|
||||||
|
echo -e " ${INFO} Removing $1 from $listname..."
|
||||||
|
# /I flag: search case-insensitive
|
||||||
|
sed -i "/address=\/${domain}/Id" "${list}"
|
||||||
|
reload=true
|
||||||
|
else
|
||||||
|
if [[ "${verbose}" == true ]]; then
|
||||||
|
echo -e " ${INFO} ${1} does not exist in ${listname}, no need to remove!"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
Reload() {
|
Reload() {
|
||||||
# Reload hosts file
|
# Reload hosts file
|
||||||
|
echo ""
|
||||||
|
echo -e " ${INFO} Updating gravity..."
|
||||||
|
echo ""
|
||||||
pihole -g -sd
|
pihole -g -sd
|
||||||
}
|
}
|
||||||
|
|
||||||
Displaylist() {
|
Displaylist() {
|
||||||
if [[ "${listMain}" == "${whitelist}" ]]; then
|
if [[ -f ${listMain} ]]; then
|
||||||
string="gravity resistant domains"
|
if [[ "${listMain}" == "${whitelist}" ]]; then
|
||||||
|
string="gravity resistant domains"
|
||||||
|
else
|
||||||
|
string="domains caught in the sinkhole"
|
||||||
|
fi
|
||||||
|
verbose=false
|
||||||
|
echo -e "Displaying $string:\n"
|
||||||
|
count=1
|
||||||
|
while IFS= read -r RD; do
|
||||||
|
echo " ${count}: ${RD}"
|
||||||
|
count=$((count+1))
|
||||||
|
done < "${listMain}"
|
||||||
else
|
else
|
||||||
string="domains caught in the sinkhole"
|
echo -e " ${COL_LIGHT_RED}${listMain} does not exist!${COL_NC}"
|
||||||
fi
|
fi
|
||||||
verbose=false
|
|
||||||
echo -e "Displaying $string:\n"
|
|
||||||
count=1
|
|
||||||
while IFS= read -r RD; do
|
|
||||||
echo "${count}: ${RD}"
|
|
||||||
count=$((count+1))
|
|
||||||
done < "${listMain}"
|
|
||||||
exit 0;
|
exit 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,13 +3,14 @@
|
||||||
# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
|
# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
|
||||||
# Network-wide ad blocking via your own hardware.
|
# Network-wide ad blocking via your own hardware.
|
||||||
#
|
#
|
||||||
# Switch Pi-hole subsystems to a different Github branch
|
# Switch Pi-hole subsystems to a different Github branch.
|
||||||
#
|
#
|
||||||
# This file is copyright under the latest version of the EUPL.
|
# This file is copyright under the latest version of the EUPL.
|
||||||
# Please see LICENSE file for your rights under this license.
|
# Please see LICENSE file for your rights under this license.
|
||||||
|
|
||||||
readonly PI_HOLE_FILES_DIR="/etc/.pihole"
|
readonly PI_HOLE_FILES_DIR="/etc/.pihole"
|
||||||
PH_TEST="true" source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
|
PH_TEST="true"
|
||||||
|
source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
|
||||||
|
|
||||||
# webInterfaceGitUrl set in basic-install.sh
|
# webInterfaceGitUrl set in basic-install.sh
|
||||||
# webInterfaceDir set in basic-install.sh
|
# webInterfaceDir set in basic-install.sh
|
||||||
|
|
@ -20,9 +21,8 @@ PH_TEST="true" source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
|
||||||
source "${setupVars}"
|
source "${setupVars}"
|
||||||
update="false"
|
update="false"
|
||||||
|
|
||||||
# Colour codes
|
coltable="/opt/pihole/COL_TABLE"
|
||||||
red="\e[1;31m"
|
source ${coltable}
|
||||||
def="\e[0m"
|
|
||||||
|
|
||||||
fully_fetch_repo() {
|
fully_fetch_repo() {
|
||||||
# Add upstream branches to shallow clone
|
# Add upstream branches to shallow clone
|
||||||
|
|
@ -41,10 +41,12 @@ fully_fetch_repo() {
|
||||||
get_available_branches() {
|
get_available_branches() {
|
||||||
# Return available branches
|
# Return available branches
|
||||||
local directory="${1}"
|
local directory="${1}"
|
||||||
|
local output
|
||||||
|
|
||||||
cd "${directory}" || return 1
|
cd "${directory}" || return 1
|
||||||
# Get reachable remote branches
|
# Get reachable remote branches, but store STDERR as STDOUT variable
|
||||||
git remote show origin | grep 'tracked' | sed 's/tracked//;s/ //g'
|
output=$( { git remote show origin | grep 'tracked' | sed 's/tracked//;s/ //g'; } 2>&1 )
|
||||||
|
echo "$output"
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -58,7 +60,7 @@ fetch_checkout_pull_branch() {
|
||||||
cd "${directory}"
|
cd "${directory}"
|
||||||
git remote set-branches origin "${branch}" || return 1
|
git remote set-branches origin "${branch}" || return 1
|
||||||
git stash --all --quiet &> /dev/null || true
|
git stash --all --quiet &> /dev/null || true
|
||||||
git clean --force -d || true
|
git clean --quiet --force -d || true
|
||||||
git fetch --quiet || return 1
|
git fetch --quiet || return 1
|
||||||
checkout_pull_branch "${directory}" "${branch}" || return 1
|
checkout_pull_branch "${directory}" "${branch}" || return 1
|
||||||
}
|
}
|
||||||
|
|
@ -73,28 +75,35 @@ checkout_pull_branch() {
|
||||||
|
|
||||||
oldbranch="$(git symbolic-ref HEAD)"
|
oldbranch="$(git symbolic-ref HEAD)"
|
||||||
|
|
||||||
git checkout "${branch}" || return 1
|
git checkout "${branch}" --quiet || return 1
|
||||||
|
|
||||||
if [ "$(git diff "${oldbranch}" | grep -c "^")" -gt "0" ]; then
|
if [[ "$(git diff "${oldbranch}" | grep -c "^")" -gt "0" ]]; then
|
||||||
update="true"
|
update="true"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
git pull || return 1
|
git_pull=$(git pull || return 1)
|
||||||
|
|
||||||
|
if [[ "$git_pull" == *"up-to-date"* ]]; then
|
||||||
|
echo -e " ${INFO} $(git pull)"
|
||||||
|
else
|
||||||
|
echo -e "$git_pull\n"
|
||||||
|
fi
|
||||||
|
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
warning1() {
|
warning1() {
|
||||||
echo " Please note that changing branches severely alters your Pi-hole subsystems"
|
echo " Please note that changing branches severely alters your Pi-hole subsystems"
|
||||||
echo " Features that work on the master branch, may not on a development branch"
|
echo " Features that work on the master branch, may not on a development branch"
|
||||||
echo -e " ${red}This feature is NOT supported unless a Pi-hole developer explicitly asks!${def}"
|
echo -e " ${COL_LIGHT_RED}This feature is NOT supported unless a Pi-hole developer explicitly asks!${COL_NC}"
|
||||||
read -r -p " Have you read and understood this? [Y/N] " response
|
read -r -p " Have you read and understood this? [y/N] " response
|
||||||
case ${response} in
|
case ${response} in
|
||||||
[yY][eE][sS]|[yY])
|
[yY][eE][sS]|[yY])
|
||||||
echo "::: Continuing with branch change."
|
echo ""
|
||||||
return 0
|
return 0
|
||||||
;;
|
;;
|
||||||
*)
|
*)
|
||||||
echo "::: Branch change has been cancelled."
|
echo -e "\n ${INFO} Branch change has been cancelled"
|
||||||
return 1
|
return 1
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
|
@ -107,24 +116,23 @@ checkout() {
|
||||||
# Avoid globbing
|
# Avoid globbing
|
||||||
set -f
|
set -f
|
||||||
|
|
||||||
#This is unlikely
|
# This is unlikely
|
||||||
if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
|
if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
|
||||||
echo "::: Critical Error: Core Pi-hole repo is missing from system!"
|
echo -e " ${COL_LIGHT_RED}Error: Core Pi-hole repo is missing from system!
|
||||||
echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
|
Please re-run install script from https://github.com/pi-hole/pi-hole${COL_NC}"
|
||||||
exit 1;
|
exit 1;
|
||||||
fi
|
fi
|
||||||
if [[ ${INSTALL_WEB} == "true" ]]; then
|
if [[ ${INSTALL_WEB} == "true" ]]; then
|
||||||
if ! is_repo "${webInterfaceDir}" ; then
|
if ! is_repo "${webInterfaceDir}" ; then
|
||||||
echo "::: Critical Error: Web Admin repo is missing from system!"
|
echo -e " ${COL_LIGHT_RED}Error: Web Admin repo is missing from system!
|
||||||
echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
|
Please re-run install script from https://github.com/pi-hole/pi-hole${COL_NC}"
|
||||||
exit 1;
|
exit 1;
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ -z "${1}" ]]; then
|
if [[ -z "${1}" ]]; then
|
||||||
echo "::: No option detected. Please use 'pihole checkout <master|dev>'."
|
echo -e " ${COL_LIGHT_RED}Invalid option${COL_NC}
|
||||||
echo "::: Or enter the repository and branch you would like to check out:"
|
Try 'pihole checkout --help' for more information."
|
||||||
echo "::: 'pihole checkout <web|core> <branchname>'"
|
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
@ -134,72 +142,93 @@ checkout() {
|
||||||
|
|
||||||
if [[ "${1}" == "dev" ]] ; then
|
if [[ "${1}" == "dev" ]] ; then
|
||||||
# Shortcut to check out development branches
|
# Shortcut to check out development branches
|
||||||
echo "::: Shortcut \"dev\" detected - checking out development / devel branches ..."
|
echo -e " ${INFO} Shortcut \"dev\" detected - checking out development / devel branches..."
|
||||||
echo "::: Pi-hole core"
|
echo ""
|
||||||
fetch_checkout_pull_branch "${PI_HOLE_FILES_DIR}" "development" || { echo "Unable to pull Core developement branch"; exit 1; }
|
echo -e " ${INFO} Pi-hole Core"
|
||||||
|
fetch_checkout_pull_branch "${PI_HOLE_FILES_DIR}" "development" || { echo " ${CROSS} Unable to pull Core developement branch"; exit 1; }
|
||||||
if [[ ${INSTALL_WEB} == "true" ]]; then
|
if [[ ${INSTALL_WEB} == "true" ]]; then
|
||||||
echo "::: Web interface"
|
echo ""
|
||||||
fetch_checkout_pull_branch "${webInterfaceDir}" "devel" || { echo "Unable to pull Web development branch"; exit 1; }
|
echo -e " ${INFO} Web interface"
|
||||||
|
fetch_checkout_pull_branch "${webInterfaceDir}" "devel" || { echo " ${CROSS} Unable to pull Web development branch"; exit 1; }
|
||||||
fi
|
fi
|
||||||
echo "::: done!"
|
#echo -e " ${TICK} Pi-hole Core"
|
||||||
elif [[ "${1}" == "master" ]] ; then
|
elif [[ "${1}" == "master" ]] ; then
|
||||||
# Shortcut to check out master branches
|
# Shortcut to check out master branches
|
||||||
echo "::: Shortcut \"master\" detected - checking out master branches ..."
|
echo -e " ${INFO} Shortcut \"master\" detected - checking out master branches..."
|
||||||
echo "::: Pi-hole core"
|
echo -e " ${INFO} Pi-hole core"
|
||||||
fetch_checkout_pull_branch "${PI_HOLE_FILES_DIR}" "master" || { echo "Unable to pull Core master branch"; exit 1; }
|
fetch_checkout_pull_branch "${PI_HOLE_FILES_DIR}" "master" || { echo " ${CROSS} Unable to pull Core master branch"; exit 1; }
|
||||||
if [[ ${INSTALL_WEB} == "true" ]]; then
|
if [[ ${INSTALL_WEB} == "true" ]]; then
|
||||||
echo "::: Web interface"
|
echo -e " ${INFO} Web interface"
|
||||||
fetch_checkout_pull_branch "${webInterfaceDir}" "master" || { echo "Unable to pull web master branch"; exit 1; }
|
fetch_checkout_pull_branch "${webInterfaceDir}" "master" || { echo " ${CROSS} Unable to pull Web master branch"; exit 1; }
|
||||||
fi
|
fi
|
||||||
echo "::: done!"
|
#echo -e " ${TICK} Web Interface"
|
||||||
|
|
||||||
elif [[ "${1}" == "core" ]] ; then
|
elif [[ "${1}" == "core" ]] ; then
|
||||||
echo -n "::: Fetching remote branches for Pi-hole core from ${piholeGitUrl} ... "
|
str="Fetching branches from ${piholeGitUrl}"
|
||||||
|
echo -ne " ${INFO} $str"
|
||||||
if ! fully_fetch_repo "${PI_HOLE_FILES_DIR}" ; then
|
if ! fully_fetch_repo "${PI_HOLE_FILES_DIR}" ; then
|
||||||
echo "::: Fetching all branches for Pi-hole core repo failed!"
|
echo -e " ${CROSS} $str"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
corebranches=($(get_available_branches "${PI_HOLE_FILES_DIR}"))
|
corebranches=($(get_available_branches "${PI_HOLE_FILES_DIR}"))
|
||||||
echo " done!"
|
|
||||||
echo "::: ${#corebranches[@]} branches available"
|
if [[ "${corebranches[@]}" == *"master"* ]]; then
|
||||||
echo ":::"
|
echo -e "${OVER} ${TICK} $str
|
||||||
# Have to user chosing the branch he wants
|
${INFO} ${#corebranches[@]} branches available for Pi-hole Core"
|
||||||
|
else
|
||||||
|
# Print STDERR output from get_available_branches
|
||||||
|
echo -e "${OVER} ${CROSS} $str\n\n${corebranches[*]}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
# Have the user choose the branch they want
|
||||||
if ! (for e in "${corebranches[@]}"; do [[ "$e" == "${2}" ]] && exit 0; done); then
|
if ! (for e in "${corebranches[@]}"; do [[ "$e" == "${2}" ]] && exit 0; done); then
|
||||||
echo "::: Requested branch \"${2}\" is not available!"
|
echo -e " ${INFO} Requested branch \"${2}\" is not available"
|
||||||
echo "::: Available branches for core are:"
|
echo -e " ${INFO} Available branches for Core are:"
|
||||||
for e in "${corebranches[@]}"; do echo "::: $e"; done
|
for e in "${corebranches[@]}"; do echo " - $e"; done
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
checkout_pull_branch "${PI_HOLE_FILES_DIR}" "${2}"
|
checkout_pull_branch "${PI_HOLE_FILES_DIR}" "${2}"
|
||||||
elif [[ "${1}" == "web" && "${INSTALL_WEB}" == "true" ]] ; then
|
elif [[ "${1}" == "web" ]] && [[ "${INSTALL_WEB}" == "true" ]] ; then
|
||||||
echo -n "::: Fetching remote branches for the web interface from ${webInterfaceGitUrl} ... "
|
str="Fetching branches from ${webInterfaceGitUrl}"
|
||||||
|
echo -ne " ${INFO} $str"
|
||||||
if ! fully_fetch_repo "${webInterfaceDir}" ; then
|
if ! fully_fetch_repo "${webInterfaceDir}" ; then
|
||||||
echo "::: Fetching all branches for Pi-hole web interface repo failed!"
|
echo -e " ${CROSS} $str"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
webbranches=($(get_available_branches "${webInterfaceDir}"))
|
webbranches=($(get_available_branches "${webInterfaceDir}"))
|
||||||
echo " done!"
|
|
||||||
echo "::: ${#webbranches[@]} branches available"
|
if [[ "${corebranches[@]}" == *"master"* ]]; then
|
||||||
echo ":::"
|
echo -e "${OVER} ${TICK} $str
|
||||||
# Have to user chosing the branch he wants
|
${INFO} ${#webbranches[@]} branches available for Web Admin"
|
||||||
|
else
|
||||||
|
# Print STDERR output from get_available_branches
|
||||||
|
echo -e "${OVER} ${CROSS} $str\n\n${corebranches[*]}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
# Have the user choose the branch they want
|
||||||
if ! (for e in "${webbranches[@]}"; do [[ "$e" == "${2}" ]] && exit 0; done); then
|
if ! (for e in "${webbranches[@]}"; do [[ "$e" == "${2}" ]] && exit 0; done); then
|
||||||
echo "::: Requested branch \"${2}\" is not available!"
|
echo -e " ${INFO} Requested branch \"${2}\" is not available"
|
||||||
echo "::: Available branches for web are:"
|
echo -e " ${INFO} Available branches for Web Admin are:"
|
||||||
for e in "${webbranches[@]}"; do echo "::: $e"; done
|
for e in "${webbranches[@]}"; do echo " - $e"; done
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
checkout_pull_branch "${webInterfaceDir}" "${2}"
|
checkout_pull_branch "${webInterfaceDir}" "${2}"
|
||||||
else
|
else
|
||||||
echo "::: Requested option \"${1}\" is not available!"
|
echo -e " ${INFO} Requested option \"${1}\" is not available"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Force updating everything
|
# Force updating everything
|
||||||
if [[ ! "${1}" == "web" && "${update}" == "true" ]]; then
|
if [[ ! "${1}" == "web" && "${update}" == "true" ]]; then
|
||||||
echo "::: Running installer to upgrade your installation"
|
echo -e " ${INFO} Running installer to upgrade your installation"
|
||||||
if "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh" --unattended; then
|
if "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh" --unattended; then
|
||||||
exit 0
|
exit 0
|
||||||
else
|
else
|
||||||
echo "Unable to complete update, contact Pi-hole"
|
echo -e " ${COL_LIGHT_RED} Error: Unable to complete update, please contact support${COL_NC}"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
|
||||||
|
|
@ -8,8 +8,11 @@
|
||||||
# This file is copyright under the latest version of the EUPL.
|
# This file is copyright under the latest version of the EUPL.
|
||||||
# Please see LICENSE file for your rights under this license.
|
# Please see LICENSE file for your rights under this license.
|
||||||
|
|
||||||
|
colfile="/opt/pihole/COL_TABLE"
|
||||||
|
source ${colfile}
|
||||||
|
|
||||||
if [[ "$@" != *"quiet"* ]]; then
|
if [[ "$@" != *"quiet"* ]]; then
|
||||||
echo -n "::: Flushing /var/log/pihole.log ..."
|
echo -ne " ${INFO} Flushing /var/log/pihole.log ..."
|
||||||
fi
|
fi
|
||||||
if [[ "$@" == *"once"* ]]; then
|
if [[ "$@" == *"once"* ]]; then
|
||||||
# Nightly logrotation
|
# Nightly logrotation
|
||||||
|
|
@ -41,5 +44,5 @@ else
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ "$@" != *"quiet"* ]]; then
|
if [[ "$@" != *"quiet"* ]]; then
|
||||||
echo "... done!"
|
echo -e "${OVER} ${TICK} Flushed /var/log/pihole.log"
|
||||||
fi
|
fi
|
||||||
|
|
|
||||||
|
|
@ -10,17 +10,20 @@
|
||||||
# This file is copyright under the latest version of the EUPL.
|
# This file is copyright under the latest version of the EUPL.
|
||||||
# Please see LICENSE file for your rights under this license.
|
# Please see LICENSE file for your rights under this license.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Variables
|
# Variables
|
||||||
|
|
||||||
readonly ADMIN_INTERFACE_GIT_URL="https://github.com/pi-hole/AdminLTE.git"
|
readonly ADMIN_INTERFACE_GIT_URL="https://github.com/pi-hole/AdminLTE.git"
|
||||||
readonly ADMIN_INTERFACE_DIR="/var/www/html/admin"
|
readonly ADMIN_INTERFACE_DIR="/var/www/html/admin"
|
||||||
readonly PI_HOLE_GIT_URL="https://github.com/pi-hole/pi-hole.git"
|
readonly PI_HOLE_GIT_URL="https://github.com/pi-hole/pi-hole.git"
|
||||||
readonly PI_HOLE_FILES_DIR="/etc/.pihole"
|
readonly PI_HOLE_FILES_DIR="/etc/.pihole"
|
||||||
|
|
||||||
|
# shellcheck disable=SC2034
|
||||||
PH_TEST=true
|
PH_TEST=true
|
||||||
source ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh
|
|
||||||
|
# Have to ignore the following rule as spaces in paths are not supported by ShellCheck
|
||||||
|
#shellcheck disable=SC1090
|
||||||
|
source "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh"
|
||||||
|
|
||||||
|
source "/opt/pihole/COL_TABLE"
|
||||||
|
|
||||||
# is_repo() sourced from basic-install.sh
|
# is_repo() sourced from basic-install.sh
|
||||||
# make_repo() sourced from basic-install.sh
|
# make_repo() sourced from basic-install.sh
|
||||||
|
|
@ -30,14 +33,14 @@ source ${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh
|
||||||
GitCheckUpdateAvail() {
|
GitCheckUpdateAvail() {
|
||||||
local directory="${1}"
|
local directory="${1}"
|
||||||
curdir=$PWD
|
curdir=$PWD
|
||||||
cd "${directory}"
|
cd "${directory}" || return
|
||||||
|
|
||||||
# Fetch latest changes in this repo
|
# Fetch latest changes in this repo
|
||||||
git fetch --quiet origin
|
git fetch --quiet origin
|
||||||
|
|
||||||
# @ alone is a shortcut for HEAD. Older versions of git
|
# @ alone is a shortcut for HEAD. Older versions of git
|
||||||
# need @{0}
|
# need @{0}
|
||||||
LOCAL="$(git rev-parse @{0})"
|
LOCAL="$(git rev-parse "@{0}")"
|
||||||
|
|
||||||
# The suffix @{upstream} to a branchname
|
# The suffix @{upstream} to a branchname
|
||||||
# (short form <branchname>@{u}) refers
|
# (short form <branchname>@{u}) refers
|
||||||
|
|
@ -46,23 +49,23 @@ GitCheckUpdateAvail() {
|
||||||
# (configured with branch.<name>.remote and
|
# (configured with branch.<name>.remote and
|
||||||
# branch.<name>.merge). A missing branchname
|
# branch.<name>.merge). A missing branchname
|
||||||
# defaults to the current one.
|
# defaults to the current one.
|
||||||
REMOTE="$(git rev-parse @{upstream})"
|
REMOTE="$(git rev-parse "@{upstream}")"
|
||||||
|
|
||||||
if [[ ${#LOCAL} == 0 ]]; then
|
if [[ ${#LOCAL} == 0 ]]; then
|
||||||
echo "::: Error: Local revision could not be obtained, ask Pi-hole support."
|
echo -e " ${COL_LIGHT_RED}Error: Local revision could not be obtained, ask Pi-hole support."
|
||||||
echo "::: Additional debugging output:"
|
echo -e " Additional debugging output:${COL_NC}"
|
||||||
git status
|
git status
|
||||||
exit
|
exit
|
||||||
fi
|
fi
|
||||||
if [[ ${#REMOTE} == 0 ]]; then
|
if [[ ${#REMOTE} == 0 ]]; then
|
||||||
echo "::: Error: Remote revision could not be obtained, ask Pi-hole support."
|
echo -e " ${COL_LIGHT_RED}Error: Remote revision could not be obtained, ask Pi-hole support."
|
||||||
echo "::: Additional debugging output:"
|
echo -e " Additional debugging output:${COL_NC}"
|
||||||
git status
|
git status
|
||||||
exit
|
exit
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Change back to original directory
|
# Change back to original directory
|
||||||
cd "${curdir}"
|
cd "${curdir}" || exit
|
||||||
|
|
||||||
if [[ "${LOCAL}" != "${REMOTE}" ]]; then
|
if [[ "${LOCAL}" != "${REMOTE}" ]]; then
|
||||||
# Local branch is behind remote branch -> Update
|
# Local branch is behind remote branch -> Update
|
||||||
|
|
@ -76,9 +79,10 @@ GitCheckUpdateAvail() {
|
||||||
}
|
}
|
||||||
|
|
||||||
FTLcheckUpdate() {
|
FTLcheckUpdate() {
|
||||||
|
local FTLversion
|
||||||
local FTLversion=$(/usr/bin/pihole-FTL tag)
|
FTLversion=$(/usr/bin/pihole-FTL tag)
|
||||||
local FTLlatesttag=$(curl -sI https://github.com/pi-hole/FTL/releases/latest | grep 'Location' | awk -F '/' '{print $NF}' | tr -d '\r\n')
|
local FTLlatesttag
|
||||||
|
FTLlatesttag=$(curl -sI https://github.com/pi-hole/FTL/releases/latest | grep 'Location' | awk -F '/' '{print $NF}' | tr -d '\r\n')
|
||||||
|
|
||||||
if [[ "${FTLversion}" != "${FTLlatesttag}" ]]; then
|
if [[ "${FTLversion}" != "${FTLlatesttag}" ]]; then
|
||||||
return 0
|
return 0
|
||||||
|
|
@ -90,53 +94,57 @@ FTLcheckUpdate() {
|
||||||
main() {
|
main() {
|
||||||
local pihole_version_current
|
local pihole_version_current
|
||||||
local web_version_current
|
local web_version_current
|
||||||
|
#shellcheck disable=1090,2154
|
||||||
source "${setupVars}"
|
source "${setupVars}"
|
||||||
|
|
||||||
#This is unlikely
|
#This is unlikely
|
||||||
if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
|
if ! is_repo "${PI_HOLE_FILES_DIR}" ; then
|
||||||
echo "::: Critical Error: Core Pi-hole repo is missing from system!"
|
echo -e " ${COL_LIGHT_RED}Critical Error: Core Pi-hole repo is missing from system!"
|
||||||
echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
|
echo -e " Please re-run install script from https://github.com/pi-hole/pi-hole${COL_NC}"
|
||||||
exit 1;
|
exit 1;
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo "::: Checking for updates..."
|
echo -e " ${INFO} Checking for updates..."
|
||||||
|
|
||||||
if GitCheckUpdateAvail "${PI_HOLE_FILES_DIR}" ; then
|
if GitCheckUpdateAvail "${PI_HOLE_FILES_DIR}" ; then
|
||||||
core_update=true
|
core_update=true
|
||||||
echo "::: Pi-hole Core: update available"
|
echo -e " ${INFO} Pi-hole Core:\t${COL_YELLOW}update available${COL_NC}"
|
||||||
else
|
else
|
||||||
core_update=false
|
core_update=false
|
||||||
echo "::: Pi-hole Core: up to date"
|
echo -e " ${INFO} Pi-hole Core:\t${COL_LIGHT_GREEN}up to date${COL_NC}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if FTLcheckUpdate ; then
|
if FTLcheckUpdate ; then
|
||||||
FTL_update=true
|
FTL_update=true
|
||||||
echo "::: FTL: update available"
|
echo -e " ${INFO} FTL:\t\t${COL_YELLOW}update available${COL_NC}"
|
||||||
else
|
else
|
||||||
FTL_update=false
|
FTL_update=false
|
||||||
echo "::: FTL: up to date"
|
echo -e " ${INFO} FTL:\t\t${COL_LIGHT_GREEN}up to date${COL_NC}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if ${FTL_update}; then
|
# Logic: Don't update FTL when there is a core update available
|
||||||
echo ":::"
|
# since the core update will run the installer which will itself
|
||||||
echo "::: FTL out of date"
|
# re-install (i.e. update) FTL
|
||||||
|
if ${FTL_update} && ! ${core_update}; then
|
||||||
|
echo ""
|
||||||
|
echo -e " ${INFO} FTL out of date"
|
||||||
FTLdetect
|
FTLdetect
|
||||||
echo ":::"
|
echo ""
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ ${INSTALL_WEB} == true ]]; then
|
if [[ ${INSTALL_WEB} == true ]]; then
|
||||||
if ! is_repo "${ADMIN_INTERFACE_DIR}" ; then
|
if ! is_repo "${ADMIN_INTERFACE_DIR}" ; then
|
||||||
echo "::: Critical Error: Web Admin repo is missing from system!"
|
echo -e " ${COL_LIGHT_RED}Critical Error: Web Admin repo is missing from system!"
|
||||||
echo "::: Please re-run install script from https://github.com/pi-hole/pi-hole"
|
echo -e " Please re-run install script from https://github.com/pi-hole/pi-hole${COL_NC}"
|
||||||
exit 1;
|
exit 1;
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if GitCheckUpdateAvail "${ADMIN_INTERFACE_DIR}" ; then
|
if GitCheckUpdateAvail "${ADMIN_INTERFACE_DIR}" ; then
|
||||||
web_update=true
|
web_update=true
|
||||||
echo "::: Web Interface: update available"
|
echo -e " ${INFO} Web Interface:\t${COL_YELLOW}update available${COL_NC}"
|
||||||
else
|
else
|
||||||
web_update=false
|
web_update=false
|
||||||
echo "::: Web Interface: up to date"
|
echo -e " ${INFO} Web Interface:\t${COL_LIGHT_GREEN}up to date${COL_NC}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Logic
|
# Logic
|
||||||
|
|
@ -151,64 +159,64 @@ main() {
|
||||||
|
|
||||||
if ! ${core_update} && ! ${web_update} ; then
|
if ! ${core_update} && ! ${web_update} ; then
|
||||||
if ! ${FTL_update} ; then
|
if ! ${FTL_update} ; then
|
||||||
echo ":::"
|
echo ""
|
||||||
echo "::: Everything is up to date!"
|
echo -e " ${TICK} Everything is up to date!"
|
||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
elif ! ${core_update} && ${web_update} ; then
|
elif ! ${core_update} && ${web_update} ; then
|
||||||
echo ":::"
|
echo ""
|
||||||
echo "::: Pi-hole Web Admin files out of date"
|
echo -e " ${INFO} Pi-hole Web Admin files out of date"
|
||||||
getGitFiles "${ADMIN_INTERFACE_DIR}" "${ADMIN_INTERFACE_GIT_URL}"
|
getGitFiles "${ADMIN_INTERFACE_DIR}" "${ADMIN_INTERFACE_GIT_URL}"
|
||||||
|
|
||||||
elif ${core_update} && ! ${web_update} ; then
|
elif ${core_update} && ! ${web_update} ; then
|
||||||
echo ":::"
|
echo ""
|
||||||
echo "::: Pi-hole core files out of date"
|
echo -e " ${INFO} Pi-hole core files out of date"
|
||||||
getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
|
getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
|
||||||
${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
|
${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || echo -e " ${COL_LIGHT_RED}Unable to complete update, contact Pi-hole${COL_NC}" && exit 1
|
||||||
|
|
||||||
elif ${core_update} && ${web_update} ; then
|
elif ${core_update} && ${web_update} ; then
|
||||||
echo ":::"
|
echo ""
|
||||||
echo "::: Updating Pi-hole core and web admin files"
|
echo -e " ${INFO} Updating Pi-hole core and web admin files"
|
||||||
getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
|
getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
|
||||||
${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
|
${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --unattended || echo -e " ${COL_LIGHT_RED}Unable to complete update, contact Pi-hole${COL_NC}" && exit 1
|
||||||
else
|
else
|
||||||
echo "*** Update script has malfunctioned, fallthrough reached. Please contact support"
|
echo -e " ${COL_LIGHT_RED}Update script has malfunctioned, fallthrough reached. Please contact support${COL_NC}"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
else # Web Admin not installed, so only verify if core is up to date
|
else # Web Admin not installed, so only verify if core is up to date
|
||||||
if ! ${core_update}; then
|
if ! ${core_update}; then
|
||||||
if ! ${FTL_update} ; then
|
if ! ${FTL_update} ; then
|
||||||
echo ":::"
|
echo ""
|
||||||
echo "::: Everything is up to date!"
|
echo -e " ${INFO} Everything is up to date!"
|
||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
echo ":::"
|
echo ""
|
||||||
echo "::: Pi-hole core files out of date"
|
echo -e " ${INFO} Pi-hole core files out of date"
|
||||||
getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
|
getGitFiles "${PI_HOLE_FILES_DIR}" "${PI_HOLE_GIT_URL}"
|
||||||
${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || echo "Unable to complete update, contact Pi-hole" && exit 1
|
${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --reconfigure --unattended || echo -e " ${COL_LIGHT_RED}Unable to complete update, contact Pi-hole${COL_NC}" && exit 1
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ "${web_update}" == true ]]; then
|
if [[ "${web_update}" == true ]]; then
|
||||||
web_version_current="$(/usr/local/bin/pihole version --admin --current)"
|
web_version_current="$(/usr/local/bin/pihole version --admin --current)"
|
||||||
echo ":::"
|
echo ""
|
||||||
echo "::: Web Admin version is now at ${web_version_current}"
|
echo -e " ${INFO} 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'"
|
echo -e " ${INFO} If you had made any changes in '/var/www/html/admin/', they have been stashed using 'git stash'"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ "${core_update}" == true ]]; then
|
if [[ "${core_update}" == true ]]; then
|
||||||
pihole_version_current="$(/usr/local/bin/pihole version --pihole --current)"
|
pihole_version_current="$(/usr/local/bin/pihole version --pihole --current)"
|
||||||
echo ":::"
|
echo ""
|
||||||
echo "::: Pi-hole version is now at ${pihole_version_current}"
|
echo -e " ${INFO} 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'"
|
echo -e " ${INFO} If you had made any changes in '/etc/.pihole/', they have been stashed using 'git stash'"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ ${FTL_update} == true ]]; then
|
if [[ ${FTL_update} == true ]]; then
|
||||||
FTL_version_current="$(/usr/bin/pihole-FTL tag)"
|
FTL_version_current="$(/usr/bin/pihole-FTL tag)"
|
||||||
echo ":::"
|
echo ""
|
||||||
echo "::: FTL version is now at ${FTL_version_current}"
|
echo -e " ${INFO} FTL version is now at ${FTL_version_current/* v/v}"
|
||||||
start_service pihole-FTL
|
start_service pihole-FTL
|
||||||
enable_service pihole-FTL
|
enable_service pihole-FTL
|
||||||
fi
|
fi
|
||||||
|
|
|
||||||
|
|
@ -14,13 +14,17 @@ readonly dhcpconfig="/etc/dnsmasq.d/02-pihole-dhcp.conf"
|
||||||
# 03 -> wildcards
|
# 03 -> wildcards
|
||||||
readonly dhcpstaticconfig="/etc/dnsmasq.d/04-pihole-static-dhcp.conf"
|
readonly dhcpstaticconfig="/etc/dnsmasq.d/04-pihole-static-dhcp.conf"
|
||||||
|
|
||||||
|
coltable="/opt/pihole/COL_TABLE"
|
||||||
|
if [[ -f ${coltable} ]]; then
|
||||||
|
source ${coltable}
|
||||||
|
fi
|
||||||
|
|
||||||
helpFunc() {
|
helpFunc() {
|
||||||
echo "Usage: pihole -a [options]
|
echo "Usage: pihole -a [options]
|
||||||
Example: pihole -a -p password
|
Example: pihole -a -p password
|
||||||
Set options for the Admin Console
|
Set options for the Admin Console
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-f, flush Flush the Pi-hole log
|
|
||||||
-p, password Set Admin Console password
|
-p, password Set Admin Console password
|
||||||
-c, celsius Set Celsius as preferred temperature unit
|
-c, celsius Set Celsius as preferred temperature unit
|
||||||
-f, fahrenheit Set Fahrenheit as preferred temperature unit
|
-f, fahrenheit Set Fahrenheit as preferred temperature unit
|
||||||
|
|
@ -58,6 +62,7 @@ delete_dnsmasq_setting() {
|
||||||
|
|
||||||
SetTemperatureUnit() {
|
SetTemperatureUnit() {
|
||||||
change_setting "TEMPERATUREUNIT" "${unit}"
|
change_setting "TEMPERATUREUNIT" "${unit}"
|
||||||
|
echo -e " ${TICK} Set temperature unit to ${unit}"
|
||||||
}
|
}
|
||||||
|
|
||||||
HashPassword() {
|
HashPassword() {
|
||||||
|
|
@ -89,7 +94,7 @@ SetWebPassword() {
|
||||||
|
|
||||||
if [ "${PASSWORD}" == "" ]; then
|
if [ "${PASSWORD}" == "" ]; then
|
||||||
change_setting "WEBPASSWORD" ""
|
change_setting "WEBPASSWORD" ""
|
||||||
echo "Password Removed"
|
echo -e " ${TICK} Password Removed"
|
||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
@ -101,9 +106,9 @@ SetWebPassword() {
|
||||||
hash=$(HashPassword ${PASSWORD})
|
hash=$(HashPassword ${PASSWORD})
|
||||||
# Save hash to file
|
# Save hash to file
|
||||||
change_setting "WEBPASSWORD" "${hash}"
|
change_setting "WEBPASSWORD" "${hash}"
|
||||||
echo "New password set"
|
echo -e " ${TICK} New password set"
|
||||||
else
|
else
|
||||||
echo "Passwords don't match. Your password has not been changed"
|
echo -e " ${CROSS} Passwords don't match. Your password has not been changed"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
@ -213,11 +218,19 @@ Reboot() {
|
||||||
}
|
}
|
||||||
|
|
||||||
RestartDNS() {
|
RestartDNS() {
|
||||||
if [ -x "$(command -v systemctl)" ]; then
|
local str="Restarting dnsmasq"
|
||||||
systemctl restart dnsmasq &> /dev/null
|
echo -ne " ${INFO} ${str}..."
|
||||||
else
|
if [[ -x "$(command -v systemctl)" ]]; then
|
||||||
service dnsmasq restart &> /dev/null
|
systemctl restart dnsmasq
|
||||||
fi
|
else
|
||||||
|
service dnsmasq restart
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ "$?" == 0 ]]; then
|
||||||
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
|
else
|
||||||
|
echo -e "${OVER} ${CROSS} ${str}"
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
SetQueryLogOptions() {
|
SetQueryLogOptions() {
|
||||||
|
|
@ -404,13 +417,13 @@ Interfaces:
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ "${args[2]}" == "all" ]]; then
|
if [[ "${args[2]}" == "all" ]]; then
|
||||||
echo "Listening on all interfaces, permiting all origins, hope you have a firewall!"
|
echo -e " ${INFO} Listening on all interfaces, permiting all origins. Please use a firewall!"
|
||||||
change_setting "DNSMASQ_LISTENING" "all"
|
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)"
|
echo -e " ${INFO} Listening on all interfaces, permiting origins from one hop away (LAN)"
|
||||||
change_setting "DNSMASQ_LISTENING" "local"
|
change_setting "DNSMASQ_LISTENING" "local"
|
||||||
else
|
else
|
||||||
echo "Listening only on interface ${PIHOLE_INTERFACE}"
|
echo -e " ${INFO} Listening only on interface ${PIHOLE_INTERFACE}"
|
||||||
change_setting "DNSMASQ_LISTENING" "single"
|
change_setting "DNSMASQ_LISTENING" "single"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
@ -428,6 +441,11 @@ Teleporter() {
|
||||||
php /var/www/html/admin/scripts/pi-hole/php/teleporter.php > "pi-hole-teleporter_${datetimestamp}.zip"
|
php /var/www/html/admin/scripts/pi-hole/php/teleporter.php > "pi-hole-teleporter_${datetimestamp}.zip"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
audit()
|
||||||
|
{
|
||||||
|
echo "${args[2]}" >> /etc/pihole/auditlog.list
|
||||||
|
}
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
args=("$@")
|
args=("$@")
|
||||||
|
|
||||||
|
|
@ -454,6 +472,7 @@ main() {
|
||||||
"-i" | "interface" ) SetListeningMode "$@";;
|
"-i" | "interface" ) SetListeningMode "$@";;
|
||||||
"-t" | "teleporter" ) Teleporter;;
|
"-t" | "teleporter" ) Teleporter;;
|
||||||
"adlist" ) CustomizeAdLists;;
|
"adlist" ) CustomizeAdLists;;
|
||||||
|
"audit" ) audit;;
|
||||||
* ) helpFunc;;
|
* ) helpFunc;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,3 +8,14 @@
|
||||||
notifempty
|
notifempty
|
||||||
nomail
|
nomail
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/var/log/pihole-FTL.log {
|
||||||
|
# su #
|
||||||
|
weekly
|
||||||
|
copytruncate
|
||||||
|
rotate 3
|
||||||
|
compress
|
||||||
|
delaycompress
|
||||||
|
notifempty
|
||||||
|
nomail
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ start() {
|
||||||
echo "pihole-FTL is already running"
|
echo "pihole-FTL is already running"
|
||||||
else
|
else
|
||||||
touch /var/log/pihole-FTL.log /run/pihole-FTL.pid /run/pihole-FTL.port
|
touch /var/log/pihole-FTL.log /run/pihole-FTL.pid /run/pihole-FTL.port
|
||||||
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
|
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"
|
su -s /bin/sh -c "/usr/bin/pihole-FTL" "$FTLUSER"
|
||||||
echo
|
echo
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load diff
|
|
@ -8,19 +8,30 @@
|
||||||
# This file is copyright under the latest version of the EUPL.
|
# This file is copyright under the latest version of the EUPL.
|
||||||
# Please see LICENSE file for your rights under this license.
|
# Please see LICENSE file for your rights under this license.
|
||||||
|
|
||||||
|
source "/opt/pihole/COL_TABLE"
|
||||||
|
|
||||||
|
while true; do
|
||||||
|
read -rp " ${QST} Are you sure you would like to remove ${COL_WHITE}Pi-hole${COL_NC}? [y/N] " yn
|
||||||
|
case ${yn} in
|
||||||
|
[Yy]* ) break;;
|
||||||
|
[Nn]* ) echo -e "\n ${COL_LIGHT_GREEN}Uninstall has been cancelled${COL_NC}"; exit 0;;
|
||||||
|
* ) echo -e "\n ${COL_LIGHT_GREEN}Uninstall has been cancelled${COL_NC}"; exit 0;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
# Must be root to uninstall
|
# Must be root to uninstall
|
||||||
|
str="Root user check"
|
||||||
if [[ ${EUID} -eq 0 ]]; then
|
if [[ ${EUID} -eq 0 ]]; then
|
||||||
echo "::: You are root."
|
echo -e " ${TICK} ${str}"
|
||||||
else
|
else
|
||||||
echo "::: Sudo will be used for the uninstall."
|
# Check if sudo is actually installed
|
||||||
# Check if it is actually installed
|
# If it isn't, exit because the uninstall can not complete
|
||||||
# If it isn't, exit because the unnstall cannot complete
|
|
||||||
if [ -x "$(command -v sudo)" ]; then
|
if [ -x "$(command -v sudo)" ]; then
|
||||||
export SUDO="sudo"
|
export SUDO="sudo"
|
||||||
else
|
else
|
||||||
echo "::: Please install sudo or run this as root."
|
echo -e " ${CROSS} ${str}
|
||||||
|
Script called with non-root privileges
|
||||||
|
The Pi-hole requires elevated privleges to uninstall"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
@ -54,59 +65,48 @@ elif [ -x "$(command -v apt-get)" ]; then
|
||||||
${SUDO} ${PKG_MANAGER} -y autoclean
|
${SUDO} ${PKG_MANAGER} -y autoclean
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
echo "OS distribution not supported"
|
echo -e " ${CROSS} OS distribution not supported"
|
||||||
exit
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
spinner() {
|
|
||||||
local pid=$1
|
|
||||||
local delay=0.50
|
|
||||||
local spinstr='/-\|'
|
|
||||||
while [ "$(ps a | awk '{print $1}' | grep "${pid}")" ]; do
|
|
||||||
local temp=${spinstr#?}
|
|
||||||
printf " [%c] " "${spinstr}"
|
|
||||||
local spinstr=${temp}${spinstr%"$temp}"}
|
|
||||||
sleep ${delay}
|
|
||||||
printf "\b\b\b\b\b\b"
|
|
||||||
done
|
|
||||||
printf " \b\b\b\b"
|
|
||||||
}
|
|
||||||
|
|
||||||
removeAndPurge() {
|
removeAndPurge() {
|
||||||
# Purge dependencies
|
# Purge dependencies
|
||||||
echo ":::"
|
echo ""
|
||||||
for i in "${PIHOLE_DEPS[@]}"; do
|
for i in "${PIHOLE_DEPS[@]}"; do
|
||||||
package_check ${i} > /dev/null
|
package_check ${i} > /dev/null
|
||||||
if [ $? -eq 0 ]; then
|
if [[ "$?" -eq 0 ]]; then
|
||||||
while true; do
|
while true; do
|
||||||
read -rp "::: Do you wish to remove ${i} from your system? [y/n]: " yn
|
read -rp " ${QST} Do you wish to remove ${COL_WHITE}${i}${COL_NC} from your system? [Y/N] " yn
|
||||||
case ${yn} in
|
case ${yn} in
|
||||||
[Yy]* ) printf ":::\tRemoving %s..." "${i}"; ${SUDO} ${PKG_REMOVE} "${i}" &> /dev/null & spinner $!; printf "done!\n"; break;;
|
[Yy]* )
|
||||||
[Nn]* ) printf ":::\tSkipping %s\n" "${i}"; break;;
|
echo -ne " ${INFO} Removing ${i}...";
|
||||||
* ) printf "::: You must answer yes or no!\n";;
|
${SUDO} ${PKG_REMOVE} "${i}" &> /dev/null;
|
||||||
|
echo -e "${OVER} ${INFO} Removed ${i}";
|
||||||
|
break;;
|
||||||
|
[Nn]* ) echo -e " ${INFO} Skipped ${i}"; break;;
|
||||||
esac
|
esac
|
||||||
done
|
done
|
||||||
else
|
else
|
||||||
printf ":::\tPackage %s not installed... Not removing.\n" "${i}"
|
echo -e " ${INFO} Package ${i} not installed"
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
|
|
||||||
# Remove dependency config files
|
# Remove dnsmasq config files
|
||||||
echo "::: Removing dnsmasq config files..."
|
|
||||||
${SUDO} rm /etc/dnsmasq.conf /etc/dnsmasq.conf.orig /etc/dnsmasq.d/01-pihole.conf &> /dev/null
|
${SUDO} rm /etc/dnsmasq.conf /etc/dnsmasq.conf.orig /etc/dnsmasq.d/01-pihole.conf &> /dev/null
|
||||||
|
echo -e " ${TICK} Removing dnsmasq config files"
|
||||||
|
|
||||||
# Take care of any additional package cleaning
|
# Take care of any additional package cleaning
|
||||||
printf "::: Auto removing & cleaning remaining dependencies..."
|
echo -ne " ${INFO} Removing & cleaning remaining dependencies..."
|
||||||
package_cleanup &> /dev/null & spinner $!; printf "done!\n";
|
package_cleanup &> /dev/null
|
||||||
|
echo -e "${OVER} ${TICK} Removed & cleaned up remaining dependencies"
|
||||||
# Call removeNoPurge to remove PiHole specific files
|
|
||||||
|
# Call removeNoPurge to remove Pi-hole specific files
|
||||||
removeNoPurge
|
removeNoPurge
|
||||||
}
|
}
|
||||||
|
|
||||||
removeNoPurge() {
|
removeNoPurge() {
|
||||||
echo ":::"
|
# Only web directories/files that are created by Pi-hole should be removed
|
||||||
# Only web directories/files that are created by pihole should be removed.
|
echo -ne " ${INFO} Removing Web Interface..."
|
||||||
echo "::: Removing the Pi-hole Web server files..."
|
|
||||||
${SUDO} rm -rf /var/www/html/admin &> /dev/null
|
${SUDO} rm -rf /var/www/html/admin &> /dev/null
|
||||||
${SUDO} rm -rf /var/www/html/pihole &> /dev/null
|
${SUDO} rm -rf /var/www/html/pihole &> /dev/null
|
||||||
${SUDO} rm /var/www/html/index.lighttpd.orig &> /dev/null
|
${SUDO} rm /var/www/html/index.lighttpd.orig &> /dev/null
|
||||||
|
|
@ -117,34 +117,35 @@ removeNoPurge() {
|
||||||
${SUDO} rm -rf /var/www/html &> /dev/null
|
${SUDO} rm -rf /var/www/html &> /dev/null
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
echo -e "${OVER} ${TICK} Removed Web Interface"
|
||||||
|
|
||||||
# Attempt to preserve backwards compatibility with older versions
|
# Attempt to preserve backwards compatibility with older versions
|
||||||
# to guarantee no additional changes were made to /etc/crontab after
|
# to guarantee no additional changes were made to /etc/crontab after
|
||||||
# the installation of pihole, /etc/crontab.pihole should be permanently
|
# the installation of pihole, /etc/crontab.pihole should be permanently
|
||||||
# preserved.
|
# preserved.
|
||||||
if [[ -f /etc/crontab.orig ]]; then
|
if [[ -f /etc/crontab.orig ]]; then
|
||||||
echo "::: Initial Pi-hole cron detected. Restoring the default system cron..."
|
|
||||||
${SUDO} mv /etc/crontab /etc/crontab.pihole
|
${SUDO} mv /etc/crontab /etc/crontab.pihole
|
||||||
${SUDO} mv /etc/crontab.orig /etc/crontab
|
${SUDO} mv /etc/crontab.orig /etc/crontab
|
||||||
${SUDO} service cron restart
|
${SUDO} service cron restart
|
||||||
|
echo -e " ${TICK} Restored the default system cron"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Attempt to preserve backwards compatibility with older versions
|
# Attempt to preserve backwards compatibility with older versions
|
||||||
if [[ -f /etc/cron.d/pihole ]];then
|
if [[ -f /etc/cron.d/pihole ]];then
|
||||||
echo "::: Removing cron.d/pihole..."
|
|
||||||
${SUDO} rm /etc/cron.d/pihole &> /dev/null
|
${SUDO} rm /etc/cron.d/pihole &> /dev/null
|
||||||
|
echo -e " ${TICK} Removed /etc/cron.d/pihole"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo "::: Removing config files and scripts..."
|
|
||||||
package_check lighttpd > /dev/null
|
package_check lighttpd > /dev/null
|
||||||
if [ $? -eq 1 ]; then
|
if [[ $? -eq 1 ]]; then
|
||||||
${SUDO} rm -rf /etc/lighttpd/ &> /dev/null
|
${SUDO} rm -rf /etc/lighttpd/ &> /dev/null
|
||||||
|
echo -e " ${TICK} Removed lighttpd"
|
||||||
else
|
else
|
||||||
if [ -f /etc/lighttpd/lighttpd.conf.orig ]; then
|
if [ -f /etc/lighttpd/lighttpd.conf.orig ]; then
|
||||||
${SUDO} mv /etc/lighttpd/lighttpd.conf.orig /etc/lighttpd/lighttpd.conf
|
${SUDO} mv /etc/lighttpd/lighttpd.conf.orig /etc/lighttpd/lighttpd.conf
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
${SUDO} rm /etc/dnsmasq.d/adList.conf &> /dev/null
|
${SUDO} rm /etc/dnsmasq.d/adList.conf &> /dev/null
|
||||||
${SUDO} rm /etc/dnsmasq.d/01-pihole.conf &> /dev/null
|
${SUDO} rm /etc/dnsmasq.d/01-pihole.conf &> /dev/null
|
||||||
${SUDO} rm -rf /var/log/*pihole* &> /dev/null
|
${SUDO} rm -rf /var/log/*pihole* &> /dev/null
|
||||||
|
|
@ -154,28 +155,53 @@ removeNoPurge() {
|
||||||
${SUDO} rm /usr/local/bin/pihole &> /dev/null
|
${SUDO} rm /usr/local/bin/pihole &> /dev/null
|
||||||
${SUDO} rm /etc/bash_completion.d/pihole &> /dev/null
|
${SUDO} rm /etc/bash_completion.d/pihole &> /dev/null
|
||||||
${SUDO} rm /etc/sudoers.d/pihole &> /dev/null
|
${SUDO} rm /etc/sudoers.d/pihole &> /dev/null
|
||||||
|
echo -e " ${TICK} Removed config files"
|
||||||
|
|
||||||
|
# Remove FTL
|
||||||
|
if command -v pihole-FTL &> /dev/null; then
|
||||||
|
echo -ne " ${INFO} Removing pihole-FTL..."
|
||||||
|
|
||||||
|
if [[ -x "$(command -v systemctl)" ]]; then
|
||||||
|
systemctl stop pihole-FTL
|
||||||
|
else
|
||||||
|
service pihole-FTL stop
|
||||||
|
fi
|
||||||
|
|
||||||
|
${SUDO} rm /etc/init.d/pihole-FTL
|
||||||
|
${SUDO} rm /usr/bin/pihole-FTL
|
||||||
|
|
||||||
|
echo -e "${OVER} ${TICK} Removed pihole-FTL"
|
||||||
|
fi
|
||||||
|
|
||||||
# If the pihole user exists, then remove
|
# If the pihole user exists, then remove
|
||||||
if id "pihole" >/dev/null 2>&1; then
|
if id "pihole" &> /dev/null; then
|
||||||
echo "::: Removing pihole user..."
|
${SUDO} userdel -r pihole 2> /dev/null
|
||||||
${SUDO} userdel -r pihole
|
if [[ "$?" -eq 0 ]]; then
|
||||||
|
echo -e " ${TICK} Removed 'pihole' user"
|
||||||
|
else
|
||||||
|
echo -e " ${CROSS} Unable to remove 'pihole' user"
|
||||||
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo ":::"
|
echo -e "\n We're sorry to see you go, but thanks for checking out Pi-hole!
|
||||||
printf "::: Finished removing PiHole from your system. Sorry to see you go!\n"
|
If you need help, reach out to us on Github, Discourse, Reddit or Twitter
|
||||||
printf "::: Reach out to us at https://github.com/pi-hole/pi-hole/issues if you need help\n"
|
Reinstall at any time: ${COL_WHITE}curl -sSL https://install.pi-hole.net | bash${COL_NC}
|
||||||
printf "::: Reinstall by simpling running\n:::\n:::\tcurl -sSL https://install.pi-hole.net | bash\n:::\n::: at any time!\n:::\n"
|
|
||||||
printf "::: PLEASE RESET YOUR DNS ON YOUR ROUTER/CLIENTS TO RESTORE INTERNET CONNECTIVITY!\n"
|
${COL_LIGHT_RED}Please reset the DNS on your router/clients to restore internet connectivity
|
||||||
|
${COL_LIGHT_GREEN}Uninstallation Complete! ${COL_NC}"
|
||||||
}
|
}
|
||||||
|
|
||||||
######### SCRIPT ###########
|
######### SCRIPT ###########
|
||||||
echo "::: Preparing to remove packages, be sure that each may be safely removed depending on your operating system."
|
if command -v vcgencmd &> /dev/null; then
|
||||||
echo "::: (SAFE TO REMOVE ALL ON RASPBIAN)"
|
echo -e " ${INFO} All dependencies are safe to remove on Raspbian"
|
||||||
|
else
|
||||||
|
echo -e " ${INFO} Be sure to confirm if any dependencies should not be removed"
|
||||||
|
fi
|
||||||
while true; do
|
while true; do
|
||||||
read -rp "::: Do you wish to purge PiHole's dependencies from your OS? (You will be prompted for each package) [y/n]: " yn
|
read -rp " ${QST} Do you wish to go through each dependency for removal? [Y/n] " yn
|
||||||
case ${yn} in
|
case ${yn} in
|
||||||
[Yy]* ) removeAndPurge; break;;
|
[Yy]* ) removeAndPurge; break;;
|
||||||
|
|
||||||
[Nn]* ) removeNoPurge; break;;
|
[Nn]* ) removeNoPurge; break;;
|
||||||
|
* ) removeAndPurge; break;;
|
||||||
esac
|
esac
|
||||||
done
|
done
|
||||||
|
|
|
||||||
608
gravity.sh
608
gravity.sh
|
|
@ -8,52 +8,50 @@
|
||||||
# This file is copyright under the latest version of the EUPL.
|
# This file is copyright under the latest version of the EUPL.
|
||||||
# Please see LICENSE file for your rights under this license.
|
# Please see LICENSE file for your rights under this license.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Run this script as root or under sudo
|
# Run this script as root or under sudo
|
||||||
echo ":::"
|
|
||||||
|
coltable="/opt/pihole/COL_TABLE"
|
||||||
|
source ${coltable}
|
||||||
|
|
||||||
helpFunc() {
|
helpFunc() {
|
||||||
cat << EOM
|
echo "Usage: pihole -g
|
||||||
::: Pull in domains from adlists
|
Update domains from blocklists specified in adlists.list
|
||||||
:::
|
|
||||||
::: Usage: pihole -g
|
Options:
|
||||||
:::
|
-f, --force Force the download of all specified blocklists
|
||||||
::: Options:
|
-h, --help Show this help dialog"
|
||||||
::: -f, --force Force lists to be downloaded, even if they don't need updating.
|
exit 0
|
||||||
::: -h, --help Show this help dialog
|
|
||||||
EOM
|
|
||||||
exit 0
|
|
||||||
}
|
}
|
||||||
|
|
||||||
PIHOLE_COMMAND="/usr/local/bin/pihole"
|
PIHOLE_COMMAND="/usr/local/bin/pihole"
|
||||||
|
|
||||||
adListFile=/etc/pihole/adlists.list
|
adListFile=/etc/pihole/adlists.list
|
||||||
adListDefault=/etc/pihole/adlists.default #being deprecated
|
adListDefault=/etc/pihole/adlists.default # Deprecated
|
||||||
adListRepoDefault=/etc/.pihole/adlists.default
|
adListRepoDefault=/etc/.pihole/adlists.default
|
||||||
whitelistScript="${PIHOLE_COMMAND} -w"
|
whitelistScript="${PIHOLE_COMMAND} -w"
|
||||||
whitelistFile=/etc/pihole/whitelist.txt
|
whitelistFile=/etc/pihole/whitelist.txt
|
||||||
blacklistFile=/etc/pihole/blacklist.txt
|
blacklistFile=/etc/pihole/blacklist.txt
|
||||||
readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
|
readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
|
||||||
|
|
||||||
#Source the setupVars from install script for the IP
|
# Source the setupVars from install script for the IP
|
||||||
setupVars=/etc/pihole/setupVars.conf
|
setupVars=/etc/pihole/setupVars.conf
|
||||||
if [[ -f ${setupVars} ]];then
|
if [[ -f "${setupVars}" ]];then
|
||||||
. /etc/pihole/setupVars.conf
|
. /etc/pihole/setupVars.conf
|
||||||
else
|
else
|
||||||
echo "::: WARNING: /etc/pihole/setupVars.conf missing. Possible installation failure."
|
echo -e " ${COL_LIGHT_RED}Error: /etc/pihole/setupVars.conf missing. Possible installation failure.${COL_NC}
|
||||||
echo "::: Please run 'pihole -r', and choose the 'reconfigure' option to reconfigure."
|
Please run 'pihole -r', and choose the 'reconfigure' option to reconfigure."
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
#Remove the /* from the end of the IPv4addr.
|
# Remove the /* from the end of the IP addresses
|
||||||
IPV4_ADDRESS=${IPV4_ADDRESS%/*}
|
IPV4_ADDRESS=${IPV4_ADDRESS%/*}
|
||||||
IPV6_ADDRESS=${IPV6_ADDRESS}
|
IPV6_ADDRESS=${IPV6_ADDRESS%/*}
|
||||||
|
|
||||||
# Variables for various stages of downloading and formatting the list
|
# Variables for various stages of downloading and formatting the list
|
||||||
basename=pihole
|
basename=pihole
|
||||||
piholeDir=/etc/${basename}
|
piholeDir=/etc/${basename}
|
||||||
adList=${piholeDir}/gravity.list
|
adList=${piholeDir}/gravity.list
|
||||||
|
blackList=${piholeDir}/black.list
|
||||||
localList=${piholeDir}/local.list
|
localList=${piholeDir}/local.list
|
||||||
justDomainsExtension=domains
|
justDomainsExtension=domains
|
||||||
matterAndLight=${basename}.0.matterandlight.txt
|
matterAndLight=${basename}.0.matterandlight.txt
|
||||||
|
|
@ -64,13 +62,13 @@ accretionDisc=${basename}.3.accretionDisc.txt
|
||||||
|
|
||||||
skipDownload=false
|
skipDownload=false
|
||||||
|
|
||||||
# Warn users still using pihole.conf that it no longer has any effect (I imagine about 2 people use it)
|
# Warn users still using pihole.conf that it no longer has any effect
|
||||||
if [[ -r ${piholeDir}/pihole.conf ]]; then
|
if [[ -r ${piholeDir}/pihole.conf ]]; then
|
||||||
echo "::: pihole.conf file no longer supported. Over-rides in this file are ignored."
|
echo -e " ${COL_LIGHT_RED}pihole.conf file no longer supported. Overrides in this file are ignored.${COL_NC}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
###########################
|
###########################
|
||||||
# collapse - begin formation of pihole
|
# Collapse - begin formation of pihole
|
||||||
gravity_collapse() {
|
gravity_collapse() {
|
||||||
|
|
||||||
#New Logic:
|
#New Logic:
|
||||||
|
|
@ -78,355 +76,401 @@ gravity_collapse() {
|
||||||
# If not, cp /etc/.pihole/adlists.default /etc/pihole/adlists.list
|
# If not, cp /etc/.pihole/adlists.default /etc/pihole/adlists.list
|
||||||
# Read from adlists.list
|
# Read from adlists.list
|
||||||
|
|
||||||
#The following two blocks will sort out any missing adlists in the /etc/pihole directory, and remove legacy adlists.default
|
# The following two blocks will sort out any missing adlists in the /etc/pihole directory, and remove legacy adlists.default
|
||||||
if [ -f ${adListDefault} ] && [ -f ${adListFile} ]; then
|
if [[ -f "${adListDefault}" ]] && [[ -f "${adListFile}" ]]; then
|
||||||
rm ${adListDefault}
|
rm "${adListDefault}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [ ! -f ${adListFile} ]; then
|
if [ ! -f "${adListFile}" ]; then
|
||||||
cp ${adListRepoDefault} ${adListFile}
|
cp "${adListRepoDefault}" "${adListFile}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo "::: Neutrino emissions detected..."
|
echo -e " ${INFO} Neutrino emissions detected..."
|
||||||
echo ":::"
|
echo ""
|
||||||
echo -n "::: Pulling source lists into range..."
|
local str="Pulling source lists into range"
|
||||||
|
echo -ne " ${INFO} ${str}..."
|
||||||
|
|
||||||
sources=()
|
sources=()
|
||||||
while IFS= read -r line || [[ -n "$line" ]]; do
|
while IFS= read -r line || [[ -n "$line" ]]; do
|
||||||
#Do not read commented out or blank lines
|
# Do not read commented out or blank lines
|
||||||
if [[ ${line} = \#* ]] || [[ ! ${line} ]]; then
|
if [[ ${line} = \#* ]] || [[ ! ${line} ]]; then
|
||||||
echo "" > /dev/null
|
echo "" > /dev/null
|
||||||
else
|
else
|
||||||
sources+=(${line})
|
sources+=(${line})
|
||||||
fi
|
fi
|
||||||
done < ${adListFile}
|
done < ${adListFile}
|
||||||
echo " done!"
|
|
||||||
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
}
|
}
|
||||||
|
|
||||||
# patternCheck - check to see if curl downloaded any new files.
|
# patternCheck - check to see if curl downloaded any new files.
|
||||||
gravity_patternCheck() {
|
gravity_patternCheck() {
|
||||||
patternBuffer=$1
|
patternBuffer=$1
|
||||||
success=$2
|
success=$2
|
||||||
error=$3
|
error=$3
|
||||||
if [ $success = true ]; then
|
if [[ "${success}" = true ]]; then
|
||||||
# check if download was successful but list has not been modified
|
# Check if download was successful but list has not been modified
|
||||||
if [ "${error}" == "304" ]; then
|
if [[ "${error}" == "304" ]]; then
|
||||||
echo "::: No changes detected, transport skipped!"
|
echo -e " ${TICK} No changes detected, transport skipped!"
|
||||||
# check if the patternbuffer is a non-zero length file
|
# Check if the patternbuffer is a non-zero length file
|
||||||
elif [[ -s "${patternBuffer}" ]]; then
|
elif [[ -s "${patternBuffer}" ]]; then
|
||||||
# Some of the blocklists are copyright, they need to be downloaded
|
# Some blocklists are copyright, they need to be downloaded and stored
|
||||||
# and stored as is. They can be processed for content after they
|
# as is. They can be processed for content after they have been saved.
|
||||||
# have been saved.
|
mv "${patternBuffer}" "${saveLocation}"
|
||||||
mv "${patternBuffer}" "${saveLocation}"
|
echo -e " ${TICK} List updated, transport successful!"
|
||||||
echo "::: List updated, transport successful!"
|
else
|
||||||
else
|
# Empty file -> use previously downloaded list
|
||||||
# Empty file -> use previously downloaded list
|
echo -e " ${INFO} Received empty file, ${COL_LIGHT_GREEN}using cached one${COL_NC} (list not updated!)"
|
||||||
echo "::: Received empty file, using cached one (list not updated!)"
|
fi
|
||||||
fi
|
else
|
||||||
else
|
# Check if cached list exists
|
||||||
# check if cached list exists
|
if [[ -r "${saveLocation}" ]]; then
|
||||||
if [[ -r "${saveLocation}" ]]; then
|
echo -e " ${CROSS} List download failed, using cached list (list not updated!)"
|
||||||
echo "::: List download failed, using cached list (list not updated!)"
|
else
|
||||||
else
|
echo -e " ${CROSS} Download failed and no cached list available (list will not be considered)"
|
||||||
echo "::: Download failed and no cached list available (list will not be considered)"
|
fi
|
||||||
fi
|
fi
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# transport - curl the specified url with any needed command extentions
|
# transport - curl the specified url with any needed command extentions
|
||||||
gravity_transport() {
|
gravity_transport() {
|
||||||
url=$1
|
url=$1
|
||||||
cmd_ext=$2
|
cmd_ext=$2
|
||||||
agent=$3
|
agent=$3
|
||||||
|
|
||||||
# tmp file, so we don't have to store the (long!) lists in RAM
|
# tmp file, so we don't have to store the (long!) lists in RAM
|
||||||
patternBuffer=$(mktemp)
|
patternBuffer=$(mktemp)
|
||||||
heisenbergCompensator=""
|
heisenbergCompensator=""
|
||||||
if [[ -r ${saveLocation} ]]; then
|
if [[ -r ${saveLocation} ]]; then
|
||||||
# if domain has been saved, add file for date check to only download newer
|
# If domain has been saved, add file for date check to only download newer
|
||||||
heisenbergCompensator="-z ${saveLocation}"
|
heisenbergCompensator="-z ${saveLocation}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Silently curl url
|
# Silently curl url
|
||||||
err=$(curl -s -L ${cmd_ext} ${heisenbergCompensator} -w %{http_code} -A "${agent}" ${url} -o ${patternBuffer})
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
|
local str="Status:"
|
||||||
|
echo -ne " ${INFO} ${str} Pending"
|
||||||
|
err=$(curl -s -L ${cmd_ext} ${heisenbergCompensator} -w %{http_code} -A "${agent}" ${url} -o ${patternBuffer})
|
||||||
|
|
||||||
echo " done"
|
# Analyze http response
|
||||||
# Analyze http response
|
case "$err" in
|
||||||
echo -n "::: Status: "
|
"200" ) echo -e "${OVER} ${TICK} ${str} Success (OK)"; success=true;;
|
||||||
case "$err" in
|
"304" ) echo -e "${OVER} ${TICK} ${str} Not modified"; success=true;;
|
||||||
"200" ) echo "Success (OK)"; success=true;;
|
"403" ) echo -e "${OVER} ${CROSS} ${str} Forbidden"; success=false;;
|
||||||
"304" ) echo "Not modified"; success=true;;
|
"404" ) echo -e "${OVER} ${CROSS} ${str} Not found"; success=false;;
|
||||||
"403" ) echo "Forbidden"; success=false;;
|
"408" ) echo -e "${OVER} ${CROSS} ${str} Time-out"; success=false;;
|
||||||
"404" ) echo "Not found"; success=false;;
|
"451" ) echo -e "${OVER} ${CROSS} ${str} Unavailable For Legal Reasons"; success=false;;
|
||||||
"408" ) echo "Time-out"; success=false;;
|
"521" ) echo -e "${OVER} ${CROSS} ${str} Web Server Is Down (Cloudflare)"; success=false;;
|
||||||
"451" ) echo "Unavailable For Legal Reasons"; success=false;;
|
"522" ) echo -e "${OVER} ${CROSS} ${str} Connection Timed Out (Cloudflare)"; success=false;;
|
||||||
"521" ) echo "Web Server Is Down (Cloudflare)"; success=false;;
|
"500" ) echo -e "${OVER} ${CROSS} ${str} Internal Server Error"; success=false;;
|
||||||
"522" ) echo "Connection Timed Out (Cloudflare)"; success=false;;
|
* ) echo -e "${OVER} ${CROSS} ${str} Status $err"; success=false;;
|
||||||
"500" ) echo "Internal Server Error"; success=false;;
|
esac
|
||||||
* ) echo "Status $err"; success=false;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
# Process result
|
# Process result
|
||||||
gravity_patternCheck "${patternBuffer}" ${success} "${err}"
|
gravity_patternCheck "${patternBuffer}" "${success}" "${err}"
|
||||||
|
|
||||||
# Delete temp file if it hasn't been moved
|
# Delete temp file if it hasn't been moved
|
||||||
if [[ -f "${patternBuffer}" ]]; then
|
if [[ -f "${patternBuffer}" ]]; then
|
||||||
rm "${patternBuffer}"
|
rm "${patternBuffer}"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# spinup - main gravity function
|
# spinup - main gravity function
|
||||||
gravity_spinup() {
|
gravity_spinup() {
|
||||||
echo ":::"
|
echo ""
|
||||||
# Loop through domain list. Download each one and remove commented lines (lines beginning with '# 'or '/') and # blank lines
|
# Loop through domain list. Download each one and remove commented lines (lines beginning with '# 'or '/') and # blank lines
|
||||||
for ((i = 0; i < "${#sources[@]}"; i++)); do
|
for ((i = 0; i < "${#sources[@]}"; i++)); do
|
||||||
url=${sources[$i]}
|
url=${sources[$i]}
|
||||||
# Get just the domain from the URL
|
# Get just the domain from the URL
|
||||||
domain=$(echo "${url}" | cut -d'/' -f3)
|
domain=$(cut -d'/' -f3 <<< "${url}")
|
||||||
|
|
||||||
# Save the file as list.#.domain
|
# Save the file as list.#.domain
|
||||||
saveLocation=${piholeDir}/list.${i}.${domain}.${justDomainsExtension}
|
saveLocation=${piholeDir}/list.${i}.${domain}.${justDomainsExtension}
|
||||||
activeDomains[$i]=${saveLocation}
|
activeDomains[$i]=${saveLocation}
|
||||||
|
|
||||||
agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.0 Safari/537.36"
|
agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.0 Safari/537.36"
|
||||||
|
|
||||||
# Use a case statement to download lists that need special cURL commands
|
# Use a case statement to download lists that need special cURL commands
|
||||||
# to complete properly and reset the user agent when required
|
# to complete properly and reset the user agent when required
|
||||||
case "${domain}" in
|
case "${domain}" in
|
||||||
"adblock.mahakala.is")
|
"pgl.yoyo.org")
|
||||||
agent='Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
|
cmd_ext="-d mimetype=plaintext -d hostformat=hosts"
|
||||||
cmd_ext="-e http://forum.xda-developers.com/"
|
;;
|
||||||
;;
|
|
||||||
|
|
||||||
"adaway.org")
|
# Default is a simple request
|
||||||
agent='Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
|
*) cmd_ext=""
|
||||||
;;
|
esac
|
||||||
|
|
||||||
"pgl.yoyo.org")
|
if [[ "${skipDownload}" == false ]]; then
|
||||||
cmd_ext="-d mimetype=plaintext -d hostformat=hosts"
|
local str="Aiming tractor beam at $domain"
|
||||||
;;
|
echo -ne " ${INFO} ${str}..."
|
||||||
|
|
||||||
# Default is a simple request
|
gravity_transport "$url" "$cmd_ext" "$agent" "$str"
|
||||||
*) cmd_ext=""
|
echo ""
|
||||||
esac
|
fi
|
||||||
if [[ "${skipDownload}" == false ]]; then
|
done
|
||||||
echo -n "::: Getting $domain list..."
|
|
||||||
gravity_transport "$url" "$cmd_ext" "$agent"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Schwarzchild - aggregate domains to one list and add blacklisted domains
|
# Schwarzchild - aggregate domains to one list and add blacklisted domains
|
||||||
gravity_Schwarzchild() {
|
gravity_Schwarzchild() {
|
||||||
echo "::: "
|
echo ""
|
||||||
# Find all active domains and compile them into one file and remove CRs
|
# Find all active domains and compile them into one file and remove CRs
|
||||||
echo -n "::: Aggregating list of domains..."
|
local str="Aggregating list of domains"
|
||||||
truncate -s 0 ${piholeDir}/${matterAndLight}
|
echo -ne " ${INFO} ${str}..."
|
||||||
for i in "${activeDomains[@]}"; do
|
|
||||||
# Only assimilate list if it is available (download might have faild permanently)
|
truncate -s 0 ${piholeDir}/${matterAndLight}
|
||||||
if [[ -r "${i}" ]]; then
|
for i in "${activeDomains[@]}"; do
|
||||||
cat "${i}" | tr -d '\r' >> ${piholeDir}/${matterAndLight}
|
# Only assimilate list if it is available (download might have failed permanently)
|
||||||
fi
|
if [[ -r "${i}" ]]; then
|
||||||
done
|
cat "${i}" | tr -d '\r' >> ${piholeDir}/${matterAndLight}
|
||||||
echo " done!"
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
}
|
}
|
||||||
|
|
||||||
gravity_Blacklist() {
|
gravity_Blacklist() {
|
||||||
# Append blacklist entries to eventHorizon if they exist
|
# Append blacklist entries to eventHorizon if they exist
|
||||||
if [[ -f "${blacklistFile}" ]]; then
|
if [[ -f "${blacklistFile}" ]]; then
|
||||||
numBlacklisted=$(wc -l < "${blacklistFile}")
|
numBlacklisted=$(wc -l < "${blacklistFile}")
|
||||||
plural=; [[ "$numBlacklisted" != "1" ]] && plural=s
|
plural=; [[ "$numBlacklisted" != "1" ]] && plural=s
|
||||||
echo -n "::: Blacklisting $numBlacklisted domain${plural}..."
|
local str="Exact blocked domain${plural}: $numBlacklisted"
|
||||||
cat ${blacklistFile} >> ${piholeDir}/${eventHorizon}
|
echo -e " ${INFO} ${str}"
|
||||||
echo " done!"
|
else
|
||||||
else
|
echo -e " ${INFO} Nothing to blacklist!"
|
||||||
echo "::: Nothing to blacklist!"
|
fi
|
||||||
fi
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
gravity_Wildcard() {
|
gravity_Wildcard() {
|
||||||
# Return number of wildcards in output - don't actually handle wildcards
|
# Return number of wildcards in output - don't actually handle wildcards
|
||||||
if [[ -f "${wildcardlist}" ]]; then
|
if [[ -f "${wildcardlist}" ]]; then
|
||||||
numWildcards=$(grep -c ^ "${wildcardlist}")
|
numWildcards=$(grep -c ^ "${wildcardlist}")
|
||||||
if [[ -n "${IPV4_ADDRESS}" && -n "${IPV6_ADDRESS}" ]];then
|
if [[ -n "${IPV4_ADDRESS}" ]] && [[ -n "${IPV6_ADDRESS}" ]];then
|
||||||
let numWildcards/=2
|
let numWildcards/=2
|
||||||
fi
|
fi
|
||||||
plural=; [[ "$numWildcards" != "1" ]] && plural=s
|
plural=; [[ "$numWildcards" != "1" ]] && plural=s
|
||||||
echo "::: Wildcard blocked domain${plural}: $numWildcards"
|
echo -e " ${INFO} Wildcard blocked domain${plural}: $numWildcards"
|
||||||
else
|
else
|
||||||
echo "::: No wildcards used!"
|
echo -e " ${INFO} No wildcards used!"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
gravity_Whitelist() {
|
gravity_Whitelist() {
|
||||||
#${piholeDir}/${eventHorizon})
|
echo ""
|
||||||
echo ":::"
|
# Prevent our sources from being pulled into the hole
|
||||||
# Prevent our sources from being pulled into the hole
|
plural=; [[ "${sources[@]}" != "1" ]] && plural=s
|
||||||
plural=; [[ "${sources[@]}" != "1" ]] && plural=s
|
local str="Adding adlist source${plural} to the whitelist"
|
||||||
echo -n "::: Adding adlist source${plural} to the whitelist..."
|
echo -ne " ${INFO} ${str}..."
|
||||||
|
|
||||||
urls=()
|
urls=()
|
||||||
for url in "${sources[@]}"; do
|
for url in "${sources[@]}"; do
|
||||||
tmp=$(echo "${url}" | awk -F '/' '{print $3}')
|
tmp=$(awk -F '/' '{print $3}' <<< "${url}")
|
||||||
urls=("${urls[@]}" ${tmp})
|
urls=("${urls[@]}" ${tmp})
|
||||||
done
|
done
|
||||||
echo " done!"
|
|
||||||
|
|
||||||
# Ensure adlist domains are in whitelist.txt
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
${whitelistScript} -nr -q "${urls[@]}" > /dev/null
|
|
||||||
|
|
||||||
# Check whitelist.txt exists.
|
# Ensure adlist domains are in whitelist.txt
|
||||||
if [[ -f "${whitelistFile}" ]]; then
|
${whitelistScript} -nr -q "${urls[@]}" > /dev/null
|
||||||
# Remove anything in whitelist.txt from the Event Horizon
|
|
||||||
numWhitelisted=$(wc -l < "${whitelistFile}")
|
# Check whitelist.txt exists.
|
||||||
plural=; [[ "$numWhitelisted" != "1" ]] && plural=s
|
if [[ -f "${whitelistFile}" ]]; then
|
||||||
echo -n "::: Whitelisting $numWhitelisted domain${plural}..."
|
# Remove anything in whitelist.txt from the Event Horizon
|
||||||
#print everything from preEventHorizon into eventHorizon EXCEPT domains in whitelist.txt
|
numWhitelisted=$(wc -l < "${whitelistFile}")
|
||||||
grep -F -x -v -f ${whitelistFile} ${piholeDir}/${preEventHorizon} > ${piholeDir}/${eventHorizon}
|
plural=; [[ "$numWhitelisted" != "1" ]] && plural=s
|
||||||
echo " done!"
|
local str="Whitelisting $numWhitelisted domain${plural}"
|
||||||
else
|
echo -ne " ${INFO} ${str}..."
|
||||||
echo "::: Nothing to whitelist!"
|
|
||||||
fi
|
# Print everything from preEventHorizon into eventHorizon EXCEPT domains in whitelist.txt
|
||||||
|
grep -F -x -v -f ${whitelistFile} ${piholeDir}/${preEventHorizon} > ${piholeDir}/${eventHorizon}
|
||||||
|
|
||||||
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
|
else
|
||||||
|
echo -e " ${INFO} Nothing to whitelist!"
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
gravity_unique() {
|
gravity_unique() {
|
||||||
# Sort and remove duplicates
|
# Sort and remove duplicates
|
||||||
echo -n "::: Removing duplicate domains...."
|
local str="Removing duplicate domains"
|
||||||
sort -u ${piholeDir}/${supernova} > ${piholeDir}/${preEventHorizon}
|
echo -ne " ${INFO} ${str}..."
|
||||||
echo " done!"
|
|
||||||
numberOf=$(wc -l < ${piholeDir}/${preEventHorizon})
|
sort -u ${piholeDir}/${supernova} > ${piholeDir}/${preEventHorizon}
|
||||||
echo "::: $numberOf unique domains trapped in the event horizon."
|
|
||||||
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
|
numberOf=$(wc -l < ${piholeDir}/${preEventHorizon})
|
||||||
|
echo -e " ${INFO} ${COL_LIGHT_BLUE}${numberOf}${COL_NC} unique domains trapped in the event horizon."
|
||||||
}
|
}
|
||||||
|
|
||||||
gravity_hostFormat() {
|
gravity_doHostFormat() {
|
||||||
# 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)
|
|
||||||
elif [ -x "$(command -v hostname)" ]; then
|
|
||||||
hostname=$(hostname -f)
|
|
||||||
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.
|
# Check vars from setupVars.conf to see if we're using IPv4, IPv6, Or both.
|
||||||
if [[ -n "${IPV4_ADDRESS}" && -n "${IPV6_ADDRESS}" ]];then
|
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 -e "${OVER} ${CROSS} ${str}"
|
||||||
|
echo -e " ${COL_LIGHT_RED}No IP Values found! Please run 'pihole -r' and choose reconfigure to restore values${COL_NC}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
echo -e "${IPV4_ADDRESS} ${hostname}\n${IPV6_ADDRESS} ${hostname}\n${IPV4_ADDRESS} pi.hole\n${IPV6_ADDRESS} pi.hole" > ${localList}
|
gravity_hostFormatLocal() {
|
||||||
# Both IPv4 and IPv6
|
# Format domain list as "192.168.x.x domain.com"
|
||||||
cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPV4_ADDRESS" -v ipv6addr="$IPV6_ADDRESS" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> ${piholeDir}/${accretionDisc}
|
|
||||||
|
|
||||||
elif [[ -n "${IPV4_ADDRESS}" && -z "${IPV6_ADDRESS}" ]];then
|
if [[ -f "/etc/hostname" ]]; then
|
||||||
|
hostname=$(< /etc/hostname)
|
||||||
echo -e "${IPV4_ADDRESS} ${hostname}\n${IPV4_ADDRESS} pi.hole" > ${localList}
|
elif [ -x "$(command -v hostname)" ]; then
|
||||||
# Only IPv4
|
hostname=$(hostname -f)
|
||||||
cat ${piholeDir}/${eventHorizon} | awk -v ipv4addr="$IPV4_ADDRESS" '{sub(/\r$/,""); print ipv4addr" "$0}' >> ${piholeDir}/${accretionDisc}
|
else
|
||||||
|
echo -e " ${CROSS} Unable to determine fully qualified domain name of host"
|
||||||
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
|
fi
|
||||||
|
|
||||||
# Copy the file over as /etc/pihole/gravity.list so dnsmasq can use it
|
echo -e "${hostname}\npi.hole" > "${localList}.tmp"
|
||||||
cp ${piholeDir}/${accretionDisc} ${adList}
|
# Copy the file over as /etc/pihole/local.list so dnsmasq can use it
|
||||||
echo " done!"
|
rm "${localList}"
|
||||||
|
gravity_doHostFormat "${localList}.tmp" "${localList}"
|
||||||
|
rm "${localList}.tmp"
|
||||||
|
}
|
||||||
|
|
||||||
|
gravity_hostFormatGravity() {
|
||||||
|
# Format domain list as "192.168.x.x domain.com"
|
||||||
|
echo "" > "${piholeDir}/${accretionDisc}"
|
||||||
|
gravity_doHostFormat "${piholeDir}/${eventHorizon}" "${piholeDir}/${accretionDisc}"
|
||||||
|
# Copy the file over as /etc/pihole/gravity.list so dnsmasq can use it
|
||||||
|
mv "${piholeDir}/${accretionDisc}" "${adList}"
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
gravity_hostFormatBlack() {
|
||||||
|
if [[ -f "${blacklistFile}" ]]; then
|
||||||
|
numBlacklisted=$(wc -l < "${blacklistFile}")
|
||||||
|
# Format domain list as "192.168.x.x domain.com"
|
||||||
|
gravity_doHostFormat "${blacklistFile}" "${blackList}.tmp"
|
||||||
|
# Copy the file over as /etc/pihole/black.list so dnsmasq can use it
|
||||||
|
mv "${blackList}.tmp" "${blackList}"
|
||||||
|
else
|
||||||
|
echo -e " ${INFO} Nothing to blacklist!"
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# blackbody - remove any remnant files from script processes
|
# blackbody - remove any remnant files from script processes
|
||||||
gravity_blackbody() {
|
gravity_blackbody() {
|
||||||
# Loop through list files
|
# Loop through list files
|
||||||
for file in ${piholeDir}/*.${justDomainsExtension}; do
|
for file in ${piholeDir}/*.${justDomainsExtension}; do
|
||||||
# If list is in active array then leave it (noop) else rm the list
|
# If list is in active array then leave it (noop) else rm the list
|
||||||
if [[ " ${activeDomains[@]} " =~ ${file} ]]; then
|
if [[ " ${activeDomains[@]} " =~ ${file} ]]; then
|
||||||
:
|
:
|
||||||
else
|
else
|
||||||
rm -f "${file}"
|
rm -f "${file}"
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
gravity_advanced() {
|
gravity_advanced() {
|
||||||
# Remove comments and print only the domain name
|
# Remove comments and print only the domain name
|
||||||
# Most of the lists downloaded are already in hosts file format but the spacing/formating is not contigious
|
# Most of the lists downloaded are already in hosts file format but the spacing/formating is not contigious
|
||||||
# This helps with that and makes it easier to read
|
# This helps with that and makes it easier to read
|
||||||
# It also helps with debugging so each stage of the script can be researched more in depth
|
# It also helps with debugging so each stage of the script can be researched more in depth
|
||||||
echo -n "::: Formatting list of domains to remove comments...."
|
local str="Formatting list of domains to remove comments"
|
||||||
#awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' ${piholeDir}/${matterAndLight} | sed -nr -e 's/\.{2,}/./g' -e '/\./p' > ${piholeDir}/${supernova}
|
echo -ne " ${INFO} ${str}..."
|
||||||
#Above line does not correctly grab domains where comment is on the same line (e.g 'addomain.com #comment')
|
|
||||||
#Awk -F splits on given IFS, we grab the right hand side (chops trailing #coments and /'s to grab the domain only.
|
|
||||||
#Last awk command takes non-commented lines and if they have 2 fields, take the left field (the domain) and leave
|
|
||||||
#+ the right (IP address), otherwise grab the single field.
|
|
||||||
cat ${piholeDir}/${matterAndLight} | \
|
|
||||||
awk -F '#' '{print $1}' | \
|
|
||||||
awk -F '/' '{print $1}' | \
|
|
||||||
awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' | \
|
|
||||||
sed -nr -e 's/\.{2,}/./g' -e '/\./p' > ${piholeDir}/${supernova}
|
|
||||||
echo " done!"
|
|
||||||
|
|
||||||
numberOf=$(wc -l < ${piholeDir}/${supernova})
|
#awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' ${piholeDir}/${matterAndLight} | sed -nr -e 's/\.{2,}/./g' -e '/\./p' > ${piholeDir}/${supernova}
|
||||||
echo "::: ${numberOf} domains being pulled in by gravity..."
|
#Above line does not correctly grab domains where comment is on the same line (e.g 'addomain.com #comment')
|
||||||
|
#Awk -F splits on given IFS, we grab the right hand side (chops trailing #coments and /'s to grab the domain only.
|
||||||
|
#Last awk command takes non-commented lines and if they have 2 fields, take the left field (the domain) and leave
|
||||||
|
#+ the right (IP address), otherwise grab the single field.
|
||||||
|
cat ${piholeDir}/${matterAndLight} | \
|
||||||
|
awk -F '#' '{print $1}' | \
|
||||||
|
awk -F '/' '{print $1}' | \
|
||||||
|
awk '($1 !~ /^#/) { if (NF>1) {print $2} else {print $1}}' | \
|
||||||
|
sed -nr -e 's/\.{2,}/./g' -e '/\./p' > ${piholeDir}/${supernova}
|
||||||
|
|
||||||
gravity_unique
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
|
|
||||||
|
numberOf=$(wc -l < ${piholeDir}/${supernova})
|
||||||
|
echo -e " ${INFO} ${COL_LIGHT_BLUE}${numberOf}${COL_NC} domains being pulled in by gravity"
|
||||||
|
|
||||||
|
gravity_unique
|
||||||
}
|
}
|
||||||
|
|
||||||
gravity_reload() {
|
gravity_reload() {
|
||||||
#Clear no longer needed files...
|
# Reload hosts file
|
||||||
echo ":::"
|
echo ""
|
||||||
echo -n "::: Cleaning up un-needed files..."
|
local str="Refreshing lists in dnsmasq"
|
||||||
rm ${piholeDir}/pihole.*.txt
|
echo -e " ${INFO} ${str}..."
|
||||||
echo " done!"
|
|
||||||
|
|
||||||
# Reload hosts file
|
# Ensure /etc/dnsmasq.d/01-pihole.conf is pointing at the correct list!
|
||||||
echo ":::"
|
# First escape forward slashes in the path:
|
||||||
echo -n "::: Refresh lists in dnsmasq..."
|
adList=${adList//\//\\\/}
|
||||||
|
# Now replace the line in dnsmasq file
|
||||||
|
# sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf
|
||||||
|
|
||||||
#ensure /etc/dnsmasq.d/01-pihole.conf is pointing at the correct list!
|
"${PIHOLE_COMMAND}" restartdns
|
||||||
#First escape forward slashes in the path:
|
|
||||||
adList=${adList//\//\\\/}
|
|
||||||
#Now replace the line in dnsmasq file
|
|
||||||
# sed -i "s/^addn-hosts.*/addn-hosts=$adList/" /etc/dnsmasq.d/01-pihole.conf
|
|
||||||
|
|
||||||
"${PIHOLE_COMMAND}" restartdns
|
|
||||||
echo " done!"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
for var in "$@"; do
|
for var in "$@"; do
|
||||||
case "${var}" in
|
case "${var}" in
|
||||||
"-f" | "--force" ) forceGrav=true;;
|
"-f" | "--force" ) forceGrav=true;;
|
||||||
"-h" | "--help" ) helpFunc;;
|
"-h" | "--help" ) helpFunc;;
|
||||||
"-sd" | "--skip-download" ) skipDownload=true;;
|
"-sd" | "--skip-download" ) skipDownload=true;;
|
||||||
esac
|
"-b" | "--blacklist-only" ) blackListOnly=true;;
|
||||||
|
esac
|
||||||
done
|
done
|
||||||
|
|
||||||
if [[ "${forceGrav}" == true ]]; then
|
if [[ "${forceGrav}" == true ]]; then
|
||||||
echo -n "::: Deleting exising list cache..."
|
str="Deleting exising list cache"
|
||||||
rm /etc/pihole/list.*
|
echo -ne "${INFO} ${str}..."
|
||||||
echo " done!"
|
|
||||||
|
if rm /etc/pihole/list.* 2> /dev/null; then
|
||||||
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
|
else
|
||||||
|
echo -e "${OVER} ${CROSS} ${str}"
|
||||||
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
gravity_collapse
|
if [[ ! "${blackListOnly}" == true ]]; then
|
||||||
gravity_spinup
|
gravity_collapse
|
||||||
if [[ "${skipDownload}" == false ]]; then
|
gravity_spinup
|
||||||
|
if [[ "${skipDownload}" == false ]]; then
|
||||||
gravity_Schwarzchild
|
gravity_Schwarzchild
|
||||||
gravity_advanced
|
gravity_advanced
|
||||||
else
|
else
|
||||||
echo "::: Using cached Event Horizon list..."
|
echo -e " ${INFO} Using cached Event Horizon list..."
|
||||||
numberOf=$(wc -l < ${piholeDir}/${preEventHorizon})
|
numberOf=$(wc -l < ${piholeDir}/${preEventHorizon})
|
||||||
echo "::: $numberOf unique domains trapped in the event horizon."
|
echo -e " ${INFO} ${COL_LIGHT_BLUE}$numberOf${COL_NC} unique domains trapped in the event horizon."
|
||||||
|
fi
|
||||||
|
gravity_Whitelist
|
||||||
fi
|
fi
|
||||||
gravity_Whitelist
|
|
||||||
gravity_Blacklist
|
gravity_Blacklist
|
||||||
gravity_Wildcard
|
gravity_Wildcard
|
||||||
|
|
||||||
gravity_hostFormat
|
str="Formatting domains into a HOSTS file"
|
||||||
|
echo -ne " ${INFO} ${str}..."
|
||||||
|
if [[ ! "${blackListOnly}" == true ]]; then
|
||||||
|
gravity_hostFormatLocal
|
||||||
|
gravity_hostFormatGravity
|
||||||
|
fi
|
||||||
|
gravity_hostFormatBlack
|
||||||
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
|
|
||||||
gravity_blackbody
|
gravity_blackbody
|
||||||
|
|
||||||
|
if [[ ! "${blackListOnly}" == true ]]; then
|
||||||
|
# Clear no longer needed files...
|
||||||
|
str="Cleaning up un-needed files"
|
||||||
|
echo -ne " ${INFO} ${str}..."
|
||||||
|
|
||||||
|
rm ${piholeDir}/pihole.*.txt 2> /dev/null
|
||||||
|
|
||||||
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
|
fi
|
||||||
|
|
||||||
gravity_reload
|
gravity_reload
|
||||||
"${PIHOLE_COMMAND}" status
|
"${PIHOLE_COMMAND}" status
|
||||||
|
|
|
||||||
197
pihole
197
pihole
|
|
@ -8,6 +8,9 @@
|
||||||
# This file is copyright under the latest version of the EUPL.
|
# This file is copyright under the latest version of the EUPL.
|
||||||
# Please see LICENSE file for your rights under this license.
|
# Please see LICENSE file for your rights under this license.
|
||||||
|
|
||||||
|
colfile="/opt/pihole/COL_TABLE"
|
||||||
|
source ${colfile}
|
||||||
|
|
||||||
readonly PI_HOLE_SCRIPT_DIR="/opt/pihole"
|
readonly PI_HOLE_SCRIPT_DIR="/opt/pihole"
|
||||||
readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
|
readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
|
||||||
|
|
||||||
|
|
@ -17,7 +20,7 @@ if [[ ! $EUID -eq 0 ]];then
|
||||||
exec sudo bash "$0" "$@"
|
exec sudo bash "$0" "$@"
|
||||||
exit $?
|
exit $?
|
||||||
else
|
else
|
||||||
echo "::: sudo is needed to run pihole commands. Please run this script as root or install sudo."
|
echo -e " ${CROSS} sudo is needed to run pihole commands. Please run this script as root or install sudo."
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
@ -80,49 +83,73 @@ updateGravityFunc() {
|
||||||
exit 0
|
exit 0
|
||||||
}
|
}
|
||||||
|
|
||||||
scanList() {
|
scanList(){
|
||||||
domain="${1}"
|
domain="${1}"
|
||||||
list="${2}"
|
list="${2}"
|
||||||
method="${3}"
|
method="${3}"
|
||||||
|
if [[ ${method} == "-exact" ]] ; then
|
||||||
if [[ "${method}" == "-exact" ]]; then
|
grep -i -E "(^|\s)${domain}($|\s)" "${list}"
|
||||||
grep -i -E -l "(^|\s|\/)${domain}($|\s|\/)" ${list}
|
|
||||||
else
|
else
|
||||||
grep -i "${domain}" ${list}
|
grep -i "${domain}" "${list}"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
processWildcards() {
|
||||||
|
IFS="." read -r -a array <<< "${1}"
|
||||||
|
for (( i=${#array[@]}-1; i>=0; i-- )); do
|
||||||
|
ar=""
|
||||||
|
for (( j=${#array[@]}-1; j>${#array[@]}-i-2; j-- )); do
|
||||||
|
if [[ $j == $((${#array[@]}-1)) ]]; then
|
||||||
|
ar="${array[$j]}"
|
||||||
|
else
|
||||||
|
ar="${array[$j]}.${ar}"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
echo "${ar}"
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
queryFunc() {
|
queryFunc() {
|
||||||
method="${3}"
|
domain="${2}"
|
||||||
|
|
||||||
# If domain contains non ASCII characters, convert domain to punycode if python exists
|
if [[ -z "${domain}" ]]; then
|
||||||
# Cr: https://serverfault.com/a/335079
|
echo -e " ${COL_LIGHT_RED}Invalid option${COL_NC}
|
||||||
if [[ -z "${2}" ]]; then
|
Try 'pihole query --help' for more information."
|
||||||
echo "::: No domain specified"
|
|
||||||
exit 1
|
exit 1
|
||||||
elif [[ "${2}" = *[![:ascii:]]* ]]; then
|
|
||||||
[[ "$(which python)" ]] && domain=$(python -c 'import sys;print sys.argv[1].decode("utf-8").encode("idna")' "${2}")
|
|
||||||
else
|
|
||||||
domain="${2}"
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
method="${3}"
|
||||||
|
lists=( /etc/pihole/list.* /etc/pihole/blacklist.txt)
|
||||||
|
for list in ${lists[@]}; do
|
||||||
|
if [ -e "${list}" ]; then
|
||||||
|
result=$(scanList ${domain} ${list} ${method})
|
||||||
|
# Remove empty lines before couting number of results
|
||||||
|
count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
|
||||||
|
echo "${list} (${count} results)"
|
||||||
|
if [[ ${count} > 0 ]]; then
|
||||||
|
echo "${result}"
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
else
|
||||||
|
echo -e " ${CROSS} List does not exist"
|
||||||
|
echo ""
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
# Scan Whitelist, Blacklist and Wildcards
|
# Scan for possible wildcard matches
|
||||||
lists="/etc/pihole/whitelist.txt /etc/pihole/blacklist.txt $wildcardlist"
|
if [ -e "${wildcardlist}" ]; then
|
||||||
result=$(scanList ${domain} "${lists}" ${method})
|
local wildcards=($(processWildcards "${domain}"))
|
||||||
if [[ -n "$result" ]]; then
|
for domain in ${wildcards[@]}; do
|
||||||
echo "$result"
|
result=$(scanList "\/${domain}\/" ${wildcardlist})
|
||||||
[[ ! -t 1 ]] && exit 0
|
# Remove empty lines before couting number of results
|
||||||
|
count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
|
||||||
|
if [[ ${count} > 0 ]]; then
|
||||||
|
echo -e " ${TICK} Wildcard blocking ${domain} (${count} results)"
|
||||||
|
echo "${result}"
|
||||||
|
echo ""
|
||||||
|
fi
|
||||||
|
done
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Scan Domains lists
|
|
||||||
result=$(scanList ${domain} "/etc/pihole/*.domains" ${method})
|
|
||||||
if [[ -n "$result" ]]; then
|
|
||||||
sort -t . -k 2 -g <<< "$result"
|
|
||||||
else
|
|
||||||
[ -n "$method" ] && exact="exact "
|
|
||||||
echo "::: No ${exact}results found for ${domain}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
exit 0
|
exit 0
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -148,18 +175,22 @@ restartDNS() {
|
||||||
dnsmasqPid=$(pidof dnsmasq)
|
dnsmasqPid=$(pidof dnsmasq)
|
||||||
if [[ "${dnsmasqPid}" ]]; then
|
if [[ "${dnsmasqPid}" ]]; then
|
||||||
# Service already running - reload config
|
# Service already running - reload config
|
||||||
|
echo -ne " ${INFO} Restarting dnsmasq"
|
||||||
if [[ -x "$(command -v systemctl)" ]]; then
|
if [[ -x "$(command -v systemctl)" ]]; then
|
||||||
systemctl restart dnsmasq
|
systemctl restart dnsmasq
|
||||||
else
|
else
|
||||||
service dnsmasq restart
|
service dnsmasq restart
|
||||||
fi
|
fi
|
||||||
|
[[ "$?" == 0 ]] && echo -e "${OVER} ${TICK} Restarted dnsmasq" || echo -e "${OVER} ${CROSS} Failed to restart dnsmasq"
|
||||||
else
|
else
|
||||||
# Service not running, start it up
|
# Service not running, start it up
|
||||||
|
echo -ne " ${INFO} Starting dnsmasq"
|
||||||
if [[ -x "$(command -v systemctl)" ]]; then
|
if [[ -x "$(command -v systemctl)" ]]; then
|
||||||
systemctl start dnsmasq
|
systemctl start dnsmasq
|
||||||
else
|
else
|
||||||
service dnsmasq start
|
service dnsmasq start
|
||||||
fi
|
fi
|
||||||
|
[[ "$?" == 0 ]] && echo -e "${OVER} ${TICK} Restarted dnsmasq" || echo -e "${OVER} ${CROSS} Failed to restart dnsmasq"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -173,34 +204,65 @@ Time:
|
||||||
#s Disable Pi-hole functionality for # second(s)
|
#s Disable Pi-hole functionality for # second(s)
|
||||||
#m Disable Pi-hole functionality for # minute(s)"
|
#m Disable Pi-hole functionality for # minute(s)"
|
||||||
exit 0
|
exit 0
|
||||||
|
|
||||||
elif [[ "${1}" == "0" ]]; then
|
elif [[ "${1}" == "0" ]]; then
|
||||||
# Disable Pi-hole
|
# 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\/gravity.list/#addn-hosts=\/etc\/pihole\/gravity.list/' /etc/dnsmasq.d/01-pihole.conf
|
||||||
echo "::: Blocking has been disabled!"
|
sed -i 's/^addn-hosts=\/etc\/pihole\/black.list/#addn-hosts=\/etc\/pihole\/black.list/' /etc/dnsmasq.d/01-pihole.conf
|
||||||
|
if [[ -e "$wildcardlist" ]]; then
|
||||||
|
mv "$wildcardlist" "/etc/pihole/wildcard.list"
|
||||||
|
fi
|
||||||
if [[ $# > 1 ]]; then
|
if [[ $# > 1 ]]; then
|
||||||
if [[ "${2}" == *"s"* ]]; then
|
local error=false
|
||||||
|
if [[ "${2}" == *"s" ]]; then
|
||||||
tt=${2%"s"}
|
tt=${2%"s"}
|
||||||
echo "::: Blocking will be re-enabled in ${tt} seconds"
|
if [[ "${tt}" =~ ^-?[0-9]+$ ]];then
|
||||||
nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
|
local str="Disabling blocking for ${tt} seconds"
|
||||||
elif [[ "${2}" == *"m"* ]]; then
|
echo -e " ${INFO} ${str}..."
|
||||||
|
local str="Blocking will be re-enabled in ${tt} seconds"
|
||||||
|
nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
|
||||||
|
else
|
||||||
|
local error=true
|
||||||
|
fi
|
||||||
|
elif [[ "${2}" == *"m" ]]; then
|
||||||
tt=${2%"m"}
|
tt=${2%"m"}
|
||||||
echo "::: Blocking will be re-enabled in ${tt} minutes"
|
if [[ "${tt}" =~ ^-?[0-9]+$ ]];then
|
||||||
tt=$((${tt}*60))
|
local str="Disabling blocking for ${tt} minutes"
|
||||||
nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
|
echo -e " ${INFO} ${str}..."
|
||||||
|
local str="Blocking will be re-enabled in ${tt} minutes"
|
||||||
|
tt=$((${tt}*60))
|
||||||
|
nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
|
||||||
|
else
|
||||||
|
local error=true
|
||||||
|
fi
|
||||||
|
elif [[ -n "${2}" ]]; then
|
||||||
|
local error=true
|
||||||
else
|
else
|
||||||
echo "::: Unknown format for delayed reactivation of the blocking!"
|
echo -e " ${INFO} Disabling blocking"
|
||||||
echo "::: Example:"
|
|
||||||
echo "::: pihole disable 5s - will disable blocking for 5 seconds"
|
|
||||||
echo "::: pihole disable 7m - will disable blocking for 7 minutes"
|
|
||||||
echo "::: Blocking will not automatically be re-enabled!"
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
if [[ ${error} == true ]];then
|
||||||
|
echo -e " ${COL_LIGHT_RED}Unknown format for delayed reactivation of the blocking!${COL_NC}"
|
||||||
|
echo -e " Try 'pihole disable --help' for more information."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
local str="Pi-hole Disabled"
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
# Enable Pi-hole
|
# Enable Pi-hole
|
||||||
echo "::: Blocking has been enabled!"
|
echo -e " ${INFO} Enabling blocking"
|
||||||
|
local str="Pi-hole Enabled"
|
||||||
|
|
||||||
sed -i 's/^#addn-hosts/addn-hosts/' /etc/dnsmasq.d/01-pihole.conf
|
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
|
fi
|
||||||
|
|
||||||
restartDNS
|
restartDNS
|
||||||
|
|
||||||
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
}
|
}
|
||||||
|
|
||||||
piholeLogging() {
|
piholeLogging() {
|
||||||
|
|
@ -219,29 +281,33 @@ Options:
|
||||||
sed -i 's/^log-queries/#log-queries/' /etc/dnsmasq.d/01-pihole.conf
|
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
|
sed -i 's/^QUERY_LOGGING=true/QUERY_LOGGING=false/' /etc/pihole/setupVars.conf
|
||||||
pihole -f
|
pihole -f
|
||||||
echo "::: Logging has been disabled!"
|
echo -e " ${INFO} Disabling logging..."
|
||||||
|
local str="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/^#log-queries/log-queries/' /etc/dnsmasq.d/01-pihole.conf
|
||||||
sed -i 's/^QUERY_LOGGING=false/QUERY_LOGGING=true/' /etc/pihole/setupVars.conf
|
sed -i 's/^QUERY_LOGGING=false/QUERY_LOGGING=true/' /etc/pihole/setupVars.conf
|
||||||
echo "::: Logging has been enabled!"
|
echo -e " ${INFO} Enabling logging..."
|
||||||
|
local str="Logging has been enabled!"
|
||||||
else
|
else
|
||||||
echo "::: Invalid option passed, please pass 'on' or 'off'"
|
echo -e " ${COL_LIGHT_RED}Invalid option${COL_NC}
|
||||||
|
Try 'pihole logging --help' for more information."
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
restartDNS
|
restartDNS
|
||||||
|
echo -e "${OVER} ${TICK} ${str}"
|
||||||
}
|
}
|
||||||
|
|
||||||
piholeStatus() {
|
piholeStatus() {
|
||||||
if [[ "$(netstat -plnt | grep -c ':53 ')" -gt "0" ]]; then
|
if [[ "$(netstat -plnt | grep -c ':53 ')" -gt "0" ]]; then
|
||||||
if [[ "${1}" != "web" ]]; then
|
if [[ "${1}" != "web" ]]; then
|
||||||
echo "::: DNS service is running"
|
echo -e " ${TICK} DNS service is running"
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
if [[ "${1}" == "web" ]]; then
|
if [[ "${1}" == "web" ]]; then
|
||||||
echo "-1";
|
echo "-1";
|
||||||
else
|
else
|
||||||
echo "::: DNS service is NOT running"
|
echo -e " ${CROSS} DNS service is NOT running"
|
||||||
fi
|
fi
|
||||||
return
|
return
|
||||||
fi
|
fi
|
||||||
|
|
@ -251,21 +317,21 @@ piholeStatus() {
|
||||||
if [[ "${1}" == "web" ]]; then
|
if [[ "${1}" == "web" ]]; then
|
||||||
echo 0;
|
echo 0;
|
||||||
else
|
else
|
||||||
echo "::: Pi-hole blocking is Disabled";
|
echo -e " ${CROSS} Pi-hole blocking is Disabled";
|
||||||
fi
|
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;
|
echo 1;
|
||||||
else
|
else
|
||||||
echo "::: Pi-hole blocking is Enabled";
|
echo -e " ${TICK} Pi-hole blocking is Enabled";
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
# Addn-host not found
|
# Addn-host not found
|
||||||
if [[ "${1}" == "web" ]]; then
|
if [[ "${1}" == "web" ]]; then
|
||||||
echo 99
|
echo 99
|
||||||
else
|
else
|
||||||
echo "::: No hosts file linked to dnsmasq, adding it in enabled state"
|
echo -e " ${INFO} No hosts file linked to dnsmasq, adding it in enabled state"
|
||||||
fi
|
fi
|
||||||
# Add addn-host= to dnsmasq
|
# Add addn-host= to dnsmasq
|
||||||
echo "addn-hosts=/etc/pihole/gravity.list" >> /etc/dnsmasq.d/01-pihole.conf
|
echo "addn-hosts=/etc/pihole/gravity.list" >> /etc/dnsmasq.d/01-pihole.conf
|
||||||
|
|
@ -274,8 +340,13 @@ piholeStatus() {
|
||||||
}
|
}
|
||||||
|
|
||||||
tailFunc() {
|
tailFunc() {
|
||||||
echo "Press Ctrl-C to exit"
|
date=$(date +'%b %d ')
|
||||||
tail -F /var/log/pihole.log
|
echo -e " ${INFO} Press Ctrl-C to exit"
|
||||||
|
tail -f /var/log/pihole.log | sed \
|
||||||
|
-e "s,\(${date}\| dnsmasq\[.*[0-9]]\),,g" \
|
||||||
|
-e "s,\(.*\(gravity.list\|black.list\| config \).* is \(${IPV4_ADDRESS%/*}\|${IPV6_ADDRESS:-NULL}\).*\),${COL_LIGHT_RED}&${COL_NC}," \
|
||||||
|
-e "s,.*\(query\[A\|DHCP\).*,${COL_NC}&${COL_NC}," \
|
||||||
|
-e "s,.*,${COL_DARK_GRAY}&${COL_NC},"
|
||||||
exit 0
|
exit 0
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -302,12 +373,12 @@ Branches:
|
||||||
|
|
||||||
tricorderFunc() {
|
tricorderFunc() {
|
||||||
if [[ ! -p "/dev/stdin" ]]; then
|
if [[ ! -p "/dev/stdin" ]]; then
|
||||||
echo "Please do not call Tricorder directly."
|
echo -e " ${INFO} Please do not call Tricorder directly"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if ! timeout 2 nc -z tricorder.pi-hole.net 9998 &> /dev/null; then
|
if ! timeout 2 nc -z tricorder.pi-hole.net 9998 &> /dev/null; then
|
||||||
echo "Unable to connect to Pi-hole's Tricorder server."
|
echo -e " ${CROSS} Unable to connect to Pi-hole's Tricorder server"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
@ -315,9 +386,10 @@ tricorderFunc() {
|
||||||
openssl s_client -quiet -connect tricorder.pi-hole.net:9998 2> /dev/null < /dev/stdin
|
openssl s_client -quiet -connect tricorder.pi-hole.net:9998 2> /dev/null < /dev/stdin
|
||||||
exit "$?"
|
exit "$?"
|
||||||
else
|
else
|
||||||
echo "Your debug log will be transmitted unencrypted via plain-text"
|
echo -e " ${INFO} ${COL_YELLOW}Security Notice${COL_NC}: ${COL_WHITE}openssl${COL_NC} is not installed
|
||||||
echo "There is a possibility that this could be intercepted by a third party"
|
Your debug log will be transmitted unencrypted via plain-text
|
||||||
echo "If you wish to cancel, press Ctrl-C to exit within 10 seconds"
|
There is a possibility that this could be intercepted by a third party
|
||||||
|
If you wish to cancel, press Ctrl-C to exit within 10 seconds"
|
||||||
secs="10"
|
secs="10"
|
||||||
while [[ "$secs" -gt "0" ]]; do
|
while [[ "$secs" -gt "0" ]]; do
|
||||||
echo -ne "."
|
echo -ne "."
|
||||||
|
|
@ -400,5 +472,6 @@ case "${1}" in
|
||||||
"-a" | "admin" ) webpageFunc "$@";;
|
"-a" | "admin" ) webpageFunc "$@";;
|
||||||
"-t" | "tail" ) tailFunc;;
|
"-t" | "tail" ) tailFunc;;
|
||||||
"checkout" ) piholeCheckoutFunc "$@";;
|
"checkout" ) piholeCheckoutFunc "$@";;
|
||||||
|
"tricorder" ) tricorderFunc;;
|
||||||
* ) helpFunc;;
|
* ) helpFunc;;
|
||||||
esac
|
esac
|
||||||
|
|
|
||||||
|
|
@ -9,6 +9,10 @@ SETUPVARS = {
|
||||||
'PIHOLE_DNS_2' : '4.2.2.2'
|
'PIHOLE_DNS_2' : '4.2.2.2'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
tick_box="[\x1b[1;32m\xe2\x9c\x93\x1b[0m]".decode("utf-8")
|
||||||
|
cross_box="[\x1b[1;31m\xe2\x9c\x97\x1b[0m]".decode("utf-8")
|
||||||
|
info_box="[i]".decode("utf-8")
|
||||||
|
|
||||||
def test_setupVars_are_sourced_to_global_scope(Pihole):
|
def test_setupVars_are_sourced_to_global_scope(Pihole):
|
||||||
''' currently update_dialogs sources setupVars with a dot,
|
''' currently update_dialogs sources setupVars with a dot,
|
||||||
then various other functions use the variables.
|
then various other functions use the variables.
|
||||||
|
|
@ -173,8 +177,11 @@ def test_installPiholeWeb_fresh_install_no_errors(Pihole):
|
||||||
source /opt/pihole/basic-install.sh
|
source /opt/pihole/basic-install.sh
|
||||||
installPiholeWeb
|
installPiholeWeb
|
||||||
''')
|
''')
|
||||||
assert 'Installing pihole custom index page...' in installWeb.stdout
|
assert info_box + ' Installing blocking page...' in installWeb.stdout
|
||||||
|
assert tick_box + ' Creating directory for blocking page, and copying files' in installWeb.stdout
|
||||||
|
assert cross_box + ' Backing up index.lighttpd.html' in installWeb.stdout
|
||||||
assert 'No default index.lighttpd.html file found... not backing up' in installWeb.stdout
|
assert 'No default index.lighttpd.html file found... not backing up' in installWeb.stdout
|
||||||
|
assert tick_box + ' Installing sudoer file' in installWeb.stdout
|
||||||
web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
|
web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
|
||||||
assert 'index.php' in web_directory
|
assert 'index.php' in web_directory
|
||||||
assert 'index.js' in web_directory
|
assert 'index.js' in web_directory
|
||||||
|
|
@ -187,11 +194,12 @@ def test_installPiholeWeb_empty_directory_no_errors(Pihole):
|
||||||
mkdir -p /var/www/html/pihole
|
mkdir -p /var/www/html/pihole
|
||||||
installPiholeWeb
|
installPiholeWeb
|
||||||
''')
|
''')
|
||||||
assert 'Installing pihole custom index page...' in installWeb.stdout
|
assert info_box + ' Installing blocking page...' in installWeb.stdout
|
||||||
|
assert info_box + ' Installing index.php' in installWeb.stdout
|
||||||
|
assert info_box + ' Installing index.js' in installWeb.stdout
|
||||||
|
assert info_box + ' Installing blockingpage.css' in installWeb.stdout
|
||||||
assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
|
assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
|
||||||
assert 'index.php missing, replacing...' in installWeb.stdout
|
assert tick_box + ' Installing sudoer file' in installWeb.stdout
|
||||||
assert 'index.js missing, replacing...' in installWeb.stdout
|
|
||||||
assert 'blockingpage.css missing, replacing...' in installWeb.stdout
|
|
||||||
web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
|
web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
|
||||||
assert 'index.php' in web_directory
|
assert 'index.php' in web_directory
|
||||||
assert 'index.js' in web_directory
|
assert 'index.js' in web_directory
|
||||||
|
|
@ -205,11 +213,13 @@ def test_installPiholeWeb_index_php_no_errors(Pihole):
|
||||||
touch /var/www/html/pihole/index.php
|
touch /var/www/html/pihole/index.php
|
||||||
installPiholeWeb
|
installPiholeWeb
|
||||||
''')
|
''')
|
||||||
assert 'Installing pihole custom index page...' in installWeb.stdout
|
assert info_box + ' Installing blocking page...' in installWeb.stdout
|
||||||
|
assert info_box + ' Installing index.php' in installWeb.stdout
|
||||||
|
assert 'detected index.php, not overwriting' in installWeb.stdout
|
||||||
|
assert info_box + ' Installing index.js' in installWeb.stdout
|
||||||
|
assert info_box + ' Installing blockingpage.css' in installWeb.stdout
|
||||||
assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
|
assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
|
||||||
assert 'Existing index.php detected, not overwriting' in installWeb.stdout
|
assert tick_box + ' Installing sudoer file' in installWeb.stdout
|
||||||
assert 'index.js missing, replacing...' in installWeb.stdout
|
|
||||||
assert 'blockingpage.css missing, replacing...' in installWeb.stdout
|
|
||||||
web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
|
web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
|
||||||
assert 'index.php' in web_directory
|
assert 'index.php' in web_directory
|
||||||
assert 'index.js' in web_directory
|
assert 'index.js' in web_directory
|
||||||
|
|
@ -223,11 +233,13 @@ def test_installPiholeWeb_index_js_no_errors(Pihole):
|
||||||
touch /var/www/html/pihole/index.js
|
touch /var/www/html/pihole/index.js
|
||||||
installPiholeWeb
|
installPiholeWeb
|
||||||
''')
|
''')
|
||||||
assert 'Installing pihole custom index page...' in installWeb.stdout
|
assert info_box + ' Installing blocking page...' in installWeb.stdout
|
||||||
|
assert info_box + ' Installing index.php' in installWeb.stdout
|
||||||
|
assert info_box + ' Installing index.js' in installWeb.stdout
|
||||||
|
assert 'detected index.js, not overwriting' in installWeb.stdout
|
||||||
|
assert info_box + ' Installing blockingpage.css' in installWeb.stdout
|
||||||
assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
|
assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
|
||||||
assert 'index.php missing, replacing...' in installWeb.stdout
|
assert tick_box + ' Installing sudoer file' in installWeb.stdout
|
||||||
assert 'Existing index.js detected, not overwriting' in installWeb.stdout
|
|
||||||
assert 'blockingpage.css missing, replacing...' in installWeb.stdout
|
|
||||||
web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
|
web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
|
||||||
assert 'index.php' in web_directory
|
assert 'index.php' in web_directory
|
||||||
assert 'index.js' in web_directory
|
assert 'index.js' in web_directory
|
||||||
|
|
@ -241,11 +253,13 @@ def test_installPiholeWeb_blockingpage_css_no_errors(Pihole):
|
||||||
touch /var/www/html/pihole/blockingpage.css
|
touch /var/www/html/pihole/blockingpage.css
|
||||||
installPiholeWeb
|
installPiholeWeb
|
||||||
''')
|
''')
|
||||||
assert 'Installing pihole custom index page...' in installWeb.stdout
|
assert info_box + ' Installing blocking page...' in installWeb.stdout
|
||||||
|
assert info_box + ' Installing index.php' in installWeb.stdout
|
||||||
|
assert info_box + ' Installing index.js' in installWeb.stdout
|
||||||
|
assert info_box + ' Installing blockingpage.css' in installWeb.stdout
|
||||||
|
assert 'detected blockingpage.css, not overwriting' in installWeb.stdout
|
||||||
assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
|
assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
|
||||||
assert 'index.php missing, replacing...' in installWeb.stdout
|
assert tick_box + ' Installing sudoer file' in installWeb.stdout
|
||||||
assert 'index.js missing, replacing...' in installWeb.stdout
|
|
||||||
assert 'Existing blockingpage.css detected, not overwriting' in installWeb.stdout
|
|
||||||
web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
|
web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
|
||||||
assert 'index.php' in web_directory
|
assert 'index.php' in web_directory
|
||||||
assert 'index.js' in web_directory
|
assert 'index.js' in web_directory
|
||||||
|
|
@ -261,14 +275,14 @@ def test_installPiholeWeb_already_populated_no_errors(Pihole):
|
||||||
touch /var/www/html/pihole/blockingpage.css
|
touch /var/www/html/pihole/blockingpage.css
|
||||||
installPiholeWeb
|
installPiholeWeb
|
||||||
''')
|
''')
|
||||||
assert 'Installing pihole custom index page...' in installWeb.stdout
|
assert info_box + ' Installing blocking page...' in installWeb.stdout
|
||||||
assert 'No default index.lighttpd.html file found... not backing up' not in installWeb.stdout
|
assert info_box + ' Installing index.php' in installWeb.stdout
|
||||||
assert 'Existing index.php detected, not overwriting' in installWeb.stdout
|
assert 'detected index.php, not overwriting' in installWeb.stdout
|
||||||
assert 'index.php missing, replacing...' not in installWeb.stdout
|
assert info_box + ' Installing index.js' in installWeb.stdout
|
||||||
assert 'Existing index.js detected, not overwriting' in installWeb.stdout
|
assert 'detected index.js, not overwriting' in installWeb.stdout
|
||||||
assert 'index.js missing, replacing...' not in installWeb.stdout
|
assert info_box + ' Installing blockingpage.css' in installWeb.stdout
|
||||||
assert 'Existing blockingpage.css detected, not overwriting' in installWeb.stdout
|
assert 'detected blockingpage.css, not overwriting' in installWeb.stdout
|
||||||
assert 'blockingpage.css missing, replacing... ' not in installWeb.stdout
|
assert tick_box + ' Installing sudoer file' in installWeb.stdout
|
||||||
web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
|
web_directory = Pihole.run('ls -r /var/www/html/pihole').stdout
|
||||||
assert 'index.php' in web_directory
|
assert 'index.php' in web_directory
|
||||||
assert 'index.js' in web_directory
|
assert 'index.js' in web_directory
|
||||||
|
|
@ -281,9 +295,8 @@ def test_update_package_cache_success_no_errors(Pihole):
|
||||||
distro_check
|
distro_check
|
||||||
update_package_cache
|
update_package_cache
|
||||||
''')
|
''')
|
||||||
assert 'Updating local cache of available packages...' in updateCache.stdout
|
assert tick_box + ' Update local cache of available packages' in updateCache.stdout
|
||||||
assert 'ERROR' not in updateCache.stdout
|
assert 'Error: Unable to update package cache.' not in updateCache.stdout
|
||||||
assert 'done!' in updateCache.stdout
|
|
||||||
|
|
||||||
def test_update_package_cache_failure_no_errors(Pihole):
|
def test_update_package_cache_failure_no_errors(Pihole):
|
||||||
''' confirms package cache was not updated'''
|
''' confirms package cache was not updated'''
|
||||||
|
|
@ -293,9 +306,8 @@ def test_update_package_cache_failure_no_errors(Pihole):
|
||||||
distro_check
|
distro_check
|
||||||
update_package_cache
|
update_package_cache
|
||||||
''')
|
''')
|
||||||
assert 'Updating local cache of available packages...' in updateCache.stdout
|
assert cross_box + ' Update local cache of available packages' in updateCache.stdout
|
||||||
assert 'ERROR' in updateCache.stdout
|
assert 'Error: Unable to update package cache.' in updateCache.stdout
|
||||||
assert 'done!' not in updateCache.stdout
|
|
||||||
|
|
||||||
def test_FTL_detect_aarch64_no_errors(Pihole):
|
def test_FTL_detect_aarch64_no_errors(Pihole):
|
||||||
''' confirms only aarch64 package is downloaded for FTL engine '''
|
''' confirms only aarch64 package is downloaded for FTL engine '''
|
||||||
|
|
@ -307,7 +319,11 @@ def test_FTL_detect_aarch64_no_errors(Pihole):
|
||||||
source /opt/pihole/basic-install.sh
|
source /opt/pihole/basic-install.sh
|
||||||
FTLdetect
|
FTLdetect
|
||||||
''')
|
''')
|
||||||
expected_stdout = 'Detected ARM-aarch64 architecture'
|
expected_stdout = info_box + ' Downloading latest version of FTL...'
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
expected_stdout = tick_box + ' Detected ARM-aarch64 architecture'
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
expected_stdout = tick_box + ' Installing FTL'
|
||||||
assert expected_stdout in detectPlatform.stdout
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
|
||||||
def test_FTL_detect_armv6l_no_errors(Pihole):
|
def test_FTL_detect_armv6l_no_errors(Pihole):
|
||||||
|
|
@ -320,7 +336,11 @@ def test_FTL_detect_armv6l_no_errors(Pihole):
|
||||||
source /opt/pihole/basic-install.sh
|
source /opt/pihole/basic-install.sh
|
||||||
FTLdetect
|
FTLdetect
|
||||||
''')
|
''')
|
||||||
expected_stdout = 'Detected ARM-hf architecture (armv6 or lower)'
|
expected_stdout = info_box + ' Downloading latest version of FTL...'
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
expected_stdout = tick_box + ' Detected ARM-hf architecture (armv6 or lower)'
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
expected_stdout = tick_box + ' Installing FTL'
|
||||||
assert expected_stdout in detectPlatform.stdout
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
|
||||||
def test_FTL_detect_armv7l_no_errors(Pihole):
|
def test_FTL_detect_armv7l_no_errors(Pihole):
|
||||||
|
|
@ -333,7 +353,11 @@ def test_FTL_detect_armv7l_no_errors(Pihole):
|
||||||
source /opt/pihole/basic-install.sh
|
source /opt/pihole/basic-install.sh
|
||||||
FTLdetect
|
FTLdetect
|
||||||
''')
|
''')
|
||||||
expected_stdout = 'Detected ARM-hf architecture (armv7+)'
|
expected_stdout = info_box + ' Downloading latest version of FTL...'
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
expected_stdout = tick_box + ' Detected ARM-hf architecture (armv7+)'
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
expected_stdout = tick_box + ' Installing FTL'
|
||||||
assert expected_stdout in detectPlatform.stdout
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
|
||||||
def test_FTL_detect_x86_64_no_errors(Pihole):
|
def test_FTL_detect_x86_64_no_errors(Pihole):
|
||||||
|
|
@ -342,7 +366,11 @@ def test_FTL_detect_x86_64_no_errors(Pihole):
|
||||||
source /opt/pihole/basic-install.sh
|
source /opt/pihole/basic-install.sh
|
||||||
FTLdetect
|
FTLdetect
|
||||||
''')
|
''')
|
||||||
expected_stdout = 'Detected x86_64 architecture'
|
expected_stdout = info_box + ' Downloading latest version of FTL...'
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
expected_stdout = tick_box + ' Detected x86_64 architecture'
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
expected_stdout = tick_box + ' Installing FTL'
|
||||||
assert expected_stdout in detectPlatform.stdout
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
|
||||||
def test_FTL_detect_unknown_no_errors(Pihole):
|
def test_FTL_detect_unknown_no_errors(Pihole):
|
||||||
|
|
@ -363,9 +391,12 @@ def test_FTL_download_aarch64_no_errors(Pihole):
|
||||||
source /opt/pihole/basic-install.sh
|
source /opt/pihole/basic-install.sh
|
||||||
FTLinstall pihole-FTL-aarch64-linux-gnu
|
FTLinstall pihole-FTL-aarch64-linux-gnu
|
||||||
''')
|
''')
|
||||||
expected_stdout = 'done'
|
expected_stdout = tick_box + ' Installing FTL'
|
||||||
assert expected_stdout in download_binary.stdout
|
assert expected_stdout in download_binary.stdout
|
||||||
assert 'failed' not in download_binary.stdout
|
error = 'Error: Download of binary from Github failed'
|
||||||
|
assert error not in download_binary.stdout
|
||||||
|
error = 'Error: URL not found'
|
||||||
|
assert error not in download_binary.stdout
|
||||||
|
|
||||||
def test_FTL_download_unknown_fails_no_errors(Pihole):
|
def test_FTL_download_unknown_fails_no_errors(Pihole):
|
||||||
''' confirms unknown binary is not downloaded for FTL engine '''
|
''' confirms unknown binary is not downloaded for FTL engine '''
|
||||||
|
|
@ -374,9 +405,10 @@ def test_FTL_download_unknown_fails_no_errors(Pihole):
|
||||||
source /opt/pihole/basic-install.sh
|
source /opt/pihole/basic-install.sh
|
||||||
FTLinstall pihole-FTL-mips
|
FTLinstall pihole-FTL-mips
|
||||||
''')
|
''')
|
||||||
expected_stdout = 'failed'
|
expected_stdout = cross_box + ' Installing FTL'
|
||||||
assert expected_stdout in download_binary.stdout
|
assert expected_stdout in download_binary.stdout
|
||||||
assert 'done' not in download_binary.stdout
|
error = 'Error: URL not found'
|
||||||
|
assert error in download_binary.stdout
|
||||||
|
|
||||||
def test_FTL_binary_installed_and_responsive_no_errors(Pihole):
|
def test_FTL_binary_installed_and_responsive_no_errors(Pihole):
|
||||||
''' confirms FTL binary is copied and functional in installed location '''
|
''' confirms FTL binary is copied and functional in installed location '''
|
||||||
|
|
@ -402,6 +434,61 @@ def test_FTL_binary_installed_and_responsive_no_errors(Pihole):
|
||||||
# assert '644 /run/pihole-FTL.pid' in support_files.stdout
|
# assert '644 /run/pihole-FTL.pid' in support_files.stdout
|
||||||
# assert '644 /var/log/pihole-FTL.log' in support_files.stdout
|
# 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
|
# Helper functions
|
||||||
def mock_command(script, args, container):
|
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 '''
|
''' Allows for setup of commands we don't really want to have to run for real in unit tests '''
|
||||||
|
|
@ -424,6 +511,27 @@ def mock_command(script, args, container):
|
||||||
chmod +x {script}
|
chmod +x {script}
|
||||||
rm -f /var/log/{scriptlog}'''.format(script=full_script_path, content=mock_script, scriptlog=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):
|
def run_script(Pihole, script):
|
||||||
result = Pihole.run(script)
|
result = Pihole.run(script)
|
||||||
assert result.rc == 0
|
assert result.rc == 0
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@ run_local = testinfra.get_backend(
|
||||||
|
|
||||||
def test_scripts_pass_shellcheck():
|
def test_scripts_pass_shellcheck():
|
||||||
''' Make sure shellcheck does not find anything wrong with our shell scripts '''
|
''' Make sure shellcheck does not find anything wrong with our shell scripts '''
|
||||||
shellcheck = "find . -type f \( -name 'update.sh' -o -name 'piholeDebug.sh' \) | while read file; do shellcheck \"$file\"; done;"
|
shellcheck = "find . -type f -name 'update.sh' | while read file; do shellcheck -x \"$file\" -e SC1090,SC1091; done;"
|
||||||
results = run_local(shellcheck)
|
results = run_local(shellcheck)
|
||||||
print results.stdout
|
print results.stdout
|
||||||
assert '' == results.stdout
|
assert '' == results.stdout
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue