2 * Copyright 2016 IoT.bzh
3 * Author: José Bollo <jose.bollo@iot.bzh>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
28 #include <microhttpd.h>
31 #if defined(USE_MAGIC_MIME_TYPE)
35 #include "afb-method.h"
36 #include "afb-req-itf.h"
37 #include "afb-msg-json.h"
42 #define SIZE_RESPONSE_BUFFER 8192
44 static char empty_string[] = "";
46 static const char uuid_header[] = "x-afb-uuid";
47 static const char uuid_arg[] = "uuid";
48 static const char uuid_cookie[] = "uuid";
50 static const char token_header[] = "x-afb-token";
51 static const char token_arg[] = "token";
52 static const char token_cookie[] = "token";
54 static char *cookie_name = NULL;
55 static char *cookie_setter = NULL;
56 static char *tmp_pattern = NULL;
59 struct hreq_data *next;
66 static struct json_object *req_json(struct afb_hreq *hreq);
67 static struct afb_arg req_get(struct afb_hreq *hreq, const char *name);
68 static void req_fail(struct afb_hreq *hreq, const char *status, const char *info);
69 static void req_success(struct afb_hreq *hreq, json_object *obj, const char *info);
70 static const char *req_raw(struct afb_hreq *hreq, size_t *size);
71 static void req_send(struct afb_hreq *hreq, const char *buffer, size_t size);
72 static int req_session_create(struct afb_hreq *hreq);
73 static int req_session_check(struct afb_hreq *hreq, int refresh);
74 static void req_session_close(struct afb_hreq *hreq);
76 static const struct afb_req_itf afb_hreq_itf = {
77 .json = (void*)req_json,
78 .get = (void*)req_get,
79 .success = (void*)req_success,
80 .fail = (void*)req_fail,
81 .raw = (void*)req_raw,
82 .send = (void*)req_send,
83 .session_create = (void*)req_session_create,
84 .session_check = (void*)req_session_check,
85 .session_close = (void*)req_session_close,
86 .context_get = (void*)afb_context_get,
87 .context_set = (void*)afb_context_set
90 static struct hreq_data *get_data(struct afb_hreq *hreq, const char *key, int create)
92 struct hreq_data *data = hreq->data;
93 while (data != NULL) {
94 if (!strcasecmp(data->key, key))
99 data = calloc(1, sizeof *data);
101 data->key = strdup(key);
102 if (data->key == NULL) {
106 data->next = hreq->data;
114 /* a valid subpath is a relative path not looking deeper than root using .. */
115 static int validsubpath(const char *subpath)
120 switch (subpath[i++]) {
124 if (subpath[i] == '/') {
128 if (subpath[i++] == '.') {
134 if (subpath[i++] == '/') {
141 while (subpath[i] && subpath[i] != '/')
151 static void afb_hreq_reply_v(struct afb_hreq *hreq, unsigned status, struct MHD_Response *response, va_list args)
156 if (hreq->replied != 0)
159 k = va_arg(args, const char *);
161 v = va_arg(args, const char *);
162 MHD_add_response_header(response, k, v);
163 k = va_arg(args, const char *);
165 if (hreq->context != NULL && asprintf(&cookie, cookie_setter, hreq->context->uuid)) {
166 MHD_add_response_header(response, MHD_HTTP_HEADER_SET_COOKIE, cookie);
169 MHD_queue_response(hreq->connection, status, response);
170 MHD_destroy_response(response);
173 if (hreq->suspended != 0) {
174 extern void run_micro_httpd(struct afb_hsrv *hsrv);
175 MHD_resume_connection (hreq->connection);
177 run_micro_httpd(hreq->hsrv);
181 void afb_hreq_reply(struct afb_hreq *hreq, unsigned status, struct MHD_Response *response, ...)
184 va_start(args, response);
185 afb_hreq_reply_v(hreq, status, response, args);
189 void afb_hreq_reply_empty(struct afb_hreq *hreq, unsigned status, ...)
192 va_start(args, status);
193 afb_hreq_reply_v(hreq, status, MHD_create_response_from_buffer(0, NULL, MHD_RESPMEM_PERSISTENT), args);
197 void afb_hreq_reply_static(struct afb_hreq *hreq, unsigned status, size_t size, const char *buffer, ...)
200 va_start(args, buffer);
201 afb_hreq_reply_v(hreq, status, MHD_create_response_from_buffer((unsigned)size, (char*)buffer, MHD_RESPMEM_PERSISTENT), args);
205 void afb_hreq_reply_copy(struct afb_hreq *hreq, unsigned status, size_t size, const char *buffer, ...)
208 va_start(args, buffer);
209 afb_hreq_reply_v(hreq, status, MHD_create_response_from_buffer((unsigned)size, (char*)buffer, MHD_RESPMEM_MUST_COPY), args);
213 void afb_hreq_reply_free(struct afb_hreq *hreq, unsigned status, size_t size, char *buffer, ...)
216 va_start(args, buffer);
217 afb_hreq_reply_v(hreq, status, MHD_create_response_from_buffer((unsigned)size, buffer, MHD_RESPMEM_MUST_FREE), args);
221 #if defined(USE_MAGIC_MIME_TYPE)
223 #if !defined(MAGIC_DB)
224 #define MAGIC_DB "/usr/share/misc/magic.mgc"
227 static magic_t lazy_libmagic()
230 static magic_t result = NULL;
234 /* MAGIC_MIME tells magic to return a mime of the file,
235 but you can specify different things */
237 fprintf(stderr, "Loading mimetype default magic database\n");
239 result = magic_open(MAGIC_MIME_TYPE);
240 if (result == NULL) {
241 fprintf(stderr,"ERROR: unable to initialize magic library\n");
243 /* Warning: should not use NULL for DB
244 [libmagic bug wont pass efence check] */
245 else if (magic_load(result, MAGIC_DB) != 0) {
246 fprintf(stderr,"cannot load magic database - %s\n",
247 magic_error(result));
256 static const char *magic_mimetype_fd(int fd)
258 magic_t lib = lazy_libmagic();
259 return lib ? magic_descriptor(lib, fd) : NULL;
264 static const char *mimetype_fd_name(int fd, const char *filename)
266 const char *result = NULL;
268 #if defined(INFER_EXTENSION)
269 const char *extension = strrchr(filename, '.');
271 static const char *const known[][2] = {
272 { ".js", "text/javascript" },
273 { ".html", "text/html" },
274 { ".css", "text/css" },
278 while (known[i][0]) {
279 if (!strcasecmp(extension, known[i][0])) {
280 result = known[i][1];
287 #if defined(USE_MAGIC_MIME_TYPE)
289 result = magic_mimetype_fd(fd);
294 void afb_hreq_free(struct afb_hreq *hreq)
296 struct hreq_data *data;
298 if (hreq->postform != NULL)
299 MHD_destroy_post_processor(hreq->postform);
300 for (data = hreq->data; data; data = hreq->data) {
301 hreq->data = data->next;
310 ctxClientPut(hreq->context);
311 json_object_put(hreq->json);
317 * Removes the 'prefix' of 'length' from the tail of 'hreq'
318 * if and only if the prefix exists and is terminated by a leading
321 int afb_hreq_unprefix(struct afb_hreq *hreq, const char *prefix, size_t length)
323 /* check the prefix ? */
324 if (length > hreq->lentail || (hreq->tail[length] && hreq->tail[length] != '/')
325 || strncasecmp(prefix, hreq->tail, length))
328 /* removes successives / */
329 while (length < hreq->lentail && hreq->tail[length + 1] == '/')
332 /* update the tail */
333 hreq->lentail -= length;
334 hreq->tail += length;
338 int afb_hreq_valid_tail(struct afb_hreq *hreq)
340 return validsubpath(hreq->tail);
343 void afb_hreq_reply_error(struct afb_hreq *hreq, unsigned int status)
345 afb_hreq_reply_empty(hreq, status, NULL);
348 int afb_hreq_reply_file_if_exist(struct afb_hreq *hreq, int dirfd, const char *filename)
354 char etag[1 + 2 * sizeof(int)];
356 struct MHD_Response *response;
357 const char *mimetype;
359 /* Opens the file or directory */
361 fd = openat(dirfd, filename, O_RDONLY);
365 afb_hreq_reply_error(hreq, MHD_HTTP_FORBIDDEN);
371 afb_hreq_reply_error(hreq, MHD_HTTP_INTERNAL_SERVER_ERROR);
376 /* Retrieves file's status */
377 if (fstat(fd, &st) != 0) {
379 afb_hreq_reply_error(hreq, MHD_HTTP_INTERNAL_SERVER_ERROR);
383 /* serve directory */
384 if (S_ISDIR(st.st_mode)) {
385 static const char *indexes[] = { "index.html", NULL };
388 while (indexes[i] != NULL) {
389 if (faccessat(fd, indexes[i], R_OK, 0) == 0) {
390 if (hreq->url[hreq->lenurl - 1] != '/') {
391 /* the redirect is needed for reliability of relative path */
392 char *tourl = alloca(hreq->lenurl + 2);
393 memcpy(tourl, hreq->url, hreq->lenurl);
394 tourl[hreq->lenurl] = '/';
395 tourl[hreq->lenurl + 1] = 0;
396 rc = afb_hreq_redirect_to(hreq, tourl);
398 rc = afb_hreq_reply_file_if_exist(hreq, fd, indexes[i]);
408 /* Don't serve special files */
409 if (!S_ISREG(st.st_mode)) {
411 afb_hreq_reply_error(hreq, MHD_HTTP_FORBIDDEN);
415 /* Check the method */
416 if ((hreq->method & (afb_method_get | afb_method_head)) == 0) {
418 afb_hreq_reply_error(hreq, MHD_HTTP_METHOD_NOT_ALLOWED);
422 /* computes the etag */
423 sprintf(etag, "%08X%08X", ((int)(st.st_mtim.tv_sec) ^ (int)(st.st_mtim.tv_nsec)), (int)(st.st_size));
425 /* checks the etag */
426 inm = MHD_lookup_connection_value(hreq->connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_IF_NONE_MATCH);
427 if (inm && 0 == strcmp(inm, etag)) {
428 /* etag ok, return NOT MODIFIED */
431 fprintf(stderr, "Not Modified: [%s]\n", filename);
432 response = MHD_create_response_from_buffer(0, empty_string, MHD_RESPMEM_PERSISTENT);
433 status = MHD_HTTP_NOT_MODIFIED;
436 if (st.st_size != (off_t) (size_t) st.st_size) {
438 afb_hreq_reply_error(hreq, MHD_HTTP_INTERNAL_SERVER_ERROR);
442 /* create the response */
443 response = MHD_create_response_from_fd((size_t) st.st_size, fd);
444 status = MHD_HTTP_OK;
447 mimetype = mimetype_fd_name(fd, filename);
448 if (mimetype != NULL)
449 MHD_add_response_header(response, MHD_HTTP_HEADER_CONTENT_TYPE, mimetype);
452 /* fills the value and send */
453 afb_hreq_reply(hreq, status, response,
454 MHD_HTTP_HEADER_CACHE_CONTROL, hreq->cacheTimeout,
455 MHD_HTTP_HEADER_ETAG, etag,
460 int afb_hreq_reply_file(struct afb_hreq *hreq, int dirfd, const char *filename)
462 int rc = afb_hreq_reply_file_if_exist(hreq, dirfd, filename);
464 afb_hreq_reply_error(hreq, MHD_HTTP_NOT_FOUND);
468 int afb_hreq_redirect_to(struct afb_hreq *hreq, const char *url)
470 afb_hreq_reply_static(hreq, MHD_HTTP_MOVED_PERMANENTLY, 0, NULL,
471 MHD_HTTP_HEADER_LOCATION, url, NULL);
473 fprintf(stderr, "redirect from [%s] to [%s]\n", hreq->url, url);
477 const char *afb_hreq_get_cookie(struct afb_hreq *hreq, const char *name)
479 return MHD_lookup_connection_value(hreq->connection, MHD_COOKIE_KIND, name);
482 const char *afb_hreq_get_argument(struct afb_hreq *hreq, const char *name)
484 struct hreq_data *data = get_data(hreq, name, 0);
485 return data ? data->value : MHD_lookup_connection_value(hreq->connection, MHD_GET_ARGUMENT_KIND, name);
488 const char *afb_hreq_get_header(struct afb_hreq *hreq, const char *name)
490 return MHD_lookup_connection_value(hreq->connection, MHD_HEADER_KIND, name);
493 int afb_hreq_post_add(struct afb_hreq *hreq, const char *key, const char *data, size_t size)
496 struct hreq_data *hdat = get_data(hreq, key, 1);
497 if (hdat->path != NULL) {
500 p = realloc(hdat->value, hdat->length + size + 1);
505 memcpy(&hdat->value[hdat->length], data, size);
506 hdat->length += size;
507 hdat->value[hdat->length] = 0;
511 int afb_hreq_init_download_path(const char *directory)
517 if (access(directory, R_OK|W_OK)) {
518 /* no read/write access */
521 if (stat(directory, &st)) {
525 if (!S_ISDIR(st.st_mode)) {
526 /* not a directory */
530 n = strlen(directory);
531 while(n > 1 && directory[n-1] == '/') n--;
534 /* can't allocate memory */
538 memcpy(p, directory, n);
552 static int opentempfile(char **path)
557 fname = strdup(tmp_pattern ? : "XXXXXX"); /* TODO improve the path */
561 fd = mkostemp(fname, O_CLOEXEC|O_WRONLY);
569 int afb_hreq_post_add_file(struct afb_hreq *hreq, const char *key, const char *file, const char *data, size_t size)
573 struct hreq_data *hdat = get_data(hreq, key, 1);
575 if (hdat->value == NULL) {
576 hdat->value = strdup(file);
577 if (hdat->value == NULL)
579 fd = opentempfile(&hdat->path);
580 } else if (strcmp(hdat->value, file) || hdat->path == NULL) {
583 fd = open(hdat->path, O_WRONLY|O_APPEND);
588 sz = write(fd, data, size);
590 hdat->length += (size_t)sz;
593 } else if (errno != EINTR)
600 struct afb_req afb_hreq_to_req(struct afb_hreq *hreq)
602 return (struct afb_req){ .itf = &afb_hreq_itf, .req_closure = hreq };
605 static struct afb_arg req_get(struct afb_hreq *hreq, const char *name)
607 struct hreq_data *hdat = get_data(hreq, name, 0);
609 return (struct afb_arg){
611 .value = hdat->value,
615 return (struct afb_arg){
617 .value = MHD_lookup_connection_value(hreq->connection, MHD_GET_ARGUMENT_KIND, name),
622 static int _iterargs_(struct json_object *obj, enum MHD_ValueKind kind, const char *key, const char *value)
624 json_object_object_add(obj, key, value ? json_object_new_string(value) : NULL);
628 static struct json_object *req_json(struct afb_hreq *hreq)
630 struct hreq_data *hdat;
631 struct json_object *obj, *val;
635 hreq->json = obj = json_object_new_object();
638 MHD_get_connection_values (hreq->connection, MHD_GET_ARGUMENT_KIND, (void*)_iterargs_, obj);
639 for (hdat = hreq->data ; hdat ; hdat = hdat->next) {
640 if (hdat->path == NULL)
641 val = hdat->value ? json_object_new_string(hdat->value) : NULL;
643 val = json_object_new_object();
646 json_object_object_add(val, "file", json_object_new_string(hdat->value));
647 json_object_object_add(val, "path", json_object_new_string(hdat->path));
650 json_object_object_add(obj, hdat->key, val);
657 static const char *req_raw(struct afb_hreq *hreq, size_t *size)
659 const char *result = json_object_get_string(req_json(hreq));
660 *size = result ? strlen(result) : 0;
664 static void req_send(struct afb_hreq *hreq, const char *buffer, size_t size)
666 afb_hreq_reply_copy(hreq, MHD_HTTP_OK, size, buffer, NULL);
669 static ssize_t send_json_cb(json_object *obj, uint64_t pos, char *buf, size_t max)
671 ssize_t len = stpncpy(buf, json_object_to_json_string(obj)+pos, max) - buf;
672 return len ? : (ssize_t)MHD_CONTENT_READER_END_OF_STREAM;
675 static void req_reply(struct afb_hreq *hreq, unsigned retcode, const char *status, const char *info, json_object *resp)
677 struct json_object *reply;
678 const char *token, *uuid;
679 struct MHD_Response *response;
681 if (hreq->context == NULL) {
684 token = hreq->context->token;
685 uuid = hreq->context->uuid;
687 reply = afb_msg_json_reply(status, info, resp, token, uuid);
688 response = MHD_create_response_from_callback((uint64_t)strlen(json_object_to_json_string(reply)), SIZE_RESPONSE_BUFFER, (void*)send_json_cb, reply, (void*)json_object_put);
689 afb_hreq_reply(hreq, retcode, response, NULL);
692 static void req_fail(struct afb_hreq *hreq, const char *status, const char *info)
694 req_reply(hreq, MHD_HTTP_OK, status, info, NULL);
697 static void req_success(struct afb_hreq *hreq, json_object *obj, const char *info)
699 req_reply(hreq, MHD_HTTP_OK, "success", info, obj);
702 struct AFB_clientCtx *afb_hreq_context(struct afb_hreq *hreq)
706 if (hreq->context == NULL) {
707 uuid = afb_hreq_get_header(hreq, uuid_header);
709 uuid = afb_hreq_get_argument(hreq, uuid_arg);
711 uuid = afb_hreq_get_cookie(hreq, cookie_name);
712 hreq->context = ctxClientGetForUuid(uuid);
714 return hreq->context;
717 static int req_session_create(struct afb_hreq *hreq)
719 struct AFB_clientCtx *context = afb_hreq_context(hreq);
722 if (context->created)
724 return req_session_check(hreq, 1);
727 static int req_session_check(struct afb_hreq *hreq, int refresh)
731 struct AFB_clientCtx *context = afb_hreq_context(hreq);
736 token = afb_hreq_get_header(hreq, token_header);
738 token = afb_hreq_get_argument(hreq, token_arg);
740 token = afb_hreq_get_cookie(hreq, token_cookie);
744 if (!ctxTokenCheck (context, token))
748 ctxTokenNew (context);
754 static void req_session_close(struct afb_hreq *hreq)
756 struct AFB_clientCtx *context = afb_hreq_context(hreq);
758 ctxClientClose(context);
761 int afb_hreq_init_cookie(int port, const char *path, int maxage)
768 cookie_setter = NULL;
771 rc = asprintf(&cookie_name, "x-afb-uuid-%d", port);
774 rc = asprintf(&cookie_setter, "%s=%%s; Path=%s; Max-Age=%d; HttpOnly",
775 cookie_name, path, maxage);