include/local-def.h

   1 /*
   2    alsajson-gw -- provide a REST/HTTP interface to ALSA-Mixer
   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
  49 #define AJQ_VERSION "0.1"
  50
  51 /* other definitions --------------------------------------------------- */
  52
  53 // Note: because of a bug in libmagic MAGIC_DB NULL should not be used for default
  54 #define MAGIC_DB "/usr/share/misc/magic.mgc"
  55 #define OPA_INDEX "index.html"
  56 #define MAX_ALIAS 10           // max number of aliases
  57 #define COOKIE_NAME   "AJB_session"
  58
  59
  60 #define DEFLT_CNTX_TIMEOUT  3600   // default Client Connection Timeout
  61 #define DEFLT_API_TIMEOUT   0      // default Plugin API Timeout [0=NoLimit for Debug Only]
  62 #define DEFLT_API_TIMEOUT   0      // default Plugin API Timeout
  63 #define DEFLT_CACHE_TIMEOUT 100000 // default Static File Chache [Client Side Cache 100000~=1day]
  64 #define DEFLT_AUTH_TOKEN    NULL   // expect for debug should == NULL
  65 #define DEFLT_HTTP_TIMEOUT  15     // Max MibMicroHttp timeout
  66
  67 typedef int BOOL;
  68 #ifndef FALSE
  69   #define FALSE 0
  70 #endif
  71 #ifndef TRUE
  72   #define TRUE 1
  73 #endif
  74
  75 #define PUBLIC
  76 #define STATIC    static
  77 #define FAILED    -1
  78
  79 #define AUDIO_BUFFER "/tmp/buf"
  80
  81 extern int verbose;  // this is the only global variable
  82
  83 // Plugin Type
  84 typedef enum  {AFB_PLUGIN_JSON=123456789, AFB_PLUGIN_JSCRIPT=987654321,  AFB_PLUGIN_RAW=987123546} AFB_pluginE;
  85
  86 // prebuild json error are constructed in config.c
  87 typedef enum  { AFB_FALSE, AFB_TRUE, AFB_FATAL, AFB_FAIL, AFB_WARNING, AFB_EMPTY, AFB_SUCCESS, AFB_DONE, AFB_UNAUTH} AFB_error;
  88
  89 extern char *ERROR_LABEL[];
  90 #define ERROR_LABEL_DEF {"false", "true","fatal", "fail", "warning", "empty", "success"}
  91
  92 #define BANNER "<html><head><title>Application Framework Binder</title></head><body>Application Framework </body></html>"
  93 #define JSON_CONTENT  "application/json"
  94 #define FORM_CONTENT "multipart/form-data"
  95 #define MAX_POST_SIZE  4096   // maximum size for POST data
  96 #define CTX_NBCLIENTS   10   // allow a default of 10 authenticated clients
  97
  98
  99 typedef json_object* (*AFB_apiCB)();
 100
 101 // Error code are requested through function to manage json usage count
 102 typedef struct {
 103   int   level;
 104   char* label;
 105   json_object *json;
 106 } AFB_errorT;
 107
 108 typedef enum  {AFB_POST_NONE=0, AFB_POST_JSON, AFB_POST_FORM} AFB_PostType;
 109
 110 typedef  struct {
 111     int  len;   // post element size
 112     char *data; // post data in raw format
 113     AFB_PostType type; // Json type
 114 } AFB_PostRequest;
 115
 116 // Post handler
 117 typedef struct {
 118   void*  ctx;               // Application context
 119   int    len;               // current len for post
 120   int    uid;               // post uid for debug
 121   AFB_PostType type;        // JSON or FORM
 122   AFB_apiCB  completeCB;    // callback when post is completed
 123   char   *private;          // use internally to keep track or partial buffer
 124   struct MHD_PostProcessor *pp; // iterator handle
 125 } AFB_PostHandle;
 126
 127 typedef struct {
 128     enum MHD_ValueKind kind; // kind type of the value
 129     const char *key;         // key 0-terminated key for the value
 130     const char *filename;    // filename of the uploaded file, NULL if not known
 131     const char *mimetype;    // content_type mime-type of the data, NULL if not known
 132     const char *encoding;    // transfer_encoding encoding of the data, NULL if not known
 133     const char *data;        // data pointer to size bytes of data at the specified offset
 134     uint64_t   offset;       // offset of data in the overall value
 135     size_t     len;          // number of bytes in data available
 136 } AFB_PostItem;
 137
 138 typedef struct {
 139   char  path[512];
 140   int   fd;
 141 } AFB_staticfile;
 142
 143 typedef struct {
 144   char  *url;
 145   char  *path;
 146   size_t len;
 147 } AFB_aliasdir;
 148
 149 // Command line structure hold cli --command + help text
 150 typedef struct {
 151   int  val;        // command number within application
 152   int  has_arg;    // command number within application
 153   char *name;      // command as used in --xxxx cli
 154   char *help;      // help text
 155 } AFB_options;
 156
 157 // main config structure
 158 typedef struct {
 159   char *logname;           // logfile path for info & error log
 160   char *console;           // console device name (can be a file or a tty)
 161   int  localhostOnly;
 162   int   httpdPort;
 163   char *smack;             // smack label
 164   char *plugins;           // list of requested plugins
 165   char *rootdir;           // base dir for httpd file download
 166   char *rootbase;          // Angular HTML5 base URL
 167   char *rootapi;           // Base URL for REST APIs
 168   char *pidfile;           // where to store pid when running background
 169   char *sessiondir;        // where to store mixer session files
 170   char *configfile;        // where to store configuration on gateway exit
 171   char *setuid;            // downgrade uid to username
 172   char *token;             // initial authentication token [default NULL no session]
 173   int  cacheTimeout;
 174   int  apiTimeout;
 175   int  cntxTimeout;        // Client Session Context timeout
 176   AFB_aliasdir *aliasdir;  // alias mapping for icons,apps,...
 177 } AFB_config;
 178
 179 typedef struct {
 180   int  len;        // command number within application
 181   json_object *jtype;
 182 } AFB_privateApi;
 183
 184
 185 typedef struct {
 186      char    *msg;
 187      size_t  len;
 188 } AFB_redirect_msg;
 189
 190 // Enum for Session/Token/Authentication middleware
 191 typedef enum  {AFB_SESSION_NONE, AFB_SESSION_CREATE, AFB_SESSION_CLOSE, AFB_SESSION_RENEW, AFB_SESSION_CHECK} AFB_sessionE;
 192
 193 // API definition
 194 typedef struct {
 195   char *name;
 196   AFB_sessionE session;
 197   AFB_apiCB callback;
 198   char *info;
 199   AFB_privateApi *private;
 200 } AFB_restapi;
 201
 202 // Plugin definition
 203 typedef struct {
 204   AFB_pluginE type;
 205   char *info;
 206   char *prefix;
 207   size_t prefixlen;
 208   json_object *jtype;
 209   AFB_restapi *apis;
 210   void *handle;
 211   int  ctxCount;
 212   AFB_apiCB freeCtxCB;  // callback to free application context [null for standard free]
 213 } AFB_plugin;
 214
 215
 216 // User Client Session Context
 217 typedef struct {
 218   int  cid;             // index 0 if global
 219   char uuid[37];        // long term authentication of remote client
 220   char token[37];       // short term authentication of remote client
 221   time_t timeStamp;     // last time token was refresh
 222   int   restfull;       // client does not use cookie
 223   void *ctx;            // application specific context
 224   AFB_plugin *plugin;   // provide callback and easy access to plugin
 225 } AFB_clientCtx;
 226
 227 // MHD_lookup_connection_value(connection, MHD_GET_ARGUMENT_KIND, "value");
 228 typedef struct {
 229   const char *url;
 230   char *plugin;
 231   char *api;
 232   AFB_PostRequest *post;
 233   json_object *jresp;
 234   AFB_clientCtx *client;      // needed because libmicrohttp cannot create an empty response
 235   int   restfull;             // request is resfull [uuid token provided]
 236   int   errcode;              // http error code
 237   sigjmp_buf checkPluginCall; // context save for timeout set/longjmp
 238   AFB_config *config;         // plugin may need access to config
 239   struct MHD_Connection *connection;
 240   AFB_plugin **plugins;
 241 } AFB_request;
 242
 243
 244 typedef struct {
 245   AFB_config  *config;   // pointer to current config
 246   // List of commands to execute
 247   int  killPrevious;
 248   int  background;        // run in backround mode
 249   int  foreground;        // run in forground mode
 250   int  configsave;        // Save config on disk on start
 251   char *cacheTimeout;     // http require timeout to be a string
 252   void *httpd;            // anonymous structure for httpd handler
 253   int  fakemod;           // respond to GET/POST request without interacting with sndboard
 254   int  forceexit;         // when autoconfig from script force exit before starting server
 255   AFB_plugin **plugins;   // pointer to REST/API plugins
 256   magic_t  magic;         // Mime type file magic lib
 257   sigjmp_buf restartCkpt; // context save for restart set/longjmp
 258 } AFB_session;
 259
 260
 261
 262 #include "proto-def.h"
 263
 264 #endif /* LOCAL_DEF_H */