src/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 // prebuild json error are constructed in helper-api.c
  57 typedef enum  { AFB_FALSE, AFB_TRUE, AFB_FATAL, AFB_FAIL, AFB_WARNING, AFB_EMPTY, AFB_SUCCESS, AFB_DONE, AFB_UNAUTH} AFB_error;
  58
  59 #define MAX_POST_SIZE  4096   // maximum size for POST data
  60 #define CTX_NBCLIENTS   10   // allow a default of 10 authenticated clients
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71 enum AFB_Mode;
  72
  73
  74 typedef struct {
  75   char  *url;
  76   char  *path;
  77   size_t len;
  78 } AFB_aliasdir;
  79
  80 // main config structure
  81 struct AFB_config
  82 {
  83   char *console;           // console device name (can be a file or a tty)
  84   int   httpdPort;
  85   char *ldpaths;           // list of plugins directories
  86   char *rootdir;           // base dir for httpd file download
  87   char *rootbase;          // Angular HTML5 base URL
  88   char *rootapi;           // Base URL for REST APIs
  89   char *sessiondir;        // where to store mixer session files
  90   char *token;             // initial authentication token [default NULL no session]
  91   int  cacheTimeout;
  92   int  apiTimeout;
  93   int  cntxTimeout;        // Client Session Context timeout
  94   int mode;           // mode of listening
  95   AFB_aliasdir *aliasdir;  // alias mapping for icons,apps,...
  96 };
  97
  98 // MHD_lookup_connection_value(connection, MHD_GET_ARGUMENT_KIND, "value");
  99 typedef struct {
 100   const char *uuid;
 101   const char *url;
 102   const char *prefix;              // plugin convivial name
 103   const char *method;
 104 /*
 105   AFB_PostRequest *post;
 106 */
 107   struct json_object *jresp;
 108   void *context;             // Hold Client Context when using session
 109   int  restfull;             // request is resfull [uuid token provided]
 110   int  errcode;              // http error code
 111   struct AFB_config *config;         // plugin may need access to config
 112   struct afb_req *areq;
 113 } AFB_request;
 114
 115 struct afb_hsrv_handler;
 116 struct MHD_Daemon;
 117
 118 struct AFB_session
 119 {
 120   struct AFB_config  *config;   // pointer to current config
 121   // List of commands to execute
 122   int  background;        // run in backround mode
 123   int  foreground;        // run in forground mode
 124   char *cacheTimeout;     // http require timeout to be a string
 125   struct MHD_Daemon *httpd;            // structure for httpd handler
 126   int  fakemod;           // respond to GET/POST request without interacting with sndboard
 127   int  readyfd;           // a #fd to signal when ready to serve
 128   magic_t  magic;         // Mime type file magic lib
 129   struct afb_hsrv_handler *handlers;
 130 };
 131
 132
 133 typedef struct AFB_config AFB_config;
 134 typedef struct AFB_session AFB_session;
 135
 136 #include "proto-def.h"
 137
 138 #endif /* LOCAL_DEF_H */