cleaning copyrights
[src/app-framework-binder.git] / plugins / radio / radio-api.c
index ea17eb5..edeb978 100644 (file)
@@ -1,22 +1,29 @@
 /*
- * Copyright (C) 2015 "IoT.bzh"
+ * Copyright (C) 2015, 2016 "IoT.bzh"
  * Author "Manuel Bachmann"
  *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ *   http://www.apache.org/licenses/LICENSE-2.0
  *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 
+#define _GNU_SOURCE
+#include <strings.h>
+#include <json-c/json.h>
+
 #include "radio-api.h"
+#include "radio-rtlsdr.h"
+
+#include "afb-plugin.h"
+#include "afb-req-itf.h"
 
 /* ********************************************************
 
 
 /* ------ LOCAL HELPER FUNCTIONS --------- */
 
+static pluginHandleT *the_radio = NULL;
+
 /* detect new radio devices */
-STATIC void updateRadioDevList(pluginHandleT *handle) {
+void updateRadioDevList(pluginHandleT *handle) {
 
   int idx;  
 
@@ -41,18 +50,16 @@ STATIC void updateRadioDevList(pluginHandleT *handle) {
 }
 
 /* global plugin context creation ; at loading time [radio devices might not be visible] */
-STATIC pluginHandleT* initRadioPlugin() {
+static void initRadioPlugin() {
 
-  pluginHandleT *handle;
+  pluginHandleT *handle = the_radio;
 
   handle = calloc (1, sizeof(pluginHandleT));
   updateRadioDevList (handle);
-
-  return handle;
 }
 
 /* private client context creation ; default values */
-STATIC radioCtxHandleT* initRadioCtx () {
+static radioCtxHandleT* initRadioCtx () {
 
     radioCtxHandleT *ctx;
 
@@ -68,15 +75,15 @@ STATIC radioCtxHandleT* initRadioCtx () {
 }
 
 /* reserve a radio device for requesting client, power it on */
-STATIC AFB_error reserveRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {
-    int idx;
+unsigned char reserveRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {
+    unsigned int idx;
 
     /* loop on all devices, find an unused one */
     for (idx = 0; idx < _radio_dev_count(); idx++) {
         if (idx == MAX_RADIO) break;
         if (handle->radios[idx]->used == FALSE) goto found_radio; /* found one */
     }
-    return AFB_FAIL;
+    return 0;
 
    found_radio:
     /* try to power it on, passing client context info such as frequency... */
@@ -90,11 +97,11 @@ STATIC AFB_error reserveRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {
     ctx->radio = handle->radios[idx];
     ctx->idx = idx;
 
-    return AFB_SUCCESS;
+    return 1;
 }
 
 /* free a radio device from requesting client, power it off */
-STATIC AFB_error releaseRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {
+unsigned char releaseRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {
 
     /* stop playing if it was doing this (blocks otherwise) */
     if (ctx->is_playing) {
@@ -112,37 +119,40 @@ STATIC AFB_error releaseRadio (pluginHandleT *handle, radioCtxHandleT *ctx) {
     ctx->radio = NULL;
     ctx->idx = -1;
 
-    return AFB_SUCCESS;
+    return 1;
 }
 
 /* called when client session dies [e.g. client quits for more than 15mns] */
-STATIC void freeRadio (void *context, void *handle) {
+static void freeRadio (void *context) {
 
-    releaseRadio (handle, context);
+    releaseRadio (the_radio, context);
     free (context);
 }
 
 
 /* ------ PUBLIC PLUGIN FUNCTIONS --------- */
 
-STATIC json_object* init (AFB_request *request) {        /* AFB_SESSION_CHECK */
+static void init (struct afb_req request) {        /* AFB_SESSION_CHECK */
 
+    radioCtxHandleT *ctx = (radioCtxHandleT*) afb_req_context_get(request);
     json_object *jresp;
 
     /* create a private client context */
-    if (!request->context)
-        request->context = initRadioCtx();
+    if (!ctx) {
+        ctx = initRadioCtx();
+        afb_req_context_set (request, ctx, free);
+    }
 
     jresp = json_object_new_object();
-    json_object_object_add(jresp, "info", json_object_new_string ("Radio initialized"));
-    return jresp;
+    json_object_object_add(jresp, "init", json_object_new_string ("success"));
+    afb_req_success (request, jresp, "Radio - Initialized");
 }
 
-STATIC json_object* power (AFB_request *request) {       /* AFB_SESSION_CHECK */
+static void power (struct afb_req request) {       /* AFB_SESSION_CHECK */
 
-    pluginHandleT *handle = (pluginHandleT*)request->handle;
-    radioCtxHandleT *ctx = (radioCtxHandleT*)request->context;
-    const char *value = getQueryValue (request, "value");
+    pluginHandleT *handle = the_radio;
+    radioCtxHandleT *ctx = (radioCtxHandleT*) afb_req_context_get(request);
+    const char *value = afb_req_value (request, "value");
     json_object *jresp;
 
     /* no "?value=" parameter : return current state */
@@ -156,9 +166,9 @@ STATIC json_object* power (AFB_request *request) {       /* AFB_SESSION_CHECK */
     /* "?value=" parameter is "1" or "true" */
     else if ( atoi(value) == 1 || !strcasecmp(value, "true") ) {
         if (!ctx->radio) {
-            if (reserveRadio (handle, ctx) == AFB_FAIL) {
-                request->errcode = MHD_HTTP_SERVICE_UNAVAILABLE;
-                return (jsonNewMessage (AFB_FAIL, "No more radio devices available"));
+            if (!reserveRadio (handle, ctx)) {
+                afb_req_fail (request, "failed", "no more radio devices available");
+                       return;
             }
         }
         jresp = json_object_new_object();
@@ -168,9 +178,9 @@ STATIC json_object* power (AFB_request *request) {       /* AFB_SESSION_CHECK */
     /* "?value=" parameter is "0" or "false" */
     else if ( atoi(value) == 0 || !strcasecmp(value, "false") ) {
         if (ctx->radio) {
-            if (releaseRadio (handle, ctx) == AFB_FAIL) {
-                request->errcode = MHD_HTTP_SERVICE_UNAVAILABLE;
-                return (jsonNewMessage (AFB_FAIL, "Unable to release radio device"));
+            if (!releaseRadio (handle, ctx)) {
+                afb_req_fail (request, "failed", "Unable to release radio device");
+                       return;
             }
         }
         jresp = json_object_new_object();
@@ -179,13 +189,13 @@ STATIC json_object* power (AFB_request *request) {       /* AFB_SESSION_CHECK */
     else
         jresp = NULL;
 
-    return jresp;
+    afb_req_success (request, jresp, "Radio - Power set");
 }
 
-STATIC json_object* mode (AFB_request *request) {        /* AFB_SESSION_CHECK */
+static void mode (struct afb_req request) {        /* AFB_SESSION_CHECK */
 
-    radioCtxHandleT *ctx = (radioCtxHandleT*)request->context;
-    const char *value = getQueryValue (request, "value");
+    radioCtxHandleT *ctx = (radioCtxHandleT*) afb_req_context_get(request);
+    const char *value = afb_req_value (request, "value");
     json_object *jresp = json_object_new_object();
 
     /* no "?value=" parameter : return current state */
@@ -208,14 +218,14 @@ STATIC json_object* mode (AFB_request *request) {        /* AFB_SESSION_CHECK */
         _radio_set_mode (ctx->idx, ctx->mode);
         json_object_object_add (jresp, "mode", json_object_new_string ("FM"));
     }
-    
-    return jresp;
+
+    afb_req_success (request, jresp, "Radio - Mode set");
 }
 
-STATIC json_object* freq (AFB_request *request) {        /* AFB_SESSION_CHECK */
+static void freq (struct afb_req request) {        /* AFB_SESSION_CHECK */
 
-    radioCtxHandleT *ctx = (radioCtxHandleT*)request->context;
-    const char *value = getQueryValue (request, "value");
+    radioCtxHandleT *ctx = (radioCtxHandleT*) afb_req_context_get(request);
+    const char *value = afb_req_value (request, "value");
     json_object *jresp = json_object_new_object();
     double freq;
     char freq_str[256];
@@ -235,16 +245,15 @@ STATIC json_object* freq (AFB_request *request) {        /* AFB_SESSION_CHECK */
         snprintf (freq_str, sizeof(freq_str), "%f", ctx->freq);
         json_object_object_add (jresp, "freq", json_object_new_string (freq_str));
     }
-    
-    return jresp;
+
+    afb_req_success (request, jresp, "Radio - Frequency Set");
 }
 
-STATIC json_object* mute (AFB_request *request) {        /* AFB_SESSION_CHECK */
+static void mute (struct afb_req request) {        /* AFB_SESSION_CHECK */
 
-    radioCtxHandleT *ctx = (radioCtxHandleT*)request->context;
-    const char *value = getQueryValue (request, "value");
+    radioCtxHandleT *ctx = (radioCtxHandleT*) afb_req_context_get(request);
+    const char *value = afb_req_value (request, "value");
     json_object *jresp = json_object_new_object();
-    char *mute_str;
 
     /* no "?value=" parameter : return current state */
     if (!value || !ctx->radio) {
@@ -266,14 +275,14 @@ STATIC json_object* mute (AFB_request *request) {        /* AFB_SESSION_CHECK */
         _radio_set_mute (ctx->idx, ctx->mute);
         json_object_object_add (jresp, "mute", json_object_new_string ("off"));
     }
-    
-    return jresp;
+
+    afb_req_success (request, jresp, "Radio - Mute set"); 
 }
 
-STATIC json_object* play (AFB_request *request) {        /* AFB_SESSION_CHECK */
+static void play (struct afb_req request) {        /* AFB_SESSION_CHECK */
 
-    radioCtxHandleT *ctx = (radioCtxHandleT*)request->context;
-    const char *value = getQueryValue (request, "value");
+    radioCtxHandleT *ctx = (radioCtxHandleT*) afb_req_context_get(request);
+    const char *value = afb_req_value (request, "value");
     json_object *jresp = json_object_new_object();
     
     /* no "?value=" parameter : return current state */
@@ -299,34 +308,34 @@ STATIC json_object* play (AFB_request *request) {        /* AFB_SESSION_CHECK */
         json_object_object_add (jresp, "play", json_object_new_string ("off"));
     }
 
-    return jresp;
+    afb_req_success (request, jresp, "Radio - Play succeeded");
 }
 
-STATIC json_object* ping (AFB_request *request) {         /* AFB_SESSION_NONE */
-    return jsonNewMessage(AFB_SUCCESS, "Ping Binder Daemon - Radio API");
+static void ping (struct afb_req request) {         /* AFB_SESSION_NONE */
+    afb_req_success (request, NULL, "Radio - Ping succeeded");
 }
 
 
-STATIC AFB_restapi pluginApis[]= {
-  {"init"   , AFB_SESSION_CHECK,  (AFB_apiCB)init       , "Radio API - init"},
-  {"power"  , AFB_SESSION_CHECK,  (AFB_apiCB)power      , "Radio API - power"},
-  {"mode"   , AFB_SESSION_CHECK,  (AFB_apiCB)mode       , "Radio API - mode"},
-  {"freq"   , AFB_SESSION_CHECK,  (AFB_apiCB)freq       , "Radio API - freq"},
-  {"mute"   , AFB_SESSION_CHECK,  (AFB_apiCB)mute       , "Radio API - mute"},
-  {"play"   , AFB_SESSION_CHECK,  (AFB_apiCB)play       , "Radio API - play"},
-  {"ping"   , AFB_SESSION_NONE,   (AFB_apiCB)ping       , "Radio API - ping"},
+static const struct AFB_restapi pluginApis[]= {
+  {"init"   , AFB_SESSION_CHECK,  init       , "Radio API - init"},
+  {"power"  , AFB_SESSION_CHECK,  power      , "Radio API - power"},
+  {"mode"   , AFB_SESSION_CHECK,  mode       , "Radio API - mode"},
+  {"freq"   , AFB_SESSION_CHECK,  freq       , "Radio API - freq"},
+  {"mute"   , AFB_SESSION_CHECK,  mute       , "Radio API - mute"},
+  {"play"   , AFB_SESSION_CHECK,  play       , "Radio API - play"},
+  {"ping"   , AFB_SESSION_NONE,   ping       , "Radio API - ping"},
   {NULL}
 };
 
-PUBLIC AFB_plugin* pluginRegister () {
-    AFB_plugin *plugin = malloc (sizeof(AFB_plugin));
-    plugin->type  = AFB_PLUGIN_JSON;
-    plugin->info  = "Application Framework Binder - Radio plugin";
-    plugin->prefix  = "radio";
-    plugin->apis  = pluginApis;
-
-    plugin->handle = initRadioPlugin();
-    plugin->freeCtxCB = (AFB_freeCtxCB)freeRadio;
-
-    return (plugin);
+static const struct AFB_plugin pluginDesc = {
+    .type  = AFB_PLUGIN_JSON,
+    .info  = "Application Framework Binder - Radio plugin",
+    .prefix  = "radio",
+    .apis  = pluginApis
 };
+
+const struct AFB_plugin *pluginRegister (const struct AFB_interface *itf)
+{
+    initRadioPlugin();
+       return &pluginDesc;
+}