2 * Copyright (C) 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>
29 #include <json-c/json.h>
31 #if defined(USE_MAGIC_MIME_TYPE)
35 #include "afb-method.h"
36 #include <afb/afb-req-itf.h>
37 #include "afb-msg-json.h"
38 #include "afb-context.h"
43 #define SIZE_RESPONSE_BUFFER 8192
45 static char empty_string[] = "";
47 static const char uuid_header[] = "x-afb-uuid";
48 static const char uuid_arg[] = "uuid";
49 static const char uuid_cookie[] = "uuid";
51 static const char token_header[] = "x-afb-token";
52 static const char token_arg[] = "token";
53 static const char token_cookie[] = "token";
55 static char *cookie_name = NULL;
56 static char *cookie_setter = NULL;
57 static char *tmp_pattern = NULL;
60 * Structure for storing key/values read from POST requests
63 struct hreq_data *next; /* chain to next data */
64 char *key; /* key name */
65 size_t length; /* length of the value (used for appending) */
66 char *value; /* the value (or original filename) */
67 char *path; /* path of the file saved */
70 static struct json_object *req_json(struct afb_hreq *hreq);
71 static struct afb_arg req_get(struct afb_hreq *hreq, const char *name);
72 static void req_fail(struct afb_hreq *hreq, const char *status, const char *info);
73 static void req_success(struct afb_hreq *hreq, json_object *obj, const char *info);
74 static const char *req_raw(struct afb_hreq *hreq, size_t *size);
75 static void req_send(struct afb_hreq *hreq, const char *buffer, size_t size);
77 static const struct afb_req_itf afb_hreq_itf = {
78 .json = (void*)req_json,
79 .get = (void*)req_get,
80 .success = (void*)req_success,
81 .fail = (void*)req_fail,
82 .raw = (void*)req_raw,
83 .send = (void*)req_send,
84 .context_get = (void*)afb_context_get,
85 .context_set = (void*)afb_context_set,
86 .addref = (void*)afb_hreq_addref,
87 .unref = (void*)afb_hreq_unref
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 v = afb_context_sent_uuid(&hreq->context);
166 if (v != NULL && asprintf(&cookie, cookie_setter, v) > 0) {
167 MHD_add_response_header(response, MHD_HTTP_HEADER_SET_COOKIE, cookie);
170 MHD_queue_response(hreq->connection, status, response);
171 MHD_destroy_response(response);
174 if (hreq->suspended != 0) {
175 extern void run_micro_httpd(struct afb_hsrv *hsrv);
176 MHD_resume_connection (hreq->connection);
178 run_micro_httpd(hreq->hsrv);
182 void afb_hreq_reply(struct afb_hreq *hreq, unsigned status, struct MHD_Response *response, ...)
185 va_start(args, response);
186 afb_hreq_reply_v(hreq, status, response, args);
190 void afb_hreq_reply_empty(struct afb_hreq *hreq, unsigned status, ...)
193 va_start(args, status);
194 afb_hreq_reply_v(hreq, status, MHD_create_response_from_buffer(0, NULL, MHD_RESPMEM_PERSISTENT), args);
198 void afb_hreq_reply_static(struct afb_hreq *hreq, unsigned status, size_t size, const char *buffer, ...)
201 va_start(args, buffer);
202 afb_hreq_reply_v(hreq, status, MHD_create_response_from_buffer((unsigned)size, (char*)buffer, MHD_RESPMEM_PERSISTENT), args);
206 void afb_hreq_reply_copy(struct afb_hreq *hreq, unsigned status, size_t size, const char *buffer, ...)
209 va_start(args, buffer);
210 afb_hreq_reply_v(hreq, status, MHD_create_response_from_buffer((unsigned)size, (char*)buffer, MHD_RESPMEM_MUST_COPY), args);
214 void afb_hreq_reply_free(struct afb_hreq *hreq, unsigned status, size_t size, char *buffer, ...)
217 va_start(args, buffer);
218 afb_hreq_reply_v(hreq, status, MHD_create_response_from_buffer((unsigned)size, buffer, MHD_RESPMEM_MUST_FREE), args);
222 #if defined(USE_MAGIC_MIME_TYPE)
224 #if !defined(MAGIC_DB)
225 #define MAGIC_DB "/usr/share/misc/magic.mgc"
228 static magic_t lazy_libmagic()
231 static magic_t result = NULL;
235 /* MAGIC_MIME tells magic to return a mime of the file,
236 but you can specify different things */
237 INFO("Loading mimetype default magic database");
238 result = magic_open(MAGIC_MIME_TYPE);
239 if (result == NULL) {
240 ERROR("unable to initialize magic library");
242 /* Warning: should not use NULL for DB
243 [libmagic bug wont pass efence check] */
244 else if (magic_load(result, MAGIC_DB) != 0) {
245 ERROR("cannot load magic database: %s", magic_error(result));
254 static const char *magic_mimetype_fd(int fd)
256 magic_t lib = lazy_libmagic();
257 return lib ? magic_descriptor(lib, fd) : NULL;
262 static const char *mimetype_fd_name(int fd, const char *filename)
264 const char *result = NULL;
266 #if defined(INFER_EXTENSION)
267 const char *extension = strrchr(filename, '.');
269 static const char *const known[][2] = {
270 { ".js", "text/javascript" },
271 { ".html", "text/html" },
272 { ".css", "text/css" },
276 while (known[i][0]) {
277 if (!strcasecmp(extension, known[i][0])) {
278 result = known[i][1];
285 #if defined(USE_MAGIC_MIME_TYPE)
287 result = magic_mimetype_fd(fd);
292 void afb_hreq_addref(struct afb_hreq *hreq)
297 void afb_hreq_unref(struct afb_hreq *hreq)
299 struct hreq_data *data;
301 if (hreq == NULL || --hreq->refcount)
304 if (hreq->postform != NULL)
305 MHD_destroy_post_processor(hreq->postform);
306 for (data = hreq->data; data; data = hreq->data) {
307 hreq->data = data->next;
316 afb_context_disconnect(&hreq->context);
317 json_object_put(hreq->json);
322 * Removes the 'prefix' of 'length' from the tail of 'hreq'
323 * if and only if the prefix exists and is terminated by a leading
326 int afb_hreq_unprefix(struct afb_hreq *hreq, const char *prefix, size_t length)
328 /* check the prefix ? */
329 if (length > hreq->lentail || (hreq->tail[length] && hreq->tail[length] != '/')
330 || strncasecmp(prefix, hreq->tail, length))
333 /* removes successives / */
334 while (length < hreq->lentail && hreq->tail[length + 1] == '/')
337 /* update the tail */
338 hreq->lentail -= length;
339 hreq->tail += length;
343 int afb_hreq_valid_tail(struct afb_hreq *hreq)
345 return validsubpath(hreq->tail);
348 void afb_hreq_reply_error(struct afb_hreq *hreq, unsigned int status)
350 afb_hreq_reply_empty(hreq, status, NULL);
353 int afb_hreq_reply_file_if_exist(struct afb_hreq *hreq, int dirfd, const char *filename)
359 char etag[1 + 2 * sizeof(int)];
361 struct MHD_Response *response;
362 const char *mimetype;
364 /* Opens the file or directory */
366 fd = openat(dirfd, filename, O_RDONLY);
370 afb_hreq_reply_error(hreq, MHD_HTTP_FORBIDDEN);
376 afb_hreq_reply_error(hreq, MHD_HTTP_INTERNAL_SERVER_ERROR);
381 /* Retrieves file's status */
382 if (fstat(fd, &st) != 0) {
384 afb_hreq_reply_error(hreq, MHD_HTTP_INTERNAL_SERVER_ERROR);
388 /* serve directory */
389 if (S_ISDIR(st.st_mode)) {
390 static const char *indexes[] = { "index.html", NULL };
393 while (indexes[i] != NULL) {
394 if (faccessat(fd, indexes[i], R_OK, 0) == 0) {
395 if (hreq->url[hreq->lenurl - 1] != '/') {
396 /* the redirect is needed for reliability of relative path */
397 char *tourl = alloca(hreq->lenurl + 2);
398 memcpy(tourl, hreq->url, hreq->lenurl);
399 tourl[hreq->lenurl] = '/';
400 tourl[hreq->lenurl + 1] = 0;
401 rc = afb_hreq_redirect_to(hreq, tourl);
403 rc = afb_hreq_reply_file_if_exist(hreq, fd, indexes[i]);
413 /* Don't serve special files */
414 if (!S_ISREG(st.st_mode)) {
416 afb_hreq_reply_error(hreq, MHD_HTTP_FORBIDDEN);
420 /* Check the method */
421 if ((hreq->method & (afb_method_get | afb_method_head)) == 0) {
423 afb_hreq_reply_error(hreq, MHD_HTTP_METHOD_NOT_ALLOWED);
427 /* computes the etag */
428 sprintf(etag, "%08X%08X", ((int)(st.st_mtim.tv_sec) ^ (int)(st.st_mtim.tv_nsec)), (int)(st.st_size));
430 /* checks the etag */
431 inm = MHD_lookup_connection_value(hreq->connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_IF_NONE_MATCH);
432 if (inm && 0 == strcmp(inm, etag)) {
433 /* etag ok, return NOT MODIFIED */
435 DEBUG("Not Modified: [%s]", filename);
436 response = MHD_create_response_from_buffer(0, empty_string, MHD_RESPMEM_PERSISTENT);
437 status = MHD_HTTP_NOT_MODIFIED;
440 if (st.st_size != (off_t) (size_t) st.st_size) {
442 afb_hreq_reply_error(hreq, MHD_HTTP_INTERNAL_SERVER_ERROR);
446 /* create the response */
447 response = MHD_create_response_from_fd((size_t) st.st_size, fd);
448 status = MHD_HTTP_OK;
451 mimetype = mimetype_fd_name(fd, filename);
452 if (mimetype != NULL)
453 MHD_add_response_header(response, MHD_HTTP_HEADER_CONTENT_TYPE, mimetype);
456 /* fills the value and send */
457 afb_hreq_reply(hreq, status, response,
458 MHD_HTTP_HEADER_CACHE_CONTROL, hreq->cacheTimeout,
459 MHD_HTTP_HEADER_ETAG, etag,
464 int afb_hreq_reply_file(struct afb_hreq *hreq, int dirfd, const char *filename)
466 int rc = afb_hreq_reply_file_if_exist(hreq, dirfd, filename);
468 afb_hreq_reply_error(hreq, MHD_HTTP_NOT_FOUND);
472 int afb_hreq_redirect_to(struct afb_hreq *hreq, const char *url)
474 /* TODO: append the query part! */
475 afb_hreq_reply_static(hreq, MHD_HTTP_MOVED_PERMANENTLY, 0, NULL,
476 MHD_HTTP_HEADER_LOCATION, url, NULL);
477 DEBUG("redirect from [%s] to [%s]", hreq->url, url);
481 const char *afb_hreq_get_cookie(struct afb_hreq *hreq, const char *name)
483 return MHD_lookup_connection_value(hreq->connection, MHD_COOKIE_KIND, name);
486 const char *afb_hreq_get_argument(struct afb_hreq *hreq, const char *name)
488 struct hreq_data *data = get_data(hreq, name, 0);
489 return data ? data->value : MHD_lookup_connection_value(hreq->connection, MHD_GET_ARGUMENT_KIND, name);
492 const char *afb_hreq_get_header(struct afb_hreq *hreq, const char *name)
494 return MHD_lookup_connection_value(hreq->connection, MHD_HEADER_KIND, name);
497 int afb_hreq_post_add(struct afb_hreq *hreq, const char *key, const char *data, size_t size)
500 struct hreq_data *hdat = get_data(hreq, key, 1);
501 if (hdat->path != NULL) {
504 p = realloc(hdat->value, hdat->length + size + 1);
509 memcpy(&hdat->value[hdat->length], data, size);
510 hdat->length += size;
511 hdat->value[hdat->length] = 0;
515 int afb_hreq_init_download_path(const char *directory)
521 if (access(directory, R_OK|W_OK)) {
522 /* no read/write access */
525 if (stat(directory, &st)) {
529 if (!S_ISDIR(st.st_mode)) {
530 /* not a directory */
534 n = strlen(directory);
535 while(n > 1 && directory[n-1] == '/') n--;
538 /* can't allocate memory */
542 memcpy(p, directory, n);
556 static int opentempfile(char **path)
561 fname = strdup(tmp_pattern ? : "XXXXXX"); /* TODO improve the path */
565 fd = mkostemp(fname, O_CLOEXEC|O_WRONLY);
573 int afb_hreq_post_add_file(struct afb_hreq *hreq, const char *key, const char *file, const char *data, size_t size)
577 struct hreq_data *hdat = get_data(hreq, key, 1);
579 if (hdat->value == NULL) {
580 hdat->value = strdup(file);
581 if (hdat->value == NULL)
583 fd = opentempfile(&hdat->path);
584 } else if (strcmp(hdat->value, file) || hdat->path == NULL) {
587 fd = open(hdat->path, O_WRONLY|O_APPEND);
592 sz = write(fd, data, size);
594 hdat->length += (size_t)sz;
597 } else if (errno != EINTR)
604 struct afb_req afb_hreq_to_req(struct afb_hreq *hreq)
606 return (struct afb_req){ .itf = &afb_hreq_itf, .closure = hreq };
609 static struct afb_arg req_get(struct afb_hreq *hreq, const char *name)
611 struct hreq_data *hdat = get_data(hreq, name, 0);
613 return (struct afb_arg){
615 .value = hdat->value,
619 return (struct afb_arg){
621 .value = MHD_lookup_connection_value(hreq->connection, MHD_GET_ARGUMENT_KIND, name),
626 static int _iterargs_(struct json_object *obj, enum MHD_ValueKind kind, const char *key, const char *value)
628 json_object_object_add(obj, key, value ? json_object_new_string(value) : NULL);
632 static struct json_object *req_json(struct afb_hreq *hreq)
634 struct hreq_data *hdat;
635 struct json_object *obj, *val;
639 hreq->json = obj = json_object_new_object();
642 MHD_get_connection_values (hreq->connection, MHD_GET_ARGUMENT_KIND, (void*)_iterargs_, obj);
643 for (hdat = hreq->data ; hdat ; hdat = hdat->next) {
644 if (hdat->path == NULL)
645 val = hdat->value ? json_object_new_string(hdat->value) : NULL;
647 val = json_object_new_object();
650 json_object_object_add(val, "file", json_object_new_string(hdat->value));
651 json_object_object_add(val, "path", json_object_new_string(hdat->path));
654 json_object_object_add(obj, hdat->key, val);
661 static const char *req_raw(struct afb_hreq *hreq, size_t *size)
663 const char *result = json_object_get_string(req_json(hreq));
664 *size = result ? strlen(result) : 0;
668 static void req_send(struct afb_hreq *hreq, const char *buffer, size_t size)
670 afb_hreq_reply_copy(hreq, MHD_HTTP_OK, size, buffer, NULL);
673 static ssize_t send_json_cb(json_object *obj, uint64_t pos, char *buf, size_t max)
675 ssize_t len = stpncpy(buf, json_object_to_json_string(obj)+pos, max) - buf;
676 return len ? : (ssize_t)MHD_CONTENT_READER_END_OF_STREAM;
679 static void req_reply(struct afb_hreq *hreq, unsigned retcode, const char *status, const char *info, json_object *resp)
681 struct json_object *reply;
682 const char *token, *uuid;
683 struct MHD_Response *response;
685 token = afb_context_sent_token(&hreq->context);
686 uuid = afb_context_sent_uuid(&hreq->context);
688 reply = afb_msg_json_reply(status, info, resp, token, uuid);
689 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);
690 afb_hreq_reply(hreq, retcode, response, NULL);
693 static void req_fail(struct afb_hreq *hreq, const char *status, const char *info)
695 req_reply(hreq, MHD_HTTP_OK, status, info, NULL);
698 static void req_success(struct afb_hreq *hreq, json_object *obj, const char *info)
700 req_reply(hreq, MHD_HTTP_OK, "success", info, obj);
703 int afb_hreq_init_context(struct afb_hreq *hreq)
708 if (hreq->context.session != NULL)
711 uuid = afb_hreq_get_header(hreq, uuid_header);
713 uuid = afb_hreq_get_argument(hreq, uuid_arg);
715 uuid = afb_hreq_get_cookie(hreq, cookie_name);
717 token = afb_hreq_get_header(hreq, token_header);
719 token = afb_hreq_get_argument(hreq, token_arg);
721 token = afb_hreq_get_cookie(hreq, token_cookie);
723 return afb_context_connect(&hreq->context, uuid, token);
726 int afb_hreq_init_cookie(int port, const char *path, int maxage)
733 cookie_setter = NULL;
736 rc = asprintf(&cookie_name, "x-afb-uuid-%d", port);
739 rc = asprintf(&cookie_setter, "%s=%%s; Path=%s; Max-Age=%d; HttpOnly",
740 cookie_name, path, maxage);