Initial Audio plugin
[src/app-framework-binder.git] / src / session.c
index aade418..55098b4 100644 (file)
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ * Reference: 
+ * https://github.com/json-c/json-c/blob/master/linkhash.c
+ * https://github.com/json-c/json-c/blob/master/linkhash.h
  */
 
 
 #include <time.h>
 #include <sys/stat.h>
 #include <sys/types.h>
+#include <pthread.h>
+#include <search.h>
+
 
 #define AFB_SESSION_JTYPE "AFB_session"
 #define AFB_SESSION_JLIST "AFB_sessions"
 #define AFB_SESSION_JINFO "AFB_infos"
 
+
 #define AFB_CURRENT_SESSION "active-session"  // file link name within sndcard dir
 #define AFB_DEFAULT_SESSION "current-session" // should be in sync with UI
 
-
-
+static pthread_mutex_t mutexHash;             // declare a mutex to protect hash table
+static struct hsearch_data sessions = {0};    // Create an empty hash table for sessions
 
 // verify we can read/write in session dir
 PUBLIC AFB_error sessionCheckdir (AFB_session *session) {
@@ -251,12 +259,12 @@ PUBLIC json_object * sessionToDisk (AFB_session *session, AFB_request *request,
 
 
    // do we have extra session info ?
-   if (request->post) {
+   if (request->post->type == AFB_POST_JSON) {
        static json_object *info, *jtype;
        const char  *ajglabel;
 
        // extract session info from args
-       info = json_tokener_parse (request->post);
+       info = json_tokener_parse (request->post->data);
        if (!info) {
             response = jsonNewMessage (AFB_FATAL,"sndcard=%s session=%s invalid json args=%s", request->plugin, name, request->post);
             goto OnErrorExit;
@@ -264,7 +272,7 @@ PUBLIC json_object * sessionToDisk (AFB_session *session, AFB_request *request,
 
        // info is a valid AFB_info type
        if (!json_object_object_get_ex (info, "jtype", &jtype)) {
-            response = jsonNewMessage (AFB_EMPTY,"sndcard=%s session=%s No 'AFB_type' args=%s", request->plugin, name, request->post);
+            response = jsonNewMessage (AFB_EMPTY,"sndcard=%s session=%s No 'AFB_pluginT' args=%s", request->plugin, name, request->post);
             goto OnErrorExit;
        }
 
@@ -300,3 +308,224 @@ OnErrorExit:
    json_object_put (jsonSession);
    return response;
 }
+
+
+
+
+// Free context [XXXX Should be protected again memory abort XXXX]
+STATIC void ctxUuidFreeCB (AFB_clientCtx *client) {
+  
+    // If application add a handle let's free it now
+    if (client->ctx != NULL) {
+        
+        // Free client handle with a standard Free function, with app callback or ignore it
+        if (client->plugin->freeCtxCB == NULL) free (client->ctx); 
+        else if (client->plugin->freeCtxCB != (void*)-1) client->plugin->freeCtxCB(client); 
+    }
+}
+
+// Create a new store in RAM, not that is too small it will be automatically extended
+PUBLIC void ctxStoreInit (int nbSession) {
+   int res; 
+   // let's create session hash table
+   res = hcreate_r(nbSession, &sessions);
+}
+
+STATIC AFB_clientCtx *ctxStoreSearch (const char* uuid) {
+    ENTRY item = {(char*) uuid};
+    ENTRY *pitem = &item;
+    // printf ("searching uuid=%s\n", uuid);
+    
+    pthread_mutex_lock(&mutexHash);
+    if (hsearch_r(item, FIND, &pitem, &sessions)) {
+        pthread_mutex_unlock(&mutexHash);
+        return  (AFB_clientCtx*) pitem->data;
+    }
+    pthread_mutex_unlock(&mutexHash);
+    return NULL;
+}
+
+// Reference http://stackoverflow.com/questions/25971505/how-to-delete-element-from-hsearch
+void ctxStoreAdd (AFB_clientCtx *client) {
+    ENTRY item = {client->uuid, (void*)client};
+    ENTRY *pitem = &item;
+
+    pthread_mutex_lock(&mutexHash);
+    if (hsearch_r(item, ENTER, &pitem, &sessions)) {
+        // printf ("storing uuid=%s\n", client->uuid);
+        pitem->data = (void *)client;
+    }
+    pthread_mutex_unlock(&mutexHash);
+}
+
+void ctxStoreDel (AFB_clientCtx *client) {
+    ENTRY item = {client->uuid};
+    ENTRY *pitem = &item;
+
+    pthread_mutex_lock(&mutexHash);
+    if (hsearch_r(item, FIND, &pitem, &sessions)) {
+        pitem->data = NULL;
+    }
+    pthread_mutex_unlock(&mutexHash);
+}
+
+// Check if context timeout or not
+STATIC int ctxStoreToOld (const void *k1, int timeout) {
+    int res;
+    AFB_clientCtx *ctx = (AFB_clientCtx*) k1;
+    time_t now =  time(NULL);
+    res = ((ctx->timeStamp + timeout) <= now);
+    return (res);    
+}
+
+// Loop on every entry and remove old context sessions
+PUBLIC int ctxStoreGarbage (struct lh_table *lht, const int timeout) {
+    if (verbose) fprintf (stderr, "****** Garbage Count=%d timeout=%d\n", lht->count, timeout);
+
+  
+}
+
+// This function will return exiting client context or newly created client context
+PUBLIC AFB_error ctxClientGet (AFB_request *request, AFB_plugin *plugin) {
+  static int cid=0;
+  AFB_clientCtx *clientCtx=NULL;
+  const char *uuid;
+  uuid_t newuuid;
+  int ret;
+  
+    if (request->config->token == NULL) return AFB_EMPTY;
+
+    // Check if client as a context or not inside the URL
+    uuid  = MHD_lookup_connection_value(request->connection, MHD_GET_ARGUMENT_KIND, "uuid");
+       
+    // if UUID in query we're restfull with no cookies otherwise check for cookie
+    if (uuid != NULL) request->restfull = TRUE;
+    else {
+        request->restfull = FALSE;
+        uuid = MHD_lookup_connection_value (request->connection, MHD_COOKIE_KIND, COOKIE_NAME);  
+    };
+    
+    // Warning when no cookie defined MHD_lookup_connection_value may return something !!!
+    if ((uuid != NULL) && (strnlen (uuid, 10) >= 10))   {
+        int search;
+        // search if client context exist and it not timeout let's use it
+        printf ("search old UID=%s\n", uuid);
+        clientCtx = ctxStoreSearch (uuid);
+
+       if (clientCtx && ! ctxStoreToOld (clientCtx, request->config->cntxTimeout)) {
+            request->client=clientCtx;
+            return;            
+        }
+    }
+   
+    // we have no session let's create one otherwise let's clean any exiting values
+    if (clientCtx == NULL) clientCtx = calloc(1, sizeof(AFB_clientCtx)); // init NULL clientContext
+    uuid_generate(newuuid);         // create a new UUID
+    uuid_unparse_lower(newuuid, clientCtx->uuid);
+    clientCtx->cid=cid++;   // simple application uniqueID 
+    clientCtx->plugin = plugin;    // provide plugin callbacks a hook to plugin
+    clientCtx->plugin;    // provide plugin callbacks a hook to plugin
+        
+    // if table is full at 50% let's clean it up
+    // if(clientCtxs->count > (clientCtxs->size / 2)) ctxStoreGarbage(clientCtxs, request->config->cntxTimeout);
+    
+    // finally add uuid into hashtable
+    ctxStoreAdd (clientCtx);
+    
+    // if (ret < 0) return (AFB_FAIL);
+    
+    if (verbose) fprintf (stderr, "ctxClientGet New uuid=[%s] token=[%s] timestamp=%d\n", clientCtx->uuid, clientCtx->token, clientCtx->timeStamp);      
+    request->client = clientCtx;
+
+    return (AFB_SUCCESS);
+}
+
+// Sample Generic Ping Debug API
+PUBLIC AFB_error ctxTokenCheck (AFB_request *request) {
+    const char *token;
+    
+    if (request->client == NULL) return AFB_EMPTY;
+    
+    // this time have to extract token from query list
+    token = MHD_lookup_connection_value(request->connection, MHD_GET_ARGUMENT_KIND, "token");
+    
+    // if not token is providing we refuse the exchange
+    if ((token == NULL) || (request->client->token == NULL)) return (AFB_FALSE);
+    
+    // compare current token with previous one
+    if ((0 == strcmp (token, request->client->token)) && (!ctxStoreToOld (request->client, request->config->cntxTimeout))) {
+       return (AFB_SUCCESS);
+    }
+    
+    // Token is not valid let move level of assurance to zero and free attached client handle
+    return (AFB_FAIL);
+}
+
+// Free Client Session Context
+PUBLIC AFB_error ctxTokenReset (AFB_request *request) {
+    int ret;
+    AFB_clientCtx *clientCtx;
+
+    if (request->client == NULL) return AFB_EMPTY;
+    
+    // Search for an existing client with the same UUID
+    clientCtx = ctxStoreSearch (request->client->uuid);
+    if (clientCtx == NULL) return AFB_FALSE;
+
+    // Remove client from table
+    ctxStoreDel (clientCtx);    
+    
+    return (AFB_SUCCESS);
+}
+
+// generate a new token
+PUBLIC AFB_error ctxTokenCreate (AFB_request *request) {
+    int oldTnkValid;
+    const char *ornew;
+    uuid_t newuuid;
+    const char *token;
+
+    if (request->client == NULL) return AFB_EMPTY;
+
+    // if config->token!="" then verify that we have the right initial share secret   
+    if (request->config->token[0] != '\0') {
+        
+        // check for initial token secret and return if not presented
+        token = MHD_lookup_connection_value(request->connection, MHD_GET_ARGUMENT_KIND, "token");
+        if (token == NULL) return AFB_UNAUTH;
+        
+        // verify that presented initial tokens fit
+        if (strcmp(request->config->token, token)) return AFB_UNAUTH;       
+    }
+    
+    // create a UUID as token value
+    uuid_generate(newuuid); 
+    uuid_unparse_lower(newuuid, request->client->token);
+    
+    // keep track of time for session timeout and further clean up
+    request->client->timeStamp=time(NULL); 
+    
+    // Token is also store in context but it might be convenient for plugin to access it directly
+    return (AFB_SUCCESS);
+}
+
+
+// generate a new token and update client context
+PUBLIC AFB_error ctxTokenRefresh (AFB_request *request) {
+    int oldTnkValid;
+    const char *oldornew;
+    uuid_t newuuid;
+
+    if (request->client == NULL) return AFB_EMPTY;
+    
+    // Check if the old token is valid
+    if (ctxTokenCheck (request) != AFB_SUCCESS) return (AFB_FAIL);
+        
+    // Old token was valid let's regenerate a new one    
+    uuid_generate(newuuid);         // create a new UUID
+    uuid_unparse_lower(newuuid, request->client->token);
+    return (AFB_SUCCESS);    
+    
+}
+