Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make PADD compatible with FTLv6 #247

Merged
merged 84 commits into from
Sep 2, 2024
Merged

Make PADD compatible with FTLv6 #247

merged 84 commits into from
Sep 2, 2024
+893 −557

Conversation

yubiuser
Copy link
Member

@yubiuser yubiuser commented Jul 18, 2022 •
edited
Loading

  • 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:

  1. 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.
  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
  5. 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

yubiuser added 12 commits July 19, 2022 15:10
@yubiuser
Add FTL communication
dbe726d 
Signed-off-by: Christian König <[email protected]>
@yubiuser
Improve exit routines
8916cb2 
Signed-off-by: Christian König <[email protected]>
@yubiuser
Add TestAPIAvailability()
55ade42 
Signed-off-by: Christian König <[email protected]>
@yubiuser
Use API for GetSummaryInformation
cea974e 
Signed-off-by: Christian König <[email protected]>
@yubiuser
Use API for GetSystemInformation
0df566a 
Signed-off-by: Christian König <[email protected]>
@yubiuser
Use API for GetNetworkInformation
67184b7 
Signed-off-by: Christian König <[email protected]>
@yubiuser
Use API for GetVersionInformation
f92afc7 
Signed-off-by: Christian König <[email protected]>
@yubiuser
Remove CheckConnectivity
7531a1a 
Signed-off-by: Christian König <[email protected]>
@yubiuser
Set DHCP_ROUTER via API, turn cursor back on when exiting
cc9a9f8 
Signed-off-by: Christian König <[email protected]>
@yubiuser
Make OutputJSON compatible with FTLv6
0e00879 
Signed-off-by: Christian König <[email protected]>
@yubiuser
Remove commas between component's version
bb6f8b3 
Signed-off-by: Christian König <[email protected]>
@yubiuser
Rebase on development including new VersionConverter()
afd573e 
Signed-off-by: Christian König <[email protected]>
@yubiuser yubiuser mentioned this pull request Aug 24, 2022
Merged
1 task
yubiuser added a commit to pi-hole/pi-hole that referenced this pull request Aug 26, 2022
@yubiuser
Add jq as dependency and remove json_extract (#4878)
d6cfa57 
 **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
Copy link

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

@github-actions
Copy link

Conflicts have been resolved.

@yubiuser
Mix merge mess
a726df6 
Signed-off-by: Christian König <[email protected]>
yubiuser and others added 21 commits July 14, 2024 22:25
@yubiuser
Fix idention style
19808bf 
Signed-off-by: yubiuser <[email protected]>
@yubiuser
Fix/dhcp (#396)
aeb2a72
@yubiuser
Check for required dependencies on startup
d1707e5 
Signed-off-by: yubiuser <[email protected]>
@yubiuser
No need to check for wget in update routine as we check for curl duri…
f918bff 
…ng normal runtime

Signed-off-by: yubiuser <[email protected]>
@DL6ER
Fallback: If there is no default IPv6 gateway, use the default IPv4 g…
ef97d5b 
…ateway interface instead

Signed-off-by: DL6ER <[email protected]>
@yubiuser
Check for curl and jq dependencies (#398)
5d9090c
@DL6ER
Modify PADD to comply with the changes in FTL on the same branch (#395)
b719987
@DL6ER
Use new FTL api/padd endpoint for querying the data
5559796 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Use jq only once for parsing the entire payload after querying the API
113ef44 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Redefine jq's paths() as its built-in function skips all pais with va…
1310ea8 
…lues null and false

Signed-off-by: DL6ER <[email protected]>
@rdwebdesign
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 <[email protected]>
@yubiuser
Rename functions to clarify their use
285f387 
Signed-off-by: yubiuser <[email protected]>
@yubiuser
Re add necessary 2>/dev/null
d8c6f33 
Signed-off-by: yubiuser <[email protected]>
@yubiuser
Suppress curl errors
e18403b 
Signed-off-by: yubiuser <[email protected]>
@yubiuser
padd_data is a global variable
573d36f 
Signed-off-by: yubiuser <[email protected]>
@yubiuser
Propagate API response errors upstream
ed3143f 
Signed-off-by: yubiuser <[email protected]>
@yubiuser
Fix --version command
97006b0 
Signed-off-by: yubiuser <[email protected]>
@yubiuser
Skip all the processing if FTL is down
51fde8a 
Signed-off-by: yubiuser <[email protected]>
@yubiuser
Set --connect-timeout for curl connections
09e3396 
Signed-off-by: yubiuser <[email protected]>
@yubiuser
Require all API data after connection is re-established
0440ade 
Signed-off-by: yubiuser <[email protected]>
@yubiuser
Use FTL's taildored /padd endpoint to reduce the number of API calls (
9e7d6c8 
#399)
@PromoFaux
Copy link
Member

@yubiuser is this ready for development?

@yubiuser
Copy link
Member Author

yubiuser commented Sep 2, 2024

I think so :)

@yubiuser yubiuser marked this pull request as ready for review September 2, 2024 20:43
@yubiuser yubiuser changed the title [WIP] Make PADD compatible with FTLv6 Make PADD compatible with FTLv6 Sep 2, 2024
@yubiuser yubiuser merged commit 4a34c23 into development Sep 2, 2024
5 checks passed
@yubiuser yubiuser deleted the PADD_FTLv6 branch September 2, 2024 21:00
@yubiuser yubiuser mentioned this pull request Sep 2, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PromoFaux PromoFaux PromoFaux approved these changes

Assignees
No one assigned
Labels
Never Stale
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@yubiuser @DL6ER @PromoFaux @rdwebdesign