* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Contain all generic part to handle REST/API
+ *
+ * https://www.gnu.org/software/libmicrohttpd/tutorial.html [search 'FILE *fp']
*/
#include "../include/local-def.h"
size_t len;
} queryHandleT;
-static json_object *afbJsonType;
+static json_object *afbJsonType;
+
+
+// Sample Generic Ping Debug API
+PUBLIC json_object* apiPingTest(AFB_request *request) {
+ static pingcount = 0;
+ json_object *response;
+ char query [256];
+ char session[256];
+
+ int len;
+ AFB_clientCtx *client=request->client; // get client context from request
+
+ // request all query key/value
+ len = getQueryAll (request, query, sizeof(query));
+ if (len == 0) strncpy (query, "NoSearchQueryList", sizeof(query));
+
+ // check if we have some post data
+ if (request->post == NULL) request->post->data="NoData";
+
+ // check is we have a session and a plugin handle
+ if (client == NULL) strcpy (session,"NoSession");
+ else snprintf(session, sizeof(session),"uuid=%s token=%s ctx=0x%x handle=0x%x", client->uuid, client->token, client->ctx, client->ctx);
+
+ // return response to caller
+ response = jsonNewMessage(AFB_SUCCESS, "Ping Binder Daemon count=%d CtxtId=%d query={%s} session={%s} PostData: [%s] "
+ , pingcount++, request->client->cid, query, session, request->post->data);
+ return (response);
+}
// Helper to retrieve argument from connection
PUBLIC const char* getQueryValue(AFB_request * request, char *name) {
// Helper to retrieve argument from connection
PUBLIC int getQueryAll(AFB_request * request, char *buffer, size_t len) {
queryHandleT query;
-
+ buffer[0] = '\0'; // start with an empty string
query.msg= buffer;
query.len= len;
query.idx= 0;
return (len);
}
-
-// 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];
- int len;
-
- // request all query key/value
- len = getQueryAll (request, query, sizeof(query));
- if (len == 0) strcpy (query,"NoSearchQueryList");
-
- // 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
+PUBLIC void endPostRequest(AFB_PostHandle *postHandle) {
+
+ if (postHandle->type == AFB_POST_JSON) {
+ if (verbose) fprintf(stderr, "End PostJson Request UID=%d\n", postHandle->uid);
+ }
-STATIC void endRequest(void *cls, struct MHD_Connection *connection, void **con_cls, enum MHD_RequestTerminationCode toe) {
- AFB_HttpPost *posthandle = *con_cls;
+ if (postHandle->type == AFB_POST_FORM) {
+ AFB_PostHandle *postform = (AFB_PostHandle*) postHandle->private;
+ if (verbose) fprintf(stderr, "End PostForm Request UID=%d\n", postHandle->uid);
- // if post handle was used let's free everything
- if (posthandle) {
- if (verbose) fprintf(stderr, "End Post Request UID=%d\n", posthandle->uid);
- free(posthandle->data);
- free(posthandle);
+ // call API termination callback
+ if (!postHandle->private) {
+ if (!postHandle->completeCB) postHandle->completeCB (postHandle->private);
+ }
}
+ freeRequest (postHandle->private);
+ free(postHandle);
}
// Check of apiurl is declare in this plugin and call it
-STATIC AFB_error callPluginApi(AFB_plugin *plugin, AFB_session *session, AFB_request *request) {
+STATIC AFB_error callPluginApi(AFB_plugin *plugin, AFB_request *request, void *context) {
json_object *jresp, *jcall;
int idx, status, sig;
int signals[]= {SIGALRM, SIGSEGV, SIGFPE, 0};
+---------------------------------------------------------------- */
void pluginError (int signum) {
sigset_t sigset;
-
+ AFB_clientCtx *context;
+
// unlock signal to allow a new signal to come
sigemptyset (&sigset);
sigaddset (&sigset, signum);
} else {
// If timeout protection==0 we are in debug and we do not apply signal protection
- if (session->config->apiTimeout > 0) {
+ if (request->config->apiTimeout > 0) {
for (sig=0; signals[sig] != 0; sig++) {
if (signal (signals[sig], pluginError) == SIG_ERR) {
- fprintf (stderr, "%s ERR: main no Signal/timeout handler installed.", configTime());
- return AFB_FAIL;
+ request->errcode = MHD_HTTP_UNPROCESSABLE_ENTITY;
+ request->jresp = jsonNewMessage(AFB_FATAL, "%s ERR: Signal/timeout handler activation fail.", configTime());
+ return AFB_FAIL;
}
}
- // Trigger a timer to protect from inacceptable long time execution
- alarm (session->config->apiTimeout);
+ // Trigger a timer to protect from unacceptable long time execution
+ alarm (request->config->apiTimeout);
}
-
- // Effectively call the API
- jresp = plugin->apis[idx].callback(session, request, plugin->apis[idx].handle);
-
+
+ // add client context to request
+ ctxClientGet(request, plugin);
+
+ // Effectively call the API with a subset of the context
+ jresp = plugin->apis[idx].callback(request, context);
+
+ // Allocate Json object and build response
+ request->jresp = json_object_new_object();
+ json_object_get (afbJsonType); // increate jsontype reference count
+ json_object_object_add (request->jresp, "jtype", afbJsonType);
+
// API should return NULL of a valid Json Object
if (jresp == NULL) {
- json_object_object_add(jcall, "status", json_object_new_string ("fail"));
+ json_object_object_add(jcall, "status", json_object_new_string ("null"));
json_object_object_add(request->jresp, "request", jcall);
+ request->errcode = MHD_HTTP_NO_RESPONSE;
} else {
- json_object_object_add(jcall, "status", json_object_new_string ("success"));
+ json_object_object_add(jcall, "status", json_object_new_string ("processed"));
json_object_object_add(request->jresp, "request", jcall);
json_object_object_add(request->jresp, "response", jresp);
-
}
// cancel timeout and plugin signal handle before next call
- if (session->config->apiTimeout > 0) {
+ if (request->config->apiTimeout > 0) {
alarm (0);
for (sig=0; signals[sig] != 0; sig++) {
signal (signals[sig], SIG_DFL);
}
}
- }
-
+ }
return (AFB_DONE);
}
}
return (AFB_FAIL);
}
+STATIC AFB_error findAndCallApi (AFB_request *request, void *context) {
+ int idx;
+ char *baseurl, *baseapi;
+ AFB_error status;
+
+ // Search for a plugin with this urlpath
+ for (idx = 0; request->plugins[idx] != NULL; idx++) {
+ if (!strcmp(request->plugins[idx]->prefix, baseurl)) {
+ status =callPluginApi(request->plugins[idx], request, context);
+ break;
+ }
+ }
+ // No plugin was found
+ if (request->plugins[idx] == NULL) {
+ request->jresp = jsonNewMessage(AFB_FATAL, "No Plugin=[%s]", request->plugin);
+ goto ExitOnError;
+ }
+
+ // plugin callback did not return a valid Json Object
+ if (status != AFB_DONE) {
+ request->jresp = jsonNewMessage(AFB_FATAL, "No API=[%s] for Plugin=[%s]", request->api, request->plugin);
+ goto ExitOnError;
+ }
+
+ // Everything look OK
+ return (status);
+
+ExitOnError:
+ request->errcode = MHD_HTTP_UNPROCESSABLE_ENTITY;
+ return (AFB_FAIL);
+}
-// process rest API query
-
-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) {
+// This CB is call for every item with a form post it reformat iterator values
+// and callback Plugin API for each Item within PostForm.
+doPostIterate (void *cls, enum MHD_ValueKind kind, const char *key,
+ const char *filename, const char *mimetype,
+ const char *encoding, const char *data, uint64_t offset,
+ size_t size) {
+
+ AFB_error status;
+ AFB_PostItem item;
- static int postcount = 0; // static counter to debug POST protocol
- char *baseurl, *baseapi, *urlcpy1, *urlcpy2, *query;
- json_object *errMessage;
- AFB_error status;
- struct MHD_Response *webResponse;
- const char *serialized, parsedurl;
- AFB_request request;
- AFB_HttpPost *posthandle = *con_cls;
- int idx, ret;
+ // retrieve API request from Post iterator handle
+ AFB_PostHandle *postHandle = (AFB_PostHandle*)cls;
+ AFB_request *request = (AFB_request*)postHandle->private;
+ AFB_PostRequest postRequest;
+
+
+ // Create and Item value for Plugin API
+ item.kind = kind;
+ item.key = key;
+ item.filename = filename;
+ item.mimetype = mimetype;
+ item.encoding = encoding;
+ item.len = size;
+ item.data = data;
+ item.offset = offset;
+
+ // Reformat Request to make it somehow similar to GET/PostJson case
+ post.data= (char*) postctx;
+ post.len = size;
+ post.type= AFB_POST_FORM;;
+ request->post = &post;
+
+ // effectively call plugin API
+ status = findAndCallApi (request, &item);
+
+ // when returning no processing of postform stop
+ if (status != AFB_SUCCESS) return MHD_NO;
+
+ // let's allow iterator to move to next item
+ return (MHD_YES;);
+}
+
+STATIC void freeRequest (AFB_request *request) {
+ free (request->plugin);
+ free (request->api);
+ free (request);
+}
+STATIC AFB_request *createRequest (struct MHD_Connection *connection, AFB_session *session, const char* url) {
+
+ AFB_request *request;
+
+ // Start with a clean request
+ request = calloc (1, sizeof (AFB_request));
+ char *urlcpy1, urlcpy2;
+
// 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);
+ errMessage = jsonNewMessage(AFB_FATAL, "Invalid API call url=[%s]", url);
goto ExitOnError;
}
+ // let's compute URL and call API
baseapi = strsep(&urlcpy2, "/");
if (baseapi == NULL) {
- errMessage = jsonNewMessage(AFB_FATAL, "Invalid Plugin/API call url=%s", url);
+ errMessage = jsonNewMessage(AFB_FATAL, "Invalid API call url=[%s]", url);
goto ExitOnError;
}
+ // build request structure
+ request->connection = connection;
+ request->config = session.config;
+ request->url = url;
+ request->plugin = strdup (baseurl);
+ request->api = strdup (baseapi);
+ request->plugins= session->plugins;
+
+ free(urlcpy1);
+}
+// process rest API query
+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
+ json_object *errMessage;
+ AFB_error status;
+ struct MHD_Response *webResponse;
+ const char *serialized;
+ AFB_request request;
+ AFB_PostHandle *posthandle;
+ int ret;
+
// 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;
+ 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);
+ // This is the initial post event let's create form post structure POST datas come in multiple events
+ if (posthandle == NULL) {
+ fprintf(stderr, "This is the 1st Post Event postuid=%d\n", posthandle->uid);
- // 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;
- }
+ // allocate application POST processor handle to zero
+ posthandle = cmalloc(1, sizeof (AFB_PostHandle));
+ posthandle->uid = postcount++; // build a UID for DEBUG
+ *con_cls = posthandle; // attache POST handle to current HTTP request
+
+ // 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);
+
+ // Form post is handle through a PostProcessor and call API once per form key
+ if (strcasestr(encoding, FORM_CONTENT) != NULL) {
+
+ posthandle = malloc(sizeof (AFB_PostHandle)); // allocate application POST processor handle
+ posthandle->type = AFB_POST_FORM;
+ posthandle->private= (void*)createRequest (connection, session, url);
+ posthandle->pp = MHD_create_post_processor (connection, MAX_POST_SIZE, doPostIterate, posthandle);
+
+ if (NULL == posthandle->pp) {
+ fprintf(stderr,"OOPS: Internal error fail to allocate MHD_create_post_processor\n");
+ free (posthandle);
+ return MHD_NO;
+ }
+ return MHD_YES;
+ }
+
+ // POST json is store into a buffer and present in one piece to API
+ if (strcasestr(encoding, JSON_CONTENT) != NULL) {
- if (contentlen > MAX_POST_SIZE) {
- errMessage = jsonNewMessage(AFB_FATAL, "Post Date to big %d > %d", contentlen, MAX_POST_SIZE);
- 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 (posthandle == NULL) {
+ posthandle->type = AFB_POST_JSON;
+ posthandle->private = malloc(contentlen + 1); // allocate memory for full POST data + 1 for '\0' enf of string
- if (verbose) fprintf(stderr, "Create Post[%d] Size=%d\n", posthandle->uid, contentlen);
- return MHD_YES;
+ if (verbose) fprintf(stderr, "Create PostJson[%d] Size=%d\n", posthandle->uid, contentlen);
+ return MHD_YES;
+ }
+
+ // We only support Json and Form Post format
+ errMessage = jsonNewMessage(AFB_FATAL, "Post Date wrong type encoding=%s != %s", encoding, JSON_CONTENT);
+ goto ExitOnError;
+ }
}
// 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'.
+ // 'Internal application error, closing connection'.
if (*upload_data_size) {
if (verbose) fprintf(stderr, "Update Post[%d]\n", posthandle->uid);
+
+ if (posthandle->type == AFB_POST_FORM) {
+ MHD_post_process (con_info->postprocessor, upload_data, *upload_data_size);
+ }
+
+ // Process JsonPost request when buffer is completed let's call API
+ if (posthandle->type == AFB_POST_JSON) {
- memcpy(&posthandle->data[posthandle->len], upload_data, *upload_data_size);
- posthandle->len = posthandle->len + *upload_data_size;
- *upload_data_size = 0;
+ memcpy(&posthandle->private[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;
- }
+
+ } else { // we have finish with Post reception let's finish the work
+
+ // Create a request structure to finalise the request
+ request= createRequest (connection, session, url);
- // Before processing data, make sure buffer string is properly ended
- posthandle->data[posthandle->len] = '\0';
- request.post = posthandle->data;
+ // We should only start to process DATA after Libmicrohttpd call or application handler with *upload_data_size==0
+ if (posthandle->type == AFB_POST_FORM) {
+ MHD_post_process (posthandle->pp, upload_data, *upload_data_size);
+ }
+
+ if (posthandle->type == AFB_POST_JSON) {
+ // 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;
+ }
- if (verbose) fprintf(stderr, "Close Post[%d] Buffer=%s\n", posthandle->uid, request.post);
+ // Before processing data, make sure buffer string is properly ended
+ posthandle->private[posthandle->len] = '\0';
+ request->post.data = posthandle->private;
+ request->post.type = posthandle->type;
+ if (verbose) fprintf(stderr, "Close Post[%d] Buffer=%s\n", posthandle->uid, request.post);
+ }
+ }
} else {
- request.post = NULL;
+ // this is a get we only need a request
+ request= createRequest (connection, session, url);
};
-
-
- // build request structure
- memset(&request, 0, sizeof (request));
- request.connection = connection;
- request.url = url;
- request.plugin = baseurl;
- request.api = baseapi;
- request.jresp = json_object_new_object();
- // increase reference count and add jtype to response
- json_object_get (afbJsonType);
- json_object_object_add (request.jresp, "jtype", afbJsonType);
+ // Request is ready let's call API without any extra handle
+ status = findAndCallApi (request, NULL);
- // Search for a plugin with this urlpath
- for (idx = 0; session->plugins[idx] != NULL; idx++) {
- if (!strcmp(session->plugins[idx]->prefix, baseurl)) {
- status =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(urlcpy1);
- goto ExitOnError;
- }
-
- // plugin callback did not return a valid Json Object
- if (status != AFB_DONE) {
- errMessage = jsonNewMessage(AFB_FATAL, "No Plugin/API for %s/%s", baseurl, baseapi);
- goto ExitOnError;
- }
-
+ExitOnResponse:
+ freeRequest (request);
serialized = json_object_to_json_string(request.jresp);
webResponse = MHD_create_response_from_buffer(strlen(serialized), (void*) serialized, MHD_RESPMEM_MUST_COPY);
-
- ret = MHD_queue_response(connection, MHD_HTTP_OK, webResponse);
+
+ // client did not pass token on URI let's use cookies
+ if ((!request.restfull) && (request.client != NULL)) {
+ char cookie[64];
+ snprintf (cookie, sizeof (cookie), "%s=%s", COOKIE_NAME, request.client->uuid);
+ MHD_add_response_header (webResponse, MHD_HTTP_HEADER_SET_COOKIE, cookie);
+ }
+
+ // if requested add an error status
+ if (request.errcode != 0) ret=MHD_queue_response (connection, request.errcode, webResponse);
+ else MHD_queue_response(connection, MHD_HTTP_OK, webResponse);
+
MHD_destroy_response(webResponse);
json_object_put(request.jresp); // decrease reference rqtcount to free the json object
- return ret;
+ return MHD_YES;
ExitOnError:
+ freeRequest (request);
serialized = json_object_to_json_string(errMessage);
webResponse = MHD_create_response_from_buffer(strlen(serialized), (void*) serialized, MHD_RESPMEM_MUST_COPY);
- ret = MHD_queue_response(connection, MHD_HTTP_BAD_REQUEST, webResponse);
+ MHD_queue_response(connection, MHD_HTTP_BAD_REQUEST, webResponse);
MHD_destroy_response(webResponse);
json_object_put(errMessage); // decrease reference rqtcount to free the json object
- return ret;
+ return MHD_YES;
}
// Loop on plugins. Check that they have the right type, prepare a JSON object with prefix
-STATIC AFB_plugin ** RegisterPlugins(AFB_plugin **plugins) {
+STATIC AFB_plugin ** RegisterJsonPlugins(AFB_plugin **plugins) {
int idx, jdx;
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);
+ if (plugins[idx]->type != AFB_PLUGIN_JSON) {
+ fprintf(stderr, "ERROR: AFSV plugin[%d] invalid type=%d != %d\n", idx, AFB_PLUGIN_JSON, plugins[idx]->type);
} else {
// some sanity controls
if ((plugins[idx]->prefix == NULL) || (plugins[idx]->info == NULL) || (plugins[idx]->apis == NULL)) {
}
if (verbose) fprintf(stderr, "Loading plugin[%d] prefix=[%s] info=%s\n", idx, plugins[idx]->prefix, plugins[idx]->info);
-
+
// Prebuild plugin jtype to boost 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
for (jdx = 0; plugins[idx]->apis[jdx].name != NULL; jdx++) {
AFB_privateApi *private = malloc (sizeof (AFB_privateApi));
if (plugins[idx]->apis[jdx].private != NULL) {
- fprintf (stderr, "WARNING: plugin=%s api=%s private handle should be NULL\n"
- ,plugins[idx]->prefix,plugins[idx]->apis[jdx].name);
+ fprintf (stderr, "WARNING: plugin=%s api=%s private handle should be NULL=0x%x\n"
+ ,plugins[idx]->prefix,plugins[idx]->apis[jdx].name, plugins[idx]->apis[jdx].private);
}
private->len = strlen (plugins[idx]->apis[jdx].name);
private->jtype=json_object_new_string(plugins[idx]->apis[jdx].name);
afbJsonType = json_object_new_string (AFB_MSG_JTYPE);
int i = 0;
- plugins[i] = afsvRegister(session),
+ plugins[i++] = afsvRegister(session),
plugins[i++] = dbusRegister(session),
plugins[i++] = alsaRegister(session),
#ifdef HAVE_RADIO_PLUGIN
plugins[i++] = radioRegister(session),
#endif
plugins[i++] = NULL;
-
+
// complete plugins and save them within current sessions
- session->plugins = RegisterPlugins(plugins);
+ session->plugins = RegisterJsonPlugins(plugins);
}
Code Review / src / app-framework-binder.git / blobdiff