* Contain all generic part to handle REST/API
*/
-
-#include <microhttpd.h>
-#include <sys/stat.h>
#include "../include/local-def.h"
-// proto missing from GCC
-char *strcasestr(const char *haystack, const char *needle);
+#include <setjmp.h>
+#include <signal.h>
+
+// context save for timeout set/longjmp
+static sigjmp_buf checkPluginCall;
+
+// handle to hold queryAll values
+typedef struct {
+ char *msg;
+ int idx;
+ size_t len;
+} queryHandleT;
+
+
+// Helper to retrieve argument from connection
+PUBLIC const char* getQueryValue(AFB_request * request, char *name) {
+ const char *value;
+
+ value = MHD_lookup_connection_value(request->connection, MHD_GET_ARGUMENT_KIND, name);
+ return (value);
+}
+
+STATIC int getQueryCB (void*handle, enum MHD_ValueKind kind, const char *key, const char *value) {
+ queryHandleT *query = (queryHandleT*)handle;
+
+ query->idx += snprintf (&query->msg[query->idx],query->len," %s: \'%s\',", key, value);
+}
+
+// Helper to retrieve argument from connection
+PUBLIC const char* getQueryAll(AFB_request * request, char *buffer, size_t len) {
+ queryHandleT query;
+
+ query.msg= buffer;
+ query.len= len;
+ query.idx= 0;
+
+ MHD_get_connection_values (request->connection, MHD_GET_ARGUMENT_KIND, getQueryCB, &query);
+ return (query.msg);
+}
+
+
+// Sample Generic Ping Debug API
+PUBLIC json_object* apiPingTest(AFB_session *session, AFB_request *request, void* handle) {
+ static pingcount = 0;
+ json_object *response;
+ char query [512];
+
+ // request all query key/value
+ getQueryAll (request, query, sizeof(query));
+
+ // check if we have some post data
+ if (request->post == NULL) request->post="NoData";
+
+ // return response to caller
+ response = jsonNewMessage(AFB_SUCCESS, "Ping Binder Daemon %d query={%s} PostData: \'%s\' ", pingcount++, query, request->post);
+ return (response);
+}
// Because of POST call multiple time requestApi we need to free POST handle here
+
STATIC void endRequest(void *cls, struct MHD_Connection *connection, void **con_cls, enum MHD_RequestTerminationCode toe) {
AFB_HttpPost *posthandle = *con_cls;
}
}
+/*----------------------------------------------------------
+ | timeout signalQuit
+ +--------------------------------------------------------- */
+STATIC void pluginError (int signum) {
-PUBLIC json_object* pingSample (AFB_plugin *plugin, AFB_session *session, AFB_request *post) {
- static pingcount=0;
- json_object *response;
- response = jsonNewMessage(AFB_SUCCESS, "Ping Binder Daemon %d", pingcount++);
- if (verbose) fprintf(stderr, "%d: \n", pingcount);
- return (response);
+ sigset_t sigset;
+
+ // unlock timeout signal to allow a new signal to come
+ sigemptyset (&sigset);
+ sigaddset (&sigset, SIGALRM);
+ sigprocmask (SIG_UNBLOCK, &sigset, 0);
+
+ fprintf (stderr, "Oops:%s Plugin Api Timeout timeout\n", configTime());
+ longjmp (checkPluginCall, signum);
}
+
// Check of apiurl is declare in this plugin and call it
-STATIC json_object * callPluginApi (AFB_plugin *plugin, AFB_session *session, AFB_request *request) {
+
+STATIC json_object * callPluginApi(AFB_plugin *plugin, AFB_session *session, AFB_request *request) {
json_object *response;
- int idx;
-
+ int idx, status;
+
// If a plugin hold this urlpath call its callback
- for (idx=0; plugin->apis[idx].callback != NULL; idx++) {
- if (!strcmp (plugin->apis[idx].name, request->api)) {
- response = plugin->apis[idx].callback (session, request);
- if (response != NULL) {
- json_object_object_add (response, "jtype" ,plugin->jtype);
- }
- return (response);
- }
+ for (idx = 0; plugin->apis[idx].callback != NULL; idx++) {
+ if (!strcmp(plugin->apis[idx].name, request->api)) {
+
+ // save context before calling the API
+ status = setjmp (checkPluginCall);
+ if (status != 0) {
+ response = jsonNewMessage(AFB_FATAL, "Plugin Call Fail prefix=%s api=%s info=%s", plugin->prefix, request->api, plugin->info);
+ } else {
+ if (signal (SIGALRM, pluginError) == SIG_ERR) {
+ fprintf (stderr, "%s ERR: main no Signal/timeout handler installed.", configTime());
+ return NULL;
+ }
+
+ if (signal (SIGSEGV, pluginError) == SIG_ERR) {
+ fprintf (stderr, "%s ERR: main no Signal/memory handler installed.", configTime());
+ return NULL;
+ }
+
+ if (signal (SIGFPE , pluginError) == SIG_ERR) {
+ fprintf (stderr, "%s ERR: main no Signal/memory handler installed.", configTime());
+ return NULL;
+ }
+
+ // protect plugin call with a timeout
+ alarm (session->config->apiTimeout);
+
+ response = plugin->apis[idx].callback(session, request, plugin->apis[idx].handle);
+ if (response != NULL) json_object_object_add(response, "jtype", plugin->jtype);
+
+ // cancel timeout and sleep before next aquisition
+ alarm (0);
+ signal(SIGALRM, SIG_DFL);
+ signal(SIGSEGV, SIG_DFL);
+ signal(SIGFPE , SIG_DFL);
+ }
+ return (response);
+
+ }
}
return (NULL);
}
// process rest API query
-PUBLIC int doRestApi(struct MHD_Connection *connection, AFB_session *session, const char *method, const char* url) {
- char *baseurl, *baseapi, *urlcpy;
+PUBLIC int doRestApi(struct MHD_Connection *connection, AFB_session *session, const char* url, const char *method
+ , const char *upload_data, size_t *upload_data_size, void **con_cls) {
+
+ static int postcount = 0; // static counter to debug POST protocol
+ char *baseurl, *baseapi, *urlcpy1, *urlcpy2, *query;
json_object *jsonResponse, *errMessage;
struct MHD_Response *webResponse;
const char *serialized, parsedurl;
AFB_request request;
- int idx, ret;
+ AFB_HttpPost *posthandle = *con_cls;
+ int idx, ret;
- // Extract plugin urlpath from request
- urlcpy=strdup (url);
- baseurl = strsep(&urlcpy, "/");
+ // Extract plugin urlpath from request and make two copy because strsep overload copy
+ urlcpy1 = urlcpy2 = strdup(url);
+ baseurl = strsep(&urlcpy2, "/");
if (baseurl == NULL) {
errMessage = jsonNewMessage(AFB_FATAL, "Invalid Plugin/API call url=%s", url);
goto ExitOnError;
}
-
- baseapi = strsep(&urlcpy, "/");
+
+ baseapi = strsep(&urlcpy2, "/");
if (baseapi == NULL) {
errMessage = jsonNewMessage(AFB_FATAL, "Invalid Plugin/API call url=%s/%s", baseurl, url);
goto ExitOnError;
}
- // build request structure
- memset (&request, 0, sizeof (request));
- request.connection = connection;
- request.url = url;
- request.plugin = baseurl;
- request.api = baseapi;
- // if post wait as data may come in multiple calls
- if (0 == strcmp (method, MHD_HTTP_METHOD_POST)) {
-
- request.post="TO Be DONE";
+ // if post data may come in multiple calls
+ if (0 == strcmp(method, MHD_HTTP_METHOD_POST)) {
+ const char *encoding, *param;
+ int contentlen = -1;
+ AFB_HttpPost *posthandle = *con_cls;
+
+ // Let make sure we have the right encoding and a valid length
+ encoding = MHD_lookup_connection_value(connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_CONTENT_TYPE);
+ param = MHD_lookup_connection_value(connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_CONTENT_LENGTH);
+ if (param) sscanf(param, "%i", &contentlen);
+
+ // POST datas may come in multiple chunk. Even when it never happen on AFB, we still have to handle the case
+ if (strcasestr(encoding, JSON_CONTENT) == 0) {
+ errMessage = jsonNewMessage(AFB_FATAL, "Post Date wrong type encoding=%s != %s", encoding, JSON_CONTENT);
+ goto ExitOnError;
+ }
+
+ if (contentlen > MAX_POST_SIZE) {
+ errMessage = jsonNewMessage(AFB_FATAL, "Post Date to big %d > %d", contentlen, MAX_POST_SIZE);
+ goto ExitOnError;
+ }
+
+ // In POST mode first libmicrohttp call only establishes POST handling.
+ if (posthandle == NULL) {
+ posthandle = malloc(sizeof (AFB_HttpPost)); // allocate application POST processor handle
+ posthandle->uid = postcount++; // build a UID for DEBUG
+ posthandle->len = 0; // effective length within POST handler
+ posthandle->data = malloc(contentlen + 1); // allocate memory for full POST data + 1 for '\0' enf of string
+ *con_cls = posthandle; // attache POST handle to current HTTP session
+
+ if (verbose) fprintf(stderr, "Create Post[%d] Size=%d\n", posthandle->uid, contentlen);
+ return MHD_YES;
+ }
+
+ // This time we receive partial/all Post data. Note that even if we get all POST data. We should nevertheless
+ // return MHD_YES and not process the request directly. Otherwise Libmicrohttpd is unhappy and fails with
+ // 'Internal application error, closing connection'.
+ if (*upload_data_size) {
+ if (verbose) fprintf(stderr, "Update Post[%d]\n", posthandle->uid);
+
+ memcpy(&posthandle->data[posthandle->len], upload_data, *upload_data_size);
+ posthandle->len = posthandle->len + *upload_data_size;
+ *upload_data_size = 0;
+ return MHD_YES;
+ }
+
+ // We should only start to process DATA after Libmicrohttpd call or application handler with *upload_data_size==0
+ // At this level we're may verify that we got everything and process DATA
+ if (posthandle->len != contentlen) {
+ errMessage = jsonNewMessage(AFB_FATAL, "Post Data Incomplete UID=%d Len %d != %s", posthandle->uid, contentlen, posthandle->len);
+ goto ExitOnError;
+ }
+
+ // Before processing data, make sure buffer string is properly ended
+ posthandle->data[posthandle->len] = '\0';
+ request.post = posthandle->data;
+
+ if (verbose) fprintf(stderr, "Close Post[%d] Buffer=%s\n", posthandle->uid, request.post);
+
} else {
- request.post=NULL;
+ request.post = NULL;
};
+
+
+ // build request structure
+ memset(&request, 0, sizeof (request));
+ request.connection = connection;
+ request.url = url;
+ request.plugin = baseurl;
+ request.api = baseapi;
// Search for a plugin with this urlpath
- for (idx=0; session->plugins[idx] != NULL; idx++) {
- if (!strcmp (session->plugins[idx]->prefix, baseurl)) {
- jsonResponse = callPluginApi (session->plugins[idx], session, &request );
- // free (urlcpy);
- break;
+ for (idx = 0; session->plugins[idx] != NULL; idx++) {
+ if (!strcmp(session->plugins[idx]->prefix, baseurl)) {
+ jsonResponse = callPluginApi(session->plugins[idx], session, &request);
+ free(urlcpy1);
+ break;
}
}
// No plugin was found
if (session->plugins[idx] == NULL) {
errMessage = jsonNewMessage(AFB_FATAL, "No Plugin for %s", baseurl);
- free (urlcpy);
+ free(urlcpy1);
goto ExitOnError;
}
// plugin callback did not return a valid Json Object
if (jsonResponse == NULL) {
- errMessage = jsonNewMessage(AFB_FATAL, "No Plugin/API for %s/%s", baseurl, baseapi);
- goto ExitOnError;
+ errMessage = jsonNewMessage(AFB_FATAL, "No Plugin/API for %s/%s", baseurl, baseapi);
+ goto ExitOnError;
}
serialized = json_object_to_json_string(jsonResponse);
return ret;
}
-// Helper to retreive argument from connection
-PUBLIC const char* getQueryValue (AFB_request * request, char *name) {
- const char *value;
-
- value=MHD_lookup_connection_value(request->connection, MHD_GET_ARGUMENT_KIND, name);
- return (value);
-}
// Loop on plugins. Check that they have the right type, prepare a JSON object with prefix
+
STATIC AFB_plugin ** RegisterPlugins(AFB_plugin **plugins) {
int idx;
-
- for (idx=0; plugins[idx] != NULL; idx++) {
+
+ for (idx = 0; plugins[idx] != NULL; idx++) {
if (plugins[idx]->type != AFB_PLUGIN) {
- fprintf (stderr, "ERROR: AFSV plugin[%d] invalid type=%d != %d\n", idx, AFB_PLUGIN, plugins[idx]->type);
+ fprintf(stderr, "ERROR: AFSV plugin[%d] invalid type=%d != %d\n", idx, AFB_PLUGIN, plugins[idx]->type);
} else {
// some sanity controls
- if ((plugins[idx]->prefix == NULL) || (plugins[idx]->info == NULL) || (plugins[idx]->apis == NULL)){
+ if ((plugins[idx]->prefix == NULL) || (plugins[idx]->info == NULL) || (plugins[idx]->apis == NULL)) {
if (plugins[idx]->prefix == NULL) plugins[idx]->prefix = "No URL prefix for APIs";
if (plugins[idx]->info == NULL) plugins[idx]->info = "No Info describing plugin APIs";
- fprintf (stderr, "ERROR: plugin[%d] invalid prefix=%s info=%s", idx,plugins[idx]->prefix, plugins[idx]->info);
+ fprintf(stderr, "ERROR: plugin[%d] invalid prefix=%s info=%s", idx, plugins[idx]->prefix, plugins[idx]->info);
return NULL;
}
-
- if (verbose) fprintf (stderr, "Loading plugin[%d] prefix=[%s] info=%s\n", idx, plugins[idx]->prefix, plugins[idx]->info);
-
+
+ if (verbose) fprintf(stderr, "Loading plugin[%d] prefix=[%s] info=%s\n", idx, plugins[idx]->prefix, plugins[idx]->info);
+
// Prepare Plugin name to be added into each API response
- plugins[idx]->jtype = json_object_new_string (plugins[idx]->prefix);
- json_object_get (plugins[idx]->jtype); // increase reference count to make it permanent
-
+ plugins[idx]->jtype = json_object_new_string(plugins[idx]->prefix);
+ json_object_get(plugins[idx]->jtype); // increase reference count to make it permanent
+
// compute urlprefix lenght
- plugins[idx]->prefixlen = strlen (plugins[idx]->prefix);
- }
+ plugins[idx]->prefixlen = strlen(plugins[idx]->prefix);
+ }
}
return (plugins);
}
-void initPlugins (AFB_session *session) {
- static AFB_plugin *plugins[10];
+void initPlugins(AFB_session *session) {
+ static AFB_plugin * plugins[10];
- plugins[0]= afsvRegister (session),
- plugins[1]= dbusRegister (session),
- plugins[2]= alsaRegister (session),
- plugins[3]= NULL;
+ plugins[0] = afsvRegister(session),
+ plugins[1] = dbusRegister(session),
+ plugins[2] = alsaRegister(session),
+ plugins[3] = NULL;
// complete plugins and save them within current sessions
- session->plugins= RegisterPlugins (plugins);
+ session->plugins = RegisterPlugins(plugins);
}
\ No newline at end of file
Code Review / src / app-framework-binder.git / blobdiff