Skip to content

/ FTL

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.

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

Add HTTP server and JSON API #659

Draft
wants to merge 155 commits into
base: development
from
Draft

Add HTTP server and JSON API #659

wants to merge 155 commits into from
+32,744 −2,894

Conversation

@DL6ER
Copy link
Member

DL6ER commented Nov 21, 2019

By submitting this pull request, I confirm the following (please check boxes, eg [X]) Failure to fill the template will close your PR:

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.
  • I have checked that another pull request for this purpose does not exist.
  • I have considered, and confirmed that this submission will be valuable to others.
  • I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  • I give this submission freely, and claim no ownership to its content.

How familiar are you with the codebase?:

10

This PR adds a fully-fledged HTTP server and JSON API to FTL.
It will replace lighttpd and serve both the API and the NG web interface.

More detail is to be added here once this feature advances further.
@DL6ER DL6ER force-pushed the new/http branch 2 times, most recently from 73072e4 to 38abfff Dec 2, 2019
@DL6ER DL6ER added this to the v6.0 milestone Dec 20, 2019
@DL6ER DL6ER force-pushed the new/http branch 2 times, most recently from 6fcce6d to 586fee1 Dec 25, 2019
@pralor-bot
Copy link

pralor-bot commented Jan 10, 2020

This pull request has been mentioned on Pi-hole Userspace. There might be relevant details there:

https://discourse.pi-hole.net/t/make-some-advance-api/26786/2
@PromoFaux PromoFaux mentioned this pull request Apr 15, 2020
Closed
@joshspicer joshspicer mentioned this pull request May 4, 2020
Open
This was referenced May 13, 2020
Closed
Closed
@pralor-bot
Copy link

pralor-bot commented May 22, 2020

This pull request has been mentioned on Pi-hole Userspace. There might be relevant details there:

https://discourse.pi-hole.net/t/black-whitelisting-does-not-work-on-v5-api/33119/1
@sterrenburg sterrenburg mentioned this pull request May 22, 2020
Closed
DL6ER added 16 commits Oct 22, 2019
@DL6ER
Add HTTP server implementation to FTL.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
86f49d7 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Change absolute vs. relative path of included file.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
6851c10 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add FTL http wrapper.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
6245727 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add ping callback and pong test for CI.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
8ef74a7 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Use wget instead of curl in the tests
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
6cf54db 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add JSON formatting and parsing support to FTL
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
6fe4a51 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add listening on IPv6 address
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
2b72b8a 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Use bandwidth-friendly variant for the testing hook that does not inc…
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
15bcccd 
…lude additional whitespace for formatting.

Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Print local URI in response to /api requests.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
d37bdd9 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Use correct content type for JSON.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
4c36b8e 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Reduce code duplication.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
42fd4ea 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add hook for testing sending a chunked response.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
a5a3501 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Remove Unix socket support
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
f5824a2 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Remove rusty Telnet API. Note that this intermediate version of FTL h…
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
f537507 
…as NO API at all.

Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Added /api/dns/status and /api/stats/summary
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
bc8baab 
This allows the Pi-hole NG web interface with minimal functionality.

Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add /api/ftl/version
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
27117cb 
Signed-off-by: DL6ER <dl6er@dl6er.de>
DL6ER added 16 commits Dec 6, 2019
@DL6ER
Relock shared memory before returning an error message.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
4516ee5 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add /api/stats/database/top_domains and /api/stats/database/top_blocked
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
429622d 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add /api/stats/database/top_clients by generalizing the top-domains i…
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
76b72bf 
…nto a top-items function that can process both.

Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add /api/stats/database/summary
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
7c97cb6 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add /api/stats/database/overTime/clients
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
cb8131d 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add /api/stats/database/query_types
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
a7500f1 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add /api/stats/database/upstreams
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
ef5cfe0 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Make JSON string macros robust against being called with NULL strings.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
4dacd1c 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Fix forwarded queries counting logic quirk.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
5bdf2b9 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Minor optimizations to domain list handling routines (reading, adding…
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
6a4040e 
…, and removing)

Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Fix failed git auto-merge.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
4c6d94c 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Compute average response times for used upstream destinations.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
5d54d34 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Exclude database lookup time from computed forward destination delay.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
0aaa323 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add const attribute to new sqrt routines.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
0b68095 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Update cJSON to 1.7.13
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
d878499 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Update Civetweb server to 1.12
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
Loading status checks…
8afd063 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Copy link
Member Author

DL6ER commented May 26, 2020

We're still following this. I just rebased it onto the latest development branch.
@DL6ER DL6ER force-pushed the new/http branch from 6f396fd to 8afd063 May 26, 2020
@pralor-bot
Copy link

pralor-bot commented May 27, 2020

This pull request has been mentioned on Pi-hole Userspace. There might be relevant details there:

https://discourse.pi-hole.net/t/php-webscripts/31016/28
@pralor-bot
Copy link

pralor-bot commented May 27, 2020

This pull request has been mentioned on Pi-hole Userspace. There might be relevant details there:

https://discourse.pi-hole.net/t/php-webscripts/31016/32
DL6ER added 3 commits May 27, 2020
@DL6ER
Finish transition to cmake on the new/http branch.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
Loading status checks…
6e40e3b 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Add PHP support in Pi-hole' HTTP server.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
Loading status checks…
308c80b 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Remove React-specific index page rerouting.
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
Loading status checks…
473a88f 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER DL6ER force-pushed the new/http branch from 43d0ffc to 473a88f May 28, 2020
@DL6ER
Copy link
Member Author

DL6ER commented May 28, 2020

This branch can now host the web interface. Many things will not work as we removed the rusty telnet interface and added a React-based API in this version of FTL. This will have to be adapted for the current API. Eventually, we will be able to get rid of api.php and siblings and have all JS scripts directly talking to FTL.

However, pages not directly depending on the interactive API do already work.

For instance:

Screenshot at 2020-05-29 00-14-58
Screenshot at 2020-05-29 00-20-25
@pralor-bot
Copy link

pralor-bot commented May 28, 2020

This pull request has been mentioned on Pi-hole Userspace. There might be relevant details there:

https://discourse.pi-hole.net/t/php-webscripts/31016/35
DL6ER added 2 commits May 28, 2020
@DL6ER
Add NAPTR support for /api/stats/summary
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
Loading status checks…
2c6e2ae 
Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER
Generally assume authentication to ease the development phase until w…
Verified
This commit was signed with a verified signature.
DL6ER DL6ER
GPG key ID: 00135ACBD90B28DD Learn about signing commits
Loading status checks…
c92a0e4 
…e are actually able to add authentication.

Signed-off-by: DL6ER <dl6er@dl6er.de>
@DL6ER DL6ER mentioned this pull request Jun 13, 2020
Open
3 of 3 tasks complete
@pralor-bot
Copy link

pralor-bot commented Jun 23, 2020

This pull request has been mentioned on Pi-hole Userspace. There might be relevant details there:

https://discourse.pi-hole.net/t/how-to-update-dhcp-with-api/34773/1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Breaking change Enhancement
Projects
None yet
Milestone
v6.0
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
@DL6ER @pralor-bot
You can’t perform that action at this time.