/**
* @file fastcgi.c
- * @purpose Runs the FCGI request loop to handle web interface requests.
+ * @brief Runs the FCGI request loop to handle web interface requests.
*
* fcgi_stdio.h must be included before all else so the stdio function
* redirection works ok.
#include <fcgi_stdio.h>
#include <openssl/sha.h>
-#include <time.h>
#include "common.h"
#include "sensor.h"
#include "control.h"
#include "options.h"
+/**The time period (in seconds) before the control key expires @ */
#define CONTROL_TIMEOUT 180
+/**Contextual information related to FCGI requests*/
struct FCGIContext {
/**The time of last valid user access possessing the control key*/
time_t control_timestamp;
};
/**
- * Identifies current version info. Useful for testing that the API is running.
- * TODO - Consider adding info about available sensors and actuators (eg capabilities)?
+ * Identifies build information and the current API version to the user.
+ * Also useful for testing that the API is running and identifying the
+ * sensors and actuators present.
+ * @param context The context to work in
+ * @param params User specified paramters: [actuators, sensors]
*/
static void IdentifyHandler(FCGIContext *context, char *params) {
+ bool identSensors = false, identActuators = false;
+ const char *key, *value;
+ int i;
+
+ while ((params = FCGI_KeyPair(params, &key, &value))) {
+ if (!strcmp(key, "sensors")) {
+ identSensors = !identSensors;
+ } else if (!strcmp(key, "actuators")) {
+ identActuators = !identActuators;
+ }
+ }
+
FCGI_BeginJSON(context, STATUS_OK);
FCGI_JSONPair("description", "MCTX3420 Server API (2013)");
FCGI_JSONPair("build_date", __DATE__ " " __TIME__);
+ FCGI_JSONLong("api_version", API_VERSION);
+ if (identSensors) {
+ FCGI_JSONKey("sensors");
+ FCGI_JSONValue("{\n\t\t");
+ for (i = 0; i < NUMSENSORS; i++) {
+ if (i > 0) {
+ FCGI_JSONValue(",\n\t\t");
+ }
+ FCGI_JSONValue("\"%d\" : \"%s\"", i, g_sensor_names[i]);
+ }
+ FCGI_JSONValue("\n\t}");
+ }
+ if (identActuators) {
+ FCGI_JSONKey("actuators");
+ FCGI_JSONValue("{\n\t\t");
+ for (i = 0; i < NUMACTUATORS; i++) {
+ if (i > 0) {
+ FCGI_JSONValue(",\n\t\t");
+ }
+ FCGI_JSONValue("\"%d\" : \"%s\"", i, g_actuator_names[i]);
+ }
+ FCGI_JSONValue("\n\t}");
+ }
FCGI_EndJSON();
}
FCGI_JSONDouble("start_time", start_time);
FCGI_JSONDouble("current_time", current_time);
FCGI_JSONDouble("running_time", current_time - start_time);
-
}
/**
* Adds a key/value pair to a JSON response. The response must have already
* been initiated by FCGI_BeginJSON. Note that characters are not escaped.
* @param key The key of the JSON entry
- * ¶m value The value associated with the key.
+ * @param value The value associated with the key.
*/
void FCGI_JSONPair(const char *key, const char *value)
{
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.
*/
printf("\r\n}\r\n");
}
-/**
- * To be used when the input parameters are invalid. The return data will
- * have a status of STATUS_ERROR, along with other debugging information.
- * @param context The context to work in
- */
-void FCGI_RejectJSON(FCGIContext *context)
-{
- FCGI_RejectJSONEx(context, STATUS_ERROR, "Invalid request");
-}
-
/**
* To be used when the input parameters are rejected. The return data
* will also have debugging information provided.
* @param context The context to work in
* @param status The status the return data should have.
* @param description A short description of why the input was rejected.
- * @param params The parameters that the module handler received.
*/
void FCGI_RejectJSONEx(FCGIContext *context, StatusCodes status, const char *description)
{
+ if (description == NULL)
+ description = "Unknown";
+
+ Log(LOGINFO, "%s: Rejected query with: %d: %s", context->current_module, status, description);
FCGI_BeginJSON(context, status);
FCGI_JSONPair("description", description);
FCGI_JSONLong("responsenumber", context->response_number);
FCGI_EndJSON();
}
+/**
+ * Generates a response to the client as described by the format parameter and
+ * extra arguments (exactly like printf). To be used when none of the other
+ * predefined functions will work exactly as needed. Extra care should be taken
+ * to ensure the correctness of the output.
+ * @param format The format string
+ * @param ... Any extra arguments as required by the format string.
+ */
+void FCGI_PrintRaw(const char *format, ...)
+{
+ va_list list;
+ va_start(list, format);
+ vprintf(format, list);
+ va_end(list);
+}
/**
* Main FCGI request loop that receives/responds to client requests.
size_t lastchar = strlen(module) - 1;
if (lastchar > 0 && module[lastchar] == '/')
module[lastchar] = 0;
+
+ //Default to the 'identify' module if none specified
+ if (!*module)
+ strcpy(module, "identify");
- if (!*module || !strcmp("identify", module)) {
+ if (!strcmp("identify", module)) {
module_handler = IdentifyHandler;
} else if (!strcmp("control", module)) {
module_handler = Control_Handler;
if (module_handler) {
module_handler(&context, params);
} else {
- strncat(module, " (unhandled)", BUFSIZ);
- FCGI_RejectJSON(&context);
+ FCGI_RejectJSON(&context, "Unhandled module");
}
context.response_number++;
Thread_QuitProgram(false);
// NOTE: Don't call pthread_exit, because this runs in the main thread. Just return.
return NULL;
-
-
}