2 * Copyright (C) 2015 "IoT.bzh"
3 * Author "Fulup Ar Foll"
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 * Contain all generic part to handle REST/API
20 * https://www.gnu.org/software/libmicrohttpd/tutorial.html [search 'FILE *fp']
23 #include "../include/local-def.h"
28 #define AFB_MSG_JTYPE "AJB_reply"
31 // handle to hold queryAll values
38 static json_object *afbJsonType;
41 // Sample Generic Ping Debug API
42 PUBLIC json_object* apiPingTest(AFB_request *request) {
44 json_object *response;
49 AFB_clientCtx *client=request->client; // get client context from request
51 // request all query key/value
52 len = getQueryAll (request, query, sizeof(query));
53 if (len == 0) strncpy (query, "NoSearchQueryList", sizeof(query));
55 // check if we have some post data
56 if (request->post == NULL) request->post->data="NoData";
58 // check is we have a session and a plugin handle
59 if (client == NULL) strcpy (session,"NoSession");
60 else snprintf(session, sizeof(session),"uuid=%s token=%s ctx=0x%x handle=0x%x", client->uuid, client->token, client->ctx, client->ctx);
62 // return response to caller
63 response = jsonNewMessage(AFB_SUCCESS, "Ping Binder Daemon count=%d CtxtId=%d query={%s} session={%s} PostData: [%s] "
64 , pingcount++, request->client->cid, query, session, request->post->data);
68 // Helper to retrieve argument from connection
69 PUBLIC const char* getQueryValue(AFB_request * request, char *name) {
72 value = MHD_lookup_connection_value(request->connection, MHD_GET_ARGUMENT_KIND, name);
76 STATIC int getQueryCB (void*handle, enum MHD_ValueKind kind, const char *key, const char *value) {
77 queryHandleT *query = (queryHandleT*)handle;
79 query->idx += snprintf (&query->msg[query->idx],query->len," %s: \'%s\',", key, value);
82 // Helper to retrieve argument from connection
83 PUBLIC int getQueryAll(AFB_request * request, char *buffer, size_t len) {
85 buffer[0] = '\0'; // start with an empty string
90 MHD_get_connection_values (request->connection, MHD_GET_ARGUMENT_KIND, getQueryCB, &query);
94 // Because of POST call multiple time requestApi we need to free POST handle here
95 PUBLIC void endPostRequest(AFB_PostHandle *postHandle) {
97 if (postHandle->type == AFB_POST_JSON) {
98 if (verbose) fprintf(stderr, "End PostJson Request UID=%d\n", postHandle->uid);
101 if (postHandle->type == AFB_POST_FORM) {
102 AFB_PostHandle *postform = (AFB_PostHandle*) postHandle->private;
103 if (verbose) fprintf(stderr, "End PostForm Request UID=%d\n", postHandle->uid);
105 // call API termination callback
106 if (!postHandle->private) {
107 if (!postHandle->completeCB) postHandle->completeCB (postHandle->private);
110 free(postHandle->private);
114 // Check of apiurl is declare in this plugin and call it
115 STATIC AFB_error callPluginApi(AFB_plugin *plugin, AFB_request *request, void *context) {
116 json_object *jresp, *jcall;
117 int idx, status, sig;
118 int signals[]= {SIGALRM, SIGSEGV, SIGFPE, 0};
120 /*---------------------------------------------------------------
121 | Signal handler defined inside CallPluginApi to access Request
122 +---------------------------------------------------------------- */
123 void pluginError (int signum) {
125 AFB_clientCtx *context;
127 // unlock signal to allow a new signal to come
128 sigemptyset (&sigset);
129 sigaddset (&sigset, signum);
130 sigprocmask (SIG_UNBLOCK, &sigset, 0);
132 fprintf (stderr, "Oops:%s Plugin Api Timeout timeout\n", configTime());
133 longjmp (request->checkPluginCall, signum);
137 // If a plugin hold this urlpath call its callback
138 for (idx = 0; plugin->apis[idx].callback != NULL; idx++) {
139 if (!strcmp(plugin->apis[idx].name, request->api)) {
141 // Request was found and at least partially executed
142 request->jresp = json_object_new_object();
143 json_object_get (afbJsonType); // increate jsontype reference count
144 json_object_object_add (request->jresp, "jtype", afbJsonType);
146 // prepare an object to store calling values
147 jcall=json_object_new_object();
148 json_object_object_add(jcall, "prefix", json_object_new_string (plugin->prefix));
149 json_object_object_add(jcall, "api" , json_object_new_string (plugin->apis[idx].name));
151 // save context before calling the API
152 status = setjmp (request->checkPluginCall);
155 // Plugin aborted somewhere during its execution
156 json_object_object_add(jcall, "status", json_object_new_string ("abort"));
157 json_object_object_add(jcall, "info" , json_object_new_string ("Plugin broke during execution"));
158 json_object_object_add(request->jresp, "request", jcall);
162 // If timeout protection==0 we are in debug and we do not apply signal protection
163 if (request->config->apiTimeout > 0) {
164 for (sig=0; signals[sig] != 0; sig++) {
165 if (signal (signals[sig], pluginError) == SIG_ERR) {
166 request->errcode = MHD_HTTP_UNPROCESSABLE_ENTITY;
167 json_object_object_add(jcall, "status", json_object_new_string ("fail"));
168 json_object_object_add(jcall, "info", json_object_new_string ("Setting Timeout Handler Failed"));
169 json_object_object_add(request->jresp, "request", jcall);
173 // Trigger a timer to protect from unacceptable long time execution
174 alarm (request->config->apiTimeout);
177 // Out of SessionNone every call get a client context session
178 if (AFB_SESSION_NONE != plugin->apis[idx].session) {
180 // add client context to request
181 ctxClientGet(request, plugin);
183 if (verbose) fprintf(stderr, "Plugin=[%s] Api=[%s] Middleware=[%d] Client=[0x%x] Uuid=[%s] Token=[%s]\n"
184 , request->plugin, request->api, plugin->apis[idx].session, request->client, request->client->uuid, request->client->token);
186 switch(plugin->apis[idx].session) {
188 case AFB_SESSION_CREATE:
189 if (request->client->token[0] != '\0') {
190 request->errcode=MHD_HTTP_UNAUTHORIZED;
191 json_object_object_add(jcall, "status", json_object_new_string ("exist"));
192 json_object_object_add(jcall, "info", json_object_new_string ("AFB_SESSION_CREATE Session already exist"));
193 json_object_object_add(request->jresp, "request", jcall);
197 if (AFB_SUCCESS != ctxTokenCreate (request)) {
198 request->errcode=MHD_HTTP_UNAUTHORIZED;
199 json_object_object_add(jcall, "status", json_object_new_string ("fail"));
200 json_object_object_add(jcall, "info", json_object_new_string ("AFB_SESSION_CREATE Invalid Initial Token"));
201 json_object_object_add(request->jresp, "request", jcall);
204 json_object_object_add(jcall, "uuid", json_object_new_string (request->client->uuid));
205 json_object_object_add(jcall, "token", json_object_new_string (request->client->token));
210 case AFB_SESSION_RENEW:
211 if (AFB_SUCCESS != ctxTokenRefresh (request)) {
212 request->errcode=MHD_HTTP_UNAUTHORIZED;
213 json_object_object_add(jcall, "status", json_object_new_string ("fail"));
214 json_object_object_add(jcall, "info", json_object_new_string ("AFB_SESSION_REFRESH Broken Exchange Token Chain"));
215 json_object_object_add(request->jresp, "request", jcall);
218 json_object_object_add(jcall, "uuid", json_object_new_string (request->client->uuid));
219 json_object_object_add(jcall, "token", json_object_new_string (request->client->token));
223 case AFB_SESSION_CLOSE:
224 if (AFB_SUCCESS != ctxTokenCheck (request)) {
225 request->errcode=MHD_HTTP_UNAUTHORIZED;
226 json_object_object_add(jcall, "status", json_object_new_string ("empty"));
227 json_object_object_add(jcall, "info", json_object_new_string ("AFB_SESSION_CLOSE Not a Valid Access Token"));
228 json_object_object_add(request->jresp, "request", jcall);
231 json_object_object_add(jcall, "uuid", json_object_new_string (request->client->uuid));
235 case AFB_SESSION_CHECK:
237 // default action is check
238 if (AFB_SUCCESS != ctxTokenCheck (request)) {
239 request->errcode=MHD_HTTP_UNAUTHORIZED;
240 json_object_object_add(jcall, "status", json_object_new_string ("fail"));
241 json_object_object_add(jcall, "info", json_object_new_string ("AFB_SESSION_CHECK Invalid Active Token"));
242 json_object_object_add(request->jresp, "request", jcall);
249 // Effectively call the API with a subset of the context
250 jresp = plugin->apis[idx].callback(request, context);
252 // Session close is done after the API call so API can still use session in closing API
253 if (AFB_SESSION_CLOSE == plugin->apis[idx].session) ctxTokenReset (request);
255 // API should return NULL of a valid Json Object
257 json_object_object_add(jcall, "status", json_object_new_string ("null"));
258 json_object_object_add(request->jresp, "request", jcall);
259 request->errcode = MHD_HTTP_NO_RESPONSE;
262 json_object_object_add(jcall, "status", json_object_new_string ("processed"));
263 json_object_object_add(request->jresp, "request", jcall);
264 json_object_object_add(request->jresp, "response", jresp);
266 // cancel timeout and plugin signal handle before next call
267 if (request->config->apiTimeout > 0) {
269 for (sig=0; signals[sig] != 0; sig++) {
270 signal (signals[sig], SIG_DFL);
281 STATIC AFB_error findAndCallApi (AFB_request *request, void *context) {
286 // Search for a plugin with this urlpath
287 for (idx = 0; request->plugins[idx] != NULL; idx++) {
288 if (!strcmp(request->plugins[idx]->prefix, request->plugin)) {
289 status =callPluginApi(request->plugins[idx], request, context);
293 // No plugin was found
294 if (request->plugins[idx] == NULL) {
295 request->jresp = jsonNewMessage(AFB_FATAL, "No Plugin=[%s]", request->plugin);
299 // plugin callback did not return a valid Json Object
300 if (status != AFB_DONE) {
301 request->jresp = jsonNewMessage(AFB_FATAL, "No API=[%s] for Plugin=[%s]", request->api, request->plugin);
308 // Everything look OK
312 request->errcode = MHD_HTTP_UNPROCESSABLE_ENTITY;
316 // This CB is call for every item with a form post it reformat iterator values
317 // and callback Plugin API for each Item within PostForm.
318 doPostIterate (void *cls, enum MHD_ValueKind kind, const char *key,
319 const char *filename, const char *mimetype,
320 const char *encoding, const char *data, uint64_t offset,
326 // retrieve API request from Post iterator handle
327 AFB_PostHandle *postHandle = (AFB_PostHandle*)cls;
328 AFB_request *request = (AFB_request*)postHandle->private;
329 AFB_PostRequest postRequest;
332 // Create and Item value for Plugin API
335 item.filename = filename;
336 item.mimetype = mimetype;
337 item.encoding = encoding;
340 item.offset = offset;
342 // Reformat Request to make it somehow similar to GET/PostJson case
343 postRequest.data= (char*) postHandle;
344 postRequest.len = size;
345 postRequest.type= AFB_POST_FORM;;
346 request->post = &postRequest;
348 // effectively call plugin API
349 status = findAndCallApi (request, &item);
351 // when returning no processing of postform stop
352 if (status != AFB_SUCCESS) return MHD_NO;
354 // let's allow iterator to move to next item
358 STATIC void freeRequest (AFB_request *request) {
360 free (request->plugin);
365 STATIC AFB_request *createRequest (struct MHD_Connection *connection, AFB_session *session, const char* url) {
367 AFB_request *request;
369 // Start with a clean request
370 request = calloc (1, sizeof (AFB_request));
371 char *urlcpy1, *urlcpy2;
372 char *baseapi, *baseurl;
374 // Extract plugin urlpath from request and make two copy because strsep overload copy
375 urlcpy1 = urlcpy2 = strdup(url);
376 baseurl = strsep(&urlcpy2, "/");
377 if (baseurl == NULL) {
378 request->jresp = jsonNewMessage(AFB_FATAL, "Invalid API call url=[%s]", url);
381 // let's compute URL and call API
382 baseapi = strsep(&urlcpy2, "/");
383 if (baseapi == NULL) {
384 request->jresp = jsonNewMessage(AFB_FATAL, "Invalid API call url=[%s]", url);
387 // build request structure
388 request->connection = connection;
389 request->config = session->config;
391 request->plugin = strdup (baseurl);
392 request->api = strdup (baseapi);
393 request->plugins= session->plugins;
399 // process rest API query
400 PUBLIC int doRestApi(struct MHD_Connection *connection, AFB_session *session, const char* url, const char *method
401 , const char *upload_data, size_t *upload_data_size, void **con_cls) {
403 static int postcount = 0; // static counter to debug POST protocol
404 json_object *errMessage;
406 struct MHD_Response *webResponse;
407 const char *serialized;
408 AFB_request *request;
409 AFB_PostHandle *postHandle;
410 AFB_PostRequest postRequest;
413 // if post data may come in multiple calls
414 if (0 == strcmp(method, MHD_HTTP_METHOD_POST)) {
415 const char *encoding, *param;
417 postHandle = *con_cls;
419 // This is the initial post event let's create form post structure POST datas come in multiple events
420 if (postHandle == NULL) {
422 // allocate application POST processor handle to zero
423 postHandle = calloc(1, sizeof (AFB_PostHandle));
424 postHandle->uid = postcount++; // build a UID for DEBUG
425 *con_cls = postHandle; // attache POST handle to current HTTP request
427 // Let make sure we have the right encoding and a valid length
428 encoding = MHD_lookup_connection_value(connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_CONTENT_TYPE);
430 // Form post is handle through a PostProcessor and call API once per form key
431 if (strcasestr(encoding, FORM_CONTENT) != NULL) {
432 if (verbose) fprintf(stderr, "Create PostForm[uid=%d]\n", postHandle->uid);
434 request = createRequest (connection, session, url);
435 if (request->jresp != NULL) {
436 errMessage = request->jresp;
439 postHandle = malloc(sizeof (AFB_PostHandle)); // allocate application POST processor handle
440 postHandle->type = AFB_POST_FORM;
441 postHandle->pp = MHD_create_post_processor (connection, MAX_POST_SIZE, doPostIterate, postHandle);
442 postHandle->private= (void*)request;
444 if (NULL == postHandle->pp) {
445 fprintf(stderr,"OOPS: Internal error fail to allocate MHD_create_post_processor\n");
452 // POST json is store into a buffer and present in one piece to API
453 if (strcasestr(encoding, JSON_CONTENT) != NULL) {
455 param = MHD_lookup_connection_value(connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_CONTENT_LENGTH);
456 if (param) sscanf(param, "%i", &contentlen);
458 // Because PostJson are build in RAM size is constrained
459 if (contentlen > MAX_POST_SIZE) {
460 errMessage = jsonNewMessage(AFB_FATAL, "Post Date to big %d > %d", contentlen, MAX_POST_SIZE);
464 // Size is OK, let's allocate a buffer to hold post data
465 postHandle->type = AFB_POST_JSON;
466 postHandle->private = malloc(contentlen + 1); // allocate memory for full POST data + 1 for '\0' enf of string
468 if (verbose) fprintf(stderr, "Create PostJson[uid=%d] Size=%d\n", postHandle->uid, contentlen);
472 // We only support Json and Form Post format
473 errMessage = jsonNewMessage(AFB_FATAL, "Post Date wrong type encoding=%s != %s", encoding, JSON_CONTENT);
479 // This time we receive partial/all Post data. Note that even if we get all POST data. We should nevertheless
480 // return MHD_YES and not process the request directly. Otherwise Libmicrohttpd is unhappy and fails with
481 // 'Internal application error, closing connection'.
482 if (*upload_data_size) {
484 if (postHandle->type == AFB_POST_FORM) {
485 if (verbose) fprintf(stderr, "Processing PostForm[uid=%d]\n", postHandle->uid);
486 MHD_post_process (postHandle->pp, upload_data, *upload_data_size);
489 // Process JsonPost request when buffer is completed let's call API
490 if (postHandle->type == AFB_POST_JSON) {
491 if (verbose) fprintf(stderr, "Updating PostJson[uid=%d]\n", postHandle->uid);
493 memcpy(&postHandle->private[postHandle->len], upload_data, *upload_data_size);
494 postHandle->len = postHandle->len + *upload_data_size;
495 *upload_data_size = 0;
499 } else { // we have finish with Post reception let's finish the work
501 // Create a request structure to finalise the request
502 request= createRequest (connection, session, url);
503 if (request->jresp != NULL) {
504 errMessage = request->jresp;
509 if (postHandle->type == AFB_POST_JSON) {
510 if (verbose) fprintf(stderr, "Processing PostJson[uid=%d]\n", postHandle->uid);
512 param = MHD_lookup_connection_value(connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_CONTENT_LENGTH);
513 if (param) sscanf(param, "%i", &contentlen);
515 // At this level we're may verify that we got everything and process DATA
516 if (postHandle->len != contentlen) {
517 errMessage = jsonNewMessage(AFB_FATAL, "Post Data Incomplete UID=%d Len %d != %d", postHandle->uid, contentlen, postHandle->len);
521 // Before processing data, make sure buffer string is properly ended
522 postHandle->private[postHandle->len] = '\0';
523 postRequest.data = postHandle->private;
524 postRequest.type = postHandle->type;
525 request->post = &postRequest;
527 if (verbose) fprintf(stderr, "Close Post[%d] Buffer=%s\n", postHandle->uid, request->post->data);
531 // this is a get we only need a request
532 request= createRequest (connection, session, url);
535 // Request is ready let's call API without any extra handle
536 status = findAndCallApi (request, NULL);
539 serialized = json_object_to_json_string(request->jresp);
540 webResponse = MHD_create_response_from_buffer(strlen(serialized), (void*) serialized, MHD_RESPMEM_MUST_COPY);
542 // client did not pass token on URI let's use cookies
543 if ((!request->restfull) && (request->client != NULL)) {
545 snprintf (cookie, sizeof (cookie), "%s=%s", COOKIE_NAME, request->client->uuid);
546 MHD_add_response_header (webResponse, MHD_HTTP_HEADER_SET_COOKIE, cookie);
549 // if requested add an error status
550 if (request->errcode != 0) ret=MHD_queue_response (connection, request->errcode, webResponse);
551 else MHD_queue_response(connection, MHD_HTTP_OK, webResponse);
553 MHD_destroy_response(webResponse);
554 json_object_put(request->jresp); // decrease reference rqtcount to free the json object
555 freeRequest (request);
559 freeRequest (request);
560 serialized = json_object_to_json_string(errMessage);
561 webResponse = MHD_create_response_from_buffer(strlen(serialized), (void*) serialized, MHD_RESPMEM_MUST_COPY);
562 MHD_queue_response(connection, MHD_HTTP_BAD_REQUEST, webResponse);
563 MHD_destroy_response(webResponse);
564 json_object_put(errMessage); // decrease reference rqtcount to free the json object
569 // Loop on plugins. Check that they have the right type, prepare a JSON object with prefix
570 STATIC AFB_plugin ** RegisterJsonPlugins(AFB_plugin **plugins) {
573 for (idx = 0; plugins[idx] != NULL; idx++) {
574 if (plugins[idx]->type != AFB_PLUGIN_JSON) {
575 fprintf(stderr, "ERROR: AFSV plugin[%d] invalid type=%d != %d\n", idx, AFB_PLUGIN_JSON, plugins[idx]->type);
577 // some sanity controls
578 if ((plugins[idx]->prefix == NULL) || (plugins[idx]->info == NULL) || (plugins[idx]->apis == NULL)) {
579 if (plugins[idx]->prefix == NULL) plugins[idx]->prefix = "No URL prefix for APIs";
580 if (plugins[idx]->info == NULL) plugins[idx]->info = "No Info describing plugin APIs";
581 fprintf(stderr, "ERROR: plugin[%d] invalid prefix=%s info=%s", idx, plugins[idx]->prefix, plugins[idx]->info);
585 if (verbose) fprintf(stderr, "Loading plugin[%d] prefix=[%s] info=%s\n", idx, plugins[idx]->prefix, plugins[idx]->info);
587 // Prebuild plugin jtype to boost API response
588 plugins[idx]->jtype = json_object_new_string(plugins[idx]->prefix);
589 json_object_get(plugins[idx]->jtype); // increase reference count to make it permanent
590 plugins[idx]->prefixlen = strlen(plugins[idx]->prefix);
593 // Prebuild each API jtype to boost API json response
594 for (jdx = 0; plugins[idx]->apis[jdx].name != NULL; jdx++) {
595 AFB_privateApi *private = malloc (sizeof (AFB_privateApi));
596 if (plugins[idx]->apis[jdx].private != NULL) {
597 fprintf (stderr, "WARNING: plugin=%s api=%s private handle should be NULL=0x%x\n"
598 ,plugins[idx]->prefix,plugins[idx]->apis[jdx].name, plugins[idx]->apis[jdx].private);
600 private->len = strlen (plugins[idx]->apis[jdx].name);
601 private->jtype=json_object_new_string(plugins[idx]->apis[jdx].name);
602 json_object_get(private->jtype); // increase reference count to make it permanent
603 plugins[idx]->apis[jdx].private = private;
610 void initPlugins(AFB_session *session) {
611 static AFB_plugin * plugins[10];
612 afbJsonType = json_object_new_string (AFB_MSG_JTYPE);
615 plugins[i++] = afsvRegister(session),
616 plugins[i++] = alsaRegister(session),
617 #ifdef HAVE_RADIO_PLUGIN
618 plugins[i++] = radioRegister(session),
622 // complete plugins and save them within current sessions
623 session->plugins = RegisterJsonPlugins(plugins);