res_ari_events: Fix shutdown ref leak.
[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 int ast_ari_events_event_websocket_ws_attempted_cb(struct ast_tcptls_session_instance *ser,
57         struct ast_variable *get_params, struct ast_variable *headers, const char *session_id)
58 {
59         struct ast_ari_events_event_websocket_args args = {};
60         int res = 0;
61         RAII_VAR(struct ast_ari_response *, response, NULL, ast_free);
62         struct ast_variable *i;
63
64         response = ast_calloc(1, sizeof(*response));
65         if (!response) {
66                 ast_log(LOG_ERROR, "Failed to create response.\n");
67                 goto fin;
68         }
69
70         for (i = get_params; i; i = i->next) {
71                 if (strcmp(i->name, "app") == 0) {
72                         /* Parse comma separated list */
73                         char *vals[MAX_VALS];
74                         size_t j;
75
76                         args.app_parse = ast_strdup(i->value);
77                         if (!args.app_parse) {
78                                 ast_ari_response_alloc_failed(response);
79                                 goto fin;
80                         }
81
82                         if (strlen(args.app_parse) == 0) {
83                                 /* ast_app_separate_args can't handle "" */
84                                 args.app_count = 1;
85                                 vals[0] = args.app_parse;
86                         } else {
87                                 args.app_count = ast_app_separate_args(
88                                         args.app_parse, ',', vals,
89                                         ARRAY_LEN(vals));
90                         }
91
92                         if (args.app_count == 0) {
93                                 ast_ari_response_alloc_failed(response);
94                                 goto fin;
95                         }
96
97                         if (args.app_count >= MAX_VALS) {
98                                 ast_ari_response_error(response, 400,
99                                         "Bad Request",
100                                         "Too many values for app");
101                                 goto fin;
102                         }
103
104                         args.app = ast_malloc(sizeof(*args.app) * args.app_count);
105                         if (!args.app) {
106                                 ast_ari_response_alloc_failed(response);
107                                 goto fin;
108                         }
109
110                         for (j = 0; j < args.app_count; ++j) {
111                                 args.app[j] = (vals[j]);
112                         }
113                 } else
114                 {}
115         }
116
117         res = ast_ari_websocket_events_event_websocket_attempted(ser, headers, &args, session_id);
118
119 fin: __attribute__((unused))
120         if (!response) {
121                 ast_http_error(ser, 500, "Server Error", "Memory allocation error");
122                 res = -1;
123         } else if (response->response_code != 0) {
124                 /* Param parsing failure */
125                 RAII_VAR(char *, msg, NULL, ast_json_free);
126                 if (response->message) {
127                         msg = ast_json_dump_string(response->message);
128                 } else {
129                         ast_log(LOG_ERROR, "Missing response message\n");
130                 }
131
132                 if (msg) {
133                         ast_http_error(ser, response->response_code, response->response_text, msg);
134                 }
135                 res = -1;
136         }
137         ast_free(args.app_parse);
138         ast_free(args.app);
139         return res;
140 }
141
142 static void ast_ari_events_event_websocket_ws_established_cb(struct ast_websocket *ws_session,
143         struct ast_variable *get_params, struct ast_variable *headers)
144 {
145         struct ast_ari_events_event_websocket_args args = {};
146         RAII_VAR(struct ast_ari_response *, response, NULL, ast_free);
147         struct ast_variable *i;
148         RAII_VAR(struct ast_websocket *, s, ws_session, ast_websocket_unref);
149         RAII_VAR(struct ast_ari_websocket_session *, session, NULL, ao2_cleanup);
150
151         response = ast_calloc(1, sizeof(*response));
152         if (!response) {
153                 ast_log(LOG_ERROR, "Failed to create response.\n");
154                 goto fin;
155         }
156
157 #if defined(AST_DEVMODE)
158         session = ast_ari_websocket_session_create(ws_session,
159                 ast_ari_validate_message_fn());
160 #else
161         session = ast_ari_websocket_session_create(ws_session, NULL);
162 #endif
163         if (!session) {
164                 ast_log(LOG_ERROR, "Failed to create ARI session\n");
165                 goto fin;
166         }
167
168         for (i = get_params; i; i = i->next) {
169                 if (strcmp(i->name, "app") == 0) {
170                         /* Parse comma separated list */
171                         char *vals[MAX_VALS];
172                         size_t j;
173
174                         args.app_parse = ast_strdup(i->value);
175                         if (!args.app_parse) {
176                                 ast_ari_response_alloc_failed(response);
177                                 goto fin;
178                         }
179
180                         if (strlen(args.app_parse) == 0) {
181                                 /* ast_app_separate_args can't handle "" */
182                                 args.app_count = 1;
183                                 vals[0] = args.app_parse;
184                         } else {
185                                 args.app_count = ast_app_separate_args(
186                                         args.app_parse, ',', vals,
187                                         ARRAY_LEN(vals));
188                         }
189
190                         if (args.app_count == 0) {
191                                 ast_ari_response_alloc_failed(response);
192                                 goto fin;
193                         }
194
195                         if (args.app_count >= MAX_VALS) {
196                                 ast_ari_response_error(response, 400,
197                                         "Bad Request",
198                                         "Too many values for app");
199                                 goto fin;
200                         }
201
202                         args.app = ast_malloc(sizeof(*args.app) * args.app_count);
203                         if (!args.app) {
204                                 ast_ari_response_alloc_failed(response);
205                                 goto fin;
206                         }
207
208                         for (j = 0; j < args.app_count; ++j) {
209                                 args.app[j] = (vals[j]);
210                         }
211                 } else
212                 {}
213         }
214
215         ast_ari_websocket_events_event_websocket_established(session, headers, &args);
216
217 fin: __attribute__((unused))
218         if (response && response->response_code != 0) {
219                 /* Param parsing failure */
220                 RAII_VAR(char *, msg, NULL, ast_json_free);
221                 if (response->message) {
222                         msg = ast_json_dump_string(response->message);
223                 } else {
224                         ast_log(LOG_ERROR, "Missing response message\n");
225                 }
226                 if (msg) {
227                         ast_websocket_write(ws_session,
228                                 AST_WEBSOCKET_OPCODE_TEXT, msg, strlen(msg));
229                 }
230         }
231         ast_free(args.app_parse);
232         ast_free(args.app);
233 }
234 int ast_ari_events_user_event_parse_body(
235         struct ast_json *body,
236         struct ast_ari_events_user_event_args *args)
237 {
238         struct ast_json *field;
239         /* Parse query parameters out of it */
240         field = ast_json_object_get(body, "application");
241         if (field) {
242                 args->application = ast_json_string_get(field);
243         }
244         field = ast_json_object_get(body, "source");
245         if (field) {
246                 /* If they were silly enough to both pass in a query param and a
247                  * JSON body, free up the query value.
248                  */
249                 ast_free(args->source);
250                 if (ast_json_typeof(field) == AST_JSON_ARRAY) {
251                         /* Multiple param passed as array */
252                         size_t i;
253                         args->source_count = ast_json_array_size(field);
254                         args->source = ast_malloc(sizeof(*args->source) * args->source_count);
255
256                         if (!args->source) {
257                                 return -1;
258                         }
259
260                         for (i = 0; i < args->source_count; ++i) {
261                                 args->source[i] = ast_json_string_get(ast_json_array_get(field, i));
262                         }
263                 } else {
264                         /* Multiple param passed as single value */
265                         args->source_count = 1;
266                         args->source = ast_malloc(sizeof(*args->source) * args->source_count);
267                         if (!args->source) {
268                                 return -1;
269                         }
270                         args->source[0] = ast_json_string_get(field);
271                 }
272         }
273         return 0;
274 }
275
276 /*!
277  * \brief Parameter parsing callback for /events/user/{eventName}.
278  * \param get_params GET parameters in the HTTP request.
279  * \param path_vars Path variables extracted from the request.
280  * \param headers HTTP headers.
281  * \param[out] response Response to the HTTP request.
282  */
283 static void ast_ari_events_user_event_cb(
284         struct ast_tcptls_session_instance *ser,
285         struct ast_variable *get_params, struct ast_variable *path_vars,
286         struct ast_variable *headers, struct ast_ari_response *response)
287 {
288         struct ast_ari_events_user_event_args args = {};
289         struct ast_variable *i;
290         RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
291 #if defined(AST_DEVMODE)
292         int is_valid;
293         int code;
294 #endif /* AST_DEVMODE */
295
296         for (i = get_params; i; i = i->next) {
297                 if (strcmp(i->name, "application") == 0) {
298                         args.application = (i->value);
299                 } else
300                 if (strcmp(i->name, "source") == 0) {
301                         /* Parse comma separated list */
302                         char *vals[MAX_VALS];
303                         size_t j;
304
305                         args.source_parse = ast_strdup(i->value);
306                         if (!args.source_parse) {
307                                 ast_ari_response_alloc_failed(response);
308                                 goto fin;
309                         }
310
311                         if (strlen(args.source_parse) == 0) {
312                                 /* ast_app_separate_args can't handle "" */
313                                 args.source_count = 1;
314                                 vals[0] = args.source_parse;
315                         } else {
316                                 args.source_count = ast_app_separate_args(
317                                         args.source_parse, ',', vals,
318                                         ARRAY_LEN(vals));
319                         }
320
321                         if (args.source_count == 0) {
322                                 ast_ari_response_alloc_failed(response);
323                                 goto fin;
324                         }
325
326                         if (args.source_count >= MAX_VALS) {
327                                 ast_ari_response_error(response, 400,
328                                         "Bad Request",
329                                         "Too many values for source");
330                                 goto fin;
331                         }
332
333                         args.source = ast_malloc(sizeof(*args.source) * args.source_count);
334                         if (!args.source) {
335                                 ast_ari_response_alloc_failed(response);
336                                 goto fin;
337                         }
338
339                         for (j = 0; j < args.source_count; ++j) {
340                                 args.source[j] = (vals[j]);
341                         }
342                 } else
343                 {}
344         }
345         for (i = path_vars; i; i = i->next) {
346                 if (strcmp(i->name, "eventName") == 0) {
347                         args.event_name = (i->value);
348                 } else
349                 {}
350         }
351         /* Look for a JSON request entity */
352         body = ast_http_get_json(ser, headers);
353         if (!body) {
354                 switch (errno) {
355                 case EFBIG:
356                         ast_ari_response_error(response, 413, "Request Entity Too Large", "Request body too large");
357                         goto fin;
358                 case ENOMEM:
359                         ast_ari_response_error(response, 500, "Internal Server Error", "Error processing request");
360                         goto fin;
361                 case EIO:
362                         ast_ari_response_error(response, 400, "Bad Request", "Error parsing request body");
363                         goto fin;
364                 }
365         }
366         args.variables = body;
367         ast_ari_events_user_event(headers, &args, response);
368 #if defined(AST_DEVMODE)
369         code = response->response_code;
370
371         switch (code) {
372         case 0: /* Implementation is still a stub, or the code wasn't set */
373                 is_valid = response->message == NULL;
374                 break;
375         case 500: /* Internal Server Error */
376         case 501: /* Not Implemented */
377         case 404: /* Application does not exist. */
378         case 422: /* Event source not found. */
379         case 400: /* Invalid even tsource URI or userevent data. */
380                 is_valid = 1;
381                 break;
382         default:
383                 if (200 <= code && code <= 299) {
384                         is_valid = ast_ari_validate_void(
385                                 response->message);
386                 } else {
387                         ast_log(LOG_ERROR, "Invalid error response %d for /events/user/{eventName}\n", code);
388                         is_valid = 0;
389                 }
390         }
391
392         if (!is_valid) {
393                 ast_log(LOG_ERROR, "Response validation failed for /events/user/{eventName}\n");
394                 ast_ari_response_error(response, 500,
395                         "Internal Server Error", "Response validation failed");
396         }
397 #endif /* AST_DEVMODE */
398
399 fin: __attribute__((unused))
400         ast_free(args.source_parse);
401         ast_free(args.source);
402         return;
403 }
404
405 /*! \brief REST handler for /api-docs/events.{format} */
406 static struct stasis_rest_handlers events_user_eventName = {
407         .path_segment = "eventName",
408         .is_wildcard = 1,
409         .callbacks = {
410                 [AST_HTTP_POST] = ast_ari_events_user_event_cb,
411         },
412         .num_children = 0,
413         .children = {  }
414 };
415 /*! \brief REST handler for /api-docs/events.{format} */
416 static struct stasis_rest_handlers events_user = {
417         .path_segment = "user",
418         .callbacks = {
419         },
420         .num_children = 1,
421         .children = { &events_user_eventName, }
422 };
423 /*! \brief REST handler for /api-docs/events.{format} */
424 static struct stasis_rest_handlers events = {
425         .path_segment = "events",
426         .callbacks = {
427         },
428         .num_children = 1,
429         .children = { &events_user, }
430 };
431
432 static int load_module(void)
433 {
434         int res = 0;
435         struct ast_websocket_protocol *protocol;
436
437         if (ast_ari_websocket_events_event_websocket_init() == -1) {
438                 return AST_MODULE_LOAD_FAILURE;
439         }
440
441         events.ws_server = ast_websocket_server_create();
442         if (!events.ws_server) {
443                 return AST_MODULE_LOAD_FAILURE;
444         }
445
446         protocol = ast_websocket_sub_protocol_alloc("ari");
447         if (!protocol) {
448                 ao2_ref(events.ws_server, -1);
449                 events.ws_server = NULL;
450                 return AST_MODULE_LOAD_FAILURE;
451         }
452         protocol->session_attempted = ast_ari_events_event_websocket_ws_attempted_cb;
453         protocol->session_established = ast_ari_events_event_websocket_ws_established_cb;
454         res |= ast_websocket_server_add_protocol2(events.ws_server, protocol);
455         stasis_app_ref();
456         res |= ast_ari_add_handler(&events);
457         return res;
458 }
459
460 static int unload_module(void)
461 {
462         ast_ari_remove_handler(&events);
463         ao2_cleanup(events.ws_server);
464         events.ws_server = NULL;
465         ast_ari_websocket_events_event_websocket_dtor();
466         stasis_app_unref();
467         return 0;
468 }
469
470 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - WebSocket resource",
471         .support_level = AST_MODULE_SUPPORT_CORE,
472         .load = load_module,
473         .unload = unload_module,
474         .nonoptreq = "res_ari,res_stasis",
475 );