mirror of
https://github.com/pi-hole/FTL.git
synced 2024-10-26 16:52:18 +02:00
DL6ER
109 lines
3.7 KiB
C
109 lines
3.7 KiB
C
/* Pi-hole: A black hole for Internet advertisements
|
|
* (c) 2019 Pi-hole, LLC (https://pi-hole.net)
|
|
* Network-wide ad blocking via your own hardware.
|
|
*
|
|
* FTL Engine
|
|
* HTTP server routines
|
|
*
|
|
* This file is copyright under the latest version of the EUPL.
|
|
* Please see LICENSE file for your rights under this license. */
|
|
#ifndef HTTP_H
|
|
#define HTTP_H
|
|
|
|
// External components
|
|
#include "civetweb/civetweb.h"
|
|
#include "webserver/cJSON/cJSON.h"
|
|
// enum fifo_logs
|
|
#include "enums.h"
|
|
// tablerow
|
|
#include "database/gravity-db.h"
|
|
|
|
// strlen()
|
|
#include <string.h>
|
|
|
|
// struct session
|
|
#include "api/auth.h"
|
|
|
|
// API-internal definitions
|
|
|
|
// Maximum size of received and processed payload: 64 KB
|
|
#define MAX_PAYLOAD_BYTES 64*1024
|
|
|
|
struct api_options {
|
|
enum api_flags flags;
|
|
enum fifo_logs which;
|
|
};
|
|
|
|
struct ftl_conn {
|
|
struct mg_connection *conn;
|
|
const struct mg_request_info *request;
|
|
const enum http_method method;
|
|
char *action_path;
|
|
const char *item;
|
|
const char *message;
|
|
int user_id;
|
|
double now;
|
|
struct {
|
|
bool avail;
|
|
char *raw;
|
|
cJSON *json;
|
|
const char* json_error;
|
|
long unsigned int size;
|
|
} payload;
|
|
struct {
|
|
bool restart;
|
|
} ftl;
|
|
struct session *session;
|
|
|
|
struct api_options opts;
|
|
};
|
|
|
|
|
|
char *json_formatter(const cJSON *object);
|
|
|
|
int send_http(struct ftl_conn *api, const char *mime_type, const char *msg);
|
|
int send_http_code(struct ftl_conn *api, const char *mime_type, int code, const char *msg);
|
|
int send_http_internal_error(struct ftl_conn *api);
|
|
int send_json_unauthorized(struct ftl_conn *api);
|
|
int send_json_error(struct ftl_conn *api, const int code,
|
|
const char *key, const char* message,
|
|
const char *hint);
|
|
int send_json_error_free(struct ftl_conn *api, const int code,
|
|
const char *key, const char* message,
|
|
char *hint, bool free_hint, const bool log);
|
|
int send_json_success(struct ftl_conn *api);
|
|
const char *get_http_method_str(const enum http_method method) __attribute__((const));
|
|
|
|
void http_reread_index_html(void);
|
|
|
|
// Cookie routines
|
|
bool http_get_cookie_int(struct ftl_conn *api, const char *cookieName, int *i);
|
|
bool http_get_cookie_str(struct ftl_conn *api, const char *cookieName, char *str, size_t str_size);
|
|
|
|
// HTTP parameter routines
|
|
bool get_bool_var(const char *source, const char *var, bool *boolean);
|
|
bool get_uint64_var_msg(const char *source, const char *var, uint64_t *num, const char **msg);
|
|
bool get_uint_var_msg(const char *source, const char *var, unsigned int *num, const char **msg);
|
|
bool get_uint_var(const char *source, const char *var, unsigned int *num);
|
|
bool get_int_var_msg(const char *source, const char *var, int *num, const char **msg);
|
|
bool get_int_var(const char *source, const char *var, int *num);
|
|
bool get_double_var_msg(const char *source, const char *var, double *num, const char **msg);
|
|
bool get_double_var(const char *source, const char *var, double *num);
|
|
int get_string_var(const char *source, const char *var, char *dest, size_t dest_len);
|
|
|
|
// HTTP macros
|
|
#define GET_VAR(variable, destination, source) mg_get_var(source, strlen(source), variable, destination, sizeof(destination))
|
|
#define GET_STR(variable, destination, source) get_string_var(source, variable, destination, sizeof(destination))
|
|
|
|
// Utils
|
|
enum http_method __attribute__((pure)) http_method(struct mg_connection *conn);
|
|
const char* __attribute__((pure)) startsWith(const char *path, struct ftl_conn *api);
|
|
void read_and_parse_payload(struct ftl_conn *api);
|
|
char * __attribute__((malloc)) escape_html(const char *string);
|
|
int check_json_payload(struct ftl_conn *api);
|
|
int parse_groupIDs(struct ftl_conn *api, tablerow *table, cJSON *row);
|
|
char * __attribute__((malloc)) escape_json(const char *string);
|
|
void cJSON_unique_array(cJSON *array);
|
|
|
|
#endif // HTTP_H
|