cleanup and improvement of xreq

Change-Id: Iefda7f9d8f979a50fb2586a27edf0ca16d056a1f
Signed-off-by: José Bollo <jose.bollo@iot.bzh>

diff --git a/src/afb-api-so-v1.c b/src/afb-api-so-v1.c
index 8c4ea48..5292cfe 100644 (file)
--- a/src/afb-api-so-v1.c
+++ b/src/afb-api-so-v1.c
@@ -69,9 +69,10 @@ static void call_cb(void *closure, struct afb_xreq *xreq)
 
        verb = search(desc, xreq->verb);
        if (!verb)
-               afb_xreq_fail_f(xreq, "unknown-verb", "verb %s unknown within api %s", xreq->verb, desc->binding->v1.prefix);
+               afb_xreq_fail_unknown_verb(xreq);
        else
-               afb_xreq_so_call(xreq, verb->session, verb->callback);
+               if (!xreq_session_check_apply(xreq, verb->session))
+                       afb_xreq_call(xreq, verb->callback);
 }
 
 static int service_start_cb(void *closure, int share_session, int onneed, struct afb_apiset *apiset)

diff --git a/src/afb-api-so-v2.c b/src/afb-api-so-v2.c
index 2d939fb..6038d96 100644 (file)
--- a/src/afb-api-so-v2.c
+++ b/src/afb-api-so-v2.c
@@ -67,9 +67,10 @@ static void call_cb(void *closure, struct afb_xreq *xreq)
 
        verb = search(desc, xreq->verb);
        if (!verb)
-               afb_xreq_fail_f(xreq, "unknown-verb", "verb %s unknown within api %s", xreq->verb, desc->binding->api);
+               afb_xreq_fail_unknown_verb(xreq);
        else
-               afb_xreq_so_call(xreq, verb->session, verb->callback);
+               if (!xreq_session_check_apply(xreq, verb->session))
+                       afb_xreq_call(xreq, verb->callback);
 }
 
 static int service_start_cb(void *closure, int share_session, int onneed, struct afb_apiset *apiset)

diff --git a/src/afb-stub-ws.c b/src/afb-stub-ws.c
index 042ed25..8298fc7 100644 (file)
--- a/src/afb-stub-ws.c
+++ b/src/afb-stub-ws.c
@@ -1156,15 +1156,3 @@ void afb_stub_ws_addref(struct afb_stub_ws *stubws)
        __atomic_add_fetch(&stubws->refcount, 1, __ATOMIC_RELAXED);
 }
 
-/*
-static void client_disconnect(struct afb_stub_ws *stubws)
-{
-       if (stubws->fd >= 0) {
-               afb_ws_destroy(stubws->ws);
-               stubws->ws = NULL;
-               close(stubws->fd);
-               stubws->fd = -1;
-       }
-}
-*/
-

diff --git a/src/afb-xreq.c b/src/afb-xreq.c
index 4850329..b54b436 100644 (file)
--- a/src/afb-xreq.c
+++ b/src/afb-xreq.c
@@ -375,6 +375,11 @@ static inline struct afb_req to_req(struct afb_xreq *xreq)
        return (struct afb_req){ .itf = xreq->hookflags ? &xreq_hooked_itf : &xreq_itf, .closure = xreq };
 }
 
+struct json_object *afb_xreq_json(struct afb_xreq *xreq)
+{
+       return afb_req_json(to_req(xreq));
+}
+
 void afb_xreq_success(struct afb_xreq *xreq, struct json_object *obj, const char *info)
 {
        afb_req_success(to_req(xreq), obj, info);
@@ -434,62 +439,77 @@ void afb_xreq_subcall(struct afb_xreq *xreq, const char *api, const char *verb,
        afb_req_subcall(to_req(xreq), api, verb, args, callback, cb_closure);
 }
 
-static int xcheck(struct afb_xreq *xreq, int sessionflags)
+int xreq_session_check(struct afb_xreq *xreq, int sessionflags)
 {
+       int loa;
+
        if ((sessionflags & (AFB_SESSION_CREATE|AFB_SESSION_CLOSE|AFB_SESSION_RENEW|AFB_SESSION_CHECK|AFB_SESSION_LOA_EQ)) != 0) {
                if (!afb_context_check(&xreq->context)) {
                        afb_context_close(&xreq->context);
                        afb_xreq_fail_f(xreq, "failed", "invalid token's identity");
-                       return 0;
+                       errno = EINVAL;
+                       return -1;
                }
        }
 
        if ((sessionflags & AFB_SESSION_CREATE) != 0) {
                if (afb_context_check_loa(&xreq->context, 1)) {
                        afb_xreq_fail_f(xreq, "failed", "invalid creation state");
-                       return 0;
+                       errno = EINVAL;
+                       return -1;
                }
-               afb_context_change_loa(&xreq->context, 1);
-               afb_context_refresh(&xreq->context);
-       }
-
-       if ((sessionflags & (AFB_SESSION_CREATE | AFB_SESSION_RENEW)) != 0)
-               afb_context_refresh(&xreq->context);
-
-       if ((sessionflags & AFB_SESSION_CLOSE) != 0) {
-               afb_context_change_loa(&xreq->context, 0);
-               afb_context_close(&xreq->context);
        }
 
        if ((sessionflags & AFB_SESSION_LOA_GE) != 0) {
-               int loa = (sessionflags >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
+               loa = (sessionflags >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
                if (!afb_context_check_loa(&xreq->context, loa)) {
                        afb_xreq_fail_f(xreq, "failed", "invalid LOA");
-                       return 0;
+                       errno = EPERM;
+                       return -1;
                }
        }
 
        if ((sessionflags & AFB_SESSION_LOA_LE) != 0) {
-               int loa = (sessionflags >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
+               loa = (sessionflags >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
                if (afb_context_check_loa(&xreq->context, loa + 1)) {
                        afb_xreq_fail_f(xreq, "failed", "invalid LOA");
-                       return 0;
+                       errno = EPERM;
+                       return -1;
                }
        }
-       return 1;
+
+       return 0;
 }
 
-void afb_xreq_so_call(struct afb_xreq *xreq, int sessionflags, void (*method)(struct afb_req req))
+void xreq_session_apply(struct afb_xreq *xreq, int sessionflags)
 {
-       if (xcheck(xreq, sessionflags))
-               method(to_req(xreq));
+       if ((sessionflags & (AFB_SESSION_CREATE | AFB_SESSION_RENEW)) != 0) {
+               afb_context_refresh(&xreq->context);
+       }
+       if ((sessionflags & AFB_SESSION_CLOSE) != 0) {
+               afb_context_change_loa(&xreq->context, 0);
+               afb_context_close(&xreq->context);
+       }
+}
+
+int xreq_session_check_apply(struct afb_xreq *xreq, int sessionflags)
+{
+       int rc = xreq_session_check(xreq, sessionflags);
+       if (!rc)
+               xreq_session_apply(xreq, sessionflags);
+
+       return rc;
+}
+
+void afb_xreq_call(struct afb_xreq *xreq, void (*method)(struct afb_req req))
+{
+       method(to_req(xreq));
 }
 
-void afb_xreq_begin(struct afb_xreq *xreq)
+void afb_xreq_check_apply_call(struct afb_xreq *xreq, int sessionflags, void (*method)(struct afb_req req))
 {
-       afb_hook_init_xreq(xreq);
-       if (xreq->hookflags)
-               afb_hook_xreq_begin(xreq);
+       if (!xreq_session_check_apply(xreq, sessionflags))
+               method(to_req(xreq));
 }
 
 void afb_xreq_init(struct afb_xreq *xreq, const struct afb_xreq_query_itf *queryitf)
@@ -499,6 +519,15 @@ void afb_xreq_init(struct afb_xreq *xreq, const struct afb_xreq_query_itf *query
        xreq->queryitf = queryitf;
 }
 
+void afb_xreq_fail_unknown_api(struct afb_xreq *xreq)
+{
+       afb_xreq_fail_f(xreq, "unknown-api", "api %s not found (for verb %s)", xreq->api, xreq->verb);
+}
+
+void afb_xreq_fail_unknown_verb(struct afb_xreq *xreq)
+{
+       afb_xreq_fail_f(xreq, "unknown-verb", "verb %s unknown within api %s", xreq->verb, xreq->api);
+}
 
 static void process_async(int signum, void *arg)
 {

diff --git a/src/afb-xreq.h b/src/afb-xreq.h
index 6da325a..a7b086b 100644 (file)
--- a/src/afb-xreq.h
+++ b/src/afb-xreq.h
@@ -38,7 +38,13 @@ struct afb_xreq_query_itf {
        void (*unref)(struct afb_xreq *xreq);
        int (*subscribe)(struct afb_xreq *xreq, struct afb_event event);
        int (*unsubscribe)(struct afb_xreq *xreq, struct afb_event event);
-       void (*subcall)(struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *cb_closure);
+       void (*subcall)(
+               struct afb_xreq *xreq,
+               const char *api,
+               const char *verb,
+               struct json_object *args,
+               void (*callback)(void*, int, struct json_object*),
+               void *cb_closure);
 };
 
 /**
@@ -46,36 +52,82 @@ struct afb_xreq_query_itf {
  */
 struct afb_xreq
 {
-       struct afb_context context; /**< context of the request */
-       struct afb_apiset *apiset; /**< apiset of the xreq */
-       const char *api;        /**< the requested API */
-       const char *verb;       /**< the requested VERB */
-       struct json_object *json; /**< the json object (or NULL) */
-       const struct afb_xreq_query_itf *queryitf;
-       int refcount;   /**< current ref count */
-       int replied;    /**< is replied? */
-       int hookflags;  /**< flags for hooking */
-       int hookindex;  /**< index for hooking */
-       struct afb_evt_listener *listener;
-       struct afb_cred *cred;
+       struct afb_context context;     /**< context of the request */
+       struct afb_apiset *apiset;      /**< apiset of the xreq */
+       const char *api;                /**< the requested API */
+       const char *verb;               /**< the requested VERB */
+       struct json_object *json;       /**< the json object (or NULL) */
+       const struct afb_xreq_query_itf *queryitf; /**< interface of xreq implmentation functions */
+       int refcount;                   /**< current ref count */
+       int replied;                    /**< is replied? */
+       int hookflags;                  /**< flags for hooking */
+       int hookindex;                  /**< index for hooking */
+       struct afb_evt_listener *listener; /**< event listener for the request */
+       struct afb_cred *cred;          /**< client credential if revelant */
 };
 
-#define CONTAINER_OF_XREQ(type,x) ((type*)(((intptr_t)(x))-((intptr_t)&(((type*)NULL)->xreq))))
+/**
+ * Macro for retrieve the pointer of a structure of 'type' having a field named 'field'
+ * of adress 'ptr'.
+ * @param type the type that has the 'field' (ex: "struct mystruct")
+ * @param field the name of the field within the structure 'type'
+ * @param ptr the pointer to an element 'field'
+ * @return the pointer to the structure that contains the 'field' at address 'ptr'
+ */
+#define CONTAINER_OF(type,field,ptr) ((type*)(((intptr_t)(ptr))-((intptr_t)&(((type*)NULL)->field))))
+
+/**
+ * Macro for retrieve the pointer of a structure of 'type' having a field named "xreq"
+ * of adress 'x'.
+ * @param type the type that has the field "xreq" (ex: "struct mystruct")
+ * @param x the pointer to the field "xreq"
+ * @return the pointer to the structure that contains the field "xreq" of address 'x'
+ */
+#define CONTAINER_OF_XREQ(type,x) CONTAINER_OF(type,xreq,x)
 
+/* req wrappers for xreq */
 extern void afb_xreq_addref(struct afb_xreq *xreq);
 extern void afb_xreq_unref(struct afb_xreq *xreq);
+
+extern struct json_object *afb_xreq_json(struct afb_xreq *xreq);
+
 extern void afb_xreq_success(struct afb_xreq *xreq, struct json_object *obj, const char *info);
+extern void afb_xreq_success_f(struct afb_xreq *xreq, struct json_object *obj, const char *info, ...);
+
 extern void afb_xreq_fail(struct afb_xreq *xreq, const char *status, const char *info);
 extern void afb_xreq_fail_f(struct afb_xreq *xreq, const char *status, const char *info, ...);
-extern void afb_xreq_success_f(struct afb_xreq *xreq, struct json_object *obj, const char *info, ...);
+extern void afb_xreq_fail_unknown_api(struct afb_xreq *xreq);
+extern void afb_xreq_fail_unknown_verb(struct afb_xreq *xreq);
+
 extern const char *afb_xreq_raw(struct afb_xreq *xreq, size_t *size);
+
 extern int afb_xreq_subscribe(struct afb_xreq *xreq, struct afb_event event);
 extern int afb_xreq_unsubscribe(struct afb_xreq *xreq, struct afb_event event);
-extern void afb_xreq_subcall(struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *cb_closure);
-extern void afb_xreq_unhooked_subcall(struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *cb_closure);
 
+extern void afb_xreq_subcall(
+               struct afb_xreq *xreq,
+               const char *api,
+               const char *verb,
+               struct json_object *args,
+               void (*callback)(void*, int, struct json_object*),
+               void *cb_closure);
+extern void afb_xreq_unhooked_subcall(
+               struct afb_xreq *xreq,
+               const char *api,
+               const char *verb,
+               struct json_object *args,
+               void (*callback)(void*, int, struct json_object*),
+               void *cb_closure);
+
+/* initialisation and processing of xreq */
 extern void afb_xreq_init(struct afb_xreq *xreq, const struct afb_xreq_query_itf *queryitf);
-extern void afb_xreq_begin(struct afb_xreq *xreq);
-extern void afb_xreq_so_call(struct afb_xreq *xreq, int sessionflags, void (*callback)(struct afb_req req));
 
 extern void afb_xreq_process(struct afb_xreq *xreq, struct afb_apiset *apiset);
+
+extern int xreq_session_check(struct afb_xreq *xreq, int sessionflags);
+extern void xreq_session_apply(struct afb_xreq *xreq, int sessionflags);
+extern int xreq_session_check_apply(struct afb_xreq *xreq, int sessionflags);
+
+extern void afb_xreq_call(struct afb_xreq *xreq, void (*callback)(struct afb_req req));
+extern void afb_xreq_check_apply_call(struct afb_xreq *xreq, int sessionflags, void (*callback)(struct afb_req req));
+