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 long_key_for_uuid[] = "x-afb-uuid";
48 static const char short_key_for_uuid[] = "uuid";
50 static const char long_key_for_token[] = "x-afb-token";
51 static const char short_key_for_token[] = "token";
53 static const char long_key_for_reqid[] = "x-afb-reqid";
54 static const char short_key_for_reqid[] = "reqid";
56 static char *cookie_name = NULL;
57 static char *cookie_setter = NULL;
58 static char *tmp_pattern = NULL;
61 * Structure for storing key/values read from POST requests
64 struct hreq_data *next; /* chain to next data */
65 char *key; /* key name */
66 size_t length; /* length of the value (used for appending) */
67 char *value; /* the value (or original filename) */
68 char *path; /* path of the file saved */
71 static struct json_object *req_json(struct afb_hreq *hreq);
72 static struct afb_arg req_get(struct afb_hreq *hreq, const char *name);
73 static void req_fail(struct afb_hreq *hreq, const char *status, const char *info);
74 static void req_success(struct afb_hreq *hreq, json_object *obj, const char *info);
75 static const char *req_raw(struct afb_hreq *hreq, size_t *size);
76 static void req_send(struct afb_hreq *hreq, const char *buffer, size_t size);
78 static const struct afb_req_itf afb_hreq_itf = {
79 .json = (void*)req_json,
80 .get = (void*)req_get,
81 .success = (void*)req_success,
82 .fail = (void*)req_fail,
83 .raw = (void*)req_raw,
84 .send = (void*)req_send,
85 .context_get = (void*)afb_context_get,
86 .context_set = (void*)afb_context_set,
87 .addref = (void*)afb_hreq_addref,
88 .unref = (void*)afb_hreq_unref,
89 .session_close = (void*)afb_context_close,
90 .session_set_LOA = (void*)afb_context_change_loa
93 static struct hreq_data *get_data(struct afb_hreq *hreq, const char *key, int create)
95 struct hreq_data *data = hreq->data;
96 while (data != NULL) {
97 if (!strcasecmp(data->key, key))
102 data = calloc(1, sizeof *data);
104 data->key = strdup(key);
105 if (data->key == NULL) {
109 data->next = hreq->data;
117 /* a valid subpath is a relative path not looking deeper than root using .. */
118 static int validsubpath(const char *subpath)
123 switch (subpath[i++]) {
127 if (subpath[i] == '/') {
131 if (subpath[i++] == '.') {
137 if (subpath[i++] == '/') {
144 while (subpath[i] && subpath[i] != '/')
154 static void afb_hreq_reply_v(struct afb_hreq *hreq, unsigned status, struct MHD_Response *response, va_list args)
159 if (hreq->replied != 0)
162 k = va_arg(args, const char *);
164 v = va_arg(args, const char *);
165 MHD_add_response_header(response, k, v);
166 k = va_arg(args, const char *);
168 v = afb_context_sent_uuid(&hreq->context);
169 if (v != NULL && asprintf(&cookie, cookie_setter, v) > 0) {
170 MHD_add_response_header(response, MHD_HTTP_HEADER_SET_COOKIE, cookie);
173 MHD_queue_response(hreq->connection, status, response);
174 MHD_destroy_response(response);
177 if (hreq->suspended != 0) {
178 extern void run_micro_httpd(struct afb_hsrv *hsrv);
179 MHD_resume_connection (hreq->connection);
181 run_micro_httpd(hreq->hsrv);
185 void afb_hreq_reply(struct afb_hreq *hreq, unsigned status, struct MHD_Response *response, ...)
188 va_start(args, response);
189 afb_hreq_reply_v(hreq, status, response, args);
193 void afb_hreq_reply_empty(struct afb_hreq *hreq, unsigned status, ...)
196 va_start(args, status);
197 afb_hreq_reply_v(hreq, status, MHD_create_response_from_buffer(0, NULL, MHD_RESPMEM_PERSISTENT), args);
201 void afb_hreq_reply_static(struct afb_hreq *hreq, unsigned status, size_t size, const char *buffer, ...)
204 va_start(args, buffer);
205 afb_hreq_reply_v(hreq, status, MHD_create_response_from_buffer((unsigned)size, (char*)buffer, MHD_RESPMEM_PERSISTENT), args);
209 void afb_hreq_reply_copy(struct afb_hreq *hreq, unsigned status, size_t size, const char *buffer, ...)
212 va_start(args, buffer);
213 afb_hreq_reply_v(hreq, status, MHD_create_response_from_buffer((unsigned)size, (char*)buffer, MHD_RESPMEM_MUST_COPY), args);
217 void afb_hreq_reply_free(struct afb_hreq *hreq, unsigned status, size_t size, char *buffer, ...)
220 va_start(args, buffer);
221 afb_hreq_reply_v(hreq, status, MHD_create_response_from_buffer((unsigned)size, buffer, MHD_RESPMEM_MUST_FREE), args);
225 #if defined(USE_MAGIC_MIME_TYPE)
227 #if !defined(MAGIC_DB)
228 #define MAGIC_DB "/usr/share/misc/magic.mgc"
231 static magic_t lazy_libmagic()
234 static magic_t result = NULL;
238 /* MAGIC_MIME tells magic to return a mime of the file,
239 but you can specify different things */
240 INFO("Loading mimetype default magic database");
241 result = magic_open(MAGIC_MIME_TYPE);
242 if (result == NULL) {
243 ERROR("unable to initialize magic library");
245 /* Warning: should not use NULL for DB
246 [libmagic bug wont pass efence check] */
247 else if (magic_load(result, MAGIC_DB) != 0) {
248 ERROR("cannot load magic database: %s", magic_error(result));
257 static const char *magic_mimetype_fd(int fd)
259 magic_t lib = lazy_libmagic();
260 return lib ? magic_descriptor(lib, fd) : NULL;
265 static const char *mimetype_fd_name(int fd, const char *filename)
267 const char *result = NULL;
269 #if defined(INFER_EXTENSION)
270 const char *extension = strrchr(filename, '.');
272 static const char *const known[][2] = {
273 { ".js", "text/javascript" },
274 { ".html", "text/html" },
275 { ".css", "text/css" },
279 while (known[i][0]) {
280 if (!strcasecmp(extension, known[i][0])) {
281 result = known[i][1];
288 #if defined(USE_MAGIC_MIME_TYPE)
290 result = magic_mimetype_fd(fd);
295 void afb_hreq_addref(struct afb_hreq *hreq)
300 void afb_hreq_unref(struct afb_hreq *hreq)
302 struct hreq_data *data;
304 if (hreq == NULL || --hreq->refcount)
307 if (hreq->postform != NULL)
308 MHD_destroy_post_processor(hreq->postform);
309 for (data = hreq->data; data; data = hreq->data) {
310 hreq->data = data->next;
319 afb_context_disconnect(&hreq->context);
320 json_object_put(hreq->json);
325 * Removes the 'prefix' of 'length' from the tail of 'hreq'
326 * if and only if the prefix exists and is terminated by a leading
329 int afb_hreq_unprefix(struct afb_hreq *hreq, const char *prefix, size_t length)
331 /* check the prefix ? */
332 if (length > hreq->lentail || (hreq->tail[length] && hreq->tail[length] != '/')
333 || strncasecmp(prefix, hreq->tail, length))
336 /* removes successives / */
337 while (length < hreq->lentail && hreq->tail[length + 1] == '/')
340 /* update the tail */
341 hreq->lentail -= length;
342 hreq->tail += length;
346 int afb_hreq_valid_tail(struct afb_hreq *hreq)
348 return validsubpath(hreq->tail);
351 void afb_hreq_reply_error(struct afb_hreq *hreq, unsigned int status)
353 afb_hreq_reply_empty(hreq, status, NULL);
356 int afb_hreq_reply_file_if_exist(struct afb_hreq *hreq, int dirfd, const char *filename)
362 char etag[1 + 2 * sizeof(int)];
364 struct MHD_Response *response;
365 const char *mimetype;
367 /* Opens the file or directory */
369 fd = openat(dirfd, filename, O_RDONLY);
373 afb_hreq_reply_error(hreq, MHD_HTTP_FORBIDDEN);
379 afb_hreq_reply_error(hreq, MHD_HTTP_INTERNAL_SERVER_ERROR);
384 /* Retrieves file's status */
385 if (fstat(fd, &st) != 0) {
387 afb_hreq_reply_error(hreq, MHD_HTTP_INTERNAL_SERVER_ERROR);
391 /* serve directory */
392 if (S_ISDIR(st.st_mode)) {
393 static const char *indexes[] = { "index.html", NULL };
396 while (indexes[i] != NULL) {
397 if (faccessat(fd, indexes[i], R_OK, 0) == 0) {
398 if (hreq->url[hreq->lenurl - 1] != '/') {
399 /* the redirect is needed for reliability of relative path */
400 char *tourl = alloca(hreq->lenurl + 2);
401 memcpy(tourl, hreq->url, hreq->lenurl);
402 tourl[hreq->lenurl] = '/';
403 tourl[hreq->lenurl + 1] = 0;
404 rc = afb_hreq_redirect_to(hreq, tourl);
406 rc = afb_hreq_reply_file_if_exist(hreq, fd, indexes[i]);
416 /* Don't serve special files */
417 if (!S_ISREG(st.st_mode)) {
419 afb_hreq_reply_error(hreq, MHD_HTTP_FORBIDDEN);
423 /* Check the method */
424 if ((hreq->method & (afb_method_get | afb_method_head)) == 0) {
426 afb_hreq_reply_error(hreq, MHD_HTTP_METHOD_NOT_ALLOWED);
430 /* computes the etag */
431 sprintf(etag, "%08X%08X", ((int)(st.st_mtim.tv_sec) ^ (int)(st.st_mtim.tv_nsec)), (int)(st.st_size));
433 /* checks the etag */
434 inm = MHD_lookup_connection_value(hreq->connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_IF_NONE_MATCH);
435 if (inm && 0 == strcmp(inm, etag)) {
436 /* etag ok, return NOT MODIFIED */
438 DEBUG("Not Modified: [%s]", filename);
439 response = MHD_create_response_from_buffer(0, empty_string, MHD_RESPMEM_PERSISTENT);
440 status = MHD_HTTP_NOT_MODIFIED;
443 if (st.st_size != (off_t) (size_t) st.st_size) {
445 afb_hreq_reply_error(hreq, MHD_HTTP_INTERNAL_SERVER_ERROR);
449 /* create the response */
450 response = MHD_create_response_from_fd((size_t) st.st_size, fd);
451 status = MHD_HTTP_OK;
454 mimetype = mimetype_fd_name(fd, filename);
455 if (mimetype != NULL)
456 MHD_add_response_header(response, MHD_HTTP_HEADER_CONTENT_TYPE, mimetype);
459 /* fills the value and send */
460 afb_hreq_reply(hreq, status, response,
461 MHD_HTTP_HEADER_CACHE_CONTROL, hreq->cacheTimeout,
462 MHD_HTTP_HEADER_ETAG, etag,
467 int afb_hreq_reply_file(struct afb_hreq *hreq, int dirfd, const char *filename)
469 int rc = afb_hreq_reply_file_if_exist(hreq, dirfd, filename);
471 afb_hreq_reply_error(hreq, MHD_HTTP_NOT_FOUND);
475 int afb_hreq_redirect_to(struct afb_hreq *hreq, const char *url)
477 /* TODO: append the query part! */
478 afb_hreq_reply_static(hreq, MHD_HTTP_MOVED_PERMANENTLY, 0, NULL,
479 MHD_HTTP_HEADER_LOCATION, url, NULL);
480 DEBUG("redirect from [%s] to [%s]", hreq->url, url);
484 const char *afb_hreq_get_cookie(struct afb_hreq *hreq, const char *name)
486 return MHD_lookup_connection_value(hreq->connection, MHD_COOKIE_KIND, name);
489 const char *afb_hreq_get_argument(struct afb_hreq *hreq, const char *name)
491 struct hreq_data *data = get_data(hreq, name, 0);
492 return data ? data->value : MHD_lookup_connection_value(hreq->connection, MHD_GET_ARGUMENT_KIND, name);
495 const char *afb_hreq_get_header(struct afb_hreq *hreq, const char *name)
497 return MHD_lookup_connection_value(hreq->connection, MHD_HEADER_KIND, name);
500 int afb_hreq_post_add(struct afb_hreq *hreq, const char *key, const char *data, size_t size)
503 struct hreq_data *hdat = get_data(hreq, key, 1);
504 if (hdat->path != NULL) {
507 p = realloc(hdat->value, hdat->length + size + 1);
512 memcpy(&hdat->value[hdat->length], data, size);
513 hdat->length += size;
514 hdat->value[hdat->length] = 0;
518 int afb_hreq_init_download_path(const char *directory)
524 if (access(directory, R_OK|W_OK)) {
525 /* no read/write access */
528 if (stat(directory, &st)) {
532 if (!S_ISDIR(st.st_mode)) {
533 /* not a directory */
537 n = strlen(directory);
538 while(n > 1 && directory[n-1] == '/') n--;
541 /* can't allocate memory */
545 memcpy(p, directory, n);
559 static int opentempfile(char **path)
564 fname = strdup(tmp_pattern ? : "XXXXXX"); /* TODO improve the path */
568 fd = mkostemp(fname, O_CLOEXEC|O_WRONLY);
576 int afb_hreq_post_add_file(struct afb_hreq *hreq, const char *key, const char *file, const char *data, size_t size)
580 struct hreq_data *hdat = get_data(hreq, key, 1);
582 if (hdat->value == NULL) {
583 hdat->value = strdup(file);
584 if (hdat->value == NULL)
586 fd = opentempfile(&hdat->path);
587 } else if (strcmp(hdat->value, file) || hdat->path == NULL) {
590 fd = open(hdat->path, O_WRONLY|O_APPEND);
595 sz = write(fd, data, size);
597 hdat->length += (size_t)sz;
600 } else if (errno != EINTR)
607 struct afb_req afb_hreq_to_req(struct afb_hreq *hreq)
609 return (struct afb_req){ .itf = &afb_hreq_itf, .closure = hreq };
612 static struct afb_arg req_get(struct afb_hreq *hreq, const char *name)
615 struct hreq_data *hdat = get_data(hreq, name, 0);
617 return (struct afb_arg){
619 .value = hdat->value,
623 value = MHD_lookup_connection_value(hreq->connection, MHD_GET_ARGUMENT_KIND, name);
624 return (struct afb_arg){
625 .name = value == NULL ? NULL : name,
631 static int _iterargs_(struct json_object *obj, enum MHD_ValueKind kind, const char *key, const char *value)
633 json_object_object_add(obj, key, value ? json_object_new_string(value) : NULL);
637 static struct json_object *req_json(struct afb_hreq *hreq)
639 struct hreq_data *hdat;
640 struct json_object *obj, *val;
644 hreq->json = obj = json_object_new_object();
647 MHD_get_connection_values (hreq->connection, MHD_GET_ARGUMENT_KIND, (void*)_iterargs_, obj);
648 for (hdat = hreq->data ; hdat ; hdat = hdat->next) {
649 if (hdat->path == NULL)
650 val = hdat->value ? json_object_new_string(hdat->value) : NULL;
652 val = json_object_new_object();
655 json_object_object_add(val, "file", json_object_new_string(hdat->value));
656 json_object_object_add(val, "path", json_object_new_string(hdat->path));
659 json_object_object_add(obj, hdat->key, val);
666 static const char *req_raw(struct afb_hreq *hreq, size_t *size)
668 const char *result = json_object_get_string(req_json(hreq));
669 *size = result ? strlen(result) : 0;
673 static void req_send(struct afb_hreq *hreq, const char *buffer, size_t size)
675 afb_hreq_reply_copy(hreq, MHD_HTTP_OK, size, buffer, NULL);
678 static ssize_t send_json_cb(json_object *obj, uint64_t pos, char *buf, size_t max)
680 ssize_t len = stpncpy(buf, json_object_to_json_string(obj)+pos, max) - buf;
681 return len ? : (ssize_t)MHD_CONTENT_READER_END_OF_STREAM;
684 static void req_reply(struct afb_hreq *hreq, unsigned retcode, const char *status, const char *info, json_object *resp)
686 struct json_object *reply, *request;
687 const char *token, *uuid, *reqid;
688 struct MHD_Response *response;
690 token = afb_context_sent_token(&hreq->context);
691 uuid = afb_context_sent_uuid(&hreq->context);
693 reply = afb_msg_json_reply(status, info, resp, token, uuid);
695 reqid = afb_hreq_get_argument(hreq, long_key_for_reqid);
697 reqid = afb_hreq_get_argument(hreq, short_key_for_reqid);
698 if (reqid != NULL && json_object_object_get_ex(reply, "request", &request))
699 json_object_object_add (request, short_key_for_reqid, json_object_new_string(reqid));
701 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);
702 afb_hreq_reply(hreq, retcode, response, NULL);
705 static void req_fail(struct afb_hreq *hreq, const char *status, const char *info)
707 req_reply(hreq, MHD_HTTP_OK, status, info, NULL);
710 static void req_success(struct afb_hreq *hreq, json_object *obj, const char *info)
712 req_reply(hreq, MHD_HTTP_OK, "success", info, obj);
715 int afb_hreq_init_context(struct afb_hreq *hreq)
720 if (hreq->context.session != NULL)
723 uuid = afb_hreq_get_header(hreq, long_key_for_uuid);
725 uuid = afb_hreq_get_argument(hreq, long_key_for_uuid);
727 uuid = afb_hreq_get_cookie(hreq, cookie_name);
729 uuid = afb_hreq_get_argument(hreq, short_key_for_uuid);
731 token = afb_hreq_get_header(hreq, long_key_for_token);
733 token = afb_hreq_get_argument(hreq, long_key_for_token);
735 token = afb_hreq_get_argument(hreq, short_key_for_token);
737 return afb_context_connect(&hreq->context, uuid, token);
740 int afb_hreq_init_cookie(int port, const char *path, int maxage)
747 cookie_setter = NULL;
750 rc = asprintf(&cookie_name, "%s-%d", long_key_for_uuid, port);
753 rc = asprintf(&cookie_setter, "%s=%%s; Path=%s; Max-Age=%d; HttpOnly",
754 cookie_name, path, maxage);