Merge branch 'master' of https://github.com/szmoore/MCTX3420.git
[matches/MCTX3420.git] / server / fastcgi.c
index 8f4ab32..67f7de3 100644 (file)
 
 #include "common.h"
 #include "sensor.h"
+#include "actuator.h"
 #include "control.h"
 #include "options.h"
+#include "image.h"
 
-/**The time period (in seconds) before the control key expires */
+/**The time period (in seconds) before the control key expires */
 #define CONTROL_TIMEOUT 180
 
 /**Contextual information related to FCGI requests*/
@@ -39,24 +41,14 @@ struct FCGIContext {
  */ 
 static void IdentifyHandler(FCGIContext *context, char *params) {
        bool ident_sensors = false, ident_actuators = false;
-       //const char *key, *value;
-       struct timeval now;
+
        int i;
 
        FCGIValue values[2] = {{"sensors", &ident_sensors, FCGI_BOOL_T},
                                         {"actuators", &ident_actuators, FCGI_BOOL_T}};
-
        if (!FCGI_ParseRequest(context, params, values, 2))
                return;
 
-       /*while ((params = FCGI_KeyPair(params, &key, &value))) {
-               if (!strcmp(key, "sensors")) {
-                       ident_sensors = !ident_sensors;
-               } else if (!strcmp(key, "actuators")) {
-                       ident_actuators = !ident_actuators;
-               }
-       }*/
-
        FCGI_BeginJSON(context, STATUS_OK);
        FCGI_JSONPair("description", "MCTX3420 Server API (2013)");
        FCGI_JSONPair("build_date", __DATE__ " " __TIME__);
@@ -97,7 +89,7 @@ static void IdentifyHandler(FCGIContext *context, char *params) {
  * @param context The context to work in
  * @param force Whether to force key generation or not.
  */ 
-void FCGI_BeginControl(FCGIContext *context, bool force) {
+void FCGI_LockControl(FCGIContext *context, bool force) {
        time_t now = time(NULL);
        bool expired = now - context->control_timestamp > CONTROL_TIMEOUT;
        
@@ -153,7 +145,7 @@ bool FCGI_HasControl(FCGIContext *context, const char *key) {
  * Revokes the current control key, if present.
  * @param context The context to work in
  */
-void FCGI_EndControl(FCGIContext *context) {
+void FCGI_ReleaseControl(FCGIContext *context) {
        *(context->control_key) = 0;
        FCGI_BeginJSON(context, STATUS_OK);
        FCGI_EndJSON();
@@ -200,9 +192,9 @@ char *FCGI_KeyPair(char *in, const char **key, const char **value)
 }
 
 /**
- * Aids in parsing request parameters. Expected keys along with their type
- * and whether or not they're required are provided. This function will then
- * parse the parameter string to find these keys.
+ * Aids in parsing request parameters. 
+ * Input: The expected keys along with their type and whether or not
+ * they're required.
  * @param context The context to work in
  * @param params The parameter string to be parsed
  * @param values An array of FCGIValue's that specify expected keys
@@ -237,19 +229,24 @@ bool FCGI_ParseRequest(FCGIContext *context, char *params, FCGIValue values[], s
                                        case FCGI_BOOL_T:
                                                *((bool*) val->value) = true;
                                                break;
-                                       case FCGI_LONG_T:
-                                               *((long*) val->value) = strtol(value, &ptr, 10);
+                                       case FCGI_INT_T: case FCGI_LONG_T: {
+                                               long parsed = strtol(value, &ptr, 10);
                                                if (!*value || *ptr) {
                                                        snprintf(buf, BUFSIZ, "Expected int for '%s' but got '%s'", key, value);
-                                                       FCGI_RejectJSON(context, FCGI_EscapeJSON(buf));
+                                                       FCGI_RejectJSON(context, buf);
                                                        return false;
                                                }
-                                               break;
+
+                                               if (FCGI_TYPE(val->flags) == FCGI_INT_T)
+                                                       *((int*) val->value) = (int) parsed;
+                                               else
+                                                       *((long*) val->value) = parsed;
+                                       }       break;
                                        case FCGI_DOUBLE_T:
                                                *((double*) val->value) = strtod(value, &ptr);
                                                if (!*value || *ptr) {
                                                        snprintf(buf, BUFSIZ, "Expected float for '%s' but got '%s'", key, value);
-                                                       FCGI_RejectJSON(context, FCGI_EscapeJSON(buf));
+                                                       FCGI_RejectJSON(context, buf);
                                                        return false;
                                                }
                                                break;
@@ -264,7 +261,7 @@ bool FCGI_ParseRequest(FCGIContext *context, char *params, FCGIValue values[], s
                } //End for loop
                if (i == count) {
                        snprintf(buf, BUFSIZ, "Unknown key '%s' specified", key);
-                       FCGI_RejectJSON(context, FCGI_EscapeJSON(buf));
+                       FCGI_RejectJSON(context, buf);
                        return false;
                }
        }
@@ -292,10 +289,12 @@ void FCGI_BeginJSON(FCGIContext *context, StatusCodes status_code)
        printf("\t\"module\" : \"%s\"", context->current_module);
        FCGI_JSONLong("status", status_code);
        //Time and running statistics
+       struct timeval now;
        gettimeofday(&now, NULL);
        FCGI_JSONDouble("start_time", TIMEVAL_TO_DOUBLE(g_options.start_time));
        FCGI_JSONDouble("current_time", TIMEVAL_TO_DOUBLE(now));
        FCGI_JSONDouble("running_time", TIMEVAL_DIFF(now, g_options.start_time));
+       FCGI_JSONPair("control_state", Control_GetModeName());
 }
 
 /**
@@ -357,36 +356,6 @@ void FCGI_EndJSON()
        printf("\r\n}\r\n");
 }
 
-/**
- * Escapes a string so it can be used as a JSON string value.
- * Does not support unicode specifiers in the form of \uXXXX.
- * @param buf The string to be escaped
- * @return The escaped string (return value == buf)
- */
-char *FCGI_EscapeJSON(char *buf)
-{
-       int length, i;
-       length = strlen(buf);
-       
-       //Escape special characters. Must count down to escape properly
-       for (i = length - 1; i >= 0; i--) {
-               if (buf[i] < 0x20) { //Control characters
-                       buf[i] = ' ';
-               } else if (buf[i] == '"') {
-                       if (i-1 >= 0 && buf[i-1] == '\\') 
-                               i--;
-                       else
-                               buf[i] = '\'';
-               } else if (buf[i] == '\\') {
-                       if (i-1 >= 0 && buf[i-1] == '\'')
-                               i--;
-                       else
-                               buf[i] = ' ';
-               }
-       }
-       return buf;
-}
-
 /**
  * To be used when the input parameters are rejected. The return data
  * will also have debugging information provided.
@@ -403,7 +372,7 @@ void FCGI_RejectJSONEx(FCGIContext *context, StatusCodes status, const char *des
        FCGI_BeginJSON(context, status);
        FCGI_JSONPair("description", description);
        FCGI_JSONLong("responsenumber", context->response_number);
-       FCGI_JSONPair("params", getenv("QUERY_STRING"));
+       //FCGI_JSONPair("params", getenv("QUERY_STRING"));
        FCGI_JSONPair("host", getenv("SERVER_HOSTNAME"));
        FCGI_JSONPair("user", getenv("REMOTE_USER"));
        FCGI_JSONPair("ip", getenv("REMOTE_ADDR"));
@@ -426,6 +395,48 @@ void FCGI_PrintRaw(const char *format, ...)
        va_end(list);
 }
 
+
+/**
+ * Write binary data
+ * See fwrite
+ */
+void FCGI_WriteBinary(void * data, size_t size, size_t num_elem)
+{
+       Log(LOGDEBUG,"Writing!");
+       fwrite(data, size, num_elem, stdout);
+}
+
+/**
+ * Escapes a string so it can be used safely.
+ * Currently escapes to ensure the validity for use as a JSON string
+ * Does not support unicode specifiers in the form of \uXXXX.
+ * @param buf The string to be escaped
+ * @return The escaped string (return value == buf)
+ */
+char *FCGI_EscapeText(char *buf)
+{
+       int length, i;
+       length = strlen(buf);
+       
+       //Escape special characters. Must count down to escape properly
+       for (i = length - 1; i >= 0; i--) {
+               if (buf[i] < 0x20) { //Control characters
+                       buf[i] = ' ';
+               } else if (buf[i] == '"') {
+                       if (i-1 >= 0 && buf[i-1] == '\\') 
+                               i--;
+                       else
+                               buf[i] = '\'';
+               } else if (buf[i] == '\\') {
+                       if (i-1 >= 0 && buf[i-1] == '\'')
+                               i--;
+                       else
+                               buf[i] = ' ';
+               }
+       }
+       return buf;
+}
+
 /**
  * Main FCGI request loop that receives/responds to client requests.
  * @param data Reserved.
@@ -436,33 +447,26 @@ void * FCGI_RequestLoop (void *data)
 {
        FCGIContext context = {0};
        
-       Log(LOGDEBUG, "First request...");
-       //TODO: The FCGI_Accept here is blocking. 
-       //              That means that if another thread terminates the program, this thread
-       //               will not terminate until the next request is made.
+       Log(LOGDEBUG, "Start loop");
        while (FCGI_Accept() >= 0) {
-
-               if (Thread_Runstate() != RUNNING)
-               {
-                       //TODO: Yeah... deal with this better :P
-                       Log(LOGERR, "FIXME; FCGI gets request after other threads have finished.");
-                       printf("Content-type: text/plain\r\n\r\n+++OUT OF CHEESE ERROR+++\n");
-                       break;
-               }
                
-               Log(LOGDEBUG, "Got request #%d", context.response_number);
                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"));
+
+               Log(LOGDEBUG, "Got request #%d - Module %s, params %s", context.response_number, module, params);
                
                //Remove trailing slashes (if present) from module query
                size_t lastchar = strlen(module) - 1;
                if (lastchar > 0 && module[lastchar] == '/')
                        module[lastchar] = 0;
 
+               //Escape all special characters
+               FCGI_EscapeText(params);
+
                //Default to the 'identify' module if none specified
                if (!*module) 
                        strcpy(module, "identify");
@@ -473,6 +477,10 @@ void * FCGI_RequestLoop (void *data)
                        module_handler = Control_Handler;
                } else if (!strcmp("sensors", module)) {
                        module_handler = Sensor_Handler;
+               } else if (!strcmp("actuators", module)) {
+                       module_handler = Actuator_Handler;
+               } else if (!strcmp("image", module)) {
+                       module_handler = Image_Handler;
                }
 
                context.current_module = module;
@@ -483,11 +491,10 @@ void * FCGI_RequestLoop (void *data)
                }
                context.response_number++;
 
-               Log(LOGDEBUG, "Waiting for request #%d", context.response_number);
+               
        }
 
        Log(LOGDEBUG, "Thread exiting.");
-       Thread_QuitProgram(false);
        // NOTE: Don't call pthread_exit, because this runs in the main thread. Just return.
        return NULL;
 }

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