Make PADD compatible with FTLv6 by yubiuser · Pull Request #247 · pi-hole/PADD

yubiuser · 2022-07-18T19:56:20Z

What does this PR aim to accomplish?:

Makes PADD compatible with FTLv6's new API.
There is a second goal: if all necessary information are available via the API one can run PADD remotely.

Important: PADD now needs jq to parse the JSON data.

This is work in progress
As long the FTL's API is changing things can break within PADD anytime. However, I try to keep development in sync. Currently, everything should be working.

By submitting this pull request, I confirm the following:

I have read and understood the contributors guide, as well as this entire template. I understand which branch to base my commits and Pull Requests against.
I have commented my proposed changes within the code and I have tested my changes.
I am willing to help maintain this change if there are issues with it later.
It is compatible with the EUPL 1.2 license
I have squashed any insignificant commits. (git rebase)

I have read the above and my PR is ready for review. Check this box to confirm

Signed-off-by: Christian König <ckoenig@posteo.de>

**What does this PR aim to accomplish?:** Adds `jq` as dependency and removes the now obsolete `json_extract` function. `jq` is a small dependency and adds powerfull json abilities. With `FTL v6` we will have a whole new json-based API where `jq` might be needed anyway. Also for `PADD` to interact with `FTL v6`, `jq` will be a requirement: pi-hole/PADD#247 --- **By submitting this pull request, I confirm the following:** 1. I have read and understood the [contributors guide](https://docs.pi-hole.net/guides/github/contributing/), as well as this entire template. I understand which branch to base my commits and Pull Requests against. 2. I have commented my proposed changes within the code and I have tested my changes. 3. I am willing to help maintain this change if there are issues with it later. 4. It is compatible with the [EUPL 1.2 license](https://opensource.org/licenses/EUPL-1.1) 5. I have squashed any insignificant commits. ([`git rebase`](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)) --- - [x] I have read the above and my PR is ready for review. _Check this box to confirm_

github-actions · 2022-12-19T21:47:24Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Signed-off-by: Christian König <ckoenig@posteo.de>

github-actions · 2023-01-14T09:39:19Z

Conflicts have been resolved.

Signed-off-by: Christian König <ckoenig@posteo.de>

Signed-off-by: yubiuser <github@yubiuser.dev>

…ng normal runtime Signed-off-by: yubiuser <github@yubiuser.dev>

…ateway interface instead Signed-off-by: DL6ER <dl6er@dl6er.de>

Signed-off-by: DL6ER <dl6er@dl6er.de>

…lues null and false Signed-off-by: DL6ER <dl6er@dl6er.de>

We also check if the value is exactly `null` and, in this case, return the string "null", as jq would return an empty string for nulls. Signed-off-by: RD WebDesign <github@rdwebdesign.com.br>

Signed-off-by: yubiuser <github@yubiuser.dev>

#399)

PromoFaux · 2024-09-02T20:40:57Z

@yubiuser is this ready for development?

yubiuser · 2024-09-02T20:43:10Z

I think so :)

yubiuser added 12 commits July 19, 2022 15:10

Add FTL communication

dbe726d

Signed-off-by: Christian König <ckoenig@posteo.de>

Improve exit routines

8916cb2

Signed-off-by: Christian König <ckoenig@posteo.de>

Add TestAPIAvailability()

55ade42

Signed-off-by: Christian König <ckoenig@posteo.de>

Use API for GetSummaryInformation

cea974e

Signed-off-by: Christian König <ckoenig@posteo.de>

Use API for GetSystemInformation

0df566a

Signed-off-by: Christian König <ckoenig@posteo.de>

Use API for GetNetworkInformation

67184b7

Signed-off-by: Christian König <ckoenig@posteo.de>

Use API for GetVersionInformation

f92afc7

Signed-off-by: Christian König <ckoenig@posteo.de>

Remove CheckConnectivity

7531a1a

Signed-off-by: Christian König <ckoenig@posteo.de>

Set DHCP_ROUTER via API, turn cursor back on when exiting

cc9a9f8

Signed-off-by: Christian König <ckoenig@posteo.de>

Make OutputJSON compatible with FTLv6

0e00879

Signed-off-by: Christian König <ckoenig@posteo.de>

Remove commas between component's version

bb6f8b3

Signed-off-by: Christian König <ckoenig@posteo.de>

Rebase on development including new VersionConverter()

afd573e

Signed-off-by: Christian König <ckoenig@posteo.de>

yubiuser force-pushed the PADD_FTLv6 branch from 11468f9 to afd573e Compare July 19, 2022 13:20

yubiuser mentioned this pull request Aug 24, 2022

Add jq as dependency and remove json_extract pi-hole/pi-hole#4878

Merged

1 task

github-actions bot added the Merge Conflict label Dec 19, 2022

yubiuser added the Never Stale label Dec 30, 2022

yubiuser added 2 commits January 6, 2023 21:36

Don't allow $validSession to be empty

2096d3b

Signed-off-by: Christian König <ckoenig@posteo.de>

Merge branch 'development' into PADD_FTLv6

699e0bd

Signed-off-by: Christian König <ckoenig@posteo.de>

github-actions bot removed the Merge Conflict label Jan 14, 2023

Mix merge mess

a726df6

Signed-off-by: Christian König <ckoenig@posteo.de>

yubiuser force-pushed the PADD_FTLv6 branch from b8dc14d to a726df6 Compare January 14, 2023 13:47

yubiuser added 5 commits January 16, 2023 21:06

Adjust to current FTL endpoints

70e33c1

Signed-off-by: Christian König <ckoenig@posteo.de>

Mask user password during input

1a23a9c

Signed-off-by: Christian König <ckoenig@posteo.de>

Format memory_percentage

d3a209e

Signed-off-by: Christian König <ckoenig@posteo.de>

Merge branch 'development' into PADD_FTLv6

b1a2fb3

Adjust for changed API endpoint

e0f78cf

Signed-off-by: Christian König <ckoenig@posteo.de>

github-actions bot added the Merge Conflict label Jan 19, 2023

yubiuser and others added 21 commits July 14, 2024 22:25

Fix idention style

19808bf

Signed-off-by: yubiuser <github@yubiuser.dev>

Fix/dhcp (#396)

aeb2a72

Check for required dependencies on startup

d1707e5

Signed-off-by: yubiuser <github@yubiuser.dev>

No need to check for wget in update routine as we check for curl duri…

f918bff

…ng normal runtime Signed-off-by: yubiuser <github@yubiuser.dev>

Fallback: If there is no default IPv6 gateway, use the default IPv4 g…

ef97d5b

…ateway interface instead Signed-off-by: DL6ER <dl6er@dl6er.de>

Check for curl and jq dependencies (#398)

5d9090c

Modify PADD to comply with the changes in FTL on the same branch (#395)

b719987

Use new FTL api/padd endpoint for querying the data

5559796

Signed-off-by: DL6ER <dl6er@dl6er.de>

Use jq only once for parsing the entire payload after querying the API

113ef44

Signed-off-by: DL6ER <dl6er@dl6er.de>

Redefine jq's paths() as its built-in function skips all pais with va…

1310ea8

…lues null and false Signed-off-by: DL6ER <dl6er@dl6er.de>

Using paths(scalars | true) to return null and false values.

f1c3382

We also check if the value is exactly `null` and, in this case, return the string "null", as jq would return an empty string for nulls. Signed-off-by: RD WebDesign <github@rdwebdesign.com.br>

Rename functions to clarify their use

285f387

Signed-off-by: yubiuser <github@yubiuser.dev>

Re add necessary 2>/dev/null

d8c6f33

Signed-off-by: yubiuser <github@yubiuser.dev>

Suppress curl errors

e18403b

Signed-off-by: yubiuser <github@yubiuser.dev>

padd_data is a global variable

573d36f

Signed-off-by: yubiuser <github@yubiuser.dev>

Propagate API response errors upstream

ed3143f

Signed-off-by: yubiuser <github@yubiuser.dev>

Fix --version command

97006b0

Signed-off-by: yubiuser <github@yubiuser.dev>

Skip all the processing if FTL is down

51fde8a

Signed-off-by: yubiuser <github@yubiuser.dev>

Set --connect-timeout for curl connections

09e3396

Signed-off-by: yubiuser <github@yubiuser.dev>

Require all API data after connection is re-established

0440ade

Signed-off-by: yubiuser <github@yubiuser.dev>

Use FTL's taildored /padd endpoint to reduce the number of API calls (

9e7d6c8

#399)

yubiuser marked this pull request as ready for review September 2, 2024 20:43

yubiuser changed the title ~~[WIP] Make PADD compatible with FTLv6~~ Make PADD compatible with FTLv6 Sep 2, 2024

Merge branch 'development' into PADD_FTLv6

e7f4989

PromoFaux approved these changes Sep 2, 2024

View reviewed changes

yubiuser merged commit 4a34c23 into development Sep 2, 2024

yubiuser deleted the PADD_FTLv6 branch September 2, 2024 21:00

yubiuser mentioned this pull request Sep 2, 2024

PADD v4.0.0 #373

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Make PADD compatible with FTLv6#247

Make PADD compatible with FTLv6#247
yubiuser merged 84 commits intodevelopmentfrom
PADD_FTLv6

yubiuser commented Jul 18, 2022 •

edited

Loading

Uh oh!

github-actions bot commented Dec 19, 2022

Uh oh!

github-actions bot commented Jan 14, 2023

Uh oh!

PromoFaux commented Sep 2, 2024

Uh oh!

yubiuser commented Sep 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

yubiuser commented Jul 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 19, 2022

Uh oh!

github-actions bot commented Jan 14, 2023

Uh oh!

PromoFaux commented Sep 2, 2024

Uh oh!

yubiuser commented Sep 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

yubiuser commented Jul 18, 2022 •

edited

Loading