2 local-def.h -- provide a REST/HTTP interface
4 Copyright (C) 2015, Fulup Ar Foll
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.
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.
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.
35 #include <sys/ioctl.h>
36 #include <sys/signal.h>
37 #include <sys/types.h>
40 #include <microhttpd.h>
44 #include <uuid/uuid.h>
48 /* other definitions --------------------------------------------------- */
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"
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
74 #define AUDIO_BUFFER "/tmp/buf"
76 extern int verbose; // this is the only global variable
78 // prebuild json error are constructed in helper-api.c
79 typedef enum { AFB_FALSE, AFB_TRUE, AFB_FATAL, AFB_FAIL, AFB_WARNING, AFB_EMPTY, AFB_SUCCESS, AFB_DONE, AFB_UNAUTH} AFB_error;
81 #define MAX_POST_SIZE 4096 // maximum size for POST data
82 #define CTX_NBCLIENTS 10 // allow a default of 10 authenticated clients
94 AFB_PLUGIN_JSON = 123456789,
95 AFB_PLUGIN_JSCRIPT = 987654321,
96 AFB_PLUGIN_RAW = 987123546
99 // Enum for Session/Token/Authentication middleware
113 enum AFB_sessionE session;
114 json_object* (*callback)();
121 enum AFB_pluginE type;
124 const struct AFB_restapi *apis;
125 void (*freeCtxCB)(void*); // callback to free application context [null for standard free]
128 typedef enum AFB_pluginE AFB_pluginE;
129 typedef enum AFB_sessionE AFB_sessionE;
130 typedef json_object* (*AFB_apiCB)();
131 typedef void (*AFB_freeCtxCB)(void*);
132 typedef struct AFB_restapi AFB_restapi;
133 typedef struct AFB_plugin AFB_plugin;
148 typedef enum {AFB_POST_NONE=0, AFB_POST_JSON, AFB_POST_FORM, AFB_POST_EMPTY} AFB_PostType;
149 typedef enum {AFB_MODE_LOCAL=0, AFB_MODE_REMOTE, AFB_MODE_GLOBAL} AFB_Mode;
153 // Post Upload File Handle
162 int len; // post element size
163 char *data; // post data in raw format
164 AFB_PostType type; // Json type
169 void* ctx; // Application context
170 int len; // current len for post
171 int uid; // post uid for debug
172 AFB_PostType type; // JSON or FORM
173 AFB_apiCB completeCB; // callback when post is completed
174 char *privatebuf; // use internally to keep track or partial buffer
175 struct MHD_PostProcessor *pp; // iterator handle
179 enum MHD_ValueKind kind; // kind type of the value
180 const char *key; // key 0-terminated key for the value
181 const char *filename; // filename of the uploaded file, NULL if not known
182 const char *mimetype; // content_type mime-type of the data, NULL if not known
183 const char *encoding; // transfer_encoding encoding of the data, NULL if not known
184 const char *data; // data pointer to size bytes of data at the specified offset
185 uint64_t offset; // offset of data in the overall value
186 size_t len; // number of bytes in data available
205 // User Client Session Context
207 char uuid[37]; // long term authentication of remote client
208 char token[37]; // short term authentication of remote client
209 time_t timeStamp; // last time token was refresh
210 int restfull; // client does not use cookie
211 void **contexts; // application specific context [one per plugin]]
214 // main config structure
217 char *console; // console device name (can be a file or a tty)
219 char *ldpaths; // list of plugins directories
220 char *rootdir; // base dir for httpd file download
221 char *rootbase; // Angular HTML5 base URL
222 char *rootapi; // Base URL for REST APIs
223 char *sessiondir; // where to store mixer session files
224 char *token; // initial authentication token [default NULL no session]
227 int cntxTimeout; // Client Session Context timeout
228 AFB_Mode mode; // mode of listening
229 AFB_aliasdir *aliasdir; // alias mapping for icons,apps,...
232 // MHD_lookup_connection_value(connection, MHD_GET_ARGUMENT_KIND, "value");
236 char *prefix; // plugin convivial name
238 AFB_PostRequest *post;
240 void *context; // Hold Client Context when using session
241 int restfull; // request is resfull [uuid token provided]
242 int errcode; // http error code
243 struct AFB_config *config; // plugin may need access to config
244 struct MHD_Connection *connection;
247 struct afb_hsrv_handler;
251 struct AFB_config *config; // pointer to current config
252 // List of commands to execute
253 int background; // run in backround mode
254 int foreground; // run in forground mode
255 char *cacheTimeout; // http require timeout to be a string
256 struct MHD_Daemon *httpd; // structure for httpd handler
257 int fakemod; // respond to GET/POST request without interacting with sndboard
258 int readyfd; // a #fd to signal when ready to serve
259 magic_t magic; // Mime type file magic lib
260 struct afb_hsrv_handler *handlers;
264 typedef struct AFB_config AFB_config;
265 typedef struct AFB_session AFB_session;
267 #include "proto-def.h"
269 #endif /* LOCAL_DEF_H */