From: Jeremy Tan Date: Tue, 20 Aug 2013 12:01:20 +0000 (+0800) Subject: Update FastCGI code and restructure includes a bit X-Git-Url: https://git.ucc.asn.au/?a=commitdiff_plain;h=621ec4c4752d4a01838aa1866cfc1bc401021dcb;p=matches%2FMCTX3420.git Update FastCGI code and restructure includes a bit --- diff --git a/server/common.h b/server/common.h index e5bcdbd..5f71f9f 100644 --- a/server/common.h +++ b/server/common.h @@ -18,4 +18,7 @@ #include #include +#include "log.h" +#include "fastcgi.h" + #endif //_COMMON_H diff --git a/server/fastcgi.c b/server/fastcgi.c index d6e8079..3bcb36a 100644 --- a/server/fastcgi.c +++ b/server/fastcgi.c @@ -8,17 +8,34 @@ #include #include -#include "fastcgi.h" +#include + #include "common.h" +#include "fastcgi.h" #include "sensor.h" #include "log.h" -#include -static void LoginHandler(void *data, char *params) { - static char loginkey[41] = {0}, ip[256]; - static time_t timestamp = 0; +#define LOGIN_TIMEOUT 180 + +struct FCGIContext { + /**The time of last valid logged-in user access*/ + time_t login_timestamp; + char login_key[41]; + char login_ip[16]; + /**The name of the current module**/ + const char *current_module; + /**For debugging purposes?**/ + int response_number; +}; + +/** + * Handles user logins. + * @param context The context to work in + * @param params User specified parameters + */ +static void LoginHandler(FCGIContext *context, char *params) { const char *key, *value; - int force = 0, end = 0; + bool force = 0, end = 0; while ((params = FCGI_KeyPair(params, &key, &value))) { if (!strcmp(key, "force")) @@ -28,14 +45,16 @@ static void LoginHandler(void *data, char *params) { } if (end) { - *loginkey = 0; - FCGI_BeginJSON(200, "login"); + *(context->login_key) = 0; + FCGI_BeginJSON(context, STATUS_OK); FCGI_EndJSON(); return; } time_t now = time(NULL); - if (force || !*loginkey || (now - timestamp > 180)) { + if (force || !*(context->login_key) || + (now - context->login_timestamp > LOGIN_TIMEOUT)) + { SHA_CTX sha1ctx; unsigned char sha1[20]; int i = rand(); @@ -45,97 +64,41 @@ static void LoginHandler(void *data, char *params) { SHA1_Update(&sha1ctx, &i, sizeof(i)); SHA1_Final(sha1, &sha1ctx); - timestamp = now; + context->login_timestamp = now; for (i = 0; i < 20; i++) - sprintf(loginkey+i*2, "%02x", sha1[i]); - sprintf(ip, "%s", getenv("REMOTE_ADDR")); - FCGI_BeginJSON(200, "login"); - FCGI_BuildJSON("key", loginkey); + sprintf(context->login_key + i * 2, "%02x", sha1[i]); + snprintf(context->login_ip, 16, "%s", getenv("REMOTE_ADDR")); + FCGI_BeginJSON(context, STATUS_OK); + FCGI_JSONPair("key", context->login_key); FCGI_EndJSON(); } else { char buf[128]; - strftime(buf, 128, "%H:%M:%S %d-%m-%Y",localtime(×tamp)); - FCGI_BeginJSON(401, "login"); - FCGI_BuildJSON("description", "Already logged in"); - FCGI_BuildJSON("user", ip); - FCGI_BuildJSON("time", buf); + strftime(buf, 128, "%H:%M:%S %d-%m-%Y", + localtime(&(context->login_timestamp))); + FCGI_BeginJSON(context, STATUS_UNAUTHORIZED); + FCGI_JSONPair("description", "Already logged in"); + FCGI_JSONPair("user", context->login_ip); + FCGI_JSONPair("time", buf); FCGI_EndJSON(); } } /** - * Handle a request to the sensor module - * @param data - Data to pass to module (?) - * @param params - Parameters passed + * Given an FCGIContext, determines if the current user (as specified by + * the key) is authorized or not. If validated, the context login_timestamp is + * updated. + * @param context The context to work in + * @param key The login key to be validated. + * @return TRUE if authorized, FALSE if not. */ -static void SensorHandler(void * data, char * params) -{ - static DataPoint buffer[SENSOR_QUERYBUFSIZ]; - StatusCodes status = STATUS_OK; - const char * key; const char * value; - - int sensor_id = SENSOR_NONE; - - while ((params = FCGI_KeyPair(params, &key, &value)) != NULL) - { - Log(LOGDEBUG, "Got key=%s and value=%s", key, value); - if (strcmp(key, "id") == 0) - { - if (sensor_id != SENSOR_NONE) - { - Log(LOGERR, "Only one sensor id should be specified"); - status = STATUS_BADREQUEST; - break; - } - //TODO: Use human readable sensor identifier string for API? - sensor_id = atoi(value); - if (sensor_id == 0 && strcmp(value, "0") != 0) - { - Log(LOGERR, "Sensor id not an integer; %s", value); - status = STATUS_BADREQUEST; - break; - } - } - else - { - Log(LOGERR, "Unknown key \"%s\" (value = %s)", key, value); - status = STATUS_BADREQUEST; - break; - } - } - - if (sensor_id == SENSOR_NONE) - { - Log(LOGERR, "No sensor id specified"); - status = STATUS_BADREQUEST; - } - else if (sensor_id >= NUMSENSORS || sensor_id < 0) - { - Log(LOGERR, "Invalid sensor id %d", sensor_id); - status = STATUS_BADREQUEST; - } - - FCGI_BeginJSON(status, "sensor"); - - if (status != STATUS_BADREQUEST) - { - FCGI_BuildJSON(key, value); // should spit back sensor ID - //Log(LOGDEBUG, "Call Sensor_Query..."); - int amount_read = Sensor_Query(&(g_sensors[sensor_id]), buffer, SENSOR_QUERYBUFSIZ); - //Log(LOGDEBUG, "Read %d DataPoints", amount_read); - //Log(LOGDEBUG, "Produce JSON response"); - printf(",\r\n\t\"data\" : ["); - for (int i = 0; i < amount_read; ++i) - { - printf("[%f,%f]", buffer[i].time, buffer[i].value); - if (i+1 < amount_read) - printf(","); - } - printf("]"); - //Log(LOGDEBUG, "Done producing JSON response"); +bool FCGI_Authorized(FCGIContext *context, const char *key) { + time_t now = time(NULL); + int result = (now - context->login_timestamp) <= LOGIN_TIMEOUT && + !strcmp(context->login_key, key); + if (result) { + context->login_timestamp = now; //Update the login_timestamp } - FCGI_EndJSON(); - + return result; } /** @@ -179,23 +142,15 @@ char *FCGI_KeyPair(char *in, const char **key, const char **value) /** * Begins a response to the client in JSON format. - * @param status_code The HTTP status code to be returned. - * @param module The name of the module that initiated the response. + * @param context The context to work in. + * @param status_code The status code to be returned. */ -void FCGI_BeginJSON(StatusCodes status_code, const char *module) +void FCGI_BeginJSON(FCGIContext *context, StatusCodes status_code) { - switch (status_code) { - case STATUS_OK: - break; - case STATUS_UNAUTHORIZED: - printf("Status: 401 Unauthorized\r\n"); - break; - default: - printf("Status: 400 Bad Request\r\n"); - } printf("Content-type: application/json; charset=utf-8\r\n\r\n"); printf("{\r\n"); - printf("\t\"module\" : \"%s\"", module); + printf("\t\"module\" : \"%s\"", context->current_module); + FCGI_JSONLong("status", status_code); } /** @@ -204,11 +159,54 @@ void FCGI_BeginJSON(StatusCodes status_code, const char *module) * @param key The key of the JSON entry * ¶m value The value associated with the key. */ -void FCGI_BuildJSON(const char *key, const char *value) +void FCGI_JSONPair(const char *key, const char *value) { printf(",\r\n\t\"%s\" : \"%s\"", key, value); } +/** + * Similar to FCGI_JSONPair except for signed integer values. + * @param key The key of the JSON entry + * @param value The value associated with the key + */ +void FCGI_JSONLong(const char *key, long value) +{ + printf(",\r\n\t\"%s\" : %ld", key, value); +} + +/** + * Similar to FCGI_JsonPair except for floating point values. + * @param key The key of the JSON entry + * @param value The value associated with the key + */ +void FCGI_JSONDouble(const char *key, double value) +{ + printf(",\r\n\t\"%s\" : %f", key, value); +} + +/** + * Begins a JSON entry by writing the key. To be used in conjunction + * with FCGI_JsonValue. + * @param key The key of the JSON entry + */ +void FCGI_JSONKey(const char *key) +{ + printf(",\r\n\t\"%s\" : ", key); +} + +/** + * Should be used to write out the value of a JSON key. This has + * the same format as the printf functions. Care should be taken to format + * the output in valid JSON. + */ +void FCGI_JSONValue(const char *format, ...) +{ + va_list list; + va_start(list, format); + vprintf(format, list); + va_end(list); +} + /** * Ends a JSON response that was initiated by FCGI_BeginJSON. */ @@ -217,17 +215,39 @@ void FCGI_EndJSON() printf("\r\n}\r\n"); } +/** + * To be used when the input parameters are invalid. + * Sends a response with HTTP status 400 Bad request, along with + * JSON data for debugging. + * @param context The context to work in + * @param params The parameters that the module handler received. + */ +void FCGI_RejectJSON(FCGIContext *context) +{ + printf("Status: 400 Bad Request\r\n"); + + FCGI_BeginJSON(context, STATUS_ERROR); + FCGI_JSONPair("description", "Invalid request"); + FCGI_JSONLong("responsenumber", context->response_number); + FCGI_JSONPair("params", getenv("DOCUMENT_URI_LOCAL")); + FCGI_JSONPair("host", getenv("SERVER_HOSTNAME")); + FCGI_JSONPair("user", getenv("REMOTE_USER")); + FCGI_JSONPair("ip", getenv("REMOTE_ADDR")); + FCGI_EndJSON(); +} + /** * Main FCGI request loop that receives/responds to client requests. - * @param data A data field to be passed to the selected module handler. + * @param data Reserved. */ -void FCGI_RequestLoop (void * data) +void FCGI_RequestLoop (void *data) { - int count = 0; - while (FCGI_Accept() >= 0) { + FCGIContext context = {0}; + + while (FCGI_Accept() >= 0) { ModuleHandler module_handler = NULL; char module[BUFSIZ], params[BUFSIZ]; - + //strncpy doesn't zero-truncate properly snprintf(module, BUFSIZ, "%s", getenv("DOCUMENT_URI_LOCAL")); snprintf(params, BUFSIZ, "%s", getenv("QUERY_STRING")); @@ -238,30 +258,22 @@ void FCGI_RequestLoop (void * data) module[lastchar] = 0; - if (!strcmp("sensors", module)) { - module_handler = SensorHandler; - } else if (!strcmp("login", module)) { + if (!strcmp("login", module)) { module_handler = LoginHandler; + } else if (!strcmp("sensors", module)) { + module_handler = Sensor_Handler; } else if (!strcmp("actuators", module)) { } + context.current_module = module; if (module_handler) { - module_handler(data, params); + module_handler(&context, params); } else { - char buf[BUFSIZ]; - - FCGI_BeginJSON(400, module); - FCGI_BuildJSON("description", "400 Invalid response"); - snprintf(buf, BUFSIZ, "%d", count); - FCGI_BuildJSON("request-number", buf); - FCGI_BuildJSON("params", params); - FCGI_BuildJSON("host", getenv("SERVER_HOSTNAME")); - FCGI_BuildJSON("user", getenv("REMOTE_USER")); - FCGI_BuildJSON("userip", getenv("REMOTE_ADDR")); - FCGI_EndJSON(); + strncat(module, " [unknown]", BUFSIZ); + FCGI_RejectJSON(&context); } - - count++; + + context.response_number++; } } diff --git a/server/fastcgi.h b/server/fastcgi.h index c43927d..e9db8ba 100644 --- a/server/fastcgi.h +++ b/server/fastcgi.h @@ -6,21 +6,28 @@ #ifndef _FASTCGI_H #define _FASTCGI_H -/**HTTP status codes that fcgi module handlers can return**/ +/**Status codes that fcgi module handlers can return**/ typedef enum StatusCodes { - STATUS_OK = 200, - STATUS_BADREQUEST = 400, - STATUS_UNAUTHORIZED = 401 + STATUS_OK = 0, + STATUS_ERROR = -1, + STATUS_UNAUTHORIZED = -2 } StatusCodes; -typedef void (*ModuleHandler) (void *data, char *params); +typedef struct FCGIContext FCGIContext; +typedef void (*ModuleHandler) (FCGIContext *data, char *params); +extern bool FCGI_Authorized(FCGIContext *context, const char *key); extern char *FCGI_KeyPair(char *in, const char **key, const char **value); -extern void FCGI_BeginJSON(StatusCodes status_code, const char *module); -extern void FCGI_BuildJSON(const char *key, const char *value); +extern void FCGI_BeginJSON(FCGIContext *context, StatusCodes status_code); +extern void FCGI_JSONPair(const char *key, const char *value); +extern void FCGI_JSONLong(const char *key, long value); +extern void FCGI_JSONDouble(const char *key, double value); +extern void FCGI_JSONKey(const char *key); +extern void FCGI_JSONValue(const char *format, ...); extern void FCGI_EndJSON(); +extern void FCGI_RejectJSON(FCGIContext *context); extern void FCGI_RequestLoop (void *data); -#define SENSOR_QUERYBUFSIZ 10 +#endif + -#endif //_FASTCGI_H diff --git a/server/log.c b/server/log.c index 6f44bb0..f7e39bc 100644 --- a/server/log.c +++ b/server/log.c @@ -5,8 +5,10 @@ #include +#include // --- Custom headers --- // +#include "common.h" #include "log.h" #include "options.h" diff --git a/server/log.h b/server/log.h index 005059c..2969540 100644 --- a/server/log.h +++ b/server/log.h @@ -6,12 +6,6 @@ #ifndef _LOG_H #define _LOG_H -#include -#include -#include -#include -#include "common.h" - //To get around a 'pedantic' C99 rule that you must have at least 1 variadic arg, combine fmt into that. #define Log(level, ...) LogEx(level, __func__, __VA_ARGS__) #define Fatal(...) FatalEx(__func__, __VA_ARGS__) diff --git a/server/main.c b/server/main.c index 596fb39..bfd5300 100644 --- a/server/main.c +++ b/server/main.c @@ -2,18 +2,15 @@ * @file main.c * @purpose main and its helper functions, signal handling and cleanup functions */ -#include "common.h" - - -// --- Standard headers --- // -#include // for signal handling // --- Custom headers --- // -#include "fastcgi.h" -#include "log.h" +#include "common.h" #include "options.h" #include "sensor.h" +// --- Standard headers --- // +#include // for signal handling + // --- Variable definitions --- // Options g_options; // options passed to program through command line arguments Sensor g_sensors[NUMSENSORS]; // sensors array diff --git a/server/sensor.c b/server/sensor.c index ab687af..6222510 100644 --- a/server/sensor.c +++ b/server/sensor.c @@ -5,9 +5,8 @@ */ - +#include "common.h" #include "sensor.h" -#include "log.h" #include /** @@ -147,4 +146,87 @@ int Sensor_Query(Sensor * s, DataPoint * buffer, int bufsiz) return amount_read; } +/** + * Handle a request to the sensor module + * @param context - The context to work in + * @param params - Parameters passed + */ +void Sensor_Handler(FCGIContext *context, char * params) +{ + DataPoint buffer[SENSOR_QUERYBUFSIZ]; + StatusCodes status = STATUS_OK; + const char * key; const char * value; + + int sensor_id = SENSOR_NONE; + + while ((params = FCGI_KeyPair(params, &key, &value)) != NULL) + { + Log(LOGDEBUG, "Got key=%s and value=%s", key, value); + if (strcmp(key, "id") == 0) + { + char *end; + if (sensor_id != SENSOR_NONE) + { + Log(LOGERR, "Only one sensor id should be specified"); + status = STATUS_ERROR; + break; + } + if (*value == '\0') + { + Log(LOGERR, "No id specified."); + status = STATUS_ERROR; + break; + } + //TODO: Use human readable sensor identifier string for API? + sensor_id = strtol(value, &end, 10); + if (*end != '\0') + { + Log(LOGERR, "Sensor id not an integer; %s", value); + status = STATUS_ERROR; + break; + } + } + else + { + Log(LOGERR, "Unknown key \"%s\" (value = %s)", key, value); + status = STATUS_ERROR; + break; + } + } + + if (sensor_id == SENSOR_NONE) + { + Log(LOGERR, "No sensor id specified"); + status = STATUS_ERROR; + } + else if (sensor_id >= NUMSENSORS || sensor_id < 0) + { + Log(LOGERR, "Invalid sensor id %d", sensor_id); + status = STATUS_ERROR; + } + if (status == STATUS_ERROR) + { + FCGI_RejectJSON(context); + } + else + { + FCGI_BeginJSON(context, status); + FCGI_JSONPair(key, value); // should spit back sensor ID + //Log(LOGDEBUG, "Call Sensor_Query..."); + int amount_read = Sensor_Query(&(g_sensors[sensor_id]), buffer, SENSOR_QUERYBUFSIZ); + //Log(LOGDEBUG, "Read %d DataPoints", amount_read); + //Log(LOGDEBUG, "Produce JSON response"); + FCGI_JSONKey("data"); + FCGI_JSONValue("["); + for (int i = 0; i < amount_read; ++i) + { + FCGI_JSONValue("[%f, %f]", buffer[i].time, buffer[i].value); + if (i+1 < amount_read) + FCGI_JSONValue(","); + } + FCGI_JSONValue("]"); + //Log(LOGDEBUG, "Done producing JSON response"); + FCGI_EndJSON(); + } +} diff --git a/server/sensor.h b/server/sensor.h index da23044..4009e5a 100644 --- a/server/sensor.h +++ b/server/sensor.h @@ -5,15 +5,13 @@ */ - #ifndef _SENSOR_H #define _SENSOR_H -#include "common.h" - /** Number of data points to keep in sensor buffers **/ #define SENSOR_DATABUFSIZ 10 +#define SENSOR_QUERYBUFSIZ 10 /** Number of sensors **/ #define NUMSENSORS 1 @@ -56,6 +54,8 @@ extern void * Sensor_Main(void * args); // main loop for sensor thread; pass a S extern int Sensor_Query(Sensor * s, DataPoint * buffer, int bufsiz); // fill buffer with sensor data +extern void Sensor_Handler(FCGIContext *context, char * params); + #endif //_SENSOR_H