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 ### License
   5 As of today, the code is licensed under GLPv3. While no decision as been taken yet, it will certainly switch to a different licence: GPLv2, Apache or MIT e.g..
   6
   7 Final goal is to keep the engine publicly accessible and modifiable, still allowing people to load non open-source plugins. The code itself already leverages open-source libraries, including libmicrohttpd & libjson.
   8
   9 Finally, whatever license is chosen, it should be compatible with dependencies and automotive industry requirements - as the primary target for this code is AGL.
  10
  11 ### Building
  12 Building Application Framework Binder has been tested under **Ubuntu 16.04 LTS (Xenial Xerus)** or **Fedora 23**, and requires the following libraries:
  13  * libmagic ("libmagic-dev" under Ubuntu, "file-devel" under Fedora);
  14  * libmicrohttpd >= 0.9.48  (fetch and build from "http://ftp.gnu.org/gnu/libmicrohttpd");
  15  * json-c ("libjson-c-dev/devel");
  16  * uuid ("uuid-dev/libuuid-devel");
  17  * openssl ("libssl-dev/openssl-devel");
  18  * systemd >= 222 ("libsystemd-dev/systemd-devel");
  19
  20 optionally, for plugins :
  21  * alsa ("libasound2-dev/alsa-devel");
  22  * pulseaudio ("libpulse-dev/libpulse-devel");
  23  * rtl-sdr >= 0.5.0 ("librtlsdr-dev", or fetch and build from "git://git.osmocom.org/rtl-sdr" under Fedora);
  24  * GUPnP ("libglib2.0-dev libgupnp-av-1.0-dev/glib2-devel libgupnp-av-devel");
  25
  26 and the following tools:
  27  * gcc;
  28  * make;
  29  * pkg-config;
  30  * cmake >= 2.8.8.
  31
  32 To install all dependencies under Ubuntu (excepting libmicrohttpd), please type:
  33 ```
  34 $ apt-get install libmagic-dev libjson-c-dev uuid-dev libsystemd-dev libssl-dev libasound2-dev libpulse-dev librtlsdr-dev libglib2.0-dev libgupnp-av-1.0-dev gcc make pkg-config cmake
  35 ```
  36 or under Fedora (excepting libmicrohttpd and rtl-sdr):
  37 ```
  38 $ dnf install file-devel json-c-devel libuuid-devel systemd-devel openssl-devel alsa-devel libpulse-devel glib2-devel libgupnp-av-devel gcc make pkg-config cmake
  39 ```
  40
  41  To build, move to the root directory and type:
  42 ```
  43 $ mkdir build; cd build<br />
  44 $ cmake ..<br />
  45 $ make; make install<br />
  46 ```
  47
  48 ### Starting
  49 ```
  50 $ afb-daemon --help
  51 $ afb-daemon --verbose --port=<port> --token='' --sessiondir=<working directory> --rootdir=<web directory (index.html)>
  52 ```
  53
  54 ### Example
  55 ```
  56 $ afb-daemon --verbose --port=1234 --token='' --sessiondir=/tmp --rootdir=/srv/www/htdocs --alias=icons:/usr/share/icons
  57 ```
  58
  59 ### Directories & Paths
  60 Default behaviour is to locate ROOTDIR in $HOME/.AFB
  61
  62 ### REST API
  63
  64 Developers are intended to provide a structure containing : API name, corresponding methods/callbacks, and optionally a context and a handle.
  65 A handle is a void* structure automatically passed to API callbacks. Callbacks also receive HTTP GET data as well as HTTP POST data, in case a POST method was used. Every method should return a JSON object or NULL in case of error.
  66
  67 API plugins can be protected from timeout and other errors. By default this behaviour is deactivated, use --apitimeout to activate it.
  68
  69         STATIC AFB_restapi myApis[]= {
  70           {"ping"    , AFB_SESSION_NONE,  (AFB_apiCB)ping,     "Ping Function"},
  71           {"action1" , AFB_SESSION_CHECK, (AFB_apiCB)action1 , "Action-1"},
  72           {"action2" , AFB_SESSION_CHECK, (AFB_apiCB)action2 , "Action-2"},
  73           {NULL}
  74         };
  75
  76         PUBLIC AFB_plugin *pluginRegister () {
  77             AFB_plugin *plugin = malloc (sizeof (AFB_plugin));
  78             plugin->type  = AFB_PLUGIN_JSON;
  79             plugin->info  = "Plugin Sample";
  80             plugin->prefix= "myPlugin";
  81             plugin->apis  = myApis;
  82             return (plugin);
  83         }
  84
  85 ### HTML5 and AngularJS Redirects
  86
  87 Binder supports HTML5 redirect mode even with an application baseurl. Default value for application base URL is /opa.
  88 See Application Framework HTML5 Client template at https://github.com/iotbzh/afb-client-sample
  89
  90 If the Binder receives something like _http://myopa/sample_ when sample is not the homepage of the AngularJS OPA, it will redirect to _http://myopa/#!sample_. This redirect will return the _index.html_ OPA file and will notify AngularJS not to display the homepage, but the sample page.
  91
  92 Warning: in order for AngularJS applications to be able to work with both BASEURL="/" and BASEURL="/MyApp/", all page references have to be relative.
  93 Recommended model is to develop with a BASEURL="/opa" as any application working with a BASEURL will work without, while the opposite is not true.
  94
  95 Note: If a resource is not accessible from ROOTDIR then the "--alias" switch should be used, as in: --alias=/icons:/usr/share/icons. Only use alias for external support static files. This should not be used for API and OPA.
  96
  97
  98 ### Ongoing work
  99
 100 Javascript plugins. As of today, only C plugins are supported, but JS plugins are on the TODO list.
 101