Commit graph

129 commits

Author SHA1 Message Date
Adam Warner
ecde222512 [Staging] 3.1 (#1502)
* Fix handling of wildcard help text

* Rewrite help text for better handling of params

* Replace misleading letter variable

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

* Make changes according to comment in #1384

* Update queryFunc()

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

* Update basic-install.sh

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

* simplify

* further simplify

* fix inteliJ IDEA complaints

* even further simplify

* tidy up output

* revert line, looks tidyer

* clarify

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

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

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

* Display FTL version & version.sh rewrite

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

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

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

* Update -h to work as --hash

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

* Perform EXACT searches on HOSTS lists correctly

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

* Fixed indentation

* Minimise string duplication & other minor changes

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

* Modified syntax to be valid for Shellcheck

* Log and echo gateway responses

* Update queryFunc() to search Whitelist

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

* Wrap in double brackets

* Provide remote hashes for version.sh

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

* whitelist on website blocked doesnt work (#1452)

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

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

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

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

* Update list.sh

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

* Document `sed` substitution for user readability

Comment the oneliner with explanations of what each step does.

* Update Help Output (#1467)



* File consistency

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

* Standardise core help text

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

* Clean up

* Fixed certain new lines and spaces

* Sync with development branch

* Formatting consistency

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

* Admin help text

* Added help text for interface command

* Sync with development branch

* Formatting consistency

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

* Formatting consistency

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

* Blacklist help text

* Formatting consistency

* Tabs to 2 spaces
* Corrected indenting

* Cronometer help text

* Formatting consistency

* Fixed certain newlines and spaces
* Corrected indenting

* Checkout warning alteration

* Add checkout help text

* Corrected help output

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

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

* Show help for "pihole -v -h" 

* Indent output text
* Minor help text change

* Show help for "pihole checkout --help"

* Tricorder: Insecure Opt-out

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

* 🌮 is the new :shipit: squirrel

* Wording changes and bug fix

* Fix wildcard help text

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

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

* Print echos only when manual flushing is requested

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

* Confirm Tricorder is online

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

* Formatting consistency

* Add link to Windows DNS Swapper

See #1400

* Install loopback firewall rules for FTL (#1419)

* Install loopback firewall rules for FTL

* FirewallD FTL ports

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

* Remove firewallD FTL local rules.

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

* Reinstate https rules, and delete FTL rules

Fixes earlier commit.

* Retrieve local repos on repair (#1481)

* Retrieve local repos on repair

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

* Perform "git reset --hard" on reconfigure

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

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

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

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

* Rewrite Chronometer to output more stats

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

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

* Move wildcards file if blocking is diabled

* Delete newline

* Roll back merge #1417 (#1494)

* Update ISSUE_TEMPLATE.md

* Remove Question option

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

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

* Add test for link-local address detection

* Add ULA-only and GUA-only tests

* Add test_IPv6_GUA_ULA_test and test_IPv6_ULA_GUA_test

* Add ""

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

* Make mock_command_2 more similar to the original mock_command

* Correct comments

* Fixed remaining comments

* Fixed one last comment...

* Fixed a comment...

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

* Update LICENSE of the project to EUPL v1.2

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

* Add tricorderFunc back as usable function (#1515)

As per #1464

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

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

* Add first version of FTL tests

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

* Add test_FTL_telnet_statistics

* Added test_FTL_telnet_top_clients

* Add test_FTL_telnet_top_domains

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

This reverts commit cf6a1ac9ad.

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

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

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

* Change from admin to approvers teams

* Introduce new file black.list for blacklist content

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

* Remove useless cat

* Improve displayed messages and overall logic

* Disable black.list on "pihole disable"

* cp + rm === mv (well, almost)
2017-06-20 22:17:41 +01:00
DL6ER
30dcf6ff47
Include pihole-FTL.log in debug report 2017-05-02 09:18:58 +02:00
Dan Schaper
2740c68a63 Merge pull request #1335 from pi-hole/tweak/debug_templog
Debugging tweaks for temporary logfiles
2017-03-16 23:35:15 -07:00
Dan Schaper
b1f769b671
Output cleaning, IP stack check headers.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-03-15 23:50:29 -07:00
Dan Schaper
77378da70a
Cat out temp files to final log.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-03-15 23:43:41 -07:00
Dan Schaper
160030b75f
Quiet systemctl output to just the current daemon status.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-03-15 23:27:18 -07:00
Dan Schaper
0a0c3a2fb7
Copy working temp to final location.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-03-15 23:20:12 -07:00
Dan Schaper
e9f1ca338f
Create temp files for working storage, log to working storage temps.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-03-15 22:49:47 -07:00
Adam Warner
cfaf1ac67c
add check on file_parse to not include WEBPASSWORD= in the debug log 2017-03-15 18:59:41 +00:00
Dan Schaper
d1e0f3ae18 Merge pull request #1294 from pi-hole/tweak/debugDNS
Tweak DNS debugging
2017-03-06 05:50:37 -08:00
Dan Schaper
512c650441
Shellchecking.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-03-04 19:07:55 -08:00
Dan Schaper
dc44fc9e27
Version check amalgamation and removal of && || logic.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-03-04 17:54:38 -08:00
Dan Schaper
6f2fb57c08
Protocol specific records checks.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-03-04 15:16:33 -08:00
Dan Schaper
2547cc4c8d
Only run IPv6 if enabled, split out Chaos TXT checks.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-03-04 15:06:34 -08:00
DL6ER
9f4ef66f41
Add IPv6 resolver test 2017-03-04 22:38:52 +01:00
DL6ER
086f0790fc
Add Google's IPv6 address for potential IPv6 resolver tests 2017-03-04 22:31:18 +01:00
Dan Schaper
709b44f736
IPv4 DNS tests
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-03-04 12:16:43 -08:00
Dan Schaper
6cd4ff6d68
Organize functions and function calls.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-03-04 12:16:32 -08:00
DL6ER
66b7d04b82
Merge branch 'development' into new/FTL-binary 2017-03-01 12:42:48 +01:00
Dan Schaper
83b0600863
Carriage return or newline based webcalls.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-02-27 11:03:57 -08:00
Dan Schaper
6c130b7960
Vebiage and highligh the token, also :::
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-02-27 10:27:11 -08:00
Dan Schaper
7244d44a1d
Notify user that log is being uploaded.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-02-27 10:02:00 -08:00
Dan Schaper
9b060aab34
Debug auto mode engaged
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2017-02-26 18:22:06 -08:00
Jacob Salmela
7a1a2dec67
update license to EUPL on core files 2017-02-22 11:55:20 -06:00
DL6ER
a64211123f
Some debug additions 2017-02-21 16:46:54 +01:00
Dan Schaper
053b38e0bd
Set up for IP matching in detection. 2017-02-16 19:45:44 -08:00
Dan Schaper
2aa3a109a0
Ping gateways and Internet. 2017-02-16 18:38:05 -08:00
Dan Schaper
472708376d
Split out IP checks. 2017-02-16 18:30:15 -08:00
Dan Schaper
cfed3d59e9
Begin fixing IP detection functions. 2017-02-16 16:49:14 -08:00
DL6ER
af8e629df4 Merge pull request #1239 from pi-hole/tweak/debug48h
Change description as we want to save the debug log for 48h instead of only 24h
2017-02-10 20:46:12 +01:00
DL6ER
01f980d49c
Change description as we want to save the debug log for 48h instead of only 24h 2017-02-10 17:45:20 +01:00
DL6ER
99fab7e52a
Scan whole dnsmasq.d directory for cofigurations files 2017-02-10 17:42:37 +01:00
Promofaux
fe8c365d17 codacy never lies 2017-01-22 20:53:30 +00:00
Promofaux
9acc3aac01 pipe du -h output to awk to ensure we only get the file size, and not the filename too. Yeah that's right Dom, pipe. 2017-01-22 20:44:07 +00:00
Promofaux
1ad23a065e switch out wc -l with grep -c ^ 2017-01-22 20:38:46 +00:00
Promofaux
de102fde5c Add line count and size check for pihole.log 2017-01-22 20:38:09 +00:00
DL6ER
74a4e62cc9
Codacy fix 2017-01-08 11:26:56 +01:00
DL6ER
63a414a544
Align outputs 2017-01-08 11:21:50 +01:00
DL6ER
7d1f5091a7
Fixed small typo 2017-01-08 11:21:10 +01:00
DL6ER
3b54cab3bc
Show branches and revisions (incl. possible dirty state) in debug log 2017-01-08 11:17:25 +01:00
Dan Schaper
68cb0782c0 Add countdown timer 2016-11-18 13:27:06 -08:00
Dan Schaper
0f4c8d4923 Set default timeout to 60 seconds 2016-11-17 11:00:11 -08:00
Dan Schaper
6d2c5b2312 Add debug timeoute 2016-11-17 10:58:58 -08:00
Dan Schaper
a95ce11ca6 Add debug timeoute 2016-11-17 10:39:51 -08:00
Adam Warner
b191cd73a7 Update piholeDebug.sh
wording
2016-11-15 13:28:18 +00:00
Dan Schaper
dcf6e6b14d Clarify user action required to end the scripts. 2016-10-29 12:24:22 -07:00
Dan Schaper
908697a963 User token instructions, and small bugfix for missing separator. 2016-10-29 12:04:18 -07:00
Dan Schaper
fad2d6b1d1 Return values start showin up now. Logic operators too... 2016-10-28 15:53:18 -07:00
Dan Schaper
9cd830b6aa Start to refine tests and clean up code. 2016-10-28 15:37:45 -07:00
Dan Schaper
d9a16b0ff4 Clear up bottom half of script with fewer redundenicies. 2016-10-28 15:25:06 -07:00