include/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 #include <json.h>
  25 #include <magic.h>
  26 #include <microhttpd.h>
  27
  28 /* other definitions --------------------------------------------------- */
  29
  30 // Note: because of a bug in libmagic MAGIC_DB NULL should not be used for default
  31 #define OPA_INDEX "index.html"
  32 #define MAX_ALIAS 10           // max number of aliases
  33 #define COOKIE_NAME   "afb-session"
  34
  35 #define DEFLT_CNTX_TIMEOUT  3600   // default Client Connection Timeout
  36 #define DEFLT_API_TIMEOUT   0      // default Plugin API Timeout [0=NoLimit for Debug Only]
  37 #define DEFLT_API_TIMEOUT   0      // default Plugin API Timeout
  38 #define DEFLT_CACHE_TIMEOUT 100000 // default Static File Chache [Client Side Cache 100000~=1day]
  39 #define DEFLT_AUTH_TOKEN    NULL   // expect for debug should == NULL
  40 #define DEFLT_HTTP_TIMEOUT  15     // Max MibMicroHttp timeout
  41 #define AFB_MAX_PLUGINS     20     // Max number of plugins for a given binder
  42
  43 #ifndef FALSE
  44   #define FALSE 0
  45 #endif
  46 #ifndef TRUE
  47   #define TRUE 1
  48 #endif
  49
  50 #define PUBLIC
  51 #define STATIC    static
  52 #define FAILED    -1
  53
  54 #define AUDIO_BUFFER "/tmp/buf"
  55
  56 extern int verbose;  // this is the only global variable
  57
  58 // prebuild json error are constructed in helper-api.c
  59 typedef enum  { AFB_FALSE, AFB_TRUE, AFB_FATAL, AFB_FAIL, AFB_WARNING, AFB_EMPTY, AFB_SUCCESS, AFB_DONE, AFB_UNAUTH} AFB_error;
  60
  61 #define MAX_POST_SIZE  4096   // maximum size for POST data
  62 #define CTX_NBCLIENTS   10   // allow a default of 10 authenticated clients
  63
  64
  65
  66
  67
  68
  69
  70
  71 // Plugin Type
  72 enum  AFB_pluginE
  73 {
  74         AFB_PLUGIN_JSON = 123456789,
  75         AFB_PLUGIN_JSCRIPT = 987654321,
  76         AFB_PLUGIN_RAW = 987123546
  77 };
  78
  79 // Enum for Session/Token/Authentication middleware
  80 enum AFB_sessionE
  81 {
  82         AFB_SESSION_NONE,
  83         AFB_SESSION_CREATE,
  84         AFB_SESSION_CLOSE,
  85         AFB_SESSION_RENEW,
  86         AFB_SESSION_CHECK
  87 };
  88
  89 // API definition
  90 struct AFB_restapi
  91 {
  92         const char *name;
  93         enum AFB_sessionE session;
  94         struct json_object* (*callback)();
  95         const char *info;
  96 };
  97
  98 // Plugin definition
  99 struct AFB_plugin
 100 {
 101         enum AFB_pluginE type;
 102         const char *info;
 103         const char *prefix;
 104         const struct AFB_restapi *apis;
 105         void (*freeCtxCB)(void*);  // callback to free application context [null for standard free]
 106 };
 107
 108 typedef enum AFB_pluginE AFB_pluginE;
 109 typedef enum AFB_sessionE AFB_sessionE;
 110 typedef struct json_object* (*AFB_apiCB)();
 111 typedef void (*AFB_freeCtxCB)(void*);
 112 typedef struct AFB_restapi AFB_restapi;
 113 typedef struct AFB_plugin AFB_plugin;
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124 typedef enum  {AFB_MODE_LOCAL=0, AFB_MODE_REMOTE, AFB_MODE_GLOBAL} AFB_Mode;
 125
 126
 127 typedef struct {
 128   char  *url;
 129   char  *path;
 130   size_t len;
 131 } AFB_aliasdir;
 132
 133 // main config structure
 134 struct AFB_config
 135 {
 136   char *console;           // console device name (can be a file or a tty)
 137   int   httpdPort;
 138   char *ldpaths;           // list of plugins directories
 139   char *rootdir;           // base dir for httpd file download
 140   char *rootbase;          // Angular HTML5 base URL
 141   char *rootapi;           // Base URL for REST APIs
 142   char *sessiondir;        // where to store mixer session files
 143   char *token;             // initial authentication token [default NULL no session]
 144   int  cacheTimeout;
 145   int  apiTimeout;
 146   int  cntxTimeout;        // Client Session Context timeout
 147   AFB_Mode mode;           // mode of listening
 148   AFB_aliasdir *aliasdir;  // alias mapping for icons,apps,...
 149 };
 150
 151 // MHD_lookup_connection_value(connection, MHD_GET_ARGUMENT_KIND, "value");
 152 typedef struct {
 153   const char *uuid;
 154   const char *url;
 155   const char *prefix;              // plugin convivial name
 156   const char *method;
 157 /*
 158   AFB_PostRequest *post;
 159 */
 160   struct json_object *jresp;
 161   void *context;             // Hold Client Context when using session
 162   int  restfull;             // request is resfull [uuid token provided]
 163   int  errcode;              // http error code
 164   struct AFB_config *config;         // plugin may need access to config
 165   struct afb_req *areq;
 166 } AFB_request;
 167
 168 struct afb_hsrv_handler;
 169 struct MHD_Daemon;
 170
 171 struct AFB_session
 172 {
 173   struct AFB_config  *config;   // pointer to current config
 174   // List of commands to execute
 175   int  background;        // run in backround mode
 176   int  foreground;        // run in forground mode
 177   char *cacheTimeout;     // http require timeout to be a string
 178   struct MHD_Daemon *httpd;            // structure for httpd handler
 179   int  fakemod;           // respond to GET/POST request without interacting with sndboard
 180   int  readyfd;           // a #fd to signal when ready to serve
 181   magic_t  magic;         // Mime type file magic lib
 182   struct afb_hsrv_handler *handlers;
 183 };
 184
 185
 186 typedef struct AFB_config AFB_config;
 187 typedef struct AFB_session AFB_session;
 188
 189 #include "proto-def.h"
 190
 191 #endif /* LOCAL_DEF_H */