refactoring context handling
[src/app-framework-binder.git] / src / session.c
index 2bb5b44..fbc7f2f 100644 (file)
  * 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.
+ *   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.
  */
 
-
-#include "local-def.h"
-#include <dirent.h>
-#include <string.h>
+#define _GNU_SOURCE
+#include <stdio.h>
 #include <time.h>
-#include <sys/stat.h>
-#include <sys/types.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
+#include <pthread.h>
+#include <stdlib.h>
+#include <string.h>
+#include <uuid/uuid.h>
+#include <assert.h>
+
+#include "session.h"
+
+#define NOW (time(NULL))
+
+// 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
+  struct AFB_clientCtx **store;          // sessions store
+  int count;                      // current number of sessions
+  int max;
+  int timeout;
+  int apicount;
+  const char *initok;
+} sessions;
+
+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 (struct AFB_clientCtx *client)
+{
+       int idx;
 
+       // If application add a handle let's free it now
+       assert (client->contexts != NULL);
 
-// verify we can read/write in session dir
-PUBLIC AFB_ERROR sessionCheckdir (AFB_session *session) {
+       // 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);
+}
 
-   int err;
+// Create a new store in RAM, not that is too small it will be automatically extended
+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)max_session_count, sizeof(struct AFB_clientCtx));
+       sessions.max = max_session_count;
+       sessions.timeout = timeout;
+       sessions.apicount = context_count;
+       if (strlen(initok) >= 37) {
+               fprintf(stderr, "Error: initial token '%s' too long (max length 36)", initok);
+               exit(1);
+       }
+       sessions.initok = initok;
+}
 
-   // in case session dir would not exist create one
-   if (verbose) fprintf (stderr, "AFB:notice checking session dir [%s]\n", session->config->sessiondir);
-   mkdir(session->config->sessiondir, S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
+static struct AFB_clientCtx *ctxStoreSearch (const char* uuid)
+{
+    int  idx;
+    struct AFB_clientCtx *client;
 
-   // change for session directory
-   err = chdir(session->config->sessiondir);
-   if (err) {
-     fprintf(stderr,"AFB: Fail to chdir to %s error=%s\n", session->config->sessiondir, strerror(err));
-     return err;
-   }
+    assert (uuid != NULL);
 
-   // verify we can write session in directory
-   json_object *dummy= json_object_new_object();
-   json_object_object_add (dummy, "checked"  , json_object_new_int (getppid()));
-   err = json_object_to_file ("./AFB-probe.json", dummy);
-   if (err < 0) return err;
+    pthread_mutex_lock(&sessions.mutex);
 
-   return AFB_SUCCESS;
-}
+    for (idx=0; idx < sessions.max; idx++) {
+       client = sessions.store[idx];
+        if (client && (0 == strcmp (uuid, client->uuid)))
+               goto found;
+    }
+    client = NULL;
 
-// let's return only sessions files
-STATIC int fileSelect (const struct dirent *entry) {
-   return (strstr (entry->d_name, ".afb") != NULL);
+found:
+    pthread_mutex_unlock(&sessions.mutex);
+    return client;
 }
 
-STATIC  json_object *checkCardDirExit (AFB_session *session, AFB_request *request ) {
-    int  sessionDir, cardDir;
+static int ctxStoreDel (struct AFB_clientCtx *client)
+{
+    int idx;
+    int status;
 
-    // card name should be more than 3 character long !!!!
-    if (strlen (request->plugin) < 3) {
-       return (jsonNewMessage (AFB_FAIL,"Fail invalid plugin=%s", request->plugin));
-    }
+    assert (client != NULL);
 
-    // open session directory
-    sessionDir = open (session->config->sessiondir, O_DIRECTORY);
-    if (sessionDir < 0) {
-          return (jsonNewMessage (AFB_FAIL,"Fail to open directory [%s] error=%s", session->config->sessiondir, strerror(sessionDir)));
-    }
+    pthread_mutex_lock(&sessions.mutex);
 
-   // create session sndcard directory if it does not exit
-    cardDir = openat (sessionDir, request->plugin,  O_DIRECTORY);
-    if (cardDir < 0) {
-          cardDir  = mkdirat (sessionDir, request->plugin, O_RDWR | S_IRWXU | S_IRGRP);
-          if (cardDir < 0) {
-              return (jsonNewMessage (AFB_FAIL,"Fail to create directory [%s/%s] error=%s", session->config->sessiondir, request->plugin, strerror(cardDir)));
-          }
+    for (idx=0; idx < sessions.max; idx++) {
+        if (sessions.store[idx] == client) {
+               sessions.store[idx]=NULL;
+               sessions.count--;
+               status = 1;
+               goto deleted;
+       }
     }
-    close (sessionDir);
-    return NULL;
+    status = 0;
+deleted:
+    pthread_mutex_unlock(&sessions.mutex);
+    return status;
 }
 
-// create a session in current directory
-PUBLIC json_object *sessionList (AFB_session *session, AFB_request *request) {
-    json_object *sessionsJ, *ajgResponse;
-    struct stat fstat;
-    struct dirent **namelist;
-    int  count, sessionDir;
-
-    // if directory for card's sessions does not exist create it
-    ajgResponse = checkCardDirExit (session, request);
-    if (ajgResponse != NULL) return ajgResponse;
-
-    // open session directory
-    sessionDir = open (session->config->sessiondir, O_DIRECTORY);
-    if (sessionDir < 0) {
-          return (jsonNewMessage (AFB_FAIL,"Fail to open directory [%s] error=%s", session->config->sessiondir, strerror(sessionDir)));
-    }
+static int ctxStoreAdd (struct AFB_clientCtx *client)
+{
+    int idx;
+    int status;
 
-    count = scandirat (sessionDir, request->plugin, &namelist, fileSelect, alphasort);
-    close (sessionDir);
+    assert (client != NULL);
 
-    if (count < 0) {
-        return (jsonNewMessage (AFB_FAIL,"Fail to scan sessions 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));
-
-    // loop on each session file, retrieve its date and push it into json response object
-    sessionsJ = json_object_new_array();
-    while (count--) {
-         json_object *sessioninfo;
-         char timestamp [64];
-         char *filename;
-
-         // extract file name and last modification date
-         filename = namelist[count]->d_name;
-         printf("%s\n", filename);
-         stat(filename,&fstat);
-         strftime (timestamp, sizeof(timestamp), "%c", localtime (&fstat.st_mtime));
-         filename[strlen(filename)-4] = '\0'; // remove .afb extension from filename
-
-         // create an object by session with last update date
-         sessioninfo = json_object_new_object();
-         json_object_object_add (sessioninfo, "date" , json_object_new_string (timestamp));
-         json_object_object_add (sessioninfo, "session" , json_object_new_string (filename));
-         json_object_array_add (sessionsJ, sessioninfo);
-
-         free(namelist[count]);
+    //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.count++;
+               status = 1;
+               goto added;
+       }
     }
+    status = 0;
+added:
+    pthread_mutex_unlock(&sessions.mutex);
+    return status;
+}
 
-    // free scandir structure
-    free(namelist);
+// Check if context timeout or not
+static int ctxStoreTooOld (struct AFB_clientCtx *ctx, time_t now)
+{
+    return ctx->expiration <= now;
+}
 
-    // everything is OK let's build final response
-    ajgResponse = json_object_new_object();
-    json_object_object_add (ajgResponse, "jtype" , json_object_new_string (AFB_SESSION_JLIST));
-    json_object_object_add (ajgResponse, "status"  , jsonNewStatus(AFB_SUCCESS));
-    json_object_object_add (ajgResponse, "data"    , sessionsJ);
+// Loop on every entry and remove old context sessions.hash
+static void ctxStoreCleanUp (time_t now)
+{
+       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);
+               }
+       }
+}
 
-    return (ajgResponse);
+// This function will return exiting client context or newly created client context
+struct AFB_clientCtx *ctxClientGetForUuid (const char *uuid)
+{
+       uuid_t newuuid;
+       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) {
+               clientCtx->refcount++;
+               return clientCtx;
+        }
+
+       /* mimic old behaviour */
+/*
+TODO remove? not remove?
+       if (sessions.initok == NULL)
+               return NULL;
+*/
+       /* check the uuid if given */
+       if (uuid != NULL && strlen(uuid) >= sizeof clientCtx->uuid)
+               return NULL;
+
+       /* returns a new one */
+        clientCtx = calloc(1, sizeof(struct AFB_clientCtx)); // init NULL clientContext
+       if (clientCtx != NULL) {
+               clientCtx->contexts = calloc ((unsigned)sessions.apicount, sizeof(*clientCtx->contexts));
+               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);
+       }
+       return NULL;
 }
 
-// Create a link toward last used sessionname within sndcard directory
-STATIC void makeSessionLink (const char *cardname, const char *sessionname) {
-   char linkname [256], filename [256];
-   int err;
-   // create a link to keep track of last uploaded sessionname for this card
-   strncpy (filename, sessionname, sizeof(filename));
-   strncat (filename, ".afb", sizeof(filename));
-
-   strncpy (linkname, cardname, sizeof(linkname));
-   strncat (linkname, "/", sizeof(filename));
-   strncat (linkname, AFB_CURRENT_SESSION, sizeof(linkname));
-   strncat (linkname, ".afb", sizeof(filename));
-   unlink (linkname); // remove previous link if any
-   err = symlink (filename, linkname);
-   if (err < 0) fprintf (stderr, "Fail to create link %s->%s error=%s\n", linkname, filename, strerror(errno));
+struct AFB_clientCtx *ctxClientGet(struct AFB_clientCtx *clientCtx)
+{
+       if (clientCtx != NULL)
+               clientCtx->refcount++;
+       return clientCtx;
 }
 
-// Load Json session object from disk
-PUBLIC json_object *sessionFromDisk (AFB_session *session, AFB_request *request, char *name) {
-    json_object *jsonSession, *jtype, *response;
-    const char *ajglabel;
-    char filename [256];
-    int defsession;
+void ctxClientPut(struct AFB_clientCtx *clientCtx)
+{
+       if (clientCtx != NULL) {
+               assert(clientCtx->refcount != 0);
+               --clientCtx->refcount;
+       }
+}
 
-    if (name == NULL) {
-        return  (jsonNewMessage (AFB_FATAL,"session name missing &session=MySessionName"));
-    }
+// Free Client Session Context
+void ctxClientClose (struct AFB_clientCtx *clientCtx)
+{
+       assert(clientCtx != NULL);
+       if (clientCtx->created) {
+               clientCtx->created = 0;
+               ctxUuidFreeCB (clientCtx);
+       }
+               if (clientCtx->refcount == 0)
+               ctxStoreDel (clientCtx);
+}
 
-    // check for current session request
-    defsession = (strcmp (name, AFB_DEFAULT_SESSION) ==0);
+// Sample Generic Ping Debug API
+int ctxTokenCheckLen (struct AFB_clientCtx *clientCtx, const char *token, size_t length)
+{
+       assert(clientCtx != NULL);
+       assert(token != NULL);
 
-    // if directory for card's sessions does not exist create it
-    response = checkCardDirExit (session, request);
-    if (response != NULL) return response;
+       // compare current token with previous one
+       if (ctxStoreTooOld (clientCtx, NOW))
+               return 0;
 
-    // add name and file extension to session name
-    strncpy (filename, request->plugin, sizeof(filename));
-    strncat (filename, "/", sizeof(filename));
-    if (defsession) strncat (filename, AFB_CURRENT_SESSION, sizeof(filename)-1);
-    else strncat (filename, name, sizeof(filename)-1);
-    strncat (filename, ".afb", sizeof(filename));
+       if (clientCtx->token[0] && (length >= sizeof(clientCtx->token) || strncmp (token, clientCtx->token, length) || clientCtx->token[length]))
+               return 0;
 
-    // just upload json object and return without any further processing
-    jsonSession = json_object_from_file (filename);
+       clientCtx->created = 1; /* creates by default */
+       return 1;
+}
 
-    if (jsonSession == NULL)  return (jsonNewMessage (AFB_EMPTY,"File [%s] not found", filename));
+// Sample Generic Ping Debug API
+int ctxTokenCheck (struct AFB_clientCtx *clientCtx, const char *token)
+{
+       assert(clientCtx != NULL);
+       assert(token != NULL);
 
-    // verify that file is a JSON ALSA session type
-    if (!json_object_object_get_ex (jsonSession, "jtype", &jtype)) {
-        json_object_put   (jsonSession);
-        return  (jsonNewMessage (AFB_EMPTY,"File [%s] 'jtype' descriptor not found", filename));
-    }
+       return ctxTokenCheckLen(clientCtx, token, strlen(token));
+}
 
-    // check type value is AFB_SESSION_JTYPE
-    ajglabel = json_object_get_string (jtype);
-    if (strcmp (AFB_SESSION_JTYPE, ajglabel)) {
-       json_object_put   (jsonSession);
-       return  (jsonNewMessage (AFB_FATAL,"File [%s] jtype=[%s] != [%s]", filename, ajglabel, AFB_SESSION_JTYPE));
-    }
+// generate a new token and update client context
+void ctxTokenNew (struct AFB_clientCtx *clientCtx)
+{
+       uuid_t newuuid;
 
-    // create a link to keep track of last uploaded session for this card
-    if (!defsession) makeSessionLink (request->plugin, name);
+       assert(clientCtx != NULL);
 
-    return (jsonSession);
-}
+       // Old token was valid let's regenerate a new one
+       uuid_generate(newuuid);         // create a new UUID
+       uuid_unparse_lower(newuuid, clientCtx->token);
 
-// push Json session object to disk
-PUBLIC json_object * sessionToDisk (AFB_session *session, AFB_request *request, char *name, json_object *jsonSession) {
-   char filename [256];
-   time_t rawtime;
-   struct tm * timeinfo;
-   int err, defsession;
-   static json_object *response;
-
-   // we should have a session name
-   if (name == NULL) return (jsonNewMessage (AFB_FATAL,"session name missing &session=MySessionName"));
-
-   // check for current session request
-   defsession = (strcmp (name, AFB_DEFAULT_SESSION) ==0);
-
-   // if directory for card's sessions does not exist create it
-   response = checkCardDirExit (session, request);
-   if (response != NULL) return response;
-
-   // add cardname and file extension to session name
-   strncpy (filename, request->plugin, sizeof(filename));
-   strncat (filename, "/", sizeof(filename));
-   if (defsession) strncat (filename, AFB_CURRENT_SESSION, sizeof(filename)-1);
-   else strncat (filename, name, sizeof(filename)-1);
-   strncat (filename, ".afb", sizeof(filename)-1);
-
-
-   json_object_object_add(jsonSession, "jtype", json_object_new_string (AFB_SESSION_JTYPE));
-
-   // add a timestamp and store session on disk
-   time ( &rawtime );  timeinfo = localtime ( &rawtime );
-   // A copy of the string is made and the memory is managed by the json_object
-   json_object_object_add (jsonSession, "timestamp", json_object_new_string (asctime (timeinfo)));
-
-
-   // do we have extra session info ?
-   if (request->post) {
-       static json_object *info, *jtype;
-       const char  *ajglabel;
-
-       // extract session info from args
-       info = json_tokener_parse (request->post);
-       if (!info) {
-            response = jsonNewMessage (AFB_FATAL,"sndcard=%s session=%s invalid json args=%s", request->plugin, name, request->post);
-            goto OnErrorExit;
-       }
-
-       // 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);
-            goto OnErrorExit;
-       }
-
-       // check type value is AFB_INFO_JTYPE
-       ajglabel = json_object_get_string (jtype);
-       if (strcmp (AFB_SESSION_JINFO, ajglabel)) {
-              json_object_put   (info); // release info json object
-              response = jsonNewMessage (AFB_FATAL,"File [%s] jtype=[%s] != [%s] data=%s", filename, ajglabel, AFB_SESSION_JTYPE, request->post);
-              goto OnErrorExit;
-       }
-
-       // this is valid info data for our session
-       json_object_object_add (jsonSession, "info", info);
-   }
-
-   // Finally save session on disk
-   err = json_object_to_file (filename, jsonSession);
-   if (err < 0) {
-        response = jsonNewMessage (AFB_FATAL,"Fail save session = [%s] to disk", filename);
-        goto OnErrorExit;
-   }
-
-
-   // create a link to keep track of last uploaded session for this card
-   if (!defsession) makeSessionLink (request->plugin, name);
-
-   // we're donne let's return status message
-   response = jsonNewMessage (AFB_SUCCESS,"Session= [%s] saved on disk", filename);
-   json_object_put (jsonSession);
-   return (response);
-
-OnErrorExit:
-   json_object_put (jsonSession);
-   return response;
+       // keep track of time for session timeout and further clean up
+       clientCtx->expiration = NOW + sessions.timeout;
 }
+