Application Framework Binder

X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=include%2Flocal-def.h;h=791f4c196a34bd1a421db7072d95a423a7f23123;hb=d00571d3c5365f40e7ec2ec3ab0f636afa0db480;hp=f69ddcbe7659c010d4beb45a6d40bca2940c0949;hpb=cd054544444e92e7695dd288f0c04b7af0f668e3;p=src%2Fapp-framework-binder.git diff --git a/include/local-def.h b/include/local-def.h index f69ddcbe..791f4c19 100644 --- a/include/local-def.h +++ b/include/local-def.h @@ -17,10 +17,11 @@ along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - $Id: $ */ -#define _GNU_SOURCE +#ifndef _GNU_SOURCE + #define _GNU_SOURCE +#endif #include #include @@ -35,12 +36,31 @@ #include #include #include +#include +#include +#include +#include + + #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 + typedef int BOOL; #ifndef FALSE #define FALSE 0 @@ -53,24 +73,32 @@ typedef int BOOL; #define STATIC static #define FAILED -1 +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_pluginT; + // 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_ERROR; +typedef enum { AFB_FALSE, AFB_TRUE, AFB_FATAL, AFB_FAIL, AFB_WARNING, AFB_EMPTY, AFB_SUCCESS, AFB_DONE} 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 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)(); // Error code are requested through function to manage json usage count typedef struct { int level; char* label; json_object *json; -} AFB_ErrorT; +} AFB_errorT; // Post handler typedef struct { @@ -79,22 +107,24 @@ typedef struct { int uid; } AFB_HttpPost; +typedef struct { + char path[512]; + int fd; +} AFB_staticfile; -// some usefull static object initialized when entering listen loop. -extern int verbose; -// MHD_lookup_connection_value(connection, MHD_GET_ARGUMENT_KIND, "value"); typedef struct { - const char *url; - char *plugin; - char *api; - char *post; - struct MHD_Connection *connection; -} AFB_request; + char *url; + char *path; + size_t len; +} AFB_aliasdir; +// Command line structure hold cli --command + help text typedef struct { - char *msg; - int len; -} AFB_redirect_msg; + 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 { @@ -110,37 +140,78 @@ typedef struct { 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 - uid_t setuid; + char *setuid; // downgrade uid to username + char *token; // initial authentication token [default NULL no session] int cacheTimeout; - AFB_redirect_msg html5; // html5 redirect message + int apiTimeout; + int cntxTimeout; // Client Session Context timeout + AFB_aliasdir *aliasdir; // alias mapping for icons,apps,... } AFB_config; -// 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; + int len; // command number within application + json_object *jtype; +} AFB_privateApi; -typedef json_object* (*AFB_apiCB)(); + +typedef struct { + char *msg; + size_t len; +} AFB_redirect_msg; // API definition typedef struct { char *name; AFB_apiCB callback; char *info; + AFB_privateApi *private; } AFB_restapi; + +// 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] +} AFB_clientCtx; + + +// MHD_lookup_connection_value(connection, MHD_GET_ARGUMENT_KIND, "value"); +typedef struct { + const char *url; + char *plugin; + char *api; + char *post; + int loa; + 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 + struct MHD_Connection *connection; +} AFB_request; + + // Plugin definition typedef struct { - AFB_type type; + AFB_pluginT type; char *info; char *prefix; + size_t prefixlen; json_object *jtype; AFB_restapi *apis; + void *handle; + int ctxCount; } AFB_plugin; + typedef struct { AFB_config *config; // pointer to current config // List of commands to execute @@ -154,7 +225,10 @@ typedef struct { 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"