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