bindings/samples/DemoContext.c

   1 /*
   2  * Copyright (C) 2015, 2016, 2017 "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 #define AFB_BINDING_VERSION 1
  23 #include <afb/afb-binding.h>
  24
  25 typedef struct {
  26   /*
  27    * client context is attached a session but private to a each plugin.
  28    * Context is passed to each API under request->context
  29    *
  30    * Note:
  31    *  -client context is free when a session is closed. Developer should not
  32    *   forget that even if context is private to each plugin, session is unique
  33    *   to a client. When session close, every plugin are notified to free there
  34    *   private context.
  35    *  -by default standard "free" function from libc is used to free context.
  36    *   Developer may define it own under plugin->freeCB. This call received
  37    *   FreeCtxCb(void *ClientCtx, void*PluginHandle, char*SessionUUID) if
  38    *   FreeCtxCb=(void*)-1 then context wont be free by session manager.
  39    *  -when an API use AFB_SESSION_RESET this close the session and each plugin
  40    *   will be notified to free ressources.
  41    */
  42
  43   int  count;
  44   char *abcd;
  45
  46 } MyClientContextT;
  47
  48 // This function is call at session open time. Any client trying to
  49 // call it with an already open session will be denied.
  50 // Ex: http://localhost:1234/api/context/create?token=123456789
  51 static void myCreate (struct afb_req request)
  52 {
  53     MyClientContextT *ctx = malloc (sizeof (MyClientContextT));
  54
  55     // store something in our plugin private client context
  56     ctx->count = 0;
  57     ctx->abcd  = "SomeThingUseful";
  58
  59     afb_req_context_set(request, ctx, free);
  60     afb_req_success_f(request, NULL, "SUCCESS: create client context for plugin [%s]", ctx->abcd);
  61 }
  62
  63 // This function can only be called with a valid token. Token should be renew before
  64 // session timeout a standard renew api is avaliable at /api/token/renew this API
  65 // can be called automatically with <token-renew> HTML5 widget.
  66 // ex: http://localhost:1234/api/context/action?token=xxxxxx-xxxxxx-xxxxx-xxxxx-xxxxxx
  67 static void myAction (struct afb_req request)
  68 {
  69     MyClientContextT *ctx = (MyClientContextT*) afb_req_context_get(request);
  70
  71     if (!ctx) {
  72         afb_req_fail(request, "invalid-state", "Can't perform action");
  73         return;
  74     }
  75     // store something in our plugin private client context
  76     ctx->count++;
  77     afb_req_success_f(request, NULL, "SUCCESS: plugin [%s] Check=[%d]\n", ctx->abcd, ctx->count);
  78 }
  79
  80 // After execution of this function, client session will be close and if they
  81 // created a context [request->context != NULL] every plugins will be notified
  82 // that they should free context resources.
  83 // ex: http://localhost:1234/api/context/close?token=xxxxxx-xxxxxx-xxxxx-xxxxx-xxxxxx
  84 static void myClose (struct afb_req request)
  85 {
  86     MyClientContextT *ctx = (MyClientContextT*) afb_req_context_get(request);
  87
  88     if (!ctx) {
  89         afb_req_success(request, NULL, NULL);
  90         return;
  91     }
  92     // store something in our plugin private client context
  93     ctx->count++;
  94     afb_req_success_f(request, NULL, "SUCCESS: plugin [%s] Close=[%d]\n", ctx->abcd, ctx->count);
  95 }
  96
  97 // Set the LOA
  98 static void setLOA(struct afb_req request, unsigned loa)
  99 {
 100     if (afb_req_session_set_LOA(request, loa))
 101         afb_req_success_f(request, NULL, "loa set to %u", loa);
 102     else
 103         afb_req_fail_f(request, "failed", "can't set loa to %u", loa);
 104 }
 105
 106 static void clientSetLOA0(struct afb_req request)
 107 {
 108     setLOA(request, 0);
 109 }
 110
 111 static void clientSetLOA1(struct afb_req request)
 112 {
 113     setLOA(request, 1);
 114 }
 115
 116 static void clientSetLOA2(struct afb_req request)
 117 {
 118     setLOA(request, 2);
 119 }
 120
 121 static void clientSetLOA3(struct afb_req request)
 122 {
 123     setLOA(request, 3);
 124 }
 125
 126 static void clientCheckLOA(struct afb_req request)
 127 {
 128     afb_req_success(request, NULL, "LOA checked and okay");
 129 }
 130
 131 // NOTE: this sample does not use session to keep test a basic as possible
 132 //       in real application most APIs should be protected with AFB_SESSION_CHECK
 133 static const struct afb_verb_desc_v1 verbs[]= {
 134   {"create", AFB_SESSION_CREATE, myCreate  , "Create a new session"},
 135   {"action", AFB_SESSION_CHECK , myAction  , "Use Session Context"},
 136   {"close" , AFB_SESSION_CLOSE , myClose   , "Free Context"},
 137   {"set_loa_0", AFB_SESSION_RENEW, clientSetLOA0       ,"Set level of assurance to 0"},
 138   {"set_loa_1", AFB_SESSION_RENEW, clientSetLOA1       ,"Set level of assurance to 1"},
 139   {"set_loa_2", AFB_SESSION_RENEW, clientSetLOA2       ,"Set level of assurance to 2"},
 140   {"set_loa_3", AFB_SESSION_RENEW, clientSetLOA3       ,"Set level of assurance to 3"},
 141   {"check_loa_ge_0", AFB_SESSION_LOA_GE_0, clientCheckLOA ,"Check whether level of assurance is greater or equal to 0"},
 142   {"check_loa_ge_1", AFB_SESSION_LOA_GE_1, clientCheckLOA ,"Check whether level of assurance is greater or equal to 1"},
 143   {"check_loa_ge_2", AFB_SESSION_LOA_GE_2, clientCheckLOA ,"Check whether level of assurance is greater or equal to 2"},
 144   {"check_loa_ge_3", AFB_SESSION_LOA_GE_3, clientCheckLOA ,"Check whether level of assurance is greater or equal to 3"},
 145   {"check_loa_le_0", AFB_SESSION_LOA_LE_0, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 0"},
 146   {"check_loa_le_1", AFB_SESSION_LOA_LE_1, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 1"},
 147   {"check_loa_le_2", AFB_SESSION_LOA_LE_2, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 2"},
 148   {"check_loa_le_3", AFB_SESSION_LOA_LE_3, clientCheckLOA ,"Check whether level of assurance is lesser or equal to 3"},
 149   {"check_loa_eq_0", AFB_SESSION_LOA_EQ_0, clientCheckLOA ,"Check whether level of assurance is equal to 0"},
 150   {"check_loa_eq_1", AFB_SESSION_LOA_EQ_1, clientCheckLOA ,"Check whether level of assurance is equal to 1"},
 151   {"check_loa_eq_2", AFB_SESSION_LOA_EQ_2, clientCheckLOA ,"Check whether level of assurance is equal to 2"},
 152   {"check_loa_eq_3", AFB_SESSION_LOA_EQ_3, clientCheckLOA ,"Check whether level of assurance is equal to 3"},
 153   {NULL}
 154 };
 155
 156 static const struct afb_binding plugin_desc = {
 157         .type = AFB_BINDING_VERSION_1,
 158         .v1 = {
 159                 .info = "Sample of Client Context Usage",
 160                 .prefix = "context",
 161                 .verbs = verbs,
 162         }
 163 };
 164
 165 const struct afb_binding *afbBindingV1Register (const struct afb_binding_interface *itf)
 166 {
 167         return &plugin_desc;
 168 }
 169