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