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