Add comments about always setting INFER_EXTENSION.
[src/app-framework-binder.git] / src / afb-hreq.c
index 81e630b..00d4b0e 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 IoT.bzh
+ * Copyright (C) 2016, 2017 "IoT.bzh"
  * Author: José Bollo <jose.bollo@iot.bzh>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
 #endif
 
 #include "afb-method.h"
-#include "afb-req-itf.h"
+#include <afb/afb-req-itf.h>
 #include "afb-msg-json.h"
 #include "afb-context.h"
 #include "afb-hreq.h"
-#include "session.h"
+#include "afb-subcall.h"
+#include "afb-session.h"
 #include "verbose.h"
+#include "locale-root.h"
 
 #define SIZE_RESPONSE_BUFFER   8192
 
 static char empty_string[] = "";
 
-static const char uuid_header[] = "x-afb-uuid";
-static const char uuid_arg[] = "uuid";
-static const char uuid_cookie[] = "uuid";
+static const char long_key_for_uuid[] = "x-afb-uuid";
+static const char short_key_for_uuid[] = "uuid";
 
-static const char token_header[] = "x-afb-token";
-static const char token_arg[] = "token";
-static const char token_cookie[] = "token";
+static const char long_key_for_token[] = "x-afb-token";
+static const char short_key_for_token[] = "token";
+
+static const char long_key_for_reqid[] = "x-afb-reqid";
+static const char short_key_for_reqid[] = "reqid";
 
 static char *cookie_name = NULL;
 static char *cookie_setter = NULL;
@@ -73,8 +76,10 @@ static void req_fail(struct afb_hreq *hreq, const char *status, const char *info
 static void req_success(struct afb_hreq *hreq, json_object *obj, const char *info);
 static const char *req_raw(struct afb_hreq *hreq, size_t *size);
 static void req_send(struct afb_hreq *hreq, const char *buffer, size_t size);
+static int req_subscribe_unsubscribe_error(struct afb_hreq *hreq, struct afb_event event);
+static void req_subcall(struct afb_hreq *hreq, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *closure);
 
-static const struct afb_req_itf afb_hreq_itf = {
+const struct afb_req_itf afb_hreq_req_itf = {
        .json = (void*)req_json,
        .get = (void*)req_get,
        .success = (void*)req_success,
@@ -84,7 +89,12 @@ static const struct afb_req_itf afb_hreq_itf = {
        .context_get = (void*)afb_context_get,
        .context_set = (void*)afb_context_set,
        .addref = (void*)afb_hreq_addref,
-       .unref = (void*)afb_hreq_unref
+       .unref = (void*)afb_hreq_unref,
+       .session_close = (void*)afb_context_close,
+       .session_set_LOA = (void*)afb_context_change_loa,
+       .subscribe = (void*)req_subscribe_unsubscribe_error,
+       .unsubscribe = (void*)req_subscribe_unsubscribe_error,
+       .subcall = (void*)req_subcall
 };
 
 static struct hreq_data *get_data(struct afb_hreq *hreq, const char *key, int create)
@@ -264,12 +274,22 @@ static const char *mimetype_fd_name(int fd, const char *filename)
        const char *result = NULL;
 
 #if defined(INFER_EXTENSION)
+       /*
+        * Set some well-known extensions
+        * Note that it is mandatory for example for css files in order to provide
+        * right mimetype that must be text/css (otherwise chrome browser will not
+        * load correctly css file) while libmagic returns text/plain.
+        */
        const char *extension = strrchr(filename, '.');
        if (extension) {
                static const char *const known[][2] = {
                        { ".js",   "text/javascript" },
                        { ".html", "text/html" },
                        { ".css",  "text/css" },
+                       { ".ico",  "image/x-icon"},
+                       { ".png",  "image/png" },
+                       { ".svg",  "image/svg+xml" },
+                       { ".ttf",  "application/x-font-ttf"},
                        { NULL, NULL }
                };
                int i = 0;
@@ -350,13 +370,29 @@ void afb_hreq_reply_error(struct afb_hreq *hreq, unsigned int status)
        afb_hreq_reply_empty(hreq, status, NULL);
 }
 
+int afb_hreq_redirect_to_ending_slash_if_needed(struct afb_hreq *hreq)
+{
+       char *tourl;
+
+       if (hreq->url[hreq->lenurl - 1] == '/')
+               return 0;
+
+       /* the redirect is needed for reliability of relative path */
+       tourl = alloca(hreq->lenurl + 2);
+       memcpy(tourl, hreq->url, hreq->lenurl);
+       tourl[hreq->lenurl] = '/';
+       tourl[hreq->lenurl + 1] = 0;
+       afb_hreq_redirect_to(hreq, tourl, 1);
+       return 1;
+}
+
 int afb_hreq_reply_file_if_exist(struct afb_hreq *hreq, int dirfd, const char *filename)
 {
        int rc;
        int fd;
        unsigned int status;
        struct stat st;
-       char etag[1 + 2 * sizeof(int)];
+       char etag[1 + 2 * 8];
        const char *inm;
        struct MHD_Response *response;
        const char *mimetype;
@@ -387,24 +423,17 @@ int afb_hreq_reply_file_if_exist(struct afb_hreq *hreq, int dirfd, const char *f
 
        /* serve directory */
        if (S_ISDIR(st.st_mode)) {
-               static const char *indexes[] = { "index.html", NULL };
-               int i = 0;
-               rc = 0;
-               while (indexes[i] != NULL) {
-                       if (faccessat(fd, indexes[i], R_OK, 0) == 0) {
-                               if (hreq->url[hreq->lenurl - 1] != '/') {
-                                       /* the redirect is needed for reliability of relative path */
-                                       char *tourl = alloca(hreq->lenurl + 2);
-                                       memcpy(tourl, hreq->url, hreq->lenurl);
-                                       tourl[hreq->lenurl] = '/';
-                                       tourl[hreq->lenurl + 1] = 0;
-                                       rc = afb_hreq_redirect_to(hreq, tourl);
-                               } else {
+               rc = afb_hreq_redirect_to_ending_slash_if_needed(hreq);
+               if (rc == 0) {
+                       static const char *indexes[] = { "index.html", NULL };
+                       int i = 0;
+                       while (indexes[i] != NULL) {
+                               if (faccessat(fd, indexes[i], R_OK, 0) == 0) {
                                        rc = afb_hreq_reply_file_if_exist(hreq, fd, indexes[i]);
+                                       break;
                                }
-                               break;
+                               i++;
                        }
-                       i++;
                }
                close(fd);
                return rc;
@@ -469,12 +498,209 @@ int afb_hreq_reply_file(struct afb_hreq *hreq, int dirfd, const char *filename)
        return 1;
 }
 
-int afb_hreq_redirect_to(struct afb_hreq *hreq, const char *url)
+int afb_hreq_reply_locale_file_if_exist(struct afb_hreq *hreq, struct locale_search *search, const char *filename)
+{
+       int rc;
+       int fd;
+       unsigned int status;
+       struct stat st;
+       char etag[1 + 2 * 8];
+       const char *inm;
+       struct MHD_Response *response;
+       const char *mimetype;
+
+       /* Opens the file or directory */
+       fd = locale_search_open(search, filename[0] ? filename : ".", O_RDONLY);
+       if (fd < 0) {
+               if (errno == ENOENT)
+                       return 0;
+               afb_hreq_reply_error(hreq, MHD_HTTP_FORBIDDEN);
+               return 1;
+       }
+
+       /* Retrieves file's status */
+       if (fstat(fd, &st) != 0) {
+               close(fd);
+               afb_hreq_reply_error(hreq, MHD_HTTP_INTERNAL_SERVER_ERROR);
+               return 1;
+       }
+
+       /* serve directory */
+       if (S_ISDIR(st.st_mode)) {
+               rc = afb_hreq_redirect_to_ending_slash_if_needed(hreq);
+               if (rc == 0) {
+                       static const char *indexes[] = { "index.html", NULL };
+                       int i = 0;
+                       size_t length = strlen(filename);
+                       char *extname = alloca(length + 30); /* 30 is enough to old data of indexes */
+                       memcpy(extname, filename, length);
+                       if (length && extname[length - 1] != '/')
+                               extname[length++] = '/';
+                       while (rc == 0 && indexes[i] != NULL) {
+                               strcpy(extname + length, indexes[i++]);
+                               rc = afb_hreq_reply_locale_file_if_exist(hreq, search, extname);
+                       }
+               }
+               close(fd);
+               return rc;
+       }
+
+       /* Don't serve special files */
+       if (!S_ISREG(st.st_mode)) {
+               close(fd);
+               afb_hreq_reply_error(hreq, MHD_HTTP_FORBIDDEN);
+               return 1;
+       }
+
+       /* Check the method */
+       if ((hreq->method & (afb_method_get | afb_method_head)) == 0) {
+               close(fd);
+               afb_hreq_reply_error(hreq, MHD_HTTP_METHOD_NOT_ALLOWED);
+               return 1;
+       }
+
+       /* computes the etag */
+       sprintf(etag, "%08X%08X", ((int)(st.st_mtim.tv_sec) ^ (int)(st.st_mtim.tv_nsec)), (int)(st.st_size));
+
+       /* checks the etag */
+       inm = MHD_lookup_connection_value(hreq->connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_IF_NONE_MATCH);
+       if (inm && 0 == strcmp(inm, etag)) {
+               /* etag ok, return NOT MODIFIED */
+               close(fd);
+               DEBUG("Not Modified: [%s]", filename);
+               response = MHD_create_response_from_buffer(0, empty_string, MHD_RESPMEM_PERSISTENT);
+               status = MHD_HTTP_NOT_MODIFIED;
+       } else {
+               /* check the size */
+               if (st.st_size != (off_t) (size_t) st.st_size) {
+                       close(fd);
+                       afb_hreq_reply_error(hreq, MHD_HTTP_INTERNAL_SERVER_ERROR);
+                       return 1;
+               }
+
+               /* create the response */
+               response = MHD_create_response_from_fd((size_t) st.st_size, fd);
+               status = MHD_HTTP_OK;
+
+               /* set the type */
+               mimetype = mimetype_fd_name(fd, filename);
+               if (mimetype != NULL)
+                       MHD_add_response_header(response, MHD_HTTP_HEADER_CONTENT_TYPE, mimetype);
+       }
+
+       /* fills the value and send */
+       afb_hreq_reply(hreq, status, response,
+                       MHD_HTTP_HEADER_CACHE_CONTROL, hreq->cacheTimeout,
+                       MHD_HTTP_HEADER_ETAG, etag,
+                       NULL);
+       return 1;
+}
+
+int afb_hreq_reply_locale_file(struct afb_hreq *hreq, struct locale_search *search, const char *filename)
+{
+       int rc = afb_hreq_reply_locale_file_if_exist(hreq, search, filename);
+       if (rc == 0)
+               afb_hreq_reply_error(hreq, MHD_HTTP_NOT_FOUND);
+       return 1;
+}
+
+struct _mkq_ {
+       int count;
+       size_t length;
+       size_t alloc;
+       char *text;
+};
+
+static void _mkq_add_(struct _mkq_ *mkq, char value)
+{
+       char *text = mkq->text;
+       if (text != NULL) {
+               if (mkq->length == mkq->alloc) {
+                       mkq->alloc += 100;
+                       text = realloc(text, mkq->alloc);
+                       if (text == NULL) {
+                               free(mkq->text);
+                               mkq->text = NULL;
+                               return;
+                       }
+                       mkq->text = text;
+               }
+               text[mkq->length++] = value;
+       }
+}
+
+static void _mkq_add_hex_(struct _mkq_ *mkq, char value)
+{
+       _mkq_add_(mkq, (char)(value < 10 ? value + '0' : value + 'A' - 10));
+}
+
+static void _mkq_add_esc_(struct _mkq_ *mkq, char value)
+{
+       _mkq_add_(mkq, '%');
+       _mkq_add_hex_(mkq, (char)((value >> 4) & 15));
+       _mkq_add_hex_(mkq, (char)(value & 15));
+}
+
+static void _mkq_add_char_(struct _mkq_ *mkq, char value)
+{
+       if (value <= ' ' || value >= 127)
+               _mkq_add_esc_(mkq, value);
+       else
+               switch(value) {
+               case '=':
+               case '&':
+               case '%':
+                       _mkq_add_esc_(mkq, value);
+                       break;
+               default:
+                       _mkq_add_(mkq, value);
+               }
+}
+
+static void _mkq_append_(struct _mkq_ *mkq, const char *value)
+{
+       while(*value)
+               _mkq_add_char_(mkq, *value++);
+}
+
+static int _mkquery_(struct _mkq_ *mkq, enum MHD_ValueKind kind, const char *key, const char *value)
+{
+       _mkq_add_(mkq, mkq->count++ ? '&' : '?');
+       _mkq_append_(mkq, key);
+       if (value != NULL) {
+               _mkq_add_(mkq, '=');
+               _mkq_append_(mkq, value);
+       }
+       return 1;
+}
+
+static char *url_with_query(struct afb_hreq *hreq, const char *url)
 {
+       struct _mkq_ mkq;
+
+       mkq.count = 0;
+       mkq.length = strlen(url);
+       mkq.alloc = mkq.length + 1000;
+       mkq.text = malloc(mkq.alloc);
+       if (mkq.text != NULL) {
+               strcpy(mkq.text, url);
+               MHD_get_connection_values(hreq->connection, MHD_GET_ARGUMENT_KIND, (void*)_mkquery_, &mkq);
+               _mkq_add_(&mkq, 0);
+       }
+       return mkq.text;
+}
+
+void afb_hreq_redirect_to(struct afb_hreq *hreq, const char *url, int add_query_part)
+{
+       const char *to;
+       char *wqp;
+
+       wqp = add_query_part ? url_with_query(hreq, url) : NULL;
+       to = wqp ? : url;
        afb_hreq_reply_static(hreq, MHD_HTTP_MOVED_PERMANENTLY, 0, NULL,
-                       MHD_HTTP_HEADER_LOCATION, url, NULL);
+                       MHD_HTTP_HEADER_LOCATION, to, NULL);
        DEBUG("redirect from [%s] to [%s]", hreq->url, url);
-       return 1;
+       free(wqp);
 }
 
 const char *afb_hreq_get_cookie(struct afb_hreq *hreq, const char *name)
@@ -602,11 +828,12 @@ int afb_hreq_post_add_file(struct afb_hreq *hreq, const char *key, const char *f
 
 struct afb_req afb_hreq_to_req(struct afb_hreq *hreq)
 {
-       return (struct afb_req){ .itf = &afb_hreq_itf, .closure = hreq };
+       return (struct afb_req){ .itf = &afb_hreq_req_itf, .closure = hreq };
 }
 
 static struct afb_arg req_get(struct afb_hreq *hreq, const char *name)
 {
+       const char *value;
        struct hreq_data *hdat = get_data(hreq, name, 0);
        if (hdat)
                return (struct afb_arg){
@@ -614,10 +841,11 @@ static struct afb_arg req_get(struct afb_hreq *hreq, const char *name)
                        .value = hdat->value,
                        .path = hdat->path
                };
-               
+
+       value = MHD_lookup_connection_value(hreq->connection, MHD_GET_ARGUMENT_KIND, name);
        return (struct afb_arg){
-               .name = name,
-               .value = MHD_lookup_connection_value(hreq->connection, MHD_GET_ARGUMENT_KIND, name),
+               .name = value == NULL ? NULL : name,
+               .value = value,
                .path = NULL
        };
 }
@@ -671,21 +899,23 @@ static void req_send(struct afb_hreq *hreq, const char *buffer, size_t size)
 
 static ssize_t send_json_cb(json_object *obj, uint64_t pos, char *buf, size_t max)
 {
-       ssize_t len = stpncpy(buf, json_object_to_json_string(obj)+pos, max) - buf;
+       ssize_t len = stpncpy(buf, json_object_to_json_string_ext(obj, JSON_C_TO_STRING_PLAIN)+pos, max) - buf;
        return len ? : (ssize_t)MHD_CONTENT_READER_END_OF_STREAM;
 }
 
 static void req_reply(struct afb_hreq *hreq, unsigned retcode, const char *status, const char *info, json_object *resp)
 {
        struct json_object *reply;
-       const char *token, *uuid;
+       const char *reqid;
        struct MHD_Response *response;
 
-       token = afb_context_sent_token(&hreq->context);
-       uuid = afb_context_sent_uuid(&hreq->context);
+       reqid = afb_hreq_get_argument(hreq, long_key_for_reqid);
+       if (reqid == NULL)
+               reqid = afb_hreq_get_argument(hreq, short_key_for_reqid);
+
+       reply = afb_msg_json_reply(status, info, resp, &hreq->context, reqid);
 
-       reply = afb_msg_json_reply(status, info, resp, token, uuid);
-       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);
+       response = MHD_create_response_from_callback((uint64_t)strlen(json_object_to_json_string_ext(reply, JSON_C_TO_STRING_PLAIN)), SIZE_RESPONSE_BUFFER, (void*)send_json_cb, reply, (void*)json_object_put);
        afb_hreq_reply(hreq, retcode, response, NULL);
 }
 
@@ -699,6 +929,17 @@ static void req_success(struct afb_hreq *hreq, json_object *obj, const char *inf
        req_reply(hreq, MHD_HTTP_OK, "success", info, obj);
 }
 
+static int req_subscribe_unsubscribe_error(struct afb_hreq *hreq, struct afb_event event)
+{
+       errno = EINVAL;
+       return -1;
+}
+
+static void req_subcall(struct afb_hreq *hreq, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *closure)
+{
+       afb_subcall(&hreq->context, api, verb, args, callback, closure, (struct afb_req){ .itf = &afb_hreq_req_itf, .closure = hreq });
+}
+
 int afb_hreq_init_context(struct afb_hreq *hreq)
 {
        const char *uuid;
@@ -707,17 +948,19 @@ int afb_hreq_init_context(struct afb_hreq *hreq)
        if (hreq->context.session != NULL)
                return 0;
 
-       uuid = afb_hreq_get_header(hreq, uuid_header);
+       uuid = afb_hreq_get_header(hreq, long_key_for_uuid);
        if (uuid == NULL)
-               uuid = afb_hreq_get_argument(hreq, uuid_arg);
+               uuid = afb_hreq_get_argument(hreq, long_key_for_uuid);
        if (uuid == NULL)
                uuid = afb_hreq_get_cookie(hreq, cookie_name);
+       if (uuid == NULL)
+               uuid = afb_hreq_get_argument(hreq, short_key_for_uuid);
 
-       token = afb_hreq_get_header(hreq, token_header);
+       token = afb_hreq_get_header(hreq, long_key_for_token);
        if (token == NULL)
-               token = afb_hreq_get_argument(hreq, token_arg);
+               token = afb_hreq_get_argument(hreq, long_key_for_token);
        if (token == NULL)
-               token = afb_hreq_get_cookie(hreq, token_cookie);
+               token = afb_hreq_get_argument(hreq, short_key_for_token);
 
        return afb_context_connect(&hreq->context, uuid, token);
 }
@@ -732,7 +975,7 @@ int afb_hreq_init_cookie(int port, const char *path, int maxage)
        cookie_setter = NULL;
 
        path = path ? : "/";
-       rc = asprintf(&cookie_name, "x-afb-uuid-%d", port);
+       rc = asprintf(&cookie_name, "%s-%d", long_key_for_uuid, port);
        if (rc < 0)
                return 0;
        rc = asprintf(&cookie_setter, "%s=%%s; Path=%s; Max-Age=%d; HttpOnly",