pi-hole/FTL
1
0
Fork 0
mirror of https://github.com/pi-hole/FTL.git synced 2024-10-26 16:52:18 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Rename /api/ftl/logs/dns -> /api/logs/dnsmasq

Browse Source 
Signed-off-by: DL6ER <dl6er@dl6er.de>
This commit is contained in:
DL6ER
2023-01-16 21:41:10 +01:00
parent c34975180e
commit c901194d3b
7 changed files with 176 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/api/CMakeLists.txt
+1
View File
@@ -18,6 +18,7 @@ set(sources
network.c
history.c
list.c
logs.c
queries.c
stats_database.c
stats.c
src/api/api.c
+1 -1
View File
@@ -44,9 +44,9 @@ static struct {
{ "/api/groups", "/{name}", api_list, { false, false }, true, HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_DELETE },
{ "/api/lists", "/{list}", api_list, { false, false }, true, HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_DELETE },
{ "/api/ftl/client", "", api_ftl_client, { false, false }, false, HTTP_GET },
{ "/api/ftl/logs/dns", "", api_ftl_logs_dns, { false, false }, true, HTTP_GET },
{ "/api/ftl/sysinfo", "", api_ftl_sysinfo, { false, false }, true, HTTP_GET },
{ "/api/ftl/dbinfo", "", api_ftl_dbinfo, { false, false }, true, HTTP_GET },
{ "/api/logs/dnsmasq", "", api_logs_dnsmasq, { false, false }, true, HTTP_GET },
{ "/api/history/clients", "", api_history_clients, { false, false }, true, HTTP_GET },
{ "/api/history/database/clients", "", api_history_database_clients, { false, false }, true, HTTP_GET },
{ "/api/history/database", "", api_history_database, { false, false }, true, HTTP_GET },
src/api/api.h
+3 -1
View File
@@ -47,13 +47,15 @@ int api_stats_database_upstreams(struct ftl_conn *api);
// FTL methods
int api_ftl_client(struct ftl_conn *api);
int api_ftl_logs_dns(struct ftl_conn *api);
int api_ftl_dbinfo(struct ftl_conn *api);
int api_ftl_sysinfo(struct ftl_conn *api);
int get_ftl_obj(struct ftl_conn *api, cJSON *ftl, const bool is_locked);
int get_system_obj(struct ftl_conn *api, cJSON *system);
int api_config(struct ftl_conn *api);
// Log methods
int api_logs_dnsmasq(struct ftl_conn *api);
// Network methods
int api_network_gateway(struct ftl_conn *api);
int api_network_interfaces(struct ftl_conn *api);
src/api/docs/content/specs/logs.yaml
+80
View File
@@ -0,0 +1,80 @@
openapi: 3.0.2
components:
paths:
logs:
dnsmasq:
get:
summary: Get DNS log content
tags:
- "FTL information"
operationId: "get_dns_log"
description: |
This API hook returns content from the log of the embedded DNS resolver `dnsmasq`.
Every successful request will return a `nextID`.
This ID can be used on the next request to only get lines which were added *after* the last request.
This makes periodic polling for new log lines easy as no check for duplicated log lines is necessary.
The expected behavior for an immediate re-request of a log line with the same ID is an empty response.
As soon as the next message arrived, this will be included in your request and `nextID` is incremented by one.
parameters:
- $ref: 'logs.yaml#/components/parameters/logs/dnsmasq/nextID'
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: 'logs.yaml#/components/schemas/logs/dnsmasq/log'
- $ref: 'logs.yaml#/components/schemas/logs/dnsmasq/nextID'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: 'common.yaml#/components/errors/unauthorized'
schemas:
logs:
dnsmasq:
log:
type: object
properties:
log:
type: array
description: Request headers
items:
type: object
properties:
timestamp:
type: number
description: Unix timestamp of log line creation (server time)
message:
type: string
description: Log line content
example:
- timestamp: 1611729969.0
message: "started, version pi-hole-2.84 cachesize 10000"
- timestamp: 1611729969.0
message: "reading /etc/resolv.conf"
- timestamp: 1611729969.0
message: "read /etc/hosts - 7 addresses"
- timestamp: 1611729969.0
message: "query[A] connectivity-check.ubuntu.com from 127.0.0.1"
nextID:
type: object
properties:
nextID:
type: integer
description: next ID to query if checking for new log lines
example: 229
parameters:
logs:
dnsmasq:
nextID:
in: query
description: (Optional) ID of next line to return
name: nextID
schema:
type: integer
required: false
example: 219
src/api/docs/content/specs/main.yaml
+3 -3
View File
@@ -144,15 +144,15 @@ paths:
/ftl/client:
$ref: 'ftl.yaml#/components/paths/client'
/ftl/logs/dns:
$ref: 'ftl.yaml#/components/paths/logs/dns'
/ftl/sysinfo:
$ref: 'ftl.yaml#/components/paths/sysinfo'
/ftl/dbinfo:
$ref: 'ftl.yaml#/components/paths/dbinfo'
/logs/dnsmasq:
$ref: 'logs.yaml#/components/paths/logs/dnsmasq'
/endpoints:
$ref: 'endpoints.yaml#/components/paths/endpoints'
src/api/ftl.c
+12 -74
View File
@@ -8,34 +8,32 @@
* This file is copyright under the latest version of the EUPL.
* Please see LICENSE file for your rights under this license. */
#include "../FTL.h"
#include "../webserver/http-common.h"
#include "../webserver/json_macros.h"
#include "api.h"
// struct fifologData
#include "../fifo.h"
#include "FTL.h"
#include "webserver/http-common.h"
#include "webserver/json_macros.h"
#include "api/api.h"
// sysinfo()
#include <sys/sysinfo.h>
// get_blockingstatus()
#include "../setupVars.h"
#include "setupVars.h"
// counters
#include "../shmem.h"
#include "shmem.h"
// get_FTL_db_filesize()
#include "../files.h"
#include "files.h"
// get_sqlite3_version()
#include "../database/common.h"
#include "database/common.h"
// get_number_of_queries_in_DB()
#include "../database/query-table.h"
#include "database/query-table.h"
// getgrgid()
#include <grp.h>
// config struct
#include "../config/config.h"
#include "config/config.h"
// struct clientsData
#include "../datastructure.h"
#include "datastructure.h"
// uname()
#include <sys/utsname.h>
// get_cpu_percentage()
#include "../daemon.h"
#include "daemon.h"
// getProcessMemory()
#include "procps.h"
@@ -66,66 +64,6 @@ int api_ftl_client(struct ftl_conn *api)
JSON_SEND_OBJECT(json);
}
// fifologData is allocated in shared memory for cross-fork compatibility
fifologData *fifo_log = NULL;
int api_ftl_logs_dns(struct ftl_conn *api)
{
unsigned int start = 0u;
if(api->request->query_string != NULL)
{
// Does the user request an ID to sent from?
unsigned int nextID;
if(get_uint_var(api->request->query_string, "nextID", &nextID))
{
if(nextID >= fifo_log->next_id)
{
// Do not return any data
start = LOG_SIZE;
}
else if((fifo_log->next_id > LOG_SIZE) && nextID < (fifo_log->next_id) - LOG_SIZE)
{
// Requested an ID smaller than the lowest one we have
// We return the entire buffer
start = 0u;
}
else if(fifo_log->next_id >= LOG_SIZE)
{
// Reply with partial buffer, measure from the end
// (the log is full)
start = LOG_SIZE - (fifo_log->next_id - nextID);
}
else
{
// Reply with partial buffer, measure from the start
// (the log is not yet full)
start = nextID;
}
}
}
// Process data
cJSON *json = JSON_NEW_OBJECT();
cJSON *log = JSON_NEW_ARRAY();
for(unsigned int i = start; i < LOG_SIZE; i++)
{
if(fifo_log->timestamp[i] < 1.0)
{
// Uninitialized buffer entry
break;
}
cJSON *entry = JSON_NEW_OBJECT();
JSON_ADD_NUMBER_TO_OBJECT(entry, "timestamp", fifo_log->timestamp[i]);
JSON_REF_STR_IN_OBJECT(entry, "message", fifo_log->message[i]);
JSON_ADD_ITEM_TO_ARRAY(log, entry);
}
JSON_ADD_ITEM_TO_OBJECT(json, "log", log);
JSON_ADD_NUMBER_TO_OBJECT(json, "nextID", fifo_log->next_id);
// Send data
JSON_SEND_OBJECT(json);
}
int api_ftl_dbinfo(struct ftl_conn *api)
{
cJSON *json = JSON_NEW_OBJECT();
src/api/logs.c
+76
View File
@@ -0,0 +1,76 @@
/* Pi-hole: A black hole for Internet advertisements
* (c) 2023 Pi-hole, LLC (https://pi-hole.net)
* Network-wide ad blocking via your own hardware.
*
* FTL Engine
* API Implementation /api/logs
*
* This file is copyright under the latest version of the EUPL.
* Please see LICENSE file for your rights under this license. */
#include "FTL.h"
#include "webserver/http-common.h"
#include "webserver/json_macros.h"
#include "api/api.h"
// struct fifologData
#include "fifo.h"
// fifologData is allocated in shared memory for cross-fork compatibility
fifologData *fifo_log = NULL;
int api_logs_dnsmasq(struct ftl_conn *api)
{
unsigned int start = 0u;
if(api->request->query_string != NULL)
{
// Does the user request an ID to sent from?
unsigned int nextID;
if(get_uint_var(api->request->query_string, "nextID", &nextID))
{
if(nextID >= fifo_log->next_id)
{
// Do not return any data
start = LOG_SIZE;
}
else if((fifo_log->next_id > LOG_SIZE) && nextID < (fifo_log->next_id) - LOG_SIZE)
{
// Requested an ID smaller than the lowest one we have
// We return the entire buffer
start = 0u;
}
else if(fifo_log->next_id >= LOG_SIZE)
{
// Reply with partial buffer, measure from the end
// (the log is full)
start = LOG_SIZE - (fifo_log->next_id - nextID);
}
else
{
// Reply with partial buffer, measure from the start
// (the log is not yet full)
start = nextID;
}
}
}
// Process data
cJSON *json = JSON_NEW_OBJECT();
cJSON *log = JSON_NEW_ARRAY();
for(unsigned int i = start; i < LOG_SIZE; i++)
{
if(fifo_log->timestamp[i] < 1.0)
{
// Uninitialized buffer entry
break;
}
cJSON *entry = JSON_NEW_OBJECT();
JSON_ADD_NUMBER_TO_OBJECT(entry, "timestamp", fifo_log->timestamp[i]);
JSON_REF_STR_IN_OBJECT(entry, "message", fifo_log->message[i]);
JSON_ADD_ITEM_TO_ARRAY(log, entry);
}
JSON_ADD_ITEM_TO_OBJECT(json, "log", log);
JSON_ADD_NUMBER_TO_OBJECT(json, "nextID", fifo_log->next_id);
// Send data
JSON_SEND_OBJECT(json);
}