AST_MODULE_INFO: Format corrections to the usages of AST_MODULE_INFO macro.
[asterisk/asterisk.git] / res / res_ari_events.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012 - 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*
20  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
21  * !!!!!                               DO NOT EDIT                        !!!!!
22  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
23  * This file is generated by a mustache template. Please see the original
24  * template in rest-api-templates/res_ari_resource.c.mustache
25  */
26
27 /*! \file
28  *
29  * \brief WebSocket resource
30  *
31  * \author David M. Lee, II <dlee@digium.com>
32  */
33
34 /*** MODULEINFO
35         <depend type="module">res_ari</depend>
36         <depend type="module">res_ari_model</depend>
37         <depend type="module">res_stasis</depend>
38         <support_level>core</support_level>
39  ***/
40
41 #include "asterisk.h"
42
43 ASTERISK_REGISTER_FILE()
44
45 #include "asterisk/app.h"
46 #include "asterisk/module.h"
47 #include "asterisk/stasis_app.h"
48 #include "ari/resource_events.h"
49 #if defined(AST_DEVMODE)
50 #include "ari/ari_model_validators.h"
51 #endif
52 #include "asterisk/http_websocket.h"
53
54 #define MAX_VALS 128
55
56 static void ast_ari_events_event_websocket_ws_cb(struct ast_websocket *ws_session,
57         struct ast_variable *get_params, struct ast_variable *headers)
58 {
59         struct ast_ari_events_event_websocket_args args = {};
60         RAII_VAR(struct ast_ari_response *, response, NULL, ast_free);
61         struct ast_variable *i;
62         RAII_VAR(struct ast_websocket *, s, ws_session, ast_websocket_unref);
63         RAII_VAR(struct ast_ari_websocket_session *, session, NULL, ao2_cleanup);
64
65         response = ast_calloc(1, sizeof(*response));
66         if (!response) {
67                 ast_log(LOG_ERROR, "Failed to create response.\n");
68                 goto fin;
69         }
70
71 #if defined(AST_DEVMODE)
72         session = ast_ari_websocket_session_create(ws_session,
73                 ast_ari_validate_message_fn());
74 #else
75         session = ast_ari_websocket_session_create(ws_session, NULL);
76 #endif
77         if (!session) {
78                 ast_log(LOG_ERROR, "Failed to create ARI session\n");
79                 goto fin;
80         }
81
82         for (i = get_params; i; i = i->next) {
83                 if (strcmp(i->name, "app") == 0) {
84                         /* Parse comma separated list */
85                         char *vals[MAX_VALS];
86                         size_t j;
87
88                         args.app_parse = ast_strdup(i->value);
89                         if (!args.app_parse) {
90                                 ast_ari_response_alloc_failed(response);
91                                 goto fin;
92                         }
93
94                         if (strlen(args.app_parse) == 0) {
95                                 /* ast_app_separate_args can't handle "" */
96                                 args.app_count = 1;
97                                 vals[0] = args.app_parse;
98                         } else {
99                                 args.app_count = ast_app_separate_args(
100                                         args.app_parse, ',', vals,
101                                         ARRAY_LEN(vals));
102                         }
103
104                         if (args.app_count == 0) {
105                                 ast_ari_response_alloc_failed(response);
106                                 goto fin;
107                         }
108
109                         if (args.app_count >= MAX_VALS) {
110                                 ast_ari_response_error(response, 400,
111                                         "Bad Request",
112                                         "Too many values for app");
113                                 goto fin;
114                         }
115
116                         args.app = ast_malloc(sizeof(*args.app) * args.app_count);
117                         if (!args.app) {
118                                 ast_ari_response_alloc_failed(response);
119                                 goto fin;
120                         }
121
122                         for (j = 0; j < args.app_count; ++j) {
123                                 args.app[j] = (vals[j]);
124                         }
125                 } else
126                 {}
127         }
128
129         ast_ari_websocket_events_event_websocket(session, headers, &args);
130
131 fin: __attribute__((unused))
132         if (response && response->response_code != 0) {
133                 /* Param parsing failure */
134                 /* TODO - ideally, this would return the error code to the
135                  * HTTP client; but we've already done the WebSocket
136                  * negotiation. Param parsing should happen earlier, but we
137                  * need a way to pass it through the WebSocket code to the
138                  * callback */
139                 RAII_VAR(char *, msg, NULL, ast_json_free);
140                 if (response->message) {
141                         msg = ast_json_dump_string(response->message);
142                 } else {
143                         ast_log(LOG_ERROR, "Missing response message\n");
144                 }
145                 if (msg) {
146                         ast_websocket_write(ws_session,
147                                 AST_WEBSOCKET_OPCODE_TEXT, msg, strlen(msg));
148                 }
149         }
150         ast_free(args.app_parse);
151         ast_free(args.app);
152 }
153 int ast_ari_events_user_event_parse_body(
154         struct ast_json *body,
155         struct ast_ari_events_user_event_args *args)
156 {
157         struct ast_json *field;
158         /* Parse query parameters out of it */
159         field = ast_json_object_get(body, "application");
160         if (field) {
161                 args->application = ast_json_string_get(field);
162         }
163         field = ast_json_object_get(body, "source");
164         if (field) {
165                 /* If they were silly enough to both pass in a query param and a
166                  * JSON body, free up the query value.
167                  */
168                 ast_free(args->source);
169                 if (ast_json_typeof(field) == AST_JSON_ARRAY) {
170                         /* Multiple param passed as array */
171                         size_t i;
172                         args->source_count = ast_json_array_size(field);
173                         args->source = ast_malloc(sizeof(*args->source) * args->source_count);
174
175                         if (!args->source) {
176                                 return -1;
177                         }
178
179                         for (i = 0; i < args->source_count; ++i) {
180                                 args->source[i] = ast_json_string_get(ast_json_array_get(field, i));
181                         }
182                 } else {
183                         /* Multiple param passed as single value */
184                         args->source_count = 1;
185                         args->source = ast_malloc(sizeof(*args->source) * args->source_count);
186                         if (!args->source) {
187                                 return -1;
188                         }
189                         args->source[0] = ast_json_string_get(field);
190                 }
191         }
192         return 0;
193 }
194
195 /*!
196  * \brief Parameter parsing callback for /events/user/{eventName}.
197  * \param get_params GET parameters in the HTTP request.
198  * \param path_vars Path variables extracted from the request.
199  * \param headers HTTP headers.
200  * \param[out] response Response to the HTTP request.
201  */
202 static void ast_ari_events_user_event_cb(
203         struct ast_tcptls_session_instance *ser,
204         struct ast_variable *get_params, struct ast_variable *path_vars,
205         struct ast_variable *headers, struct ast_ari_response *response)
206 {
207         struct ast_ari_events_user_event_args args = {};
208         struct ast_variable *i;
209         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
210 #if defined(AST_DEVMODE)
211         int is_valid;
212         int code;
213 #endif /* AST_DEVMODE */
214
215         for (i = get_params; i; i = i->next) {
216                 if (strcmp(i->name, "application") == 0) {
217                         args.application = (i->value);
218                 } else
219                 if (strcmp(i->name, "source") == 0) {
220                         /* Parse comma separated list */
221                         char *vals[MAX_VALS];
222                         size_t j;
223
224                         args.source_parse = ast_strdup(i->value);
225                         if (!args.source_parse) {
226                                 ast_ari_response_alloc_failed(response);
227                                 goto fin;
228                         }
229
230                         if (strlen(args.source_parse) == 0) {
231                                 /* ast_app_separate_args can't handle "" */
232                                 args.source_count = 1;
233                                 vals[0] = args.source_parse;
234                         } else {
235                                 args.source_count = ast_app_separate_args(
236                                         args.source_parse, ',', vals,
237                                         ARRAY_LEN(vals));
238                         }
239
240                         if (args.source_count == 0) {
241                                 ast_ari_response_alloc_failed(response);
242                                 goto fin;
243                         }
244
245                         if (args.source_count >= MAX_VALS) {
246                                 ast_ari_response_error(response, 400,
247                                         "Bad Request",
248                                         "Too many values for source");
249                                 goto fin;
250                         }
251
252                         args.source = ast_malloc(sizeof(*args.source) * args.source_count);
253                         if (!args.source) {
254                                 ast_ari_response_alloc_failed(response);
255                                 goto fin;
256                         }
257
258                         for (j = 0; j < args.source_count; ++j) {
259                                 args.source[j] = (vals[j]);
260                         }
261                 } else
262                 {}
263         }
264         for (i = path_vars; i; i = i->next) {
265                 if (strcmp(i->name, "eventName") == 0) {
266                         args.event_name = (i->value);
267                 } else
268                 {}
269         }
270         /* Look for a JSON request entity */
271         body = ast_http_get_json(ser, headers);
272         if (!body) {
273                 switch (errno) {
274                 case EFBIG:
275                         ast_ari_response_error(response, 413, "Request Entity Too Large", "Request body too large");
276                         goto fin;
277                 case ENOMEM:
278                         ast_ari_response_error(response, 500, "Internal Server Error", "Error processing request");
279                         goto fin;
280                 case EIO:
281                         ast_ari_response_error(response, 400, "Bad Request", "Error parsing request body");
282                         goto fin;
283                 }
284         }
285         args.variables = body;
286         ast_ari_events_user_event(headers, &args, response);
287 #if defined(AST_DEVMODE)
288         code = response->response_code;
289
290         switch (code) {
291         case 0: /* Implementation is still a stub, or the code wasn't set */
292                 is_valid = response->message == NULL;
293                 break;
294         case 500: /* Internal Server Error */
295         case 501: /* Not Implemented */
296         case 404: /* Application does not exist. */
297         case 422: /* Event source not found. */
298         case 400: /* Invalid even tsource URI or userevent data. */
299                 is_valid = 1;
300                 break;
301         default:
302                 if (200 <= code && code <= 299) {
303                         is_valid = ast_ari_validate_void(
304                                 response->message);
305                 } else {
306                         ast_log(LOG_ERROR, "Invalid error response %d for /events/user/{eventName}\n", code);
307                         is_valid = 0;
308                 }
309         }
310
311         if (!is_valid) {
312                 ast_log(LOG_ERROR, "Response validation failed for /events/user/{eventName}\n");
313                 ast_ari_response_error(response, 500,
314                         "Internal Server Error", "Response validation failed");
315         }
316 #endif /* AST_DEVMODE */
317
318 fin: __attribute__((unused))
319         ast_free(args.source_parse);
320         ast_free(args.source);
321         return;
322 }
323
324 /*! \brief REST handler for /api-docs/events.{format} */
325 static struct stasis_rest_handlers events_user_eventName = {
326         .path_segment = "eventName",
327         .is_wildcard = 1,
328         .callbacks = {
329                 [AST_HTTP_POST] = ast_ari_events_user_event_cb,
330         },
331         .num_children = 0,
332         .children = {  }
333 };
334 /*! \brief REST handler for /api-docs/events.{format} */
335 static struct stasis_rest_handlers events_user = {
336         .path_segment = "user",
337         .callbacks = {
338         },
339         .num_children = 1,
340         .children = { &events_user_eventName, }
341 };
342 /*! \brief REST handler for /api-docs/events.{format} */
343 static struct stasis_rest_handlers events = {
344         .path_segment = "events",
345         .callbacks = {
346         },
347         .num_children = 1,
348         .children = { &events_user, }
349 };
350
351 static int load_module(void)
352 {
353         int res = 0;
354         events.ws_server = ast_websocket_server_create();
355         if (!events.ws_server) {
356                 return AST_MODULE_LOAD_FAILURE;
357         }
358         res |= ast_websocket_server_add_protocol(events.ws_server,
359                 "ari", ast_ari_events_event_websocket_ws_cb);
360         stasis_app_ref();
361         res |= ast_ari_add_handler(&events);
362         return res;
363 }
364
365 static int unload_module(void)
366 {
367         ast_ari_remove_handler(&events);
368         ao2_cleanup(events.ws_server);
369         events.ws_server = NULL;
370         stasis_app_unref();
371         return 0;
372 }
373
374 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - WebSocket resource",
375         .support_level = AST_MODULE_SUPPORT_CORE,
376         .load = load_module,
377         .unload = unload_module,
378         .nonoptreq = "res_ari,res_stasis",
379 );