Update date of copyright notices

[src/app-framework-binder.git] / src / afb-hook.h

diff --git a/src/afb-hook.h b/src/afb-hook.h
index a9c3894..52d8335 100644 (file)
--- a/src/afb-hook.h
+++ b/src/afb-hook.h
@@ -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");
@@ -24,7 +24,7 @@ struct req;
 struct afb_context;
 struct json_object;
 struct afb_arg;
-struct afb_event;
+struct afb_eventid;
 struct afb_session;
 struct afb_xreq;
 struct afb_export;
@@ -35,6 +35,7 @@ struct afb_hook_xreq;
 struct afb_hook_ditf;
 struct afb_hook_svc;
 struct afb_hook_evt;
+struct afb_hook_session;
 struct afb_hook_global;
 
 /*********************************************************
@@ -75,6 +76,9 @@ struct afb_hookid
 #define afb_hook_flag_req_subcall_req          0x00200000
 #define afb_hook_flag_req_subcall_req_result   0x00400000
 #define afb_hook_flag_req_has_permission       0x00800000
+#define afb_hook_flag_req_get_application_id   0x01000000
+#define afb_hook_flag_req_context_make         0x02000000
+#define afb_hook_flag_req_get_uid              0x04000000
 
 /* common flags */
 #define afb_hook_flags_req_life                (afb_hook_flag_req_begin|afb_hook_flag_req_end)
@@ -85,16 +89,19 @@ struct afb_hookid
 #define afb_hook_flags_req_subcalls    (afb_hook_flag_req_subcall|afb_hook_flag_req_subcall_result\
                                        |afb_hook_flag_req_subcall_req|afb_hook_flag_req_subcall_req_result\
                                        |afb_hook_flag_req_subcallsync|afb_hook_flag_req_subcallsync_result)
+#define afb_hook_flags_req_security    (afb_hook_flag_req_has_permission|afb_hook_flag_req_get_application_id\
+                                       |afb_hook_flag_req_get_uid)
 
 /* extra flags */
 #define afb_hook_flags_req_ref         (afb_hook_flag_req_addref|afb_hook_flag_req_unref)
-#define afb_hook_flags_req_context     (afb_hook_flag_req_context_get|afb_hook_flag_req_context_set)
+#define afb_hook_flags_req_context     (afb_hook_flag_req_context_get|afb_hook_flag_req_context_set\
+                                       |afb_hook_flag_req_context_make)
 #define afb_hook_flags_req_stores      (afb_hook_flag_req_store|afb_hook_flag_req_unstore)
 
 /* predefined groups */
 #define afb_hook_flags_req_common      (afb_hook_flags_req_life|afb_hook_flags_req_args|afb_hook_flags_req_result\
                                        |afb_hook_flags_req_session|afb_hook_flags_req_event|afb_hook_flags_req_subcalls\
-                                       |afb_hook_flag_req_vverbose|afb_hook_flag_req_has_permission)
+                                       |afb_hook_flag_req_vverbose|afb_hook_flags_req_security)
 #define afb_hook_flags_req_extra       (afb_hook_flags_req_common|afb_hook_flags_req_ref|afb_hook_flags_req_context\
                                        |afb_hook_flags_req_stores)
 #define afb_hook_flags_req_all         (afb_hook_flags_req_extra)
@@ -112,8 +119,8 @@ struct afb_hook_xreq_itf {
        void (*hook_xreq_unref)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq);
        void (*hook_xreq_session_close)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq);
        void (*hook_xreq_session_set_LOA)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, unsigned level, int result);
-       void (*hook_xreq_subscribe)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_event event, int result);
-       void (*hook_xreq_unsubscribe)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_event event, int result);
+       void (*hook_xreq_subscribe)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_eventid *eventid, int result);
+       void (*hook_xreq_unsubscribe)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, struct afb_eventid *eventid, int result);
        void (*hook_xreq_subcall)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
        void (*hook_xreq_subcall_result)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int status, struct json_object *result);
        void (*hook_xreq_subcallsync)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
@@ -124,6 +131,9 @@ struct afb_hook_xreq_itf {
        void (*hook_xreq_subcall_req)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
        void (*hook_xreq_subcall_req_result)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int status, struct json_object *result);
        void (*hook_xreq_has_permission)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, const char *permission, int result);
+       void (*hook_xreq_get_application_id)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, char *result);
+       void (*hook_xreq_context_make)(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);
+       void (*hook_xreq_get_uid)(void *closure, const struct afb_hookid *hookid, const struct afb_xreq *xreq, int result);
 };
 
 extern void afb_hook_init_xreq(struct afb_xreq *xreq);
@@ -145,8 +155,8 @@ extern void afb_hook_xreq_addref(const struct afb_xreq *xreq);
 extern void afb_hook_xreq_unref(const struct afb_xreq *xreq);
 extern void afb_hook_xreq_session_close(const struct afb_xreq *xreq);
 extern int afb_hook_xreq_session_set_LOA(const struct afb_xreq *xreq, unsigned level, int result);
-extern int afb_hook_xreq_subscribe(const struct afb_xreq *xreq, struct afb_event event, int result);
-extern int afb_hook_xreq_unsubscribe(const struct afb_xreq *xreq, struct afb_event event, int result);
+extern int afb_hook_xreq_subscribe(const struct afb_xreq *xreq, struct afb_eventid *eventid, int result);
+extern int afb_hook_xreq_unsubscribe(const struct afb_xreq *xreq, struct afb_eventid *eventid, int result);
 extern void afb_hook_xreq_subcall(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
 extern void afb_hook_xreq_subcall_result(const struct afb_xreq *xreq, int status, struct json_object *result);
 extern void afb_hook_xreq_subcallsync(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
@@ -157,6 +167,9 @@ extern void afb_hook_xreq_unstore(const struct afb_xreq *xreq);
 extern void afb_hook_xreq_subcall_req(const struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args);
 extern void afb_hook_xreq_subcall_req_result(const struct afb_xreq *xreq, int status, struct json_object *result);
 extern int afb_hook_xreq_has_permission(const struct afb_xreq *xreq, const char *permission, int result);
+extern char *afb_hook_xreq_get_application_id(const struct afb_xreq *xreq, char *result);
+extern 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);
+extern int afb_hook_xreq_get_uid(const struct afb_xreq *xreq, int result);
 
 /*********************************************************
 * section hooking export (daemon interface)
@@ -201,7 +214,7 @@ struct afb_hook_ditf_itf {
        void (*hook_ditf_get_user_bus)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_bus *result);
        void (*hook_ditf_get_system_bus)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, struct sd_bus *result);
        void (*hook_ditf_vverbose)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int level, const char *file, int line, const char *function, const char *fmt, va_list args);
-       void (*hook_ditf_event_make)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct afb_event result);
+       void (*hook_ditf_event_make)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *name, struct afb_eventid *result);
        void (*hook_ditf_rootdir_get_fd)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, int result);
        void (*hook_ditf_rootdir_open_locale)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, const char *filename, int flags, const char *locale, int result);
        void (*hook_ditf_queue_job)(void *closure, const struct afb_hookid *hookid, const struct afb_export *export, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout, int result);
@@ -217,7 +230,7 @@ extern struct sd_event *afb_hook_ditf_get_event_loop(const struct afb_export *ex
 extern struct sd_bus *afb_hook_ditf_get_user_bus(const struct afb_export *export, struct sd_bus *result);
 extern struct sd_bus *afb_hook_ditf_get_system_bus(const struct afb_export *export, struct sd_bus *result);
 extern void afb_hook_ditf_vverbose(const struct afb_export *export, int level, const char *file, int line, const char *function, const char *fmt, va_list args);
-extern struct afb_event afb_hook_ditf_event_make(const struct afb_export *export, const char *name, struct afb_event result);
+extern struct afb_eventid *afb_hook_ditf_event_make(const struct afb_export *export, const char *name, struct afb_eventid *result);
 extern int afb_hook_ditf_rootdir_get_fd(const struct afb_export *export, int result);
 extern int afb_hook_ditf_rootdir_open_locale(const struct afb_export *export, const char *filename, int flags, const char *locale, int result);
 extern int afb_hook_ditf_queue_job(const struct afb_export *export, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout, int result);
@@ -284,12 +297,14 @@ extern void afb_hook_unref_svc(struct afb_hook_svc *hook);
 #define afb_hook_flag_evt_broadcast_before             0x000008
 #define afb_hook_flag_evt_broadcast_after              0x000010
 #define afb_hook_flag_evt_name                         0x000020
-#define afb_hook_flag_evt_drop                         0x000040
+#define afb_hook_flag_evt_addref                       0x000040
+#define afb_hook_flag_evt_unref                                0x000080
 
 #define afb_hook_flags_evt_common      (afb_hook_flag_evt_push_before|afb_hook_flag_evt_broadcast_before)
 #define afb_hook_flags_evt_extra       (afb_hook_flags_evt_common\
                                        |afb_hook_flag_evt_push_after|afb_hook_flag_evt_broadcast_after\
-                                       |afb_hook_flag_evt_create|afb_hook_flag_evt_drop)
+                                       |afb_hook_flag_evt_create\
+                                       |afb_hook_flag_evt_addref|afb_hook_flag_evt_unref)
 #define afb_hook_flags_evt_all         (afb_hook_flags_evt_extra|afb_hook_flag_evt_name)
 
 struct afb_hook_evt_itf {
@@ -298,8 +313,9 @@ struct afb_hook_evt_itf {
        void (*hook_evt_push_after)(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj, int result);
        void (*hook_evt_broadcast_before)(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj);
        void (*hook_evt_broadcast_after)(void *closure, const struct afb_hookid *hookid, const char *evt, int id, struct json_object *obj, int result);
-       void (*hook_evt_name)(void *closure, const struct afb_hookid *hookid, const char *evt, int id);
-       void (*hook_evt_drop)(void *closure, const struct afb_hookid *hookid, const char *evt, int id);
+       void (*hook_evt_name)(void *closure, const struct afb_hookid *hookid, const char *evt, int id, const char *result);
+       void (*hook_evt_addref)(void *closure, const struct afb_hookid *hookid, const char *evt, int id);
+       void (*hook_evt_unref)(void *closure, const struct afb_hookid *hookid, const char *evt, int id);
 };
 
 extern void afb_hook_evt_create(const char *evt, int id);
@@ -307,14 +323,51 @@ extern void afb_hook_evt_push_before(const char *evt, int id, struct json_object
 extern int afb_hook_evt_push_after(const char *evt, int id, struct json_object *obj, int result);
 extern void afb_hook_evt_broadcast_before(const char *evt, int id, struct json_object *obj);
 extern int afb_hook_evt_broadcast_after(const char *evt, int id, struct json_object *obj, int result);
-extern void afb_hook_evt_name(const char *evt, int id);
-extern void afb_hook_evt_drop(const char *evt, int id);
+extern void afb_hook_evt_name(const char *evt, int id, const char *result);
+extern void afb_hook_evt_addref(const char *evt, int id);
+extern void afb_hook_evt_unref(const char *evt, int id);
 
 extern int afb_hook_flags_evt(const char *name);
 extern struct afb_hook_evt *afb_hook_create_evt(const char *pattern, int flags, struct afb_hook_evt_itf *itf, void *closure);
 extern struct afb_hook_evt *afb_hook_addref_evt(struct afb_hook_evt *hook);
 extern void afb_hook_unref_evt(struct afb_hook_evt *hook);
 
+/*********************************************************
+* section hooking session (session interface)
+*********************************************************/
+
+#define afb_hook_flag_session_create                   0x000001
+#define afb_hook_flag_session_close                    0x000002
+#define afb_hook_flag_session_destroy                  0x000004
+#define afb_hook_flag_session_renew                    0x000008
+#define afb_hook_flag_session_addref                   0x000010
+#define afb_hook_flag_session_unref                    0x000020
+
+#define afb_hook_flags_session_common  (afb_hook_flag_session_create|afb_hook_flag_session_close\
+                                       |afb_hook_flag_session_renew)
+#define afb_hook_flags_session_all     (afb_hook_flags_session_common|afb_hook_flag_session_destroy\
+                                       |afb_hook_flag_session_addref|afb_hook_flag_session_unref)
+
+struct afb_hook_session_itf {
+       void (*hook_session_create)(void *closure, const struct afb_hookid *hookid, struct afb_session *session);
+       void (*hook_session_close)(void *closure, const struct afb_hookid *hookid, struct afb_session *session);
+       void (*hook_session_destroy)(void *closure, const struct afb_hookid *hookid, struct afb_session *session);
+       void (*hook_session_renew)(void *closure, const struct afb_hookid *hookid, struct afb_session *session);
+       void (*hook_session_addref)(void *closure, const struct afb_hookid *hookid, struct afb_session *session);
+       void (*hook_session_unref)(void *closure, const struct afb_hookid *hookid, struct afb_session *session);
+};
+
+extern void afb_hook_session_create(struct afb_session *session);
+extern void afb_hook_session_close(struct afb_session *session);
+extern void afb_hook_session_destroy(struct afb_session *session);
+extern void afb_hook_session_renew(struct afb_session *session);
+extern void afb_hook_session_addref(struct afb_session *session);
+extern void afb_hook_session_unref(struct afb_session *session);
+
+extern struct afb_hook_session *afb_hook_create_session(const char *pattern, int flags, struct afb_hook_session_itf *itf, void *closure);
+extern struct afb_hook_session *afb_hook_addref_session(struct afb_hook_session *hook);
+extern void afb_hook_unref_session(struct afb_hook_session *hook);
+
 /*********************************************************
 * section hooking global (global interface)
 *********************************************************/