#include "common.h"
#include "control.h"
+/**
+ * Handles control of the actuators.
+ */
+void ActuatorHandler(FCGIContext *context, int id, const char *set_value) {
+ char *ptr;
+
+ switch(id) { //Add new actuators here
+ case ACT_PREG: //Suppose is pressure regulator. 0-700 input (kPa)
+ {
+ int value = strtol(set_value, &ptr, 10);
+ if (*ptr == '\0' && value >= 0 && value <= 700) {
+ FCGI_BeginJSON(context, STATUS_OK);
+ FCGI_JSONKey("description");
+ FCGI_JSONValue("\"Set pressure to %d kPa!\"", value);
+ FCGI_EndJSON();
+ } else {
+ FCGI_RejectJSONEx(context,
+ STATUS_ERROR, "Invalid pressure specified.");
+ }
+ } break;
+ case ACT_SOLENOID1:
+ {
+ int value = strtol(set_value, &ptr, 10);
+ if (*ptr == '\0') {
+ const char *state = "off";
+ if (value)
+ state = "on";
+ FCGI_BeginJSON(context, STATUS_OK);
+ FCGI_JSONKey("description");
+ FCGI_JSONValue("\"Solenoid 1 turned %s!\"", state);
+ FCGI_EndJSON();
+ } else {
+ FCGI_RejectJSON(context);
+ }
+ } break;
+ default:
+ FCGI_RejectJSONEx(context,
+ STATUS_ERROR, "Invalid actuator id specified.");
+ }
+}
+
/**
* System control handler. This covers control over all aspects of the system.
* E.g: Actuators, system commands (start/stop experiment/recording) etc
* @param params The input parameters
*/
void Control_Handler(FCGIContext *context, char *params) {
- const char *key, *value, *loginkey = NULL, *action = NULL;
+ const char *key, *value, *control_key = NULL;
+ const char *action = NULL, *set_value = NULL;
bool force = false;
+ char *ptr;
+ int id = ACT_NONE;
while ((params = FCGI_KeyPair(params, &key, &value))) {
if (!strcmp(key, "action"))
action = value;
else if (!strcmp(key, "key"))
- loginkey = value;
+ control_key = value;
else if (!strcmp(key, "force"))
force = !force;
- else if (!strcmp(key, "id")) {
-
- }
- else if (!strcmp(key, "value")) {
-
+ else if (!strcmp(key, "id") && *value) { //Ensure non-empty value
+ int parsed = strtol(value, &ptr, 10);
+ if (*ptr == '\0') {
+ id = parsed;
+ }
+ } else if (!strcmp(key, "value")) {
+ set_value = value;
}
}
- if (!strcmp(action, "start")) {
- FCGI_Authorize(context, force);
+ if (action == NULL) { //Must have an action
+ FCGI_RejectJSON(context);
+ } else if (!strcmp(action, "start")) {
+ FCGI_BeginControl(context, force);
} else if (!strcmp(action, "stop")) { //Don't require control key to stop...
- //EMERGENCY STOP!!
+ //EMERGENCY STOP!! TODO - replace!
FCGI_BeginJSON(context, STATUS_OK);
- FCGI_JSONPair("description", "stopped!"); //Not really
+ FCGI_JSONPair("description", "stopped! (not)");
FCGI_EndJSON();
- } else {
- if (!FCGI_Authorized(context, loginkey)) {
- FCGI_BeginJSON(context, STATUS_UNAUTHORIZED);
- FCGI_JSONPair("description", "Invalid key specified.");
- FCGI_EndJSON();
- return;
+ } else { //Under this section, the user must have the current control key.
+ if (!FCGI_HasControl(context, control_key)) {
+ FCGI_RejectJSONEx(context,
+ STATUS_UNAUTHORIZED, "Invalid control key specified.");
} else if (!strcmp(action, "end")) {
- FCGI_AuthorizeEnd(context);
+ FCGI_EndControl(context);
} else if (!strcmp(action, "set")) {
- FCGI_BeginJSON(context, STATUS_OK);
- FCGI_JSONPair("description", "actuated!");
- FCGI_EndJSON();
+ if (set_value == NULL || *set_value == '\0') {
+ FCGI_RejectJSONEx(context,
+ STATUS_ERROR, "Set called but no value specified.");
+ } else {
+ ActuatorHandler(context, id, set_value);
+ }
}
}
}
#include "control.h"
#include "options.h"
-#define LOGIN_TIMEOUT 180
+#define CONTROL_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 time of last valid user access possessing the control key*/
+ time_t control_timestamp;
+ char control_key[41];
+ char control_ip[16];
/**The name of the current module**/
const char *current_module;
/**For debugging purposes?**/
}
/**
- * Gives the user an authorization key that determines who has control over
+ * Gives the user a key that determines who has control over
* the system at any one time. The key can be forcibly generated, revoking
* any previous control keys. To be used in conjunction with HTTP
* basic authentication.
* @param context The context to work in
* @param force Whether to force key generation or not.
*/
-void FCGI_Authorize(FCGIContext *context, bool force) {
+void FCGI_BeginControl(FCGIContext *context, bool force) {
time_t now = time(NULL);
- bool expired = now - context->login_timestamp > LOGIN_TIMEOUT;
+ bool expired = now - context->control_timestamp > CONTROL_TIMEOUT;
- if (force || !*(context->login_key) || expired) {
+ if (force || !*(context->control_key) || expired) {
SHA_CTX sha1ctx;
unsigned char sha1[20];
int i = rand();
SHA1_Update(&sha1ctx, &i, sizeof(i));
SHA1_Final(sha1, &sha1ctx);
- context->login_timestamp = now;
+ context->control_timestamp = now;
for (i = 0; i < 20; i++)
- sprintf(context->login_key + i * 2, "%02x", sha1[i]);
- snprintf(context->login_ip, 16, "%s", getenv("REMOTE_ADDR"));
+ sprintf(context->control_key + i * 2, "%02x", sha1[i]);
+ snprintf(context->control_ip, 16, "%s", getenv("REMOTE_ADDR"));
FCGI_BeginJSON(context, STATUS_OK);
- FCGI_JSONPair("key", context->login_key);
+ FCGI_JSONPair("key", context->control_key);
FCGI_EndJSON();
} else {
char buf[128];
strftime(buf, 128, "%H:%M:%S %d-%m-%Y",
- localtime(&(context->login_timestamp)));
+ localtime(&(context->control_timestamp)));
FCGI_BeginJSON(context, STATUS_UNAUTHORIZED);
- FCGI_JSONPair("description", "Already logged in");
- FCGI_JSONPair("current_user", context->login_ip);
+ FCGI_JSONPair("description", "Another user already has control");
+ FCGI_JSONPair("current_user", context->control_ip);
FCGI_JSONPair("when", buf);
FCGI_EndJSON();
}
}
-/**
- * Revokes the current authorization key, if present.
- * @param context The context to work in
- */
-void FCGI_AuthorizeEnd(FCGIContext *context) {
- *(context->login_key) = 0;
- FCGI_BeginJSON(context, STATUS_OK);
- FCGI_EndJSON();
- return;
-}
-
/**
* Given an FCGIContext, determines if the current user (as specified by
- * the key) is authorized or not. If validated, the context login_timestamp is
+ * the key) has control or not. If validated, the context control_timestamp is
* updated.
* @param context The context to work in
- * @param key The login key to be validated.
+ * @param key The control key to be validated.
* @return TRUE if authorized, FALSE if not.
*/
-bool FCGI_Authorized(FCGIContext *context, const char *key) {
+bool FCGI_HasControl(FCGIContext *context, const char *key) {
time_t now = time(NULL);
- int result = (now - context->login_timestamp) <= LOGIN_TIMEOUT &&
- key != NULL && !strcmp(context->login_key, key);
+ int result = (now - context->control_timestamp) <= CONTROL_TIMEOUT &&
+ key != NULL && !strcmp(context->control_key, key);
if (result) {
- context->login_timestamp = now; //Update the login_timestamp
+ context->control_timestamp = now; //Update the control_timestamp
}
return result;
}
+
+/**
+ * Revokes the current control key, if present.
+ * @param context The context to work in
+ */
+void FCGI_EndControl(FCGIContext *context) {
+ *(context->control_key) = 0;
+ FCGI_BeginJSON(context, STATUS_OK);
+ FCGI_EndJSON();
+ return;
+}
+
/**
* Extracts a key/value pair from a request string.
* Note that the input is modified by this function.
}
/**
- * To be used when the input parameters are invalid.
- * Sends a response with HTTP status 400 Bad request, along with
- * JSON data for debugging.
+ * 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
- * @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_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)
+{
+ FCGI_BeginJSON(context, status);
+ FCGI_JSONPair("description", description);
FCGI_JSONLong("responsenumber", context->response_number);
FCGI_JSONPair("params", getenv("QUERY_STRING"));
FCGI_JSONPair("host", getenv("SERVER_HOSTNAME"));
git.ucc.asn.au / matches / MCTX3420.git / commitdiff
UCC git Repository :: git.ucc.asn.au