Application Framework Binder

X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Flocal-def.h;h=ace9249a99de166089421733757ca69a1e1f8db7;hb=ca208671cc79bbc05c574df788035878e5d39382;hp=df4ddb238e37200c7852b8cb5c5944995b54f0c5;hpb=29d04383ea3e499840aae0220da700a27cce26e4;p=src%2Fapp-framework-binder.git diff --git a/include/local-def.h b/include/local-def.h index df4ddb23..ace9249a 100644 --- a/include/local-def.h +++ b/include/local-def.h @@ -52,7 +52,6 @@ #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 @@ -61,7 +60,6 @@ #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 @@ -77,35 +75,81 @@ typedef int BOOL; 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 +// 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; -extern char *ERROR_LABEL[]; -#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 + + + + + + +// 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; + 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 json_object* (*AFB_apiCB)(); -typedef void (*AFB_freeCtxCB)(void*, void*, char*); +typedef void (*AFB_freeCtxCB)(void*); +typedef struct AFB_restapi AFB_restapi; +typedef struct AFB_plugin AFB_plugin; + + + + + + + + + + + + -// 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; typedef enum {AFB_MODE_LOCAL=0, AFB_MODE_REMOTE, AFB_MODE_GLOBAL} AFB_Mode; + + // Post Upload File Handle typedef struct { int fd; @@ -153,68 +197,37 @@ typedef struct { size_t len; } AFB_aliasdir; -// main config structure typedef struct { - char *logname; // logfile path for info & error log + char *msg; + size_t len; +} AFB_redirect_msg; + +// 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_clientCtx; + +// main config structure +struct AFB_config +{ 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_Mode mode; // mode of listening AFB_aliasdir *aliasdir; // alias mapping for icons,apps,... -} AFB_config; - -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_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 { @@ -225,34 +238,32 @@ typedef struct { 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 AFB_config *config; // plugin may need access to config struct MHD_Connection *connection; - AFB_plugin **plugins; } AFB_request; struct afb_hsrv_handler; struct MHD_Daemon; -typedef struct { - AFB_config *config; // pointer to current config + +struct AFB_session { + 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 char *cacheTimeout; // http require timeout to be a string - struct MHD_Daemon *httpd; // anonymous structure for httpd handler + 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 - AFB_plugin **plugins; // pointer to REST/API plugins magic_t magic; // Mime type file magic lib struct afb_hsrv_handler *handlers; - sigjmp_buf restartCkpt; // context save for restart set/longjmp -} AFB_session; +}; +typedef struct AFB_config AFB_config; +typedef struct AFB_session AFB_session; #include "proto-def.h"