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
|
/*
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
#include <json.h>
#include <magic.h>
#include <microhttpd.h>
/* other definitions --------------------------------------------------- */
// Note: because of a bug in libmagic MAGIC_DB NULL should not be used for default
#define OPA_INDEX "index.html"
#define MAX_ALIAS 10 // max number of aliases
#define COOKIE_NAME "afb-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
#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
// prebuild json error are constructed in helper-api.c
typedef enum { AFB_FALSE, AFB_TRUE, AFB_FATAL, AFB_FAIL, AFB_WARNING, AFB_EMPTY, AFB_SUCCESS, AFB_DONE, AFB_UNAUTH} AFB_error;
#define MAX_POST_SIZE 4096 // maximum size for POST data
#define CTX_NBCLIENTS 10 // allow a default of 10 authenticated clients
// Plugin Type
enum AFB_pluginE
{
AFB_PLUGIN_JSON = 123456789,
AFB_PLUGIN_JSCRIPT = 987654321,
AFB_PLUGIN_RAW = 987123546
};
// Enum for Session/Token/Authentication middleware
enum AFB_sessionE
{
AFB_SESSION_NONE,
AFB_SESSION_CREATE,
AFB_SESSION_CLOSE,
AFB_SESSION_RENEW,
AFB_SESSION_CHECK
};
// API definition
struct AFB_restapi
{
const char *name;
enum AFB_sessionE session;
struct json_object* (*callback)();
const char *info;
};
// Plugin definition
struct AFB_plugin
{
enum AFB_pluginE type;
const char *info;
const char *prefix;
const struct AFB_restapi *apis;
void (*freeCtxCB)(void*); // callback to free application context [null for standard free]
};
typedef enum AFB_pluginE AFB_pluginE;
typedef enum AFB_sessionE AFB_sessionE;
typedef struct json_object* (*AFB_apiCB)();
typedef void (*AFB_freeCtxCB)(void*);
typedef struct AFB_restapi AFB_restapi;
typedef struct AFB_plugin AFB_plugin;
typedef enum {AFB_MODE_LOCAL=0, AFB_MODE_REMOTE, AFB_MODE_GLOBAL} AFB_Mode;
typedef struct {
char *url;
char *path;
size_t len;
} AFB_aliasdir;
// main config structure
struct AFB_config
{
char *console; // console device name (can be a file or a tty)
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 *sessiondir; // where to store mixer session files
char *token; // initial authentication token [default NULL no session]
int cacheTimeout;
int apiTimeout;
int cntxTimeout; // Client Session Context timeout
AFB_Mode mode; // mode of listening
AFB_aliasdir *aliasdir; // alias mapping for icons,apps,...
};
// MHD_lookup_connection_value(connection, MHD_GET_ARGUMENT_KIND, "value");
typedef struct {
const char *uuid;
const char *url;
const char *prefix; // plugin convivial name
const char *method;
/*
AFB_PostRequest *post;
*/
struct json_object *jresp;
void *context; // Hold Client Context when using session
int restfull; // request is resfull [uuid token provided]
int errcode; // http error code
struct AFB_config *config; // plugin may need access to config
struct afb_req *areq;
} AFB_request;
struct afb_hsrv_handler;
struct MHD_Daemon;
struct AFB_session
{
struct AFB_config *config; // pointer to current config
// List of commands to execute
int background; // run in backround mode
int foreground; // run in forground mode
char *cacheTimeout; // http require timeout to be a string
struct MHD_Daemon *httpd; // structure for httpd handler
int fakemod; // respond to GET/POST request without interacting with sndboard
int readyfd; // a #fd to signal when ready to serve
magic_t magic; // Mime type file magic lib
struct afb_hsrv_handler *handlers;
};
typedef struct AFB_config AFB_config;
typedef struct AFB_session AFB_session;
#include "proto-def.h"
#endif /* LOCAL_DEF_H */
|
