X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=include%2Flocal-def.h;h=4c27233b724aa242318de89e95f37cea28307890;hb=520bbafb30ce49b94b7825ff553d8cb5bda6d612;hp=22a3608b5b3e37c65ebd8788e1ece2d03170184e;hpb=6d575b22b86ebfac5e2b4c9d672f45805a5b63ce;p=src%2Fapp-framework-binder.git
diff --git a/include/local-def.h b/include/local-def.h
index 22a3608b..4c27233b 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
@@ -45,17 +45,12 @@
-
-#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]
@@ -63,8 +58,8 @@
#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
@@ -80,32 +75,80 @@ 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*);
+typedef struct AFB_restapi AFB_restapi;
+typedef struct AFB_plugin AFB_plugin;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+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;
-// 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_PostType;
// Post Upload File Handle
typedef struct {
@@ -128,7 +171,7 @@ typedef struct {
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
+ char *privatebuf; // use internally to keep track or partial buffer
struct MHD_PostProcessor *pp; // iterator handle
} AFB_PostHandle;
@@ -154,119 +197,72 @@ 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;
+ 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
-typedef struct {
- char *logname; // logfile path for info & error log
+struct AFB_config
+{
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; // downgrade uid to username
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,...
-} 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_apiCB 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 *ctx; // application specific context
- AFB_plugin *plugin; // provide callback and easy access to plugin
-} 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;
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
- sigjmp_buf checkPluginCall; // context save for timeout set/longjmp
- AFB_config *config; // plugin may need access to config
+ 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 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
- int configsave; // Save config on disk on start
char *cacheTimeout; // http require timeout to be a string
- void *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 forceexit; // when autoconfig from script force exit before starting server
- AFB_plugin **plugins; // pointer to REST/API plugins
- int pluginCount; // loaded plugins count
+ int readyfd; // a #fd to signal when ready to serve
magic_t magic; // Mime type file magic lib
- sigjmp_buf restartCkpt; // context save for restart set/longjmp
-} AFB_session;
+ struct afb_hsrv_handler *handlers;
+};
+typedef struct AFB_config AFB_config;
+typedef struct AFB_session AFB_session;
#include "proto-def.h"