Update date of copyright notices
[src/app-framework-binder.git] / src / afb-hook.c
index 188aaba..a374834 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2016, 2017 "IoT.bzh"
+ * Copyright (C) 2016, 2017, 2018 "IoT.bzh"
  * Author José Bollo <jose.bollo@iot.bzh>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -28,8 +28,8 @@
 
 #include <json-c/json.h>
 
-#include <afb/afb-req-common.h>
-#include <afb/afb-event-itf.h>
+#include <afb/afb-req.h>
+#include <afb/afb-event.h>
 
 #include "afb-context.h"
 #include "afb-hook.h"
@@ -38,6 +38,7 @@
 #include "afb-xreq.h"
 #include "afb-export.h"
 #include "afb-evt.h"
+#include "afb-api.h"
 #include "verbose.h"
 
 /**
 struct afb_hook_xreq {
        struct afb_hook_xreq *next; /**< next hook */
        unsigned refcount; /**< reference count */
+       unsigned flags; /**< hook flags */
        char *api; /**< api hooked or NULL for any */
        char *verb; /**< verb hooked or NULL for any */
        struct afb_session *session; /**< session hooked or NULL if any */
-       unsigned flags; /**< hook flags */
        struct afb_hook_xreq_itf *itf; /**< interface of hook */
        void *closure; /**< closure for callbacks */
 };
@@ -60,8 +61,8 @@ struct afb_hook_xreq {
 struct afb_hook_ditf {
        struct afb_hook_ditf *next; /**< next hook */
        unsigned refcount; /**< reference count */
-       char *api; /**< api hooked or NULL for any */
        unsigned flags; /**< hook flags */
+       char *api; /**< api hooked or NULL for any */
        struct afb_hook_ditf_itf *itf; /**< interface of hook */
        void *closure; /**< closure for callbacks */
 };
@@ -72,8 +73,8 @@ struct afb_hook_ditf {
 struct afb_hook_svc {
        struct afb_hook_svc *next; /**< next hook */
        unsigned refcount; /**< reference count */
-       char *api; /**< api hooked or NULL for any */
        unsigned flags; /**< hook flags */
+       char *api; /**< api hooked or NULL for any */
        struct afb_hook_svc_itf *itf; /**< interface of hook */
        void *closure; /**< closure for callbacks */
 };
@@ -84,12 +85,24 @@ struct afb_hook_svc {
 struct afb_hook_evt {
        struct afb_hook_evt *next; /**< next hook */
        unsigned refcount; /**< reference count */
-       char *pattern; /**< event pattern name hooked or NULL for any */
        unsigned flags; /**< hook flags */
+       char *pattern; /**< event pattern name hooked or NULL for any */
        struct afb_hook_evt_itf *itf; /**< interface of hook */
        void *closure; /**< closure for callbacks */
 };
 
+/**
+ * Definition of a hook for session
+ */
+struct afb_hook_session {
+       struct afb_hook_session *next; /**< next hook */
+       unsigned refcount; /**< reference count */
+       unsigned flags; /**< hook flags */
+       char *pattern; /**< event pattern name hooked or NULL for any */
+       struct afb_hook_session_itf *itf; /**< interface of hook */
+       void *closure; /**< closure for callbacks */
+};
+
 /**
  * Definition of a hook for global
  */
@@ -116,6 +129,9 @@ static struct afb_hook_svc *list_of_svc_hooks = NULL;
 /* list of hooks for evt */
 static struct afb_hook_evt *list_of_evt_hooks = NULL;
 
+/* list of hooks for session */
+static struct afb_hook_session *list_of_session_hooks = NULL;
+
 /* list of hooks for global */
 static struct afb_hook_global *list_of_global_hooks = NULL;
 
@@ -207,7 +223,7 @@ static void _hook_xreq_(const struct afb_xreq *xreq, const char *format, ...)
 {
        va_list ap;
        va_start(ap, format);
-       _hook_("xreq-%06d:%s/%s", format, ap, xreq->hookindex, xreq->api, xreq->verb);
+       _hook_("xreq-%06d:%s/%s", format, ap, xreq->hookindex, xreq->request.api, xreq->request.verb);
        va_end(ap);
 }
 
@@ -281,14 +297,14 @@ static void hook_xreq_session_set_LOA_default_cb(void *closure, const struct afb
        _hook_xreq_(xreq, "session_set_LOA(%u) -> %d", level, result);
 }
 
-static void hook_xreq_subscribe_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_event event, int result)
+static void hook_xreq_subscribe_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_eventid *eventid, int result)
 {
-       _hook_xreq_(xreq, "subscribe(%s:%d) -> %d", afb_evt_event_name(event), afb_evt_event_id(event), result);
+       _hook_xreq_(xreq, "subscribe(%s:%d) -> %d", afb_evt_eventid_fullname(eventid), afb_evt_eventid_id(eventid), result);
 }
 
-static void hook_xreq_unsubscribe_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_event event, int result)
+static void hook_xreq_unsubscribe_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_eventid *eventid, int result)
 {
-       _hook_xreq_(xreq, "unsubscribe(%s:%d) -> %d", afb_evt_event_name(event), afb_evt_event_id(event), result);
+       _hook_xreq_(xreq, "unsubscribe(%s:%d) -> %d", afb_evt_eventid_fullname(eventid), afb_evt_eventid_id(eventid), result);
 }
 
 static void hook_xreq_subcall_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args)
@@ -359,6 +375,16 @@ static void hook_xreq_get_application_id_default_cb(void *closure, const struct
        _hook_xreq_(xreq, "get_application_id() -> %s", result);
 }
 
+static void hook_xreq_context_make_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int replace, void *(*create_value)(void*), void (*free_value)(void*), void *create_closure, void *result)
+{
+       _hook_xreq_(xreq, "context_make(replace=%s, %p, %p, %p) -> %p", replace?"yes":"no", create_value, free_value, create_closure, result);
+}
+
+static void hook_xreq_get_uid_default_cb(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int result)
+{
+       _hook_xreq_(xreq, "get_uid() -> %d", result);
+}
+
 static struct afb_hook_xreq_itf hook_xreq_default_itf = {
        .hook_xreq_begin = hook_xreq_begin_default_cb,
        .hook_xreq_end = hook_xreq_end_default_cb,
@@ -384,7 +410,9 @@ static struct afb_hook_xreq_itf hook_xreq_default_itf = {
        .hook_xreq_subcall_req = hook_xreq_subcall_req_default_cb,
        .hook_xreq_subcall_req_result = hook_xreq_subcall_req_result_default_cb,
        .hook_xreq_has_permission = hook_xreq_has_permission_default_cb,
-       .hook_xreq_get_application_id = hook_xreq_get_application_id_default_cb
+       .hook_xreq_get_application_id = hook_xreq_get_application_id_default_cb,
+       .hook_xreq_context_make = hook_xreq_context_make_default_cb,
+       .hook_xreq_get_uid = hook_xreq_get_uid_default_cb,
 };
 
 /******************************************************************************
@@ -401,8 +429,8 @@ static struct afb_hook_xreq_itf hook_xreq_default_itf = {
                if (hook->itf->hook_xreq_##what \
                 && (hook->flags & afb_hook_flag_req_##what) != 0 \
                 && (!hook->session || hook->session == xreq->context.session) \
-                && (!hook->api || !strcasecmp(hook->api, xreq->api)) \
-                && (!hook->verb || !strcasecmp(hook->verb, xreq->verb))) { \
+                && (!hook->api || !strcasecmp(hook->api, xreq->request.api)) \
+                && (!hook->verb || !strcasecmp(hook->verb, xreq->request.verb))) { \
                        hook->itf->hook_xreq_##what(hook->closure, &hookid, __VA_ARGS__); \
                } \
                hook = hook->next; \
@@ -474,15 +502,15 @@ int afb_hook_xreq_session_set_LOA(const struct afb_xreq *xreq, unsigned level, i
        return result;
 }
 
-int afb_hook_xreq_subscribe(const struct afb_xreq *xreq, struct afb_event event, int result)
+int afb_hook_xreq_subscribe(const struct afb_xreq *xreq, struct afb_eventid *eventid, int result)
 {
-       _HOOK_XREQ_(subscribe, xreq, event, result);
+       _HOOK_XREQ_(subscribe, xreq, eventid, result);
        return result;
 }
 
-int afb_hook_xreq_unsubscribe(const struct afb_xreq *xreq, struct afb_event event, int result)
+int afb_hook_xreq_unsubscribe(const struct afb_xreq *xreq, struct afb_eventid *eventid, int result)
 {
-       _HOOK_XREQ_(unsubscribe, xreq, event, result);
+       _HOOK_XREQ_(unsubscribe, xreq, eventid, result);
        return result;
 }
 
@@ -544,6 +572,18 @@ char *afb_hook_xreq_get_application_id(const struct afb_xreq *xreq, char *result
        return result;
 }
 
+void *afb_hook_xreq_context_make(const struct afb_xreq *xreq, int replace, void *(*create_value)(void*), void (*free_value)(void*), void *create_closure, void *result)
+{
+       _HOOK_XREQ_(context_make, xreq, replace, create_value, free_value, create_closure, result);
+       return result;
+}
+
+int afb_hook_xreq_get_uid(const struct afb_xreq *xreq, int result)
+{
+       _HOOK_XREQ_(get_uid, xreq, result);
+       return result;
+}
+
 /******************************************************************************
  * section: hooking xreqs
  *****************************************************************************/
@@ -558,19 +598,21 @@ void afb_hook_init_xreq(struct afb_xreq *xreq)
 
        /* scan hook list to get the expected flags */
        flags = 0;
-       pthread_rwlock_rdlock(&rwlock);
-       hook = list_of_xreq_hooks;
-       while (hook) {
-               f = hook->flags & afb_hook_flags_req_all;
-               add = f != 0
-                  && (!hook->session || hook->session == xreq->context.session)
-                  && (!hook->api || !strcasecmp(hook->api, xreq->api))
-                  && (!hook->verb || !strcasecmp(hook->verb, xreq->verb));
-               if (add)
-                       flags |= f;
-               hook = hook->next;
+       if (afb_api_is_hookable(xreq->request.api)) {
+               pthread_rwlock_rdlock(&rwlock);
+               hook = list_of_xreq_hooks;
+               while (hook) {
+                       f = hook->flags & afb_hook_flags_req_all;
+                       add = f != 0
+                          && (!hook->session || hook->session == xreq->context.session)
+                          && (!hook->api || !strcasecmp(hook->api, xreq->request.api))
+                          && (!hook->verb || !strcasecmp(hook->verb, xreq->request.verb));
+                       if (add)
+                               flags |= f;
+                       hook = hook->next;
+               }
+               pthread_rwlock_unlock(&rwlock);
        }
-       pthread_rwlock_unlock(&rwlock);
 
        /* store the hooking data */
        xreq->hookflags = flags;
@@ -712,9 +754,9 @@ static void hook_ditf_vverbose_cb(void *closure, const struct afb_hookid *hookid
        }
 }
 
-static void hook_ditf_event_make_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct afb_event result)
+static void hook_ditf_event_make_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct afb_eventid *result)
 {
-       _hook_ditf_(export, "event_make(%s) -> %s:%d", name, afb_evt_event_name(result), afb_evt_event_id(result));
+       _hook_ditf_(export, "event_make(%s) -> %s:%d", name, afb_evt_eventid_fullname(result), afb_evt_eventid_id(result));
 }
 
 static void hook_ditf_rootdir_get_fd_cb(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result)
@@ -840,7 +882,7 @@ void afb_hook_ditf_vverbose(const struct afb_export *export, int level, const ch
        _HOOK_DITF_(vverbose, export, level, file, line, function, fmt, args);
 }
 
-struct afb_event afb_hook_ditf_event_make(const struct afb_export *export, const char *name, struct afb_event result)
+struct afb_eventid *afb_hook_ditf_event_make(const struct afb_export *export, const char *name, struct afb_eventid *result)
 {
        _HOOK_DITF_(event_make, export, name, result);
        return result;
@@ -895,15 +937,17 @@ int afb_hook_flags_ditf(const char *api)
        int flags;
        struct afb_hook_ditf *hook;
 
-       pthread_rwlock_rdlock(&rwlock);
        flags = 0;
-       hook = list_of_ditf_hooks;
-       while (hook) {
-               if (!api || !hook->api || !strcasecmp(hook->api, api))
-                       flags |= hook->flags;
-               hook = hook->next;
+       if (!api || afb_api_is_hookable(api)) {
+               pthread_rwlock_rdlock(&rwlock);
+               hook = list_of_ditf_hooks;
+               while (hook) {
+                       if (!api || !hook->api || !strcasecmp(hook->api, api))
+                               flags |= hook->flags;
+                       hook = hook->next;
+               }
+               pthread_rwlock_unlock(&rwlock);
        }
-       pthread_rwlock_unlock(&rwlock);
        return flags;
 }
 
@@ -1107,15 +1151,17 @@ int afb_hook_flags_svc(const char *api)
        int flags;
        struct afb_hook_svc *hook;
 
-       pthread_rwlock_rdlock(&rwlock);
        flags = 0;
-       hook = list_of_svc_hooks;
-       while (hook) {
-               if (!api || !hook->api || !strcasecmp(hook->api, api))
-                       flags |= hook->flags;
-               hook = hook->next;
+       if (!api || afb_api_is_hookable(api)) {
+               pthread_rwlock_rdlock(&rwlock);
+               hook = list_of_svc_hooks;
+               while (hook) {
+                       if (!api || !hook->api || !strcasecmp(hook->api, api))
+                               flags |= hook->flags;
+                       hook = hook->next;
+               }
+               pthread_rwlock_unlock(&rwlock);
        }
-       pthread_rwlock_unlock(&rwlock);
        return flags;
 }
 
@@ -1222,14 +1268,19 @@ static void hook_evt_broadcast_after_default_cb(void *closure, const struct afb_
        _hook_evt_(evt, id, "broadcast.after(%s) -> %d", json_object_to_json_string(obj), result);
 }
 
-static void hook_evt_name_default_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
+static void hook_evt_name_default_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id, const char *result)
+{
+       _hook_evt_(evt, id, "name -> %s", result);
+}
+
+static void hook_evt_addref_default_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
 {
-       _hook_evt_(evt, id, "name");
+       _hook_evt_(evt, id, "addref");
 }
 
-static void hook_evt_drop_default_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
+static void hook_evt_unref_default_cb(void *closure, const struct afb_hookid *hookid, const char *evt, int id)
 {
-       _hook_evt_(evt, id, "drop");
+       _hook_evt_(evt, id, "unref");
 }
 
 static struct afb_hook_evt_itf hook_evt_default_itf = {
@@ -1239,7 +1290,8 @@ static struct afb_hook_evt_itf hook_evt_default_itf = {
        .hook_evt_broadcast_before = hook_evt_broadcast_before_default_cb,
        .hook_evt_broadcast_after = hook_evt_broadcast_after_default_cb,
        .hook_evt_name = hook_evt_name_default_cb,
-       .hook_evt_drop = hook_evt_drop_default_cb
+       .hook_evt_addref = hook_evt_addref_default_cb,
+       .hook_evt_unref = hook_evt_unref_default_cb
 };
 
 /******************************************************************************
@@ -1289,14 +1341,19 @@ int afb_hook_evt_broadcast_after(const char *evt, int id, struct json_object *ob
        return result;
 }
 
-void afb_hook_evt_name(const char *evt, int id)
+void afb_hook_evt_name(const char *evt, int id, const char *result)
+{
+       _HOOK_EVT_(name, evt, id, result);
+}
+
+void afb_hook_evt_addref(const char *evt, int id)
 {
-       _HOOK_EVT_(name, evt, id);
+       _HOOK_EVT_(addref, evt, id);
 }
 
-void afb_hook_evt_drop(const char *evt, int id)
+void afb_hook_evt_unref(const char *evt, int id)
 {
-       _HOOK_EVT_(drop, evt, id);
+       _HOOK_EVT_(unref, evt, id);
 }
 
 /******************************************************************************
@@ -1308,15 +1365,17 @@ int afb_hook_flags_evt(const char *name)
        int flags;
        struct afb_hook_evt *hook;
 
-       pthread_rwlock_rdlock(&rwlock);
        flags = 0;
-       hook = list_of_evt_hooks;
-       while (hook) {
-               if (!name || !hook->pattern || !fnmatch(hook->pattern, name, FNM_CASEFOLD))
-                       flags |= hook->flags;
-               hook = hook->next;
+       if (!name || afb_api_is_hookable(name)) {
+               pthread_rwlock_rdlock(&rwlock);
+               hook = list_of_evt_hooks;
+               while (hook) {
+                       if (!name || !hook->pattern || !fnmatch(hook->pattern, name, FNM_CASEFOLD))
+                               flags |= hook->flags;
+                       hook = hook->next;
+               }
+               pthread_rwlock_unlock(&rwlock);
        }
-       pthread_rwlock_unlock(&rwlock);
        return flags;
 }
 
@@ -1385,6 +1444,178 @@ void afb_hook_unref_evt(struct afb_hook_evt *hook)
        }
 }
 
+/******************************************************************************
+ * section: default callbacks for sessions (session)
+ *****************************************************************************/
+
+static void _hook_session_(struct afb_session *session, const char *format, ...)
+{
+       va_list ap;
+       va_start(ap, format);
+       _hook_("session-%s", format, ap, afb_session_uuid(session));
+       va_end(ap);
+}
+
+static void hook_session_create_default_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
+{
+       _hook_session_(session, "create -> token=%s", afb_session_token(session));
+}
+
+static void hook_session_close_default_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
+{
+       _hook_session_(session, "close");
+}
+
+static void hook_session_destroy_default_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
+{
+       _hook_session_(session, "destroy");
+}
+
+static void hook_session_renew_default_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
+{
+       _hook_session_(session, "renew -> token=%s", afb_session_token(session));
+}
+
+static void hook_session_addref_default_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
+{
+       _hook_session_(session, "addref");
+}
+
+static void hook_session_unref_default_cb(void *closure, const struct afb_hookid *hookid, struct afb_session *session)
+{
+       _hook_session_(session, "unref");
+}
+
+static struct afb_hook_session_itf hook_session_default_itf = {
+       .hook_session_create = hook_session_create_default_cb,
+       .hook_session_close = hook_session_close_default_cb,
+       .hook_session_destroy = hook_session_destroy_default_cb,
+       .hook_session_renew = hook_session_renew_default_cb,
+       .hook_session_addref = hook_session_addref_default_cb,
+       .hook_session_unref = hook_session_unref_default_cb
+};
+
+/******************************************************************************
+ * section: hooks for tracing sessions (session)
+ *****************************************************************************/
+
+#define _HOOK_SESSION_(what,...)   \
+       struct afb_hook_session *hook; \
+       struct afb_hookid hookid; \
+       const char *sessid = 0; \
+       pthread_rwlock_rdlock(&rwlock); \
+       init_hookid(&hookid); \
+       hook = list_of_session_hooks; \
+       while (hook) { \
+               if (hook->itf->hook_session_##what \
+                && (hook->flags & afb_hook_flag_session_##what) != 0 \
+                && (!hook->pattern || !fnmatch(hook->pattern, (sessid?:(sessid=afb_session_uuid(session))), FNM_CASEFOLD))) { \
+                       hook->itf->hook_session_##what(hook->closure, &hookid, __VA_ARGS__); \
+               } \
+               hook = hook->next; \
+       } \
+       pthread_rwlock_unlock(&rwlock);
+
+void afb_hook_session_create(struct afb_session *session)
+{
+       _HOOK_SESSION_(create, session);
+}
+
+void afb_hook_session_close(struct afb_session *session)
+{
+       _HOOK_SESSION_(close, session);
+}
+
+void afb_hook_session_destroy(struct afb_session *session)
+{
+       _HOOK_SESSION_(destroy, session);
+}
+
+void afb_hook_session_renew(struct afb_session *session)
+{
+       _HOOK_SESSION_(renew, session);
+}
+
+void afb_hook_session_addref(struct afb_session *session)
+{
+       _HOOK_SESSION_(addref, session);
+}
+
+void afb_hook_session_unref(struct afb_session *session)
+{
+       _HOOK_SESSION_(unref, session);
+}
+
+
+/******************************************************************************
+ * section: hooking sessions (session)
+ *****************************************************************************/
+
+struct afb_hook_session *afb_hook_create_session(const char *pattern, int flags, struct afb_hook_session_itf *itf, void *closure)
+{
+       struct afb_hook_session *hook;
+
+       /* alloc the result */
+       hook = calloc(1, sizeof *hook);
+       if (hook == NULL)
+               return NULL;
+
+       /* get a copy of the names */
+       hook->pattern = pattern ? strdup(pattern) : NULL;
+       if (pattern && !hook->pattern) {
+               free(hook);
+               return NULL;
+       }
+
+       /* initialise the rest */
+       hook->refcount = 1;
+       hook->flags = flags;
+       hook->itf = itf ? itf : &hook_session_default_itf;
+       hook->closure = closure;
+
+       /* record the hook */
+       pthread_rwlock_wrlock(&rwlock);
+       hook->next = list_of_session_hooks;
+       list_of_session_hooks = hook;
+       pthread_rwlock_unlock(&rwlock);
+
+       /* returns it */
+       return hook;
+}
+
+struct afb_hook_session *afb_hook_addref_session(struct afb_hook_session *hook)
+{
+       pthread_rwlock_wrlock(&rwlock);
+       hook->refcount++;
+       pthread_rwlock_unlock(&rwlock);
+       return hook;
+}
+
+void afb_hook_unref_session(struct afb_hook_session *hook)
+{
+       struct afb_hook_session **prv;
+
+       if (hook) {
+               pthread_rwlock_wrlock(&rwlock);
+               if (--hook->refcount)
+                       hook = NULL;
+               else {
+                       /* unlink */
+                       prv = &list_of_session_hooks;
+                       while (*prv && *prv != hook)
+                               prv = &(*prv)->next;
+                       if(*prv)
+                               *prv = hook->next;
+               }
+               pthread_rwlock_unlock(&rwlock);
+               if (hook) {
+                       /* free */
+                       free(hook->pattern);
+                       free(hook);
+               }
+       }
+}
+
 /******************************************************************************
  * section: default callbacks for globals (global)
  *****************************************************************************/