include/afb/afb-req-common.h

   1 /*
   2  * Copyright (C) 2016, 2017 "IoT.bzh"
   3  * Author: José Bollo <jose.bollo@iot.bzh>
   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 #pragma once
  19
  20 #include <stdarg.h>
  21
  22 #include "afb-event-itf.h"
  23
  24 struct json_object;
  25 struct afb_stored_req;
  26 struct afb_req;
  27
  28 /*
  29  * Describes an argument (or parameter) of a request
  30  */
  31 struct afb_arg
  32 {
  33         const char *name;       /* name of the argument or NULL if invalid */
  34         const char *value;      /* string representation of the value of the argument */
  35                                 /* original filename of the argument if path != NULL */
  36         const char *path;       /* if not NULL, path of the received file for the argument */
  37                                 /* when the request is finalized this file is removed */
  38 };
  39
  40 /*
  41  * Interface for handling requests.
  42  * It records the functions to be called for the request.
  43  * Don't use this structure directly.
  44  * Use the helper functions documented below.
  45  */
  46 struct afb_req_itf
  47 {
  48         /* CAUTION: respect the order, add at the end */
  49
  50         struct json_object *(*json)(void *closure);
  51         struct afb_arg (*get)(void *closure, const char *name);
  52
  53         void (*success)(void *closure, struct json_object *obj, const char *info);
  54         void (*fail)(void *closure, const char *status, const char *info);
  55
  56         void (*vsuccess)(void *closure, struct json_object *obj, const char *fmt, va_list args);
  57         void (*vfail)(void *closure, const char *status, const char *fmt, va_list args);
  58
  59         void *(*context_get)(void *closure);
  60         void (*context_set)(void *closure, void *value, void (*free_value)(void*));
  61
  62         void (*addref)(void *closure);
  63         void (*unref)(void *closure);
  64
  65         void (*session_close)(void *closure);
  66         int (*session_set_LOA)(void *closure, unsigned level);
  67
  68         int (*subscribe)(void *closure, struct afb_event event);
  69         int (*unsubscribe)(void *closure, struct afb_event event);
  70
  71         void (*subcall)(void *closure, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *cb_closure);
  72         int (*subcallsync)(void *closure, const char *api, const char *verb, struct json_object *args, struct json_object **result);
  73
  74         void (*vverbose)(void *closure, int level, const char *file, int line, const char * func, const char *fmt, va_list args);
  75         struct afb_stored_req *(*store)(void *closure);
  76         void (*subcall_req)(void *closure, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*, struct afb_req), void *cb_closure);
  77 };
  78
  79 /*
  80  * Describes the request by bindings from afb-daemon
  81  */
  82 struct afb_req
  83 {
  84         const struct afb_req_itf *itf;  /* the interface to use */
  85         void *closure;                  /* the closure argument for functions of 'itf' */
  86 };
  87
  88 /*
  89  * Checks wether the request 'req' is valid or not.
  90  *
  91  * Returns 0 if not valid or 1 if valid.
  92  */
  93 static inline int afb_req_is_valid(struct afb_req req)
  94 {
  95         return !!req.itf;
  96 }
  97
  98 /*
  99  * Gets from the request 'req' the argument of 'name'.
 100  * Returns a PLAIN structure of type 'struct afb_arg'.
 101  * When the argument of 'name' is not found, all fields of result are set to NULL.
 102  * When the argument of 'name' is found, the fields are filled,
 103  * in particular, the field 'result.name' is set to 'name'.
 104  *
 105  * There is a special name value: the empty string.
 106  * The argument of name "" is defined only if the request was made using
 107  * an HTTP POST of Content-Type "application/json". In that case, the
 108  * argument of name "" receives the value of the body of the HTTP request.
 109  */
 110 static inline struct afb_arg afb_req_get(struct afb_req req, const char *name)
 111 {
 112         return req.itf->get(req.closure, name);
 113 }
 114
 115 /*
 116  * Gets from the request 'req' the string value of the argument of 'name'.
 117  * Returns NULL if when there is no argument of 'name'.
 118  * Returns the value of the argument of 'name' otherwise.
 119  *
 120  * Shortcut for: afb_req_get(req, name).value
 121  */
 122 static inline const char *afb_req_value(struct afb_req req, const char *name)
 123 {
 124         return afb_req_get(req, name).value;
 125 }
 126
 127 /*
 128  * Gets from the request 'req' the path for file attached to the argument of 'name'.
 129  * Returns NULL if when there is no argument of 'name' or when there is no file.
 130  * Returns the path of the argument of 'name' otherwise.
 131  *
 132  * Shortcut for: afb_req_get(req, name).path
 133  */
 134 static inline const char *afb_req_path(struct afb_req req, const char *name)
 135 {
 136         return afb_req_get(req, name).path;
 137 }
 138
 139 /*
 140  * Gets from the request 'req' the json object hashing the arguments.
 141  * The returned object must not be released using 'json_object_put'.
 142  */
 143 static inline struct json_object *afb_req_json(struct afb_req req)
 144 {
 145         return req.itf->json(req.closure);
 146 }
 147
 148 /*
 149  * Sends a reply of kind success to the request 'req'.
 150  * The status of the reply is automatically set to "success".
 151  * Its send the object 'obj' (can be NULL) with an
 152  * informationnal comment 'info (can also be NULL).
 153  *
 154  * For convenience, the function calls 'json_object_put' for 'obj'.
 155  * Thus, in the case where 'obj' should remain available after
 156  * the function returns, the function 'json_object_get' shall be used.
 157  */
 158 static inline void afb_req_success(struct afb_req req, struct json_object *obj, const char *info)
 159 {
 160         req.itf->success(req.closure, obj, info);
 161 }
 162
 163 /*
 164  * Same as 'afb_req_success' but the 'info' is a formatting
 165  * string followed by arguments.
 166  *
 167  * For convenience, the function calls 'json_object_put' for 'obj'.
 168  * Thus, in the case where 'obj' should remain available after
 169  * the function returns, the function 'json_object_get' shall be used.
 170  */
 171 static inline void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...) __attribute__((format(printf, 3, 4)));
 172 static inline void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...)
 173 {
 174         va_list args;
 175         va_start(args, info);
 176         req.itf->vsuccess(req.closure, obj, info, args);
 177         va_end(args);
 178 }
 179
 180 /*
 181  * Same as 'afb_req_success_f' but the arguments to the format 'info'
 182  * are given as a variable argument list instance.
 183  *
 184  * For convenience, the function calls 'json_object_put' for 'obj'.
 185  * Thus, in the case where 'obj' should remain available after
 186  * the function returns, the function 'json_object_get' shall be used.
 187  */
 188 static inline void afb_req_success_v(struct afb_req req, struct json_object *obj, const char *info, va_list args)
 189 {
 190         req.itf->vsuccess(req.closure, obj, info, args);
 191 }
 192
 193 /*
 194  * Sends a reply of kind failure to the request 'req'.
 195  * The status of the reply is set to 'status' and an
 196  * informationnal comment 'info' (can also be NULL) can be added.
 197  *
 198  * Note that calling afb_req_fail("success", info) is equivalent
 199  * to call afb_req_success(NULL, info). Thus even if possible it
 200  * is strongly recommanded to NEVER use "success" for status.
 201  */
 202 static inline void afb_req_fail(struct afb_req req, const char *status, const char *info)
 203 {
 204         req.itf->fail(req.closure, status, info);
 205 }
 206
 207 /*
 208  * Same as 'afb_req_fail' but the 'info' is a formatting
 209  * string followed by arguments.
 210  */
 211 static inline void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...) __attribute__((format(printf, 3, 4)));
 212 static inline void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...)
 213 {
 214         va_list args;
 215         va_start(args, info);
 216         req.itf->vfail(req.closure, status, info, args);
 217         va_end(args);
 218 }
 219
 220 /*
 221  * Same as 'afb_req_fail_f' but the arguments to the format 'info'
 222  * are given as a variable argument list instance.
 223  */
 224 static inline void afb_req_fail_v(struct afb_req req, const char *status, const char *info, va_list args)
 225 {
 226         req.itf->vfail(req.closure, status, info, args);
 227 }
 228
 229 /*
 230  * Gets the pointer stored by the binding for the session of 'req'.
 231  * When the binding has not yet recorded a pointer, NULL is returned.
 232  */
 233 static inline void *afb_req_context_get(struct afb_req req)
 234 {
 235         return req.itf->context_get(req.closure);
 236 }
 237
 238 /*
 239  * Stores for the binding the pointer 'context' to the session of 'req'.
 240  * The function 'free_context' will be called when the session is closed
 241  * or if binding stores an other pointer.
 242  */
 243 static inline void afb_req_context_set(struct afb_req req, void *context, void (*free_context)(void*))
 244 {
 245         req.itf->context_set(req.closure, context, free_context);
 246 }
 247
 248 /*
 249  * Gets the pointer stored by the binding for the session of 'req'.
 250  * If the stored pointer is NULL, indicating that no pointer was
 251  * already stored, afb_req_context creates a new context by calling
 252  * the function 'create_context' and stores it with the freeing function
 253  * 'free_context'.
 254  */
 255 static inline void *afb_req_context(struct afb_req req, void *(*create_context)(), void (*free_context)(void*))
 256 {
 257         void *result = afb_req_context_get(req);
 258         if (!result) {
 259                 result = create_context();
 260                 afb_req_context_set(req, result, free_context);
 261         }
 262         return result;
 263 }
 264
 265 /*
 266  * Frees the pointer stored by the binding for the session of 'req'
 267  * and sets it to NULL.
 268  *
 269  * Shortcut for: afb_req_context_set(req, NULL, NULL)
 270  */
 271 static inline void afb_req_context_clear(struct afb_req req)
 272 {
 273         afb_req_context_set(req, 0, 0);
 274 }
 275
 276 /*
 277  * Adds one to the count of references of 'req'.
 278  * This function MUST be called by asynchronous implementations
 279  * of verbs if no reply was sent before returning.
 280  */
 281 static inline void afb_req_addref(struct afb_req req)
 282 {
 283         req.itf->addref(req.closure);
 284 }
 285
 286 /*
 287  * Substracts one to the count of references of 'req'.
 288  * This function MUST be called by asynchronous implementations
 289  * of verbs after sending the asynchronous reply.
 290  */
 291 static inline void afb_req_unref(struct afb_req req)
 292 {
 293         req.itf->unref(req.closure);
 294 }
 295
 296 /*
 297  * Closes the session associated with 'req'
 298  * and delete all associated contexts.
 299  */
 300 static inline void afb_req_session_close(struct afb_req req)
 301 {
 302         req.itf->session_close(req.closure);
 303 }
 304
 305 /*
 306  * Sets the level of assurance of the session of 'req'
 307  * to 'level'. The effect of this function is subject of
 308  * security policies.
 309  * Returns 1 on success or 0 if failed.
 310  */
 311 static inline int afb_req_session_set_LOA(struct afb_req req, unsigned level)
 312 {
 313         return req.itf->session_set_LOA(req.closure, level);
 314 }
 315
 316 /*
 317  * Establishes for the client link identified by 'req' a subscription
 318  * to the 'event'.
 319  * Returns 0 in case of successful subscription or -1 in case of error.
 320  */
 321 static inline int afb_req_subscribe(struct afb_req req, struct afb_event event)
 322 {
 323         return req.itf->subscribe(req.closure, event);
 324 }
 325
 326 /*
 327  * Revokes the subscription established to the 'event' for the client
 328  * link identified by 'req'.
 329  * Returns 0 in case of successful subscription or -1 in case of error.
 330  */
 331 static inline int afb_req_unsubscribe(struct afb_req req, struct afb_event event)
 332 {
 333         return req.itf->unsubscribe(req.closure, event);
 334 }
 335
 336 /*
 337  * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
 338  * This call is made in the context of the request 'req'.
 339  * On completion, the function 'callback' is invoked with the
 340  * 'closure' given at call and two other parameters: 'iserror' and 'result'.
 341  * 'status' is 0 on success or negative when on an error reply.
 342  * 'result' is the json object of the reply, you must not call json_object_put
 343  * on the result.
 344  *
 345  * For convenience, the function calls 'json_object_put' for 'args'.
 346  * Thus, in the case where 'args' should remain available after
 347  * the function returns, the function 'json_object_get' shall be used.
 348  *
 349  * See also:
 350  *  - 'afb_req_subcall_req' that is convenient to keep request alive automatically.
 351  *  - 'afb_req_subcall_sync' the synchronous version
 352  */
 353 static inline void afb_req_subcall(struct afb_req req, const char *api, const char *verb, struct json_object *args, void (*callback)(void *closure, int iserror, struct json_object *result), void *closure)
 354 {
 355         req.itf->subcall(req.closure, api, verb, args, callback, closure);
 356 }
 357
 358 /*
 359  * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
 360  * This call is made in the context of the request 'req'.
 361  * On completion, the function 'callback' is invoked with the
 362  * original request 'req', the 'closure' given at call and two
 363  * other parameters: 'iserror' and 'result'.
 364  * 'status' is 0 on success or negative when on an error reply.
 365  * 'result' is the json object of the reply, you must not call json_object_put
 366  * on the result.
 367  *
 368  * For convenience, the function calls 'json_object_put' for 'args'.
 369  * Thus, in the case where 'args' should remain available after
 370  * the function returns, the function 'json_object_get' shall be used.
 371  *
 372  * See also:
 373  *  - 'afb_req_subcall' that doesn't keep request alive automatically.
 374  *  - 'afb_req_subcall_sync' the synchronous version
 375  */
 376 static inline void afb_req_subcall_req(struct afb_req req, const char *api, const char *verb, struct json_object *args, void (*callback)(void *closure, int iserror, struct json_object *result, struct afb_req req), void *closure)
 377 {
 378         req.itf->subcall_req(req.closure, api, verb, args, callback, closure);
 379 }
 380
 381 /*
 382  * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
 383  * This call is made in the context of the request 'req'.
 384  * This call is synchronous, it waits untill completion of the request.
 385  * It returns 0 on success or a negative value on error answer.
 386  * The object pointed by 'result' is filled and must be released by the caller
 387  * after its use by calling 'json_object_put'.
 388  *
 389  * For convenience, the function calls 'json_object_put' for 'args'.
 390  * Thus, in the case where 'args' should remain available after
 391  * the function returns, the function 'json_object_get' shall be used.
 392  *
 393  * See also:
 394  *  - 'afb_req_subcall_req' that is convenient to keep request alive automatically.
 395  *  - 'afb_req_subcall' that doesn't keep request alive automatically.
 396  */
 397 static inline int afb_req_subcall_sync(struct afb_req req, const char *api, const char *verb, struct json_object *args, struct json_object **result)
 398 {
 399         return req.itf->subcallsync(req.closure, api, verb, args, result);
 400 }
 401
 402 /*
 403  * Send associated to 'req' a message described by 'fmt' and following parameters
 404  * to the journal for the verbosity 'level'.
 405  *
 406  * 'file', 'line' and 'func' are indicators of position of the code in source files
 407  * (see macros __FILE__, __LINE__ and __func__).
 408  *
 409  * 'level' is defined by syslog standard:
 410  *      EMERGENCY         0        System is unusable
 411  *      ALERT             1        Action must be taken immediately
 412  *      CRITICAL          2        Critical conditions
 413  *      ERROR             3        Error conditions
 414  *      WARNING           4        Warning conditions
 415  *      NOTICE            5        Normal but significant condition
 416  *      INFO              6        Informational
 417  *      DEBUG             7        Debug-level messages
 418  */
 419 static inline void afb_req_verbose(struct afb_req req, int level, const char *file, int line, const char * func, const char *fmt, ...) __attribute__((format(printf, 6, 7)));
 420 static inline void afb_req_verbose(struct afb_req req, int level, const char *file, int line, const char * func, const char *fmt, ...)
 421 {
 422         va_list args;
 423         va_start(args, fmt);
 424         req.itf->vverbose(req.closure, level, file, line, func, fmt, args);
 425         va_end(args);
 426 }
 427
 428 /* macro for setting file, line and function automatically */
 429 # if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS)
 430 #define AFB_REQ_VERBOSE(req,level,...) afb_req_verbose(req,level,__FILE__,__LINE__,__func__,__VA_ARGS__)
 431 #else
 432 #define AFB_REQ_VERBOSE(req,level,...) afb_req_verbose(req,level,NULL,0,NULL,__VA_ARGS__)
 433 #endif