Fix frequency setting bug in Radio API
[src/app-framework-binder.git] / src / session.c
index cd5b09f..4877acf 100644 (file)
@@ -16,8 +16,8 @@
  * 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
+ * http://stackoverflow.com/questions/25971505/how-to-delete-element-from-hsearch
+ *
  */
 
 
 #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_JLIST "AFB_sessions.hash"
 #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 struct lh_table *clientCtxs=NULL;    // let's use JsonObject Hashtable to Store Sessions
-
+// Session UUID are store in a simple array [for 10 sessions this should be enough]
+static struct {
+  pthread_mutex_t mutex;          // declare a mutex to protect hash table
+  AFB_clientCtx **store;          // sessions store
+  int count;                      // current number of sessions
+  int max;
+} sessions;
 
 // verify we can read/write in session dir
 PUBLIC AFB_error sessionCheckdir (AFB_session *session) {
@@ -65,7 +72,7 @@ PUBLIC AFB_error sessionCheckdir (AFB_session *session) {
    return AFB_SUCCESS;
 }
 
-// let's return only sessions files
+// let's return only sessions.hash files
 STATIC int fileSelect (const struct dirent *entry) {
    return (strstr (entry->d_name, ".afb") != NULL);
 }
@@ -103,7 +110,7 @@ PUBLIC json_object *sessionList (AFB_session *session, AFB_request *request) {
     struct dirent **namelist;
     int  count, sessionDir;
 
-    // if directory for card's sessions does not exist create it
+    // if directory for card's sessions.hash does not exist create it
     ajgResponse = checkCardDirExit (session, request);
     if (ajgResponse != NULL) return ajgResponse;
 
@@ -117,7 +124,7 @@ PUBLIC json_object *sessionList (AFB_session *session, AFB_request *request) {
     close (sessionDir);
 
     if (count < 0) {
-        return (jsonNewMessage (AFB_FAIL,"Fail to scan sessions directory [%s/%s] error=%s", session->config->sessiondir, request->plugin, strerror(sessionDir)));
+        return (jsonNewMessage (AFB_FAIL,"Fail to scan sessions.hash directory [%s/%s] error=%s", session->config->sessiondir, request->plugin, strerror(sessionDir)));
     }
     if (count == 0) return (jsonNewMessage (AFB_EMPTY,"[%s] no session at [%s]", request->plugin, session->config->sessiondir));
 
@@ -187,7 +194,7 @@ PUBLIC json_object *sessionFromDisk (AFB_session *session, AFB_request *request,
     // check for current session request
     defsession = (strcmp (name, AFB_DEFAULT_SESSION) ==0);
 
-    // if directory for card's sessions does not exist create it
+    // if directory for card's sessions.hash does not exist create it
     response = checkCardDirExit (session, request);
     if (response != NULL) return response;
 
@@ -236,7 +243,7 @@ PUBLIC json_object * sessionToDisk (AFB_session *session, AFB_request *request,
    // check for current session request
    defsession = (strcmp (name, AFB_DEFAULT_SESSION) ==0);
 
-   // if directory for card's sessions does not exist create it
+   // if directory for card's sessions.hash does not exist create it
    response = checkCardDirExit (session, request);
    if (response != NULL) return response;
 
@@ -257,12 +264,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;
@@ -270,7 +277,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;
        }
 
@@ -308,88 +315,134 @@ OnErrorExit:
 }
 
 
-// Function to handle Cookies and Client session context it relies on json low level
-// linked list functionalities https://github.com/json-c/json-c/blob/master/linkhash.c
-
-// Hash client UUID before storing in table
-STATIC unsigned long ctxUuidHashCB (const void *k1) {
-    unsigned long hash;
-    
-    AFB_clientCtx *ctx = (AFB_clientCtx*) k1;
-    hash = lh_char_hash(ctx->uuid);
-    return (hash);    
-}
 
-// Compare client UUIDs within table
-STATIC int ctxUuidCompCB (const void *k1, const void *k2) {
-    int res;    
-    AFB_clientCtx *ctx1 = (AFB_clientCtx*) k1;
-    AFB_clientCtx *ctx2 = (AFB_clientCtx*) k2;
-    
-    res = lh_char_equal(ctx1->uuid, ctx2->uuid);
-    return (res);    
-}
 
 // Free context [XXXX Should be protected again memory abort XXXX]
-STATIC void ctxUuidFreeCB (struct lh_entry *entry) {
-    AFB_clientCtx *ctx = (AFB_clientCtx*) entry->v;
-
+STATIC void ctxUuidFreeCB (AFB_clientCtx *client) {
+  
     // If application add a handle let's free it now
-    if (ctx->handle != NULL) {
+    if (client->ctx != NULL) {
         
         // Free client handle with a standard Free function, with app callback or ignore it
-        if (ctx->freeHandleCB == NULL) free (ctx->handle); 
-        else if (ctx->freeHandleCB != (void*)-1) ctx->freeHandleCB(ctx->handle); 
+        if (client->plugin->freeCtxCB == NULL) free (client->ctx); 
+        else if (client->plugin->freeCtxCB != (void*)-1) client->plugin->freeCtxCB(client); 
     }
-    free ((void*)entry->v);
 }
 
 // Create a new store in RAM, not that is too small it will be automatically extended
-STATIC struct lh_table *ctxStoreCreate (int nbSession) {
-   lh_table *table; 
+PUBLIC void ctxStoreInit (int nbSession) {
+   int res;
+   
+   // let's create as store as hashtable does not have any
+   sessions.store = calloc (nbSession+1, sizeof(AFB_clientCtx));
+   sessions.max=nbSession;
+}
+
+STATIC AFB_clientCtx *ctxStoreSearch (const char* uuid) {
+    int  idx;
+    AFB_clientCtx *client;
+    
+    if (uuid == NULL) return NULL;
+    
+    pthread_mutex_lock(&sessions.mutex);
+    
+    for (idx=0; idx < sessions.max; idx++) {
+        if (sessions.store[idx] && (0 == strcmp (uuid, sessions.store[idx]->uuid))) break;
+    }
     
-   // function will exit process in case of error !!! 
-   table=lh_table_new (nbSession, "CtxClient", ctxUuidFreeCB, ctxUuidHashCB, ctxUuidCompCB);
-   return (table);
+    if (idx == sessions.max) client=NULL;
+    else client= sessions.store[idx];
+    
+    pthread_mutex_unlock(&sessions.mutex);
+    
+    return (client);
 }
 
-// Check if context timeout or not
-STATIC int ctxStoreToOld (const void *k1, int timeout) {
-    int res;    
-    AFB_clientCtx *ctx = (AFB_clientCtx*) k1;
 
-    res = ((ctx->timeStamp + timeout) < time(NULL));
+STATIC AFB_error ctxStoreDel (AFB_clientCtx *client) {
+    int idx;
+    int status;
+    if (client == NULL) return (AFB_FAIL);
+
+    //fprintf (stderr, "ctxStoreDel request uuid=%s count=%d\n", client->uuid, sessions.count);
+    
+    pthread_mutex_lock(&sessions.mutex);
+    
+    for (idx=0; idx < sessions.max; idx++) {
+        if (sessions.store[idx] && (0 == strcmp (client->uuid, sessions.store[idx]->uuid))) break;
+    }
+    
+    if (idx == sessions.max) status=AFB_FAIL;
+    else {
+        sessions.count --;
+        sessions.store[idx]=NULL;
+        status=AFB_SUCCESS;
+    }
+    
+    pthread_mutex_unlock(&sessions.mutex);
+    
+    return (status);
+    
+    // plugin registered a callback let's release semaphore and cleanup now
+    if ((client->plugin->freeCtxCB != NULL) && client->ctx) client->plugin->freeCtxCB(client);
+}
+
+STATIC AFB_error ctxStoreAdd (AFB_clientCtx *client) {
+    int idx;
+    int status;
+    if (client == NULL) return (AFB_FAIL);
+
+    //fprintf (stderr, "ctxStoreAdd request uuid=%s count=%d\n", client->uuid, sessions.count);
+    
+    pthread_mutex_lock(&sessions.mutex);
+    
+    for (idx=0; idx < sessions.max; idx++) {
+        if (NULL == sessions.store[idx]) break;
+    }
+    
+    if (idx == sessions.max) status=AFB_FAIL;
+    else {
+        status=AFB_SUCCESS;
+        sessions.count ++;
+        sessions.store[idx]= client;
+    }
+    
+    pthread_mutex_unlock(&sessions.mutex);
+    
+    return (status);
+}
+
+// Check if context timeout or not
+STATIC int ctxStoreToOld (AFB_clientCtx *ctx, int timeout) {
+    int res;
+    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) {
-    struct lh_entry *c;
+// Loop on every entry and remove old context sessions.hash
+PUBLIC int ctxStoreGarbage (const int timeout) {
+    AFB_clientCtx *ctx;
+    long idx;
     
-    // Loop on every entry within table
-    for(c = lht->head; c != NULL; c = c->next) {
-        if(lht->free_fn) {
-            if(c->k == LH_EMPTY) return lht->count;
-            if(c->k != LH_FREED &&  ctxStoreToOld(c->v, timeout)) lh_table_delete_entry (lht, c);
-       }
+    // Loop on Sessions Table and remove anything that is older than timeout
+    for (idx=0; idx < sessions.max; idx++) {
+        ctx=sessions.store[idx];
+        if ((ctx != NULL) && (ctxStoreToOld(ctx, timeout))) {
+            ctxStoreDel (ctx);
+        }
     }
-  
-    // return current size after cleanup
-    return (lht->count);
 }
 
 // This function will return exiting client context or newly created client context
-PUBLIC int ctxClientGet (AFB_request *request) {
+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 client session store is null create it
-   if (clientCtxs == NULL) {
-       clientCtxs= ctxStoreCreate(CTX_NBCLIENTS);
-   }
+    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");
@@ -401,41 +454,53 @@ PUBLIC int ctxClientGet (AFB_request *request) {
         uuid = MHD_lookup_connection_value (request->connection, MHD_COOKIE_KIND, COOKIE_NAME);  
     };
     
-    
-    if (uuid != NULL)   {
+    // 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
-       if ((lh_table_lookup_ex (clientCtxs, uuid, (void**) &clientCtx)) 
-                && ! ctxStoreToOld (clientCtx, request->config->cntxTimeout)) {
+        clientCtx = ctxStoreSearch (uuid);
+
+       if (clientCtx) {
+            if (ctxStoreToOld (clientCtx, request->config->cntxTimeout)) {
+                 // this session is too old let's delete it
+                ctxStoreDel (clientCtx);
+                clientCtx=NULL;
+            } else {
                 request->client=clientCtx;
-                if (verbose) fprintf (stderr, "ctxClientGet Old uuid=[%s] token=[%s] timestamp=%d\n"
-                             ,request->client->uuid, request->client->token, request->client->timeStamp);
-                return;            
+                return (AFB_SUCCESS);            
+            }
         }
     }
-
-    
+   
     // 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++;
+    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*0.5)) ctxStoreGarbage(clientCtxs, request->config->cntxTimeout);
+    if(sessions.count > (sessions.max / 2)) ctxStoreGarbage(request->config->cntxTimeout);
     
     // finally add uuid into hashtable
-    ret= lh_table_insert (clientCtxs, (void*)clientCtx->uuid, clientCtx);
+    if (AFB_SUCCESS != ctxStoreAdd (clientCtx)) {
+        free (clientCtx);
+        return(AFB_FAIL);
+    }
     
-    if (verbose) fprintf (stderr, "ctxClientGet New uuid=[%s] token=[%s] timestamp=%d\n", clientCtx->uuid, clientCtx->token, clientCtx->timeStamp);
-       
+    // if (verbose) fprintf (stderr, "ctxClientGet New uuid=[%s] token=[%s] timestamp=%d\n", clientCtx->uuid, clientCtx->token, clientCtx->timeStamp);      
     request->client = clientCtx;
-    return (ret);
+
+    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");
     
@@ -444,32 +509,50 @@ PUBLIC AFB_error ctxTokenCheck (AFB_request *request) {
     
     // compare current token with previous one
     if ((0 == strcmp (token, request->client->token)) && (!ctxStoreToOld (request->client, request->config->cntxTimeout))) {
-       return (AFB_TRUE);
+       return (AFB_SUCCESS);
     }
     
     // Token is not valid let move level of assurance to zero and free attached client handle
-    return (AFB_FALSE);
+    return (AFB_FAIL);
 }
 
 // Free Client Session Context
-PUBLIC int ctxTokenReset (AFB_request *request) {
-    struct lh_entry* entry;
+PUBLIC AFB_error ctxTokenReset (AFB_request *request) {
     int ret;
-        
-    entry = lh_table_lookup_entry (clientCtxs, request->client->uuid);
-    if (entry == NULL) return FALSE;
+    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);    
     
-    lh_table_delete_entry (clientCtxs, entry);
-    return (TRUE);
+    return (AFB_SUCCESS);
 }
 
 // generate a new token
-PUBLIC char* ctxTokenCreate (AFB_request *request) {
+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);
@@ -478,28 +561,25 @@ PUBLIC char* ctxTokenCreate (AFB_request *request) {
     request->client->timeStamp=time(NULL); 
     
     // Token is also store in context but it might be convenient for plugin to access it directly
-    return (request->client->token);
+    return (AFB_SUCCESS);
 }
 
 
 // generate a new token and update client context
-PUBLIC char* ctxTokenRefresh (AFB_request *request) {
+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
-    oldTnkValid= ctxTokenCheck (request);
+    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);    
     
-    // if token is not valid let check for query argument "oldornew"
-    if (!oldTnkValid) {
-        oldornew = MHD_lookup_connection_value(request->connection, MHD_GET_ARGUMENT_KIND, "oldornew");
-        if (oldornew != NULL) oldTnkValid= TRUE;
-    }
-   
-    // No existing token and no request to create one
-    if (oldTnkValid != TRUE) return NULL;
-
-    return (ctxTokenCreate (request));
 }