refactoring context handling
[src/app-framework-binder.git] / src / session.c
index ad41123..fbc7f2f 100644 (file)
@@ -2,22 +2,17 @@
  * Copyright (C) 2015 "IoT.bzh"
  * Author "Fulup Ar Foll"
  *
- * 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.
- *
- * 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:
- * http://stackoverflow.com/questions/25971505/how-to-delete-element-from-hsearch
+ *   http://www.apache.org/licenses/LICENSE-2.0
  *
+ * 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 <uuid/uuid.h>
 #include <assert.h>
 
-
-/*
-#include <dirent.h>
-#include <string.h>
-#include <sys/stat.h>
-#include <sys/types.h>
-#include <search.h>
-#include <assert.h>
-*/
-
-#include "afb-apis.h"
 #include "session.h"
 
 #define NOW (time(NULL))
@@ -47,7 +31,7 @@
 // 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
+  struct AFB_clientCtx **store;          // sessions store
   int count;                      // current number of sessions
   int max;
   int timeout;
@@ -55,34 +39,41 @@ static struct {
   const char *initok;
 } sessions;
 
-static const char key_uuid[] = "uuid";
-static const char key_token[] = "token";
+void *afb_context_get(struct afb_context *actx)
+{
+       return actx->context;
+}
+
+void afb_context_set(struct afb_context *actx, void *context, void (*free_context)(void*))
+{
+fprintf(stderr, "afb_context_set(%p,%p) was (%p,%p)\n",context, free_context, actx->context, actx->free_context);
+       if (actx->context != NULL && actx->free_context != NULL)
+               actx->free_context(actx->context);
+       actx->context = context;
+       actx->free_context = free_context;
+}
 
 // Free context [XXXX Should be protected again memory abort XXXX]
-static void ctxUuidFreeCB (AFB_clientCtx *client)
+static void ctxUuidFreeCB (struct AFB_clientCtx *client)
 {
-    int idx;
+       int idx;
 
-    // If application add a handle let's free it now
-    if (client->contexts != NULL) {
+       // If application add a handle let's free it now
+       assert (client->contexts != NULL);
 
-        // Free client handle with a standard Free function, with app callback or ignore it
-        for (idx=0; idx < sessions.apicount; idx ++) {
-            if (client->contexts[idx] != NULL) {
-               afb_apis_free_context(idx, client->contexts[idx]);
-            }
-        }
-    }
+       // Free client handle with a standard Free function, with app callback or ignore it
+       for (idx=0; idx < sessions.apicount; idx ++)
+               afb_context_set(&client->contexts[idx], NULL, NULL);
 }
 
 // Create a new store in RAM, not that is too small it will be automatically extended
-void ctxStoreInit (int nbSession, int timeout, int apicount, const char *initok)
+void ctxStoreInit (int max_session_count, int timeout, const char *initok, int context_count)
 {
        // let's create as store as hashtable does not have any
-       sessions.store = calloc (1 + (unsigned)nbSession, sizeof(AFB_clientCtx));
-       sessions.max = nbSession;
+       sessions.store = calloc (1 + (unsigned)max_session_count, sizeof(struct AFB_clientCtx));
+       sessions.max = max_session_count;
        sessions.timeout = timeout;
-       sessions.apicount = apicount;
+       sessions.apicount = context_count;
        if (strlen(initok) >= 37) {
                fprintf(stderr, "Error: initial token '%s' too long (max length 36)", initok);
                exit(1);
@@ -90,10 +81,10 @@ void ctxStoreInit (int nbSession, int timeout, int apicount, const char *initok)
        sessions.initok = initok;
 }
 
-static AFB_clientCtx *ctxStoreSearch (const char* uuid)
+static struct AFB_clientCtx *ctxStoreSearch (const char* uuid)
 {
     int  idx;
-    AFB_clientCtx *client;
+    struct AFB_clientCtx *client;
 
     assert (uuid != NULL);
 
@@ -111,7 +102,7 @@ found:
     return client;
 }
 
-static int ctxStoreDel (AFB_clientCtx *client)
+static int ctxStoreDel (struct AFB_clientCtx *client)
 {
     int idx;
     int status;
@@ -124,7 +115,6 @@ static int ctxStoreDel (AFB_clientCtx *client)
         if (sessions.store[idx] == client) {
                sessions.store[idx]=NULL;
                sessions.count--;
-               ctxUuidFreeCB (client);
                status = 1;
                goto deleted;
        }
@@ -135,7 +125,7 @@ deleted:
     return status;
 }
 
-static int ctxStoreAdd (AFB_clientCtx *client)
+static int ctxStoreAdd (struct AFB_clientCtx *client)
 {
     int idx;
     int status;
@@ -161,59 +151,67 @@ added:
 }
 
 // Check if context timeout or not
-static int ctxStoreTooOld (AFB_clientCtx *ctx, time_t now)
+static int ctxStoreTooOld (struct AFB_clientCtx *ctx, time_t now)
 {
-    return ctx->timeStamp <= now;
+    return ctx->expiration <= now;
 }
 
 // Loop on every entry and remove old context sessions.hash
-void ctxStoreGarbage ()
+static void ctxStoreCleanUp (time_t now)
 {
-    AFB_clientCtx *ctx;
-    long idx;
-    time_t now = NOW;
-
-    // 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 && ctxStoreTooOld(ctx, now)) {
-            ctxStoreDel (ctx);
-        }
-    }
+       struct AFB_clientCtx *ctx;
+       long idx;
+
+       // 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 && ctxStoreTooOld(ctx, now)) {
+                       ctxClientClose (ctx);
+               }
+       }
 }
 
 // This function will return exiting client context or newly created client context
-AFB_clientCtx *ctxClientGet (const char *uuid)
+struct AFB_clientCtx *ctxClientGetForUuid (const char *uuid)
 {
        uuid_t newuuid;
-       AFB_clientCtx *clientCtx;
+       struct AFB_clientCtx *clientCtx;
+       time_t now;
 
        /* search for an existing one not too old */
+       now = NOW;
+       ctxStoreCleanUp (now);
        clientCtx = uuid != NULL ? ctxStoreSearch (uuid) : NULL;
        if (clientCtx) {
-            if (!ctxStoreTooOld (clientCtx, NOW))
+               clientCtx->refcount++;
                return clientCtx;
-            ctxStoreDel (clientCtx);
         }
 
        /* mimic old behaviour */
+/*
+TODO remove? not remove?
        if (sessions.initok == NULL)
                return NULL;
-
-       /* cleanup before creating */
-       if(2 * sessions.count >= sessions.max)
-               ctxStoreGarbage();
+*/
+       /* check the uuid if given */
+       if (uuid != NULL && strlen(uuid) >= sizeof clientCtx->uuid)
+               return NULL;
 
        /* returns a new one */
-        clientCtx = calloc(1, sizeof(AFB_clientCtx)); // init NULL clientContext
+        clientCtx = calloc(1, sizeof(struct AFB_clientCtx)); // init NULL clientContext
        if (clientCtx != NULL) {
-               clientCtx->contexts = calloc ((unsigned)sessions.apicount, sizeof (void*));
+               clientCtx->contexts = calloc ((unsigned)sessions.apicount, sizeof(*clientCtx->contexts));
                if (clientCtx->contexts != NULL) {
                        /* generate the uuid */
-                       uuid_generate(newuuid);
-                       uuid_unparse_lower(newuuid, clientCtx->uuid);
-                       clientCtx->timeStamp = time(NULL) + sessions.timeout;
+                       if (uuid == NULL) {
+                               uuid_generate(newuuid);
+                               uuid_unparse_lower(newuuid, clientCtx->uuid);
+                       } else {
+                               strcpy(clientCtx->uuid, uuid);
+                       }
                        strcpy(clientCtx->token, sessions.initok);
+                       clientCtx->expiration = now + sessions.timeout;
+                       clientCtx->refcount = 1;
                        if (ctxStoreAdd (clientCtx))
                                return clientCtx;
                        free(clientCtx->contexts);
@@ -223,15 +221,35 @@ AFB_clientCtx *ctxClientGet (const char *uuid)
        return NULL;
 }
 
+struct AFB_clientCtx *ctxClientGet(struct AFB_clientCtx *clientCtx)
+{
+       if (clientCtx != NULL)
+               clientCtx->refcount++;
+       return clientCtx;
+}
+
+void ctxClientPut(struct AFB_clientCtx *clientCtx)
+{
+       if (clientCtx != NULL) {
+               assert(clientCtx->refcount != 0);
+               --clientCtx->refcount;
+       }
+}
+
 // Free Client Session Context
-int ctxClientClose (AFB_clientCtx *clientCtx)
+void ctxClientClose (struct AFB_clientCtx *clientCtx)
 {
        assert(clientCtx != NULL);
-       return ctxStoreDel (clientCtx);
+       if (clientCtx->created) {
+               clientCtx->created = 0;
+               ctxUuidFreeCB (clientCtx);
+       }
+               if (clientCtx->refcount == 0)
+               ctxStoreDel (clientCtx);
 }
 
 // Sample Generic Ping Debug API
-int ctxTokenCheck (AFB_clientCtx *clientCtx, const char *token)
+int ctxTokenCheckLen (struct AFB_clientCtx *clientCtx, const char *token, size_t length)
 {
        assert(clientCtx != NULL);
        assert(token != NULL);
@@ -239,17 +257,25 @@ int ctxTokenCheck (AFB_clientCtx *clientCtx, const char *token)
        // compare current token with previous one
        if (ctxStoreTooOld (clientCtx, NOW))
                return 0;
-       if (!clientCtx->token[0] || 0 == strcmp (token, clientCtx->token)) {
-               clientCtx->timeStamp = time(NULL) + sessions.timeout;
-               return 1;
-       }
 
-       // Token is not valid let move level of assurance to zero and free attached client handle
-       return 0;
+       if (clientCtx->token[0] && (length >= sizeof(clientCtx->token) || strncmp (token, clientCtx->token, length) || clientCtx->token[length]))
+               return 0;
+
+       clientCtx->created = 1; /* creates by default */
+       return 1;
+}
+
+// Sample Generic Ping Debug API
+int ctxTokenCheck (struct AFB_clientCtx *clientCtx, const char *token)
+{
+       assert(clientCtx != NULL);
+       assert(token != NULL);
+
+       return ctxTokenCheckLen(clientCtx, token, strlen(token));
 }
 
 // generate a new token and update client context
-int ctxTokenNew (AFB_clientCtx *clientCtx)
+void ctxTokenNew (struct AFB_clientCtx *clientCtx)
 {
        uuid_t newuuid;
 
@@ -260,8 +286,6 @@ int ctxTokenNew (AFB_clientCtx *clientCtx)
        uuid_unparse_lower(newuuid, clientCtx->token);
 
        // keep track of time for session timeout and further clean up
-       clientCtx->timeStamp = time(NULL) + sessions.timeout;
-
-       return 1;
+       clientCtx->expiration = NOW + sessions.timeout;
 }