src/http-svc.c

   1 /*
   2  * Copyright (C) 2015 "IoT.bzh"
   3  * Author "Fulup Ar Foll"
   4  *
   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.
   9  *
  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.
  14  *
  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/>.
  17  *
  18  * Handle standard HTTP request
  19  *    Features/Restriction:
  20     - handle ETAG to limit upload to modified/new files [cache default 3600s]
  21     - handles redirect to index.htlm when path is a directory [code 301]
  22     - only support GET method
  23     - does not follow link.
  24
  25    References: https://www.gnu.org/software/libmicrohttpd/manual/html_node/index.html#Top
  26    http://libmicrohttpd.sourcearchive.com/documentation/0.4.2/microhttpd_8h.html
  27    https://gnunet.org/svn/libmicrohttpd/src/examples/fileserver_example_external_select.c
  28    https://github.com/json-c/json-c
  29    POST https://www.gnu.org/software/libmicrohttpd/manual/html_node/microhttpd_002dpost.html#microhttpd_002dpost
  30  */
  31
  32
  33 #include <microhttpd.h>
  34
  35 #include <sys/stat.h>
  36 #include "../include/local-def.h"
  37
  38 // let's compute fixed URL length only once
  39 static apiUrlLen=0;
  40 static baseUrlLen=0;
  41 static rootUrlLen=0;
  42
  43 // proto missing from GCC
  44 char *strcasestr(const char *haystack, const char *needle);
  45
  46 static int rqtcount = 0;  // dummy request rqtcount to make each message be different
  47 static int postcount = 0;
  48
  49 // try to open libmagic to handle mime types
  50 static AFB_error initLibMagic (AFB_session *session) {
  51
  52     /*MAGIC_MIME tells magic to return a mime of the file, but you can specify different things*/
  53     if (verbose) printf("Loading mimetype default magic database\n");
  54
  55     session->magic = magic_open(MAGIC_MIME_TYPE);
  56     if (session->magic == NULL) {
  57         fprintf(stderr,"ERROR: unable to initialize magic library\n");
  58         return AFB_FAIL;
  59     }
  60
  61     // Warning: should not use NULL for DB [libmagic bug wont pass efence check]
  62     if (magic_load(session->magic, MAGIC_DB) != 0) {
  63         fprintf(stderr,"cannot load magic database - %s\n", magic_error(session->magic));
  64         magic_close(session->magic);
  65         return AFB_FAIL;
  66     }
  67
  68     return AFB_SUCCESS;
  69 }
  70
  71 // Because of POST call multiple time requestApi we need to free POST handle here
  72 static void endRequest (void *cls, struct MHD_Connection *connection, void **con_cls, enum MHD_RequestTerminationCode toe) {
  73   AFB_PostHandle *posthandle = *con_cls;
  74
  75   // if post handle was used let's free everything
  76   if (posthandle != NULL) endPostRequest (posthandle);
  77 }
  78
  79
  80 // Create check etag value
  81 STATIC void computeEtag(char *etag, int maxlen, struct stat *sbuf) {
  82     int time;
  83     time = sbuf->st_mtim.tv_sec;
  84     snprintf(etag, maxlen, "%d", time);
  85 }
  86
  87 STATIC int servFile (struct MHD_Connection *connection, AFB_session *session, const char *url, AFB_staticfile *staticfile) {
  88     const char *etagCache, *mimetype;
  89     char etagValue[15];
  90     struct MHD_Response *response;
  91     struct stat sbuf;
  92     int ret;
  93
  94     if (fstat (staticfile->fd, &sbuf) != 0) {
  95         fprintf(stderr, "Fail to stat file: [%s] error:%s\n", staticfile->path, strerror(errno));
  96         goto abortRequest;
  97     }
  98
  99     // if url is a directory let's add index.html and redirect client
 100     if (S_ISDIR (sbuf.st_mode)) {
 101         close (staticfile->fd); // close directory check for Index
 102
 103         // No trailing '/'. Let's add one and redirect for relative paths to work
 104         if (url [strlen (url) -1] != '/') {
 105             response = MHD_create_response_from_buffer(0,"", MHD_RESPMEM_PERSISTENT);
 106             strncpy(staticfile->path, url, sizeof (staticfile->path));
 107             strncat(staticfile->path, "/", sizeof (staticfile->path));
 108             MHD_add_response_header (response, "Location", staticfile->path);
 109             MHD_queue_response (connection, MHD_HTTP_MOVED_PERMANENTLY, response);
 110             if (verbose) fprintf (stderr,"Adding trailing '/' [%s]\n",staticfile->path);
 111             goto sendRequest;
 112         }
 113
 114         strncat (staticfile->path, OPA_INDEX, sizeof (staticfile->path));
 115         if (-1 == (staticfile->fd = open(staticfile->path, O_RDONLY)) || (fstat (staticfile->fd, &sbuf) != 0)) {
 116            fprintf(stderr, "No Index.html in direcory [%s]\n", staticfile->path);
 117            goto abortRequest;
 118         }
 119     } else if (! S_ISREG (sbuf.st_mode)) { // only standard file any other one including symbolic links are refused.
 120         close (staticfile->fd); // nothing useful to do with this file
 121         fprintf (stderr, "Fail file: [%s] is not a regular file\n", staticfile->path);
 122         const char *errorstr = "<html><body>Application Framework Binder Invalid file type</body></html>";
 123         response = MHD_create_response_from_buffer (strlen (errorstr),
 124                      (void *) errorstr,  MHD_RESPMEM_PERSISTENT);
 125         MHD_queue_response (connection, MHD_HTTP_INTERNAL_SERVER_ERROR, response);
 126         goto sendRequest;
 127     }
 128
 129     // https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching?hl=fr
 130     // ftp://ftp.heanet.ie/disk1/www.gnu.org/software/libmicrohttpd/doxygen/dc/d0c/microhttpd_8h.html
 131
 132     // Check etag value and load file only when modification date changes
 133     etagCache = MHD_lookup_connection_value(connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_IF_NONE_MATCH);
 134     computeEtag(etagValue, sizeof (etagValue), &sbuf);
 135
 136     if (etagCache != NULL && strcmp(etagValue, etagCache) == 0) {
 137         close(staticfile->fd); // file did not change since last upload
 138         if (verbose) fprintf(stderr, "Not Modify: [%s]\n", staticfile->path);
 139         response = MHD_create_response_from_buffer(0, "", MHD_RESPMEM_PERSISTENT);
 140         MHD_add_response_header(response, MHD_HTTP_HEADER_CACHE_CONTROL, session->cacheTimeout); // default one hour cache
 141         MHD_add_response_header(response, MHD_HTTP_HEADER_ETAG, etagValue);
 142         MHD_queue_response(connection, MHD_HTTP_NOT_MODIFIED, response);
 143
 144     } else { // it's a new file, we need to upload it to client
 145         // if we have magic let's try to guest mime type
 146         if (session->magic) {
 147            mimetype= magic_descriptor(session->magic, staticfile->fd);
 148            if (mimetype != NULL)  MHD_add_response_header (response, MHD_HTTP_HEADER_CONTENT_TYPE, mimetype);
 149         } else mimetype="application/unknown";
 150
 151         if (verbose) fprintf(stderr, "Serving: [%s] mime=%s\n", staticfile->path, mimetype);
 152         response = MHD_create_response_from_fd(sbuf.st_size, staticfile->fd);
 153         MHD_add_response_header(response, MHD_HTTP_HEADER_CACHE_CONTROL, session->cacheTimeout); // default one hour cache
 154         MHD_add_response_header(response, MHD_HTTP_HEADER_ETAG, etagValue);
 155         MHD_queue_response(connection, MHD_HTTP_OK, response);
 156     }
 157
 158 sendRequest:
 159     MHD_destroy_response(response);
 160     return (MHD_YES);
 161
 162 abortRequest:
 163     return (FAILED);
 164 }
 165
 166
 167 // this function return either Index.htlm or a redirect to /#!route to make angular happy
 168 STATIC int redirectHTML5(struct MHD_Connection *connection, AFB_session *session, const char* url) {
 169
 170     int fd;
 171     int ret;
 172     struct MHD_Response *response;
 173     AFB_staticfile staticfile;
 174
 175     // Url match /opa/xxxx should redirect to "/opa/#!page" to force index.html reload
 176     strncpy(staticfile.path, session->config->rootbase, sizeof (staticfile.path));
 177     strncat(staticfile.path, "/#!", sizeof (staticfile.path));
 178     strncat(staticfile.path, &url[1], sizeof (staticfile.path));
 179     response = MHD_create_response_from_buffer(0,"", MHD_RESPMEM_PERSISTENT);
 180     MHD_add_response_header (response, "Location", staticfile.path);
 181     MHD_queue_response (connection, MHD_HTTP_MOVED_PERMANENTLY, response);
 182     if (verbose) fprintf (stderr,"checkHTML5 redirect to [%s]\n",staticfile.path);
 183     return (MHD_YES);
 184 }
 185
 186
 187 // minimal httpd file server for static HTML,JS,CSS,etc...
 188 STATIC int requestFile(struct MHD_Connection *connection, AFB_session *session, const char* url) {
 189     int fd, ret, idx;
 190     AFB_staticfile staticfile;
 191     char *requestdir, *requesturl;
 192
 193     // default search for file is rootdir base
 194     requestdir= session->config->rootdir;
 195     requesturl=(char*)url;
 196
 197     // Check for optional aliases
 198     for (idx=0; session->config->aliasdir[idx].url != NULL; idx++) {
 199         if (0 == strncmp(url, session->config->aliasdir[idx].url, session->config->aliasdir[idx].len)) {
 200              requestdir = session->config->aliasdir[idx].path;
 201              requesturl=(char*)&url[session->config->aliasdir[idx].len];
 202              break;
 203         }
 204     }
 205
 206     // build full path from rootdir + url
 207     strncpy(staticfile.path, requestdir, sizeof (staticfile.path));
 208     strncat(staticfile.path, requesturl, sizeof (staticfile.path));
 209
 210     // try to open file and get its size
 211     if (-1 == (staticfile.fd = open(staticfile.path, O_RDONLY))) {
 212         fprintf(stderr, "Fail to open file: [%s] error:%s\n", staticfile.path, strerror(errno));
 213         return (FAILED);
 214     }
 215     // open file is OK let use it
 216     ret = servFile (connection, session, url, &staticfile);
 217     return ret;
 218 }
 219
 220 // Check and Dispatch HTTP request
 221 STATIC int newRequest(void *cls,
 222         struct MHD_Connection *connection,
 223         const char *url,
 224         const char *method,
 225         const char *version,
 226         const char *upload_data, size_t *upload_data_size, void **con_cls) {
 227
 228     AFB_session *session = cls;
 229     struct MHD_Response *response;
 230     int ret;
 231
 232     // this is a REST API let's check for plugins
 233     if (0 == strncmp(url, session->config->rootapi, apiUrlLen)) {
 234         ret = doRestApi(connection, session, &url[apiUrlLen+1], method, upload_data, upload_data_size, con_cls);
 235         return ret;
 236     }
 237
 238     // From here only accept get request
 239     if (0 != strcmp(method, MHD_HTTP_METHOD_GET)) return MHD_NO; /* unexpected method */
 240
 241     // If a static file exist serve it now
 242     ret = requestFile(connection, session, url);
 243     if (ret != FAILED) return ret;
 244
 245     // no static was served let's try HTML5 OPA redirect
 246     if (0 == strncmp(url, session->config->rootbase, baseUrlLen)) {
 247         ret = redirectHTML5(connection, session, &url[baseUrlLen]);
 248         return ret;
 249     }
 250
 251      // Nothing respond to this request Files, API, Angular Base
 252     const char *errorstr = "<html><body>Alsa-Json-Gateway Unknown or Not readable file</body></html>";
 253     response = MHD_create_response_from_buffer(strlen(errorstr), (void*)errorstr, MHD_RESPMEM_PERSISTENT);
 254     ret = MHD_queue_response(connection, MHD_HTTP_INTERNAL_SERVER_ERROR, response);
 255     return (MHD_YES);
 256 }
 257
 258 STATIC int newClient(void *cls, const struct sockaddr * addr, socklen_t addrlen) {
 259     // check if client is coming from an acceptable IP
 260     return (MHD_YES); // MHD_NO
 261 }
 262
 263
 264 PUBLIC AFB_error httpdStart(AFB_session *session) {
 265
 266     // compute fixed URL length at startup time
 267     apiUrlLen = strlen (session->config->rootapi);
 268     baseUrlLen= strlen (session->config->rootbase);
 269     rootUrlLen= strlen (session->config->rootdir);
 270
 271     // TBD open libmagic cache [fail to pass EFENCE check]
 272     // initLibMagic (session);
 273
 274
 275     if (verbose) {
 276         printf("AFB:notice Waiting port=%d rootdir=%s\n", session->config->httpdPort, session->config->rootdir);
 277         printf("AFB:notice Browser URL= http://localhost:%d\n", session->config->httpdPort);
 278     }
 279
 280     session->httpd = (void*) MHD_start_daemon(
 281             MHD_USE_SELECT_INTERNALLY | MHD_USE_DEBUG, // use request and not threads
 282             session->config->httpdPort, // port
 283             &newClient, NULL, // Tcp Accept call back + extra attribute
 284             &newRequest, session, // Http Request Call back + extra attribute
 285             MHD_OPTION_NOTIFY_COMPLETED, &endRequest, NULL,
 286             MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 15, MHD_OPTION_END); // 15s + options-end
 287     // TBD: MHD_OPTION_SOCK_ADDR
 288
 289     if (session->httpd == NULL) {
 290         printf("Error: httpStart invalid httpd port: %d", session->config->httpdPort);
 291         return AFB_FATAL;
 292     }
 293     return AFB_SUCCESS;
 294 }
 295
 296 // infinite loop
 297 PUBLIC AFB_error httpdLoop(AFB_session *session) {
 298     static int  count = 0;
 299
 300     if (verbose) fprintf(stderr, "AFB:notice entering httpd waiting loop\n");
 301     if (session->foreground) {
 302
 303         while (TRUE) {
 304             fprintf(stderr, "AFB:notice Use Ctrl-C to quit\n");
 305             (void) getc(stdin);
 306         }
 307     } else {
 308         while (TRUE) {
 309             sleep(3600);
 310             if (verbose) fprintf(stderr, "AFB:notice httpd alive [%d]\n", count++);
 311         }
 312     }
 313
 314     // should never return from here
 315     return AFB_FATAL;
 316 }
 317
 318 PUBLIC int httpdStatus(AFB_session *session) {
 319     return (MHD_run(session->httpd));
 320 }
 321
 322 PUBLIC void httpdStop(AFB_session *session) {
 323     MHD_stop_daemon(session->httpd);
 324 }