2 * Copyright (C) 2016, 2017 "IoT.bzh"
3 * Author: José Bollo <jose.bollo@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 #include "afb-request-itf.h"
22 typedef struct afb_request afb_request;
24 #include "afb-event.h"
27 * Gets from the request 'request' the argument of 'name'.
28 * Returns a PLAIN structure of type 'struct afb_arg'.
29 * When the argument of 'name' is not found, all fields of result are set to NULL.
30 * When the argument of 'name' is found, the fields are filled,
31 * in particular, the field 'result.name' is set to 'name'.
33 * There is a special name value: the empty string.
34 * The argument of name "" is defined only if the request was made using
35 * an HTTP POST of Content-Type "application/json". In that case, the
36 * argument of name "" receives the value of the body of the HTTP request.
38 static inline struct afb_arg afb_request_get(struct afb_request *request, const char *name)
40 return request->itf->get(request, name);
44 * Gets from the request 'request' the string value of the argument of 'name'.
45 * Returns NULL if when there is no argument of 'name'.
46 * Returns the value of the argument of 'name' otherwise.
48 * Shortcut for: afb_request_get(request, name).value
50 static inline const char *afb_request_value(struct afb_request *request, const char *name)
52 return afb_request_get(request, name).value;
56 * Gets from the request 'request' the path for file attached to the argument of 'name'.
57 * Returns NULL if when there is no argument of 'name' or when there is no file.
58 * Returns the path of the argument of 'name' otherwise.
60 * Shortcut for: afb_request_get(request, name).path
62 static inline const char *afb_request_path(struct afb_request *request, const char *name)
64 return afb_request_get(request, name).path;
68 * Gets from the request 'request' the json object hashing the arguments.
69 * The returned object must not be released using 'json_object_put'.
71 static inline struct json_object *afb_request_json(struct afb_request *request)
73 return request->itf->json(request);
77 * Sends a reply of kind success to the request 'request'.
78 * The status of the reply is automatically set to "success".
79 * Its send the object 'obj' (can be NULL) with an
80 * informationnal comment 'info (can also be NULL).
82 * For convenience, the function calls 'json_object_put' for 'obj'.
83 * Thus, in the case where 'obj' should remain available after
84 * the function returns, the function 'json_object_get' shall be used.
86 static inline void afb_request_success(struct afb_request *request, struct json_object *obj, const char *info)
88 request->itf->success(request, obj, info);
92 * Same as 'afb_request_success' but the 'info' is a formatting
93 * string followed by arguments.
95 * For convenience, the function calls 'json_object_put' for 'obj'.
96 * Thus, in the case where 'obj' should remain available after
97 * the function returns, the function 'json_object_get' shall be used.
99 static inline void afb_request_success_f(struct afb_request *request, struct json_object *obj, const char *info, ...) __attribute__((format(printf, 3, 4)));
100 static inline void afb_request_success_f(struct afb_request *request, struct json_object *obj, const char *info, ...)
103 va_start(args, info);
104 request->itf->vsuccess(request, obj, info, args);
109 * Same as 'afb_request_success_f' but the arguments to the format 'info'
110 * are given as a variable argument list instance.
112 * For convenience, the function calls 'json_object_put' for 'obj'.
113 * Thus, in the case where 'obj' should remain available after
114 * the function returns, the function 'json_object_get' shall be used.
116 static inline void afb_request_success_v(struct afb_request *request, struct json_object *obj, const char *info, va_list args)
118 request->itf->vsuccess(request, obj, info, args);
122 * Sends a reply of kind failure to the request 'request'.
123 * The status of the reply is set to 'status' and an
124 * informationnal comment 'info' (can also be NULL) can be added.
126 * Note that calling afb_request_fail("success", info) is equivalent
127 * to call afb_request_success(NULL, info). Thus even if possible it
128 * is strongly recommanded to NEVER use "success" for status.
130 static inline void afb_request_fail(struct afb_request *request, const char *status, const char *info)
132 request->itf->fail(request, status, info);
136 * Same as 'afb_request_fail' but the 'info' is a formatting
137 * string followed by arguments.
139 static inline void afb_request_fail_f(struct afb_request *request, const char *status, const char *info, ...) __attribute__((format(printf, 3, 4)));
140 static inline void afb_request_fail_f(struct afb_request *request, const char *status, const char *info, ...)
143 va_start(args, info);
144 request->itf->vfail(request, status, info, args);
149 * Same as 'afb_request_fail_f' but the arguments to the format 'info'
150 * are given as a variable argument list instance.
152 static inline void afb_request_fail_v(struct afb_request *request, const char *status, const char *info, va_list args)
154 request->itf->vfail(request, status, info, args);
158 * Gets the pointer stored by the binding for the session of 'request'.
159 * When the binding has not yet recorded a pointer, NULL is returned.
161 static inline void *afb_request_context_get(struct afb_request *request)
163 return request->itf->context_make(request, 0, 0, 0, 0);
167 * Stores for the binding the pointer 'context' to the session of 'request'.
168 * The function 'free_context' will be called when the session is closed
169 * or if binding stores an other pointer.
171 static inline void afb_request_context_set(struct afb_request *request, void *context, void (*free_context)(void*))
173 request->itf->context_make(request, 1, 0, free_context, context);
177 * Gets the pointer stored by the binding for the session of 'request'.
178 * If no previous pointer is stored or if 'replace' is not zero, a new value
179 * is generated using the function 'create_context' called with the 'closure'.
180 * If 'create_context' is NULL the generated value is 'closure'.
181 * When a value is created, the function 'free_context' is recorded and will
182 * be called (with the created value as argument) to free the created value when
183 * it is not more used.
184 * This function is atomic: it ensures that 2 threads will not race together.
186 static inline void *afb_request_context(struct afb_request *request, int replace, void *(*create_context)(void *closure), void (*free_context)(void*), void *closure)
188 return request->itf->context_make(request, replace, create_context, free_context, closure);
192 * Frees the pointer stored by the binding for the session of 'request'
193 * and sets it to NULL.
195 * Shortcut for: afb_request_context_set(request, NULL, NULL)
197 static inline void afb_request_context_clear(struct afb_request *request)
199 request->itf->context_make(request, 1, 0, 0, 0);
203 * Adds one to the count of references of 'request'.
204 * This function MUST be called by asynchronous implementations
205 * of verbs if no reply was sent before returning.
207 static inline struct afb_request *afb_request_addref(struct afb_request *request)
209 return request->itf->addref(request);
213 * Substracts one to the count of references of 'request'.
214 * This function MUST be called by asynchronous implementations
215 * of verbs after sending the asynchronous reply.
217 static inline void afb_request_unref(struct afb_request *request)
219 request->itf->unref(request);
223 * Closes the session associated with 'request'
224 * and delete all associated contexts.
226 static inline void afb_request_session_close(struct afb_request *request)
228 request->itf->session_close(request);
232 * Sets the level of assurance of the session of 'request'
233 * to 'level'. The effect of this function is subject of
235 * Returns 1 on success or 0 if failed.
237 static inline int afb_request_session_set_LOA(struct afb_request *request, unsigned level)
239 return request->itf->session_set_LOA(request, level);
243 * Establishes for the client link identified by 'request' a subscription
245 * Returns 0 in case of successful subscription or -1 in case of error.
247 static inline int afb_request_subscribe(struct afb_request *request, struct afb_event event)
249 return request->itf->subscribe(request, event);
253 * Revokes the subscription established to the 'event' for the client
254 * link identified by 'request'.
255 * Returns 0 in case of successful subscription or -1 in case of error.
257 static inline int afb_request_unsubscribe(struct afb_request *request, struct afb_event event)
259 return request->itf->unsubscribe(request, event);
263 * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
264 * This call is made in the context of the request 'request'.
265 * On completion, the function 'callback' is invoked with the
266 * 'closure' given at call and two other parameters: 'iserror' and 'result'.
267 * 'status' is 0 on success or negative when on an error reply.
268 * 'result' is the json object of the reply, you must not call json_object_put
271 * For convenience, the function calls 'json_object_put' for 'args'.
272 * Thus, in the case where 'args' should remain available after
273 * the function returns, the function 'json_object_get' shall be used.
276 * - 'afb_request_subcall_req' that is convenient to keep request alive automatically.
277 * - 'afb_request_subcall_sync' the synchronous version
279 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), void *closure)
281 request->itf->subcall(request, api, verb, args, callback, closure);
285 * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
286 * This call is made in the context of the request 'request'.
287 * This call is synchronous, it waits untill completion of the request.
288 * It returns 0 on success or a negative value on error answer.
289 * The object pointed by 'result' is filled and must be released by the caller
290 * after its use by calling 'json_object_put'.
292 * For convenience, the function calls 'json_object_put' for 'args'.
293 * Thus, in the case where 'args' should remain available after
294 * the function returns, the function 'json_object_get' shall be used.
297 * - 'afb_request_subcall_req' that is convenient to keep request alive automatically.
298 * - 'afb_request_subcall' that doesn't keep request alive automatically.
300 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)
302 return request->itf->subcallsync(request, api, verb, args, result);
306 * Send associated to 'request' a message described by 'fmt' and following parameters
307 * to the journal for the verbosity 'level'.
309 * 'file', 'line' and 'func' are indicators of position of the code in source files
310 * (see macros __FILE__, __LINE__ and __func__).
312 * 'level' is defined by syslog standard:
313 * EMERGENCY 0 System is unusable
314 * ALERT 1 Action must be taken immediately
315 * CRITICAL 2 Critical conditions
316 * ERROR 3 Error conditions
317 * WARNING 4 Warning conditions
318 * NOTICE 5 Normal but significant condition
319 * INFO 6 Informational
320 * DEBUG 7 Debug-level messages
322 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)));
323 static inline void afb_request_verbose(struct afb_request *request, int level, const char *file, int line, const char * func, const char *fmt, ...)
327 request->itf->vverbose(request, level, file, line, func, fmt, args);
331 /* macro for setting file, line and function automatically */
332 # if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS)
333 #define AFB_REQUEST_VERBOSE(request,level,...) afb_request_verbose(request,level,__FILE__,__LINE__,__func__,__VA_ARGS__)
335 #define AFB_REQUEST_VERBOSE(request,level,...) afb_request_verbose(request,level,NULL,0,NULL,__VA_ARGS__)
339 * Check whether the 'permission' is granted or not to the client
340 * identified by 'request'.
342 * Returns 1 if the permission is granted or 0 otherwise.
344 static inline int afb_request_has_permission(struct afb_request *request, const char *permission)
346 return request->itf->has_permission(request, permission);
350 * Get the application identifier of the client application for the
353 * Returns the application identifier or NULL when the application
354 * can not be identified.
356 * The returned value if not NULL must be freed by the caller
358 static inline char *afb_request_get_application_id(struct afb_request *request)
360 return request->itf->get_application_id(request);