README.md

   1 ### Application Framework Binder
   2 This is an undergoing work, publication is only intended for developers to review and provide feedback.
   3
   4 ### Licence
   5 As today the code is under GLPV3, while no decision as been taken yet, it will certainly move under a different licence like GPV2, Apache or MIT.
   6
   7 Final goal is keep the engine public while allowing people to load non open-source plugins. The code already leverage other opensource
   8 libraries especially libmicrohttpd & libjson. Finally what ever Licence is chosen it should be compatible with dependencies and automotive
   9 industry requirementsas the primary target for this code is AGL.
  10
  11 ### Building
  12  Building Application Framework Binder requires the following libraries:
  13 - libmagic ("libmagic-dev" under Debian/Ubuntu, "file-devel" under OpenSUSE);
  14 - libmicrohttpd ("libmicrohttpd-dev/devel");
  15 - json-c ("libjson-c-dev/devel");
  16  and the following tools:
  17 - pkg-config;
  18 - CMake >= 2.8.
  19
  20  To build from the root directory, please type:
  21 $ mkdir build; cd build
  22 & cmake ..
  23 & make; make install
  24
  25 ### Start
  26 afb-daemon --help
  27
  28 ### Example
  29 afb-daemon --verbose --rootdir=/home/fulup/.AFB --alias=icons:/usr/share/icons
  30
  31 ### Directory & Path
  32 Default behaviour is to locate ROOTDIR in $HOME/.AFB
  33
  34 ### REST API
  35
  36 Developer should mainly provides a structure with APIs name, corresponding methods and optionally some context and a handle.
  37 A handle is a void* structure that it is passed to the api callback. The API receive the query and well as post data, incase
  38 a post method was used. Every method should return a JSON object or NULL in case of error.
  39
  40 API plugin can be protected from timeout and other errors. By default this behaviour is deactivated, use --apitimeout to activate it.
  41
  42         STATIC  AFB_restapi myApis[]= {
  43           {"ping"     , (AFB_apiCB)ping    , "Ping Function", NULL},
  44           {"action1"  , (AFB_apiCB)action1 , "Action-1", OptionalHandle},
  45           {"action2"  , (AFB_apiCB)action2 , "Action-2", OptionalHandle},
  46           {0,0,0}
  47         };
  48
  49         PUBLIC AFB_plugin *pluginRegister (AFB_session *session) {
  50             AFB_plugin *plugin = malloc (sizeof (AFB_plugin));
  51             plugin->type  = AFB_PLUGIN;
  52             plugin->info  = "Plugin Sample";
  53             plugin->prefix= "myplugin";
  54             plugin->apis  = myApis;
  55             return (plugin);
  56         }
  57
  58 ### HTML5 and Angular Redirect
  59
  60 Binder support HTML5 redirect mode even with an application baseurl. Default value for application base URL is /opa
  61 See Application Framework HTML5 Client template at https://github.com/iotbzh/afb-client-sample
  62
  63 If the Binder receive something like http://myopa/sample when sample is not the homepage of the Angular OPA. The the serveur
  64 will redirect to http://myopa/#!sample this redirect will return the Index.html OPA file and will notify angular not to display
  65 the homepage by to goto samplepage.
  66
  67 Warning: in order Angular application to work both with a BASEURL="/" and BASEURL="/MyApp/" every page references have to be relative.
  68 Recommended model is to develop with a BASEURL="/opa" as any application working with a BASEURL will work without, when the opposite it not true.
  69
  70 Note: If a resource is not accessible from ROOTDIR then --alias should be use ex: --alias=/icons:/usr/share/icons. Only alias designed to access
  71 external support static files. They should not be used for API and OPA.
  72
  73
  74 ### On going work
  75
  76  -- Dynamic load of plugins. While everything is designed to support dynamically loadable plugins, this part is not done yet.
  77  -- Javascript plugins. As today only C plugins are supported, but JS plugins are on the ToDo list.
  78