Update FCGI JSON methods
authorJeremy Tan <[email protected]>
Tue, 20 Aug 2013 08:55:16 +0000 (16:55 +0800)
committerJeremy Tan <[email protected]>
Tue, 20 Aug 2013 08:55:16 +0000 (16:55 +0800)
testing/fastcgi-approach/common.h
testing/fastcgi-approach/fastcgi.c
testing/fastcgi-approach/fastcgi.h
testing/fastcgi-approach/main.c

index 0777772..e59ccf9 100644 (file)
@@ -14,7 +14,7 @@
 #include <pthread.h>
 #include <unistd.h>
 
-extern void Handler_Sensors(void *data, char *params);
+extern void Handler_Sensors(FCGIContext *data, char *params);
 
 #endif //_COMMON_H
 
index a518c7a..363857a 100644 (file)
 #include "common.h"
 #include <time.h>
 
-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"))
@@ -26,14 +43,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();
@@ -43,24 +62,43 @@ 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(&timestamp)); 
-               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();
        }
 }
 
+/**
+ * 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.
+ */
+int 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
+       }
+       return result;
+}
+
 /**
  * Extracts a key/value pair from a request string.
  * Note that the input is modified by this function.
@@ -102,23 +140,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);
 }
 
 /**
@@ -127,11 +157,54 @@ void FCGI_BeginJSON(StatusCodes status_code, const char *module)
  * @param key The key of the JSON entry
  * &param 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.
  */
@@ -140,17 +213,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, const char *params)
+{
+       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", params);
+       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)
 {
-       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"));
@@ -169,22 +264,14 @@ void FCGI_RequestLoop (void *data)
                        
                }
 
+               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, params);
                }
-
-               count++;
+               
+               context.response_number++;
        }
 }
index 4e0cda7..ef81b78 100644 (file)
@@ -6,18 +6,25 @@
 #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 int 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, const char *params);
 extern void FCGI_RequestLoop (void *data);
 #endif
index f5f7ae3..5076f45 100644 (file)
@@ -1,6 +1,6 @@
 #define _BSD_SOURCE
-#include "common.h"
 #include "fastcgi.h"
+#include "common.h"
 #include <time.h>
 
 typedef struct Data {
@@ -9,42 +9,39 @@ typedef struct Data {
        volatile int sensor_value;
 } Data;
 
-void Handler_Sensors(void *arg, char *params) 
+Data data;
+
+void Handler_Sensors(FCGIContext *context, char *params) 
 {
        const char *key, *value;
-       char buf[5];
-       Data *data = (Data*) arg;
-       
+
        //Begin a request only when you know the final result
        //E.g whether OK or not.
-       FCGI_BeginJSON(STATUS_OK, "sensors");
+       FCGI_BeginJSON(context, STATUS_OK);
        while ((params = FCGI_KeyPair(params, &key, &value))) {
-               FCGI_BuildJSON(key, value);
+               FCGI_JSONPair(key, value);
        }
-       pthread_mutex_lock(&(data->mutex));
-       snprintf(buf, 128, "%d", data->sensor_value);
-       FCGI_BuildJSON("sensor_value", buf); 
-       pthread_mutex_unlock(&(data->mutex));
+       pthread_mutex_lock(&(data.mutex));
+       FCGI_JSONLong("sensor_value", data.sensor_value);
+       pthread_mutex_unlock(&(data.mutex));
        FCGI_EndJSON();
 }
 
 void *SensorsLoop(void *arg) {
-       Data *data = (Data*) arg;
        srand(time(NULL));
        //Csection
        while(1) {
-               pthread_mutex_lock(&(data->mutex));
-               data->sensor_value = rand() % 1024;
-               pthread_mutex_unlock(&(data->mutex));
+               pthread_mutex_lock(&(data.mutex));
+               data.sensor_value = rand() % 1024;
+               pthread_mutex_unlock(&(data.mutex));
                usleep(200*1000); //200ms
        }
 }
 
 int main(int argc, char *argv[]) {
-       Data data = {0};
        pthread_mutex_init(&(data.mutex), NULL);
        //data.mutex = PTHREAD_MUTEX_INITIALIZER;
-       
-//     pthread_create(&data.sensors, NULL, SensorsLoop, &data);
+
+       pthread_create(&data.sensors, NULL, SensorsLoop, &data);
        FCGI_RequestLoop(&data);
 }

UCC git Repository :: git.ucc.asn.au