X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=include%2Flocal-def.h;h=360e0b0bae4b3041c43f1d81c51768fab043e14f;hb=da5a2bfe0571fbee3378f730633c17efcac94c30;hp=df66a09e473fa0a518115e03b51f8b2d8e41f67d;hpb=e7c246a1b0d30b8156c7033061a61ecb5d2bdfc8;p=src%2Fapp-framework-binder.git
diff --git a/include/local-def.h b/include/local-def.h
index df66a09e..360e0b0b 100644
--- a/include/local-def.h
+++ b/include/local-def.h
@@ -1,5 +1,5 @@
/*
- alsajson-gw -- provide a REST/HTTP interface to ALSA-Mixer
+ local-def.h -- provide a REST/HTTP interface
Copyright (C) 2015, Fulup Ar Foll
@@ -18,6 +18,8 @@
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
+#ifndef LOCAL_DEF_H
+#define LOCAL_DEF_H
#ifndef _GNU_SOURCE
#define _GNU_SOURCE
@@ -43,22 +45,21 @@
-
-#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 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
typedef int BOOL;
#ifndef FALSE
@@ -72,22 +73,28 @@ typedef int BOOL;
#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_error;
+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 ERROR_LABEL_DEF {"false", "true", "fatal", "fail", "warning", "empty", "success"}
#define BANNER "
Application Framework BinderApplication Framework "
#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
-// use to check anonymous data when using dynamic loadable lib
-typedef enum {AFB_PLUGIN=1234, AFB_REQUEST=5678} AFB_type;
+
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 {
@@ -96,12 +103,44 @@ typedef struct {
json_object *json;
} AFB_errorT;
+typedef enum {AFB_POST_NONE=0, AFB_POST_JSON, AFB_POST_FORM, AFB_POST_EMPTY} AFB_PostType;
+typedef enum {AFB_MODE_LOCAL=0, AFB_MODE_REMOTE, AFB_MODE_GLOBAL} AFB_Mode;
+
+// 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 {
- char* data;
- int len;
- int uid;
-} AFB_HttpPost;
+ 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 *privatebuf; // 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];
@@ -114,112 +153,100 @@ typedef struct {
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 *smack; // smack label
- char *plugins; // list of requested plugins
+ 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;
+ 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_Mode mode; // mode of listening
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 {
- int cid; // index 0 if global
- 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 *handle; // application specific context
- AFB_apiCB freeHandleCB; // callback to free application handle [null for standard free]
+ 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 *plugin;
+ char *prefix; // plugin convivial name
char *api;
- char *post;
- int loa;
+ AFB_PostRequest *post;
json_object *jresp;
- AFB_clientCtx *client; // needed because libmicrohttp cannot create an empty response
- int restfull; // request is resfull [uuid token provided]
- int errcode; // http error code
+ 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;
-// Plugin definition
-typedef struct {
- AFB_type type;
- char *info;
- char *prefix;
- size_t prefixlen;
- json_object *jtype;
- AFB_restapi *apis;
- void *handle;
- int ctxCount;
- AFB_clientCtx *ctxGlobal;
-} AFB_plugin;
-
-
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 checkAlsa; // Display active Alsa Board
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
+ int readyfd; // a #fd to signal when ready to serve
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
@@ -228,3 +255,5 @@ typedef struct {
#include "proto-def.h"
+
+#endif /* LOCAL_DEF_H */