cleaning copyrights
[src/app-framework-binder.git] / src / session.c
index 936bb4d..320eab9 100644 (file)
@@ -1,23 +1,18 @@
 /*
- * Copyright (C) 2015 "IoT.bzh"
+ * Copyright (C) 2015, 2016 "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 <string.h>
 #include <uuid/uuid.h>
 #include <assert.h>
+#include <errno.h>
+
+#include <json-c/json.h>
 
-#include "afb-apis.h"
 #include "session.h"
+#include "verbose.h"
 
 #define NOW (time(NULL))
 
+struct client_value
+{
+       void *value;
+       void (*free_value)(void*);
+};
+
+struct afb_event_listener_list
+{
+       struct afb_event_listener_list *next;
+       struct afb_event_listener listener;
+       int refcount;
+};
+
+struct AFB_clientCtx
+{
+       unsigned refcount;
+       time_t expiration;    // expiration time of the token
+       time_t access;
+       char uuid[37];        // long term authentication of remote client
+       char token[37];       // short term authentication of remote client
+       struct client_value *values;
+       struct afb_event_listener_list *listeners;
+};
+
 // 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
@@ -42,39 +64,48 @@ static struct {
   int max;
   int timeout;
   int apicount;
-  const char *initok;
+  char initok[37];
+  struct afb_event_listener_list *listeners;
 } sessions;
 
+/* generate a uuid */
+static void new_uuid(char uuid[37])
+{
+       uuid_t newuuid;
+       uuid_generate(newuuid);
+       uuid_unparse_lower(newuuid, uuid);
+}
+
 // Free context [XXXX Should be protected again memory abort XXXX]
 static void ctxUuidFreeCB (struct AFB_clientCtx *client)
 {
        int idx;
 
        // If application add a handle let's free it now
-       assert (client->contexts != NULL);
+       assert (client->values != 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]);
-                       client->contexts[idx] = NULL;
-               }
-       }
+       for (idx=0; idx < sessions.apicount; idx ++)
+               ctxClientValueSet(client, 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, 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(struct 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 = afb_apis_count();
-       if (strlen(initok) >= 37) {
-               fprintf(stderr, "Error: initial token '%s' too long (max length 36)", initok);
+       sessions.apicount = context_count;
+       if (initok == NULL)
+               /* without token, a secret is made to forbid creation of sessions */
+               new_uuid(sessions.initok);
+       else if (strlen(initok) < sizeof(sessions.store[0]->token))
+               strcpy(sessions.initok, initok);
+       else {
+               ERROR("initial token '%s' too long (max length 36)", initok);
                exit(1);
        }
-       sessions.initok = initok;
 }
 
 static struct AFB_clientCtx *ctxStoreSearch (const char* uuid)
@@ -109,7 +140,7 @@ static int ctxStoreDel (struct AFB_clientCtx *client)
 
     for (idx=0; idx < sessions.max; idx++) {
         if (sessions.store[idx] == client) {
-               sessions.store[idx]=NULL;
+               sessions.store[idx] = NULL;
                sessions.count--;
                status = 1;
                goto deleted;
@@ -128,13 +159,11 @@ static int ctxStoreAdd (struct AFB_clientCtx *client)
 
     assert (client != NULL);
 
-    //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]) {
-               sessions.store[idx]= client;
+               sessions.store[idx] = client;
                sessions.count++;
                status = 1;
                goto added;
@@ -149,7 +178,15 @@ added:
 // Check if context timeout or not
 static int ctxStoreTooOld (struct AFB_clientCtx *ctx, time_t now)
 {
-    return ctx->expiration <= now;
+    assert (ctx != NULL);
+    return ctx->expiration < now;
+}
+
+// Check if context is active or not
+static int ctxIsActive (struct AFB_clientCtx *ctx, time_t now)
+{
+    assert (ctx != NULL);
+    return ctx->uuid[0] != 0 && ctx->expiration >= now;
 }
 
 // Loop on every entry and remove old context sessions.hash
@@ -168,65 +205,79 @@ static void ctxStoreCleanUp (time_t now)
 }
 
 // This function will return exiting client context or newly created client context
-struct AFB_clientCtx *ctxClientGetForUuid (const char *uuid)
+struct AFB_clientCtx *ctxClientGetSession (const char *uuid, int *created)
 {
-       uuid_t newuuid;
        struct AFB_clientCtx *clientCtx;
        time_t now;
 
-       /* search for an existing one not too old */
+       /* cleaning */
        now = NOW;
        ctxStoreCleanUp (now);
-       clientCtx = uuid != NULL ? ctxStoreSearch (uuid) : NULL;
-       if (clientCtx) {
-               clientCtx->refcount++;
-               return clientCtx;
-        }
 
-       /* mimic old behaviour */
-       if (sessions.initok == NULL)
-               return NULL;
-
-       /* check the uuid if given */
-       if (uuid != NULL && 1 + strlen(uuid) >= sizeof clientCtx->uuid)
-               return NULL;
+       /* search for an existing one not too old */
+       if (uuid != NULL) {
+               if (strlen(uuid) >= sizeof clientCtx->uuid) {
+                       errno = EINVAL;
+                       goto error;
+               }
+               clientCtx = ctxStoreSearch(uuid);
+               if (clientCtx != NULL) {
+                       *created = 0;
+                       goto found;
+               }
+       }
 
        /* returns a new one */
-        clientCtx = calloc(1, sizeof(struct AFB_clientCtx)); // init NULL clientContext
-       if (clientCtx != NULL) {
-               clientCtx->contexts = calloc ((unsigned)sessions.apicount, sizeof (void*));
-               if (clientCtx->contexts != NULL) {
-                       /* generate the uuid */
-                       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);
-               }
-               free(clientCtx);
+        clientCtx = calloc(1, sizeof(struct AFB_clientCtx) + ((unsigned)sessions.apicount * sizeof(*clientCtx->values)));
+       if (clientCtx == NULL) {
+               errno = ENOMEM;
+               goto error;
+       }
+        clientCtx->values = (void*)(clientCtx + 1);
+
+       /* generate the uuid */
+       if (uuid == NULL) {
+               new_uuid(clientCtx->uuid);
+       } else {
+               strcpy(clientCtx->uuid, uuid);
        }
+
+       /* init the token */
+       strcpy(clientCtx->token, sessions.initok);
+       clientCtx->expiration = now + sessions.timeout;
+       if (!ctxStoreAdd (clientCtx)) {
+               errno = ENOMEM;
+               goto error2;
+       }
+       *created = 1;
+
+found:
+       clientCtx->access = now;
+       clientCtx->refcount++;
+       return clientCtx;
+
+error2:
+       free(clientCtx);
+error:
        return NULL;
 }
 
-struct AFB_clientCtx *ctxClientGet(struct AFB_clientCtx *clientCtx)
+struct AFB_clientCtx *ctxClientAddRef(struct AFB_clientCtx *clientCtx)
 {
        if (clientCtx != NULL)
                clientCtx->refcount++;
        return clientCtx;
 }
 
-void ctxClientPut(struct AFB_clientCtx *clientCtx)
+void ctxClientUnref(struct AFB_clientCtx *clientCtx)
 {
        if (clientCtx != NULL) {
                assert(clientCtx->refcount != 0);
                --clientCtx->refcount;
+                       if (clientCtx->refcount == 0 && clientCtx->uuid[0] == 0) {
+                       ctxStoreDel (clientCtx);
+                       free(clientCtx);
+               }
        }
 }
 
@@ -234,52 +285,171 @@ void ctxClientPut(struct AFB_clientCtx *clientCtx)
 void ctxClientClose (struct AFB_clientCtx *clientCtx)
 {
        assert(clientCtx != NULL);
-       if (clientCtx->created) {
-               clientCtx->created = 0;
+       if (clientCtx->uuid[0] != 0) {
+               clientCtx->uuid[0] = 0;
                ctxUuidFreeCB (clientCtx);
+               while(clientCtx->listeners != NULL)
+                       ctxClientEventListenerRemove(clientCtx, clientCtx->listeners->listener);
+                       if (clientCtx->refcount == 0) {
+                       ctxStoreDel (clientCtx);
+                       free(clientCtx);
+               }
        }
-               if (clientCtx->refcount == 0)
-               ctxStoreDel (clientCtx);
 }
 
 // Sample Generic Ping Debug API
-int ctxTokenCheckLen (struct AFB_clientCtx *clientCtx, const char *token, size_t length)
+int ctxTokenCheck (struct AFB_clientCtx *clientCtx, const char *token)
 {
        assert(clientCtx != NULL);
        assert(token != NULL);
 
        // compare current token with previous one
-       if (ctxStoreTooOld (clientCtx, NOW))
+       if (!ctxIsActive (clientCtx, NOW))
                return 0;
 
-       if (clientCtx->token[0] && (length >= sizeof(clientCtx->token) || strncmp (token, clientCtx->token, length) || clientCtx->token[length]))
+       if (clientCtx->token[0] && strcmp (token, clientCtx->token) != 0)
                return 0;
 
-       clientCtx->created = 1; /* creates by default */
        return 1;
 }
 
-// Sample Generic Ping Debug API
-int ctxTokenCheck (struct AFB_clientCtx *clientCtx, const char *token)
+// generate a new token and update client context
+void ctxTokenNew (struct AFB_clientCtx *clientCtx)
 {
        assert(clientCtx != NULL);
-       assert(token != NULL);
 
-       return ctxTokenCheckLen(clientCtx, token, strlen(token));
+       // Old token was valid let's regenerate a new one
+       new_uuid(clientCtx->token);
+
+       // keep track of time for session timeout and further clean up
+       clientCtx->expiration = NOW + sessions.timeout;
+}
+
+static int add_listener(struct afb_event_listener_list **head, struct afb_event_listener listener)
+{
+       struct afb_event_listener_list *iter, **prv;
+
+       prv = head;
+       for (;;) {
+               iter = *prv;
+               if (iter == NULL) {
+                       iter = calloc(1, sizeof *iter);
+                       if (iter == NULL) {
+                               errno = ENOMEM;
+                               return -1;
+                       }
+                       iter->listener = listener;
+                       iter->refcount = 1;
+                       *prv = iter;
+                       return 0;
+               }
+               if (iter->listener.itf == listener.itf && iter->listener.closure == listener.closure) {
+                       iter->refcount++;
+                       return 0;
+               }
+               prv = &iter->next;
+       }
 }
 
-// generate a new token and update client context
-void ctxTokenNew (struct AFB_clientCtx *clientCtx)
+int ctxClientEventListenerAdd(struct AFB_clientCtx *clientCtx, struct afb_event_listener listener)
 {
-       uuid_t newuuid;
+       return add_listener(clientCtx != NULL ? &clientCtx->listeners : &sessions.listeners, listener);
+}
+
+static void remove_listener(struct afb_event_listener_list **head, struct afb_event_listener listener)
+{
+       struct afb_event_listener_list *iter, **prv;
+
+       prv = head;
+       for (;;) {
+               iter = *prv;
+               if (iter == NULL)
+                       return;
+               if (iter->listener.itf == listener.itf && iter->listener.closure == listener.closure) {
+                       if (!--iter->refcount) {
+                               *prv = iter->next;
+                               free(iter);
+                       }
+                       return;
+               }
+               prv = &iter->next;
+       }
+}
+
+void ctxClientEventListenerRemove(struct AFB_clientCtx *clientCtx, struct afb_event_listener listener)
+{
+       remove_listener(clientCtx != NULL ? &clientCtx->listeners : &sessions.listeners, listener);
+}
+
+static int send(struct afb_event_listener_list *head, const char *event, struct json_object *object)
+{
+       struct afb_event_listener_list *iter;
+       int result;
+
+       result = 0;
+       iter = head;
+       while (iter != NULL) {
+               if (iter->listener.itf->expects == NULL || iter->listener.itf->expects(iter->listener.closure, event)) {
+                       iter->listener.itf->send(iter->listener.closure, event, json_object_get(object));
+                       result++;
+               }
+               iter = iter->next;
+       }
+
+       return result;
+}
 
+int ctxClientEventSend(struct AFB_clientCtx *clientCtx, const char *event, struct json_object *object)
+{
+       long idx;
+       time_t now;
+       int result;
+
+       now = NOW;
+       if (clientCtx != NULL) {
+               result = ctxIsActive(clientCtx, now) ? send(clientCtx->listeners, event, object) : 0;
+       } else {
+               result = send(sessions.listeners, event, object);
+               for (idx=0; idx < sessions.max; idx++) {
+                       clientCtx = ctxClientAddRef(sessions.store[idx]);
+                       if (clientCtx != NULL && ctxIsActive(clientCtx, now)) {
+                               clientCtx = ctxClientAddRef(clientCtx);
+                               result += send(clientCtx->listeners, event, object);
+                       }
+                       ctxClientUnref(clientCtx);
+               }
+       }
+       return result;
+}
+
+const char *ctxClientGetUuid (struct AFB_clientCtx *clientCtx)
+{
        assert(clientCtx != NULL);
+       return clientCtx->uuid;
+}
 
-       // Old token was valid let's regenerate a new one
-       uuid_generate(newuuid);         // create a new UUID
-       uuid_unparse_lower(newuuid, clientCtx->token);
+const char *ctxClientGetToken (struct AFB_clientCtx *clientCtx)
+{
+       assert(clientCtx != NULL);
+       return clientCtx->token;
+}
 
-       // keep track of time for session timeout and further clean up
-       clientCtx->expiration = NOW + sessions.timeout;
+void *ctxClientValueGet(struct AFB_clientCtx *clientCtx, int index)
+{
+       assert(clientCtx != NULL);
+       assert(index >= 0);
+       assert(index < sessions.apicount);
+       return clientCtx->values[index].value;
 }
 
+void ctxClientValueSet(struct AFB_clientCtx *clientCtx, int index, void *value, void (*free_value)(void*))
+{
+       struct client_value prev;
+       assert(clientCtx != NULL);
+       assert(index >= 0);
+       assert(index < sessions.apicount);
+       prev = clientCtx->values[index];
+       clientCtx->values[index] = (struct client_value){.value = value, .free_value = free_value};
+       if (prev.value !=  NULL && prev.free_value != NULL)
+               prev.free_value(prev.value);
+}