local-def.h

   1 /*
   2    local-def.h -- provide a REST/HTTP interface
   3
   4    Copyright (C) 2015, Fulup Ar Foll
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19
  20 */
  21 #ifndef LOCAL_DEF_H
  22 #define LOCAL_DEF_H
  23
  24 #ifndef _GNU_SOURCE
  25   #define _GNU_SOURCE
  26 #endif
  27
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <unistd.h>
  32 #include <fcntl.h>
  33 #include <errno.h>
  34 #include <termios.h>
  35 #include <sys/ioctl.h>
  36 #include <sys/signal.h>
  37 #include <sys/types.h>
  38 #include <time.h>
  39 #include <json.h>
  40 #include <microhttpd.h>
  41 #include <magic.h>
  42 #include <setjmp.h>
  43 #include <signal.h>
  44 #include <uuid/uuid.h>
  45
  46
  47
  48 /* other definitions --------------------------------------------------- */
  49
  50 // Note: because of a bug in libmagic MAGIC_DB NULL should not be used for default
  51 #define OPA_INDEX "index.html"
  52 #define MAX_ALIAS 10           // max number of aliases
  53 #define COOKIE_NAME   "afb-session"
  54
  55 #define DEFLT_CNTX_TIMEOUT  3600   // default Client Connection Timeout
  56 #define DEFLT_API_TIMEOUT   0      // default Plugin API Timeout [0=NoLimit for Debug Only]
  57 #define DEFLT_API_TIMEOUT   0      // default Plugin API Timeout
  58 #define DEFLT_CACHE_TIMEOUT 100000 // default Static File Chache [Client Side Cache 100000~=1day]
  59 #define DEFLT_AUTH_TOKEN    NULL   // expect for debug should == NULL
  60 #define DEFLT_HTTP_TIMEOUT  15     // Max MibMicroHttp timeout
  61 #define AFB_MAX_PLUGINS     20     // Max number of plugins for a given binder
  62
  63 #ifndef FALSE
  64   #define FALSE 0
  65 #endif
  66 #ifndef TRUE
  67   #define TRUE 1
  68 #endif
  69
  70 #define PUBLIC
  71 #define STATIC    static
  72 #define FAILED    -1
  73
  74 #define AUDIO_BUFFER "/tmp/buf"
  75
  76 extern int verbose;  // this is the only global variable
  77
  78 // Plugin Type
  79 typedef enum  {AFB_PLUGIN_JSON=123456789, AFB_PLUGIN_JSCRIPT=987654321,  AFB_PLUGIN_RAW=987123546} AFB_pluginE;
  80
  81 // prebuild json error are constructed in helper-api.c
  82 typedef enum  { AFB_FALSE, AFB_TRUE, AFB_FATAL, AFB_FAIL, AFB_WARNING, AFB_EMPTY, AFB_SUCCESS, AFB_DONE, AFB_UNAUTH} AFB_error;
  83
  84 #define MAX_POST_SIZE  4096   // maximum size for POST data
  85 #define CTX_NBCLIENTS   10   // allow a default of 10 authenticated clients
  86
  87
  88 typedef json_object* (*AFB_apiCB)();
  89 typedef void (*AFB_freeCtxCB)(void*, void*, char*);
  90
  91 typedef enum  {AFB_POST_NONE=0, AFB_POST_JSON, AFB_POST_FORM, AFB_POST_EMPTY} AFB_PostType;
  92 typedef enum  {AFB_MODE_LOCAL=0, AFB_MODE_REMOTE, AFB_MODE_GLOBAL} AFB_Mode;
  93
  94 // Post Upload File Handle
  95 typedef struct {
  96    int   fd;
  97    char *path;
  98    int  errcode;
  99    json_object* jresp;
 100 } AFB_PostCtx;
 101
 102 typedef  struct {
 103     int  len;   // post element size
 104     char *data; // post data in raw format
 105     AFB_PostType type; // Json type
 106 } AFB_PostRequest;
 107
 108 // Post handler
 109 typedef struct {
 110   void*  ctx;               // Application context
 111   int    len;               // current len for post
 112   int    uid;               // post uid for debug
 113   AFB_PostType type;        // JSON or FORM
 114   AFB_apiCB  completeCB;    // callback when post is completed
 115   char   *privatebuf;       // use internally to keep track or partial buffer
 116   struct MHD_PostProcessor *pp; // iterator handle
 117 } AFB_PostHandle;
 118
 119 typedef struct {
 120     enum MHD_ValueKind kind; // kind type of the value
 121     const char *key;         // key 0-terminated key for the value
 122     const char *filename;    // filename of the uploaded file, NULL if not known
 123     const char *mimetype;    // content_type mime-type of the data, NULL if not known
 124     const char *encoding;    // transfer_encoding encoding of the data, NULL if not known
 125     const char *data;        // data pointer to size bytes of data at the specified offset
 126     uint64_t   offset;       // offset of data in the overall value
 127     size_t     len;          // number of bytes in data available
 128 } AFB_PostItem;
 129
 130 typedef struct {
 131   char  path[512];
 132   int   fd;
 133 } AFB_staticfile;
 134
 135 typedef struct {
 136   char  *url;
 137   char  *path;
 138   size_t len;
 139 } AFB_aliasdir;
 140
 141 typedef struct {
 142      char    *msg;
 143      size_t  len;
 144 } AFB_redirect_msg;
 145
 146 // Enum for Session/Token/Authentication middleware
 147 typedef enum  {AFB_SESSION_NONE, AFB_SESSION_CREATE, AFB_SESSION_CLOSE, AFB_SESSION_RENEW, AFB_SESSION_CHECK} AFB_sessionE;
 148
 149 // API definition
 150 typedef struct {
 151   char *name;
 152   AFB_sessionE session;
 153   AFB_apiCB callback;
 154   char *info;
 155 } AFB_restapi;
 156
 157 // Plugin definition
 158 typedef struct {
 159   AFB_pluginE type;
 160   char *info;
 161   char *prefix;
 162   size_t prefixlen;
 163   json_object *jtype;
 164   AFB_restapi *apis;
 165   void *handle;
 166   int  ctxCount;
 167   AFB_freeCtxCB freeCtxCB;  // callback to free application context [null for standard free]
 168 } AFB_plugin;
 169
 170
 171 // User Client Session Context
 172 typedef struct {
 173   char uuid[37];        // long term authentication of remote client
 174   char token[37];       // short term authentication of remote client
 175   time_t timeStamp;     // last time token was refresh
 176   int   restfull;       // client does not use cookie
 177   void **contexts;      // application specific context [one per plugin]]
 178   AFB_plugin **plugins; // we need plugins reference to cleanup session outside of call context
 179 } AFB_clientCtx;
 180
 181 // main config structure
 182 typedef struct {
 183   char *console;           // console device name (can be a file or a tty)
 184   int   httpdPort;
 185   char *ldpaths;           // list of plugins directories
 186   char *rootdir;           // base dir for httpd file download
 187   char *rootbase;          // Angular HTML5 base URL
 188   char *rootapi;           // Base URL for REST APIs
 189   char *sessiondir;        // where to store mixer session files
 190   char *token;             // initial authentication token [default NULL no session]
 191   int  cacheTimeout;
 192   int  apiTimeout;
 193   int  cntxTimeout;        // Client Session Context timeout
 194   int  pluginCount;        // loaded plugins count
 195   AFB_Mode mode;           // mode of listening
 196   AFB_aliasdir *aliasdir;  // alias mapping for icons,apps,...
 197 } AFB_config;
 198
 199 // MHD_lookup_connection_value(connection, MHD_GET_ARGUMENT_KIND, "value");
 200 typedef struct {
 201   const char *uuid;
 202   const char *url;
 203   char *prefix;              // plugin convivial name
 204   char *api;
 205   AFB_PostRequest *post;
 206   json_object *jresp;
 207   void *context;             // Hold Client Context when using session
 208   void *handle;              // provide callback and easy access to plugin
 209   int  restfull;             // request is resfull [uuid token provided]
 210   int  errcode;              // http error code
 211   sigjmp_buf checkPluginCall; // context save for timeout set/longjmp
 212   AFB_config *config;         // plugin may need access to config
 213   struct MHD_Connection *connection;
 214   AFB_plugin **plugins;
 215 } AFB_request;
 216
 217 struct afb_hsrv_handler;
 218 struct MHD_Daemon;
 219
 220 typedef struct {
 221   AFB_config  *config;   // pointer to current config
 222   // List of commands to execute
 223   int  background;        // run in backround mode
 224   int  foreground;        // run in forground mode
 225   char *cacheTimeout;     // http require timeout to be a string
 226   struct MHD_Daemon *httpd;            // structure for httpd handler
 227   int  fakemod;           // respond to GET/POST request without interacting with sndboard
 228   int  readyfd;           // a #fd to signal when ready to serve
 229   AFB_plugin **plugins;   // pointer to REST/API plugins
 230   magic_t  magic;         // Mime type file magic lib
 231   struct afb_hsrv_handler *handlers;
 232 } AFB_session;
 233
 234
 235
 236 #include "proto-def.h"
 237
 238 #endif /* LOCAL_DEF_H */