include/afb/afb-request.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 "afb-request-itf.h"
  21
  22 /*
  23  * Gets from the request 'request' the argument of 'name'.
  24  * Returns a PLAIN structure of type 'struct afb_arg'.
  25  * When the argument of 'name' is not found, all fields of result are set to NULL.
  26  * When the argument of 'name' is found, the fields are filled,
  27  * in particular, the field 'result.name' is set to 'name'.
  28  *
  29  * There is a special name value: the empty string.
  30  * The argument of name "" is defined only if the request was made using
  31  * an HTTP POST of Content-Type "application/json". In that case, the
  32  * argument of name "" receives the value of the body of the HTTP request.
  33  */
  34 static inline struct afb_arg afb_request_get(struct afb_request *request, const char *name)
  35 {
  36         return request->itf->get(request, name);
  37 }
  38
  39 /*
  40  * Gets from the request 'request' the string value of the argument of 'name'.
  41  * Returns NULL if when there is no argument of 'name'.
  42  * Returns the value of the argument of 'name' otherwise.
  43  *
  44  * Shortcut for: afb_request_get(request, name).value
  45  */
  46 static inline const char *afb_request_value(struct afb_request *request, const char *name)
  47 {
  48         return afb_request_get(request, name).value;
  49 }
  50
  51 /*
  52  * Gets from the request 'request' the path for file attached to the argument of 'name'.
  53  * Returns NULL if when there is no argument of 'name' or when there is no file.
  54  * Returns the path of the argument of 'name' otherwise.
  55  *
  56  * Shortcut for: afb_request_get(request, name).path
  57  */
  58 static inline const char *afb_request_path(struct afb_request *request, const char *name)
  59 {
  60         return afb_request_get(request, name).path;
  61 }
  62
  63 /*
  64  * Gets from the request 'request' the json object hashing the arguments.
  65  * The returned object must not be released using 'json_object_put'.
  66  */
  67 static inline struct json_object *afb_request_json(struct afb_request *request)
  68 {
  69         return request->itf->json(request);
  70 }
  71
  72 /*
  73  * Sends a reply of kind success to the request 'request'.
  74  * The status of the reply is automatically set to "success".
  75  * Its send the object 'obj' (can be NULL) with an
  76  * informationnal comment 'info (can also be NULL).
  77  *
  78  * For convenience, the function calls 'json_object_put' for 'obj'.
  79  * Thus, in the case where 'obj' should remain available after
  80  * the function returns, the function 'json_object_get' shall be used.
  81  */
  82 static inline void afb_request_success(struct afb_request *request, struct json_object *obj, const char *info)
  83 {
  84         request->itf->success(request, obj, info);
  85 }
  86
  87 /*
  88  * Same as 'afb_request_success' but the 'info' is a formatting
  89  * string followed by arguments.
  90  *
  91  * For convenience, the function calls 'json_object_put' for 'obj'.
  92  * Thus, in the case where 'obj' should remain available after
  93  * the function returns, the function 'json_object_get' shall be used.
  94  */
  95 static inline void afb_request_success_f(struct afb_request *request, struct json_object *obj, const char *info, ...) __attribute__((format(printf, 3, 4)));
  96 static inline void afb_request_success_f(struct afb_request *request, struct json_object *obj, const char *info, ...)
  97 {
  98         va_list args;
  99         va_start(args, info);
 100         request->itf->vsuccess(request, obj, info, args);
 101         va_end(args);
 102 }
 103
 104 /*
 105  * Same as 'afb_request_success_f' but the arguments to the format 'info'
 106  * are given as a variable argument list instance.
 107  *
 108  * For convenience, the function calls 'json_object_put' for 'obj'.
 109  * Thus, in the case where 'obj' should remain available after
 110  * the function returns, the function 'json_object_get' shall be used.
 111  */
 112 static inline void afb_request_success_v(struct afb_request *request, struct json_object *obj, const char *info, va_list args)
 113 {
 114         request->itf->vsuccess(request, obj, info, args);
 115 }
 116
 117 /*
 118  * Sends a reply of kind failure to the request 'request'.
 119  * The status of the reply is set to 'status' and an
 120  * informationnal comment 'info' (can also be NULL) can be added.
 121  *
 122  * Note that calling afb_request_fail("success", info) is equivalent
 123  * to call afb_request_success(NULL, info). Thus even if possible it
 124  * is strongly recommanded to NEVER use "success" for status.
 125  */
 126 static inline void afb_request_fail(struct afb_request *request, const char *status, const char *info)
 127 {
 128         request->itf->fail(request, status, info);
 129 }
 130
 131 /*
 132  * Same as 'afb_request_fail' but the 'info' is a formatting
 133  * string followed by arguments.
 134  */
 135 static inline void afb_request_fail_f(struct afb_request *request, const char *status, const char *info, ...) __attribute__((format(printf, 3, 4)));
 136 static inline void afb_request_fail_f(struct afb_request *request, const char *status, const char *info, ...)
 137 {
 138         va_list args;
 139         va_start(args, info);
 140         request->itf->vfail(request, status, info, args);
 141         va_end(args);
 142 }
 143
 144 /*
 145  * Same as 'afb_request_fail_f' but the arguments to the format 'info'
 146  * are given as a variable argument list instance.
 147  */
 148 static inline void afb_request_fail_v(struct afb_request *request, const char *status, const char *info, va_list args)
 149 {
 150         request->itf->vfail(request, status, info, args);
 151 }
 152
 153 /*
 154  * Gets the pointer stored by the binding for the session of 'request'.
 155  * When the binding has not yet recorded a pointer, NULL is returned.
 156  */
 157 static inline void *afb_request_context_get(struct afb_request *request)
 158 {
 159         return request->itf->context_make(request, 0, 0, 0, 0);
 160 }
 161
 162 /*
 163  * Stores for the binding the pointer 'context' to the session of 'request'.
 164  * The function 'free_context' will be called when the session is closed
 165  * or if binding stores an other pointer.
 166  */
 167 static inline void afb_request_context_set(struct afb_request *request, void *context, void (*free_context)(void*))
 168 {
 169         request->itf->context_make(request, 1, 0, free_context, context);
 170 }
 171
 172 /*
 173  * Gets the pointer stored by the binding for the session of 'request'.
 174  * If no previous pointer is stored or if 'replace' is not zero, a new value
 175  * is generated using the function 'create_context' called with the 'closure'.
 176  * If 'create_context' is NULL the generated value is 'closure'.
 177  * When a value is created, the function 'free_context' is recorded and will
 178  * be called (with the created value as argument) to free the created value when
 179  * it is not more used.
 180  * This function is atomic: it ensures that 2 threads will not race together.
 181  */
 182 static inline void *afb_request_context(struct afb_request *request, int replace, void *(*create_context)(void *closure), void (*free_context)(void*), void *closure)
 183 {
 184         return request->itf->context_make(request, replace, create_context, free_context, closure);
 185 }
 186
 187 /*
 188  * Frees the pointer stored by the binding for the session of 'request'
 189  * and sets it to NULL.
 190  *
 191  * Shortcut for: afb_request_context_set(request, NULL, NULL)
 192  */
 193 static inline void afb_request_context_clear(struct afb_request *request)
 194 {
 195         request->itf->context_make(request, 1, 0, 0, 0);
 196 }
 197
 198 /*
 199  * Adds one to the count of references of 'request'.
 200  * This function MUST be called by asynchronous implementations
 201  * of verbs if no reply was sent before returning.
 202  */
 203 static inline struct afb_request *afb_request_addref(struct afb_request *request)
 204 {
 205         return request->itf->addref(request);
 206 }
 207
 208 /*
 209  * Substracts one to the count of references of 'request'.
 210  * This function MUST be called by asynchronous implementations
 211  * of verbs after sending the asynchronous reply.
 212  */
 213 static inline void afb_request_unref(struct afb_request *request)
 214 {
 215         request->itf->unref(request);
 216 }
 217
 218 /*
 219  * Closes the session associated with 'request'
 220  * and delete all associated contexts.
 221  */
 222 static inline void afb_request_session_close(struct afb_request *request)
 223 {
 224         request->itf->session_close(request);
 225 }
 226
 227 /*
 228  * Sets the level of assurance of the session of 'request'
 229  * to 'level'. The effect of this function is subject of
 230  * security policies.
 231  * Returns 1 on success or 0 if failed.
 232  */
 233 static inline int afb_request_session_set_LOA(struct afb_request *request, unsigned level)
 234 {
 235         return request->itf->session_set_LOA(request, level);
 236 }
 237
 238 /*
 239  * Establishes for the client link identified by 'request' a subscription
 240  * to the 'event'.
 241  * Returns 0 in case of successful subscription or -1 in case of error.
 242  */
 243 static inline int afb_request_subscribe(struct afb_request *request, struct afb_eventid *eventid)
 244 {
 245         return request->itf->subscribe_eventid(request, eventid);
 246 }
 247
 248 /*
 249  * Revokes the subscription established to the 'event' for the client
 250  * link identified by 'request'.
 251  * Returns 0 in case of successful subscription or -1 in case of error.
 252  */
 253 static inline int afb_request_unsubscribe(struct afb_request *request, struct afb_eventid *eventid)
 254 {
 255         return request->itf->unsubscribe_eventid(request, eventid);
 256 }
 257
 258 /*
 259  * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
 260  * This call is made in the context of the request 'request'.
 261  * On completion, the function 'callback' is invoked with the
 262  * 'closure' given at call and two other parameters: 'iserror' and 'result'.
 263  * 'status' is 0 on success or negative when on an error reply.
 264  * 'result' is the json object of the reply, you must not call json_object_put
 265  * on the result.
 266  *
 267  * For convenience, the function calls 'json_object_put' for 'args'.
 268  * Thus, in the case where 'args' should remain available after
 269  * the function returns, the function 'json_object_get' shall be used.
 270  *
 271  * See also:
 272  *  - 'afb_request_subcall_req' that is convenient to keep request alive automatically.
 273  *  - 'afb_request_subcall_sync' the synchronous version
 274  */
 275 static inline void afb_request_subcall(struct afb_request *request, const char *api, const char *verb, struct json_object *args, void (*callback)(void *closure, int iserror, struct json_object *result, struct afb_request *request), void *closure)
 276 {
 277         request->itf->subcall_request(request, api, verb, args, callback, closure);
 278 }
 279
 280 /*
 281  * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
 282  * This call is made in the context of the request 'request'.
 283  * This call is synchronous, it waits untill completion of the request.
 284  * It returns 0 on success or a negative value on error answer.
 285  * The object pointed by 'result' is filled and must be released by the caller
 286  * after its use by calling 'json_object_put'.
 287  *
 288  * For convenience, the function calls 'json_object_put' for 'args'.
 289  * Thus, in the case where 'args' should remain available after
 290  * the function returns, the function 'json_object_get' shall be used.
 291  *
 292  * See also:
 293  *  - 'afb_request_subcall_req' that is convenient to keep request alive automatically.
 294  *  - 'afb_request_subcall' that doesn't keep request alive automatically.
 295  */
 296 static inline int afb_request_subcall_sync(struct afb_request *request, const char *api, const char *verb, struct json_object *args, struct json_object **result)
 297 {
 298         return request->itf->subcallsync(request, api, verb, args, result);
 299 }
 300
 301 /*
 302  * Send associated to 'request' a message described by 'fmt' and following parameters
 303  * to the journal for the verbosity 'level'.
 304  *
 305  * 'file', 'line' and 'func' are indicators of position of the code in source files
 306  * (see macros __FILE__, __LINE__ and __func__).
 307  *
 308  * 'level' is defined by syslog standard:
 309  *      EMERGENCY         0        System is unusable
 310  *      ALERT             1        Action must be taken immediately
 311  *      CRITICAL          2        Critical conditions
 312  *      ERROR             3        Error conditions
 313  *      WARNING           4        Warning conditions
 314  *      NOTICE            5        Normal but significant condition
 315  *      INFO              6        Informational
 316  *      DEBUG             7        Debug-level messages
 317  */
 318 static inline void afb_request_verbose(struct afb_request *request, int level, const char *file, int line, const char * func, const char *fmt, ...) __attribute__((format(printf, 6, 7)));
 319 static inline void afb_request_verbose(struct afb_request *request, int level, const char *file, int line, const char * func, const char *fmt, ...)
 320 {
 321         va_list args;
 322         va_start(args, fmt);
 323         request->itf->vverbose(request, level, file, line, func, fmt, args);
 324         va_end(args);
 325 }
 326
 327 /* macro for setting file, line and function automatically */
 328 # if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS)
 329 #define AFB_REQUEST_VERBOSE(request,level,...) afb_request_verbose(request,level,__FILE__,__LINE__,__func__,__VA_ARGS__)
 330 #else
 331 #define AFB_REQUEST_VERBOSE(request,level,...) afb_request_verbose(request,level,NULL,0,NULL,__VA_ARGS__)
 332 #endif
 333
 334 /*
 335  * Check whether the 'permission' is granted or not to the client
 336  * identified by 'request'.
 337  *
 338  * Returns 1 if the permission is granted or 0 otherwise.
 339  */
 340 static inline int afb_request_has_permission(struct afb_request *request, const char *permission)
 341 {
 342         return request->itf->has_permission(request, permission);
 343 }
 344
 345 /*
 346  * Get the application identifier of the client application for the
 347  * request 'request'.
 348  *
 349  * Returns the application identifier or NULL when the application
 350  * can not be identified.
 351  *
 352  * The returned value if not NULL must be freed by the caller
 353  */
 354 static inline char *afb_request_get_application_id(struct afb_request *request)
 355 {
 356         return request->itf->get_application_id(request);
 357 }
 358