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