plugins/samples/ClientCtx.c

   1 /*
   2  * Copyright (C) 2015, 2016 "IoT.bzh"
   3  * Author "Fulup Ar Foll"
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #define _GNU_SOURCE
  19 #include <stdio.h>
  20 #include <json-c/json.h>
  21
  22 #include <afb/afb-plugin.h>
  23
  24 typedef struct {
  25   /*
  26    * client context is attached a session but private to a each plugin.
  27    * Context is passed to each API under request->context
  28    *
  29    * Note:
  30    *  -client context is free when a session is closed. Developer should not
  31    *   forget that even if context is private to each plugin, session is unique
  32    *   to a client. When session close, every plugin are notified to free there
  33    *   private context.
  34    *  -by default standard "free" function from libc is used to free context.
  35    *   Developer may define it own under plugin->freeCB. This call received
  36    *   FreeCtxCb(void *ClientCtx, void*PluginHandle, char*SessionUUID) if
  37    *   FreeCtxCb=(void*)-1 then context wont be free by session manager.
  38    *  -when an API use AFB_SESSION_RESET this close the session and each plugin
  39    *   will be notified to free ressources.
  40    */
  41
  42   int  count;
  43   char *abcd;
  44
  45 } MyClientContextT;
  46
  47 // This function is call at session open time. Any client trying to
  48 // call it with an already open session will be denied.
  49 // Ex: http://localhost:1234/api/context/create?token=123456789
  50 static void myCreate (struct afb_req request)
  51 {
  52     MyClientContextT *ctx = malloc (sizeof (MyClientContextT));
  53
  54     // store something in our plugin private client context
  55     ctx->count = 0;
  56     ctx->abcd  = "SomeThingUseful";
  57
  58     afb_req_context_set(request, ctx, free);
  59     afb_req_success_f(request, NULL, "SUCCESS: create client context for plugin [%s]", ctx->abcd);
  60 }
  61
  62 // This function can only be called with a valid token. Token should be renew before
  63 // session timeout a standard renew api is avaliable at /api/token/renew this API
  64 // can be called automatically with <token-renew> HTML5 widget.
  65 // ex: http://localhost:1234/api/context/action?token=xxxxxx-xxxxxx-xxxxx-xxxxx-xxxxxx
  66 static void myAction (struct afb_req request)
  67 {
  68     MyClientContextT *ctx = (MyClientContextT*) afb_req_context_get(request);
  69
  70     // store something in our plugin private client context
  71     ctx->count++;
  72     afb_req_success_f(request, NULL, "SUCCESS: plugin [%s] Check=[%d]\n", ctx->abcd, ctx->count);
  73 }
  74
  75 // After execution of this function, client session will be close and if they
  76 // created a context [request->context != NULL] every plugins will be notified
  77 // that they should free context resources.
  78 // ex: http://localhost:1234/api/context/close?token=xxxxxx-xxxxxx-xxxxx-xxxxx-xxxxxx
  79 static void myClose (struct afb_req request)
  80 {
  81     MyClientContextT *ctx = (MyClientContextT*) afb_req_context_get(request);
  82
  83     // store something in our plugin private client context
  84     ctx->count++;
  85     afb_req_success_f(request, NULL, "SUCCESS: plugin [%s] Close=[%d]\n", ctx->abcd, ctx->count);
  86 }
  87
  88 // NOTE: this sample does not use session to keep test a basic as possible
  89 //       in real application most APIs should be protected with AFB_SESSION_CHECK
  90 static const struct AFB_restapi pluginApis[]= {
  91   {"create", AFB_SESSION_CREATE, myCreate  , "Create a new session"},
  92   {"action", AFB_SESSION_CHECK , myAction  , "Use Session Context"},
  93   {"close" , AFB_SESSION_CLOSE , myClose   , "Free Context"},
  94   {NULL}
  95 };
  96
  97 static const struct AFB_plugin plugin_desc = {
  98         .type = AFB_PLUGIN_JSON,
  99         .info = "Sample of Client Context Usage",
 100         .prefix = "context",
 101         .apis = pluginApis,
 102 };
 103
 104 const struct AFB_plugin *pluginRegister (const struct AFB_interface *itf)
 105 {
 106         return &plugin_desc;
 107 }
 108