ARI: WebSocket event cleanup
[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
52 #define MAX_VALS 128
53
54 static void ast_ari_event_websocket_ws_cb(struct ast_websocket *ws_session,
55         struct ast_variable *get_params, struct ast_variable *headers)
56 {
57         struct ast_event_websocket_args args = {};
58         RAII_VAR(struct ast_ari_response *, response, NULL, ast_free);
59         struct ast_variable *i;
60         RAII_VAR(struct ast_websocket *, s, ws_session, ast_websocket_unref);
61         RAII_VAR(struct ast_ari_websocket_session *, session, NULL, ao2_cleanup);
62
63         response = ast_calloc(1, sizeof(*response));
64         if (!response) {
65                 ast_log(LOG_ERROR, "Failed to create response.\n");
66                 goto fin;
67         }
68
69 #if defined(AST_DEVMODE)
70         session = ast_ari_websocket_session_create(ws_session,
71                 ast_ari_validate_message_fn());
72 #else
73         session = ast_ari_websocket_session_create(ws_session, NULL);
74 #endif
75         if (!session) {
76                 ast_log(LOG_ERROR, "Failed to create ARI session\n");
77                 goto fin;
78         }
79
80         for (i = get_params; i; i = i->next) {
81                 if (strcmp(i->name, "app") == 0) {
82                         /* Parse comma separated list */
83                         char *vals[MAX_VALS];
84                         size_t j;
85
86                         args.app_parse = ast_strdup(i->value);
87                         if (!args.app_parse) {
88                                 ast_ari_response_alloc_failed(response);
89                                 goto fin;
90                         }
91
92                         if (strlen(args.app_parse) == 0) {
93                                 /* ast_app_separate_args can't handle "" */
94                                 args.app_count = 1;
95                                 vals[0] = args.app_parse;
96                         } else {
97                                 args.app_count = ast_app_separate_args(
98                                         args.app_parse, ',', vals,
99                                         ARRAY_LEN(vals));
100                         }
101
102                         if (args.app_count == 0) {
103                                 ast_ari_response_alloc_failed(response);
104                                 goto fin;
105                         }
106
107                         if (args.app_count >= MAX_VALS) {
108                                 ast_ari_response_error(response, 400,
109                                         "Bad Request",
110                                         "Too many values for app");
111                                 goto fin;
112                         }
113
114                         args.app = ast_malloc(sizeof(*args.app) * args.app_count);
115                         if (!args.app) {
116                                 ast_ari_response_alloc_failed(response);
117                                 goto fin;
118                         }
119
120                         for (j = 0; j < args.app_count; ++j) {
121                                 args.app[j] = (vals[j]);
122                         }
123                 } else
124                 {}
125         }
126
127         ast_ari_websocket_event_websocket(session, headers, &args);
128
129 fin: __attribute__((unused))
130         if (response && response->response_code != 0) {
131                 /* Param parsing failure */
132                 /* TODO - ideally, this would return the error code to the
133                  * HTTP client; but we've already done the WebSocket
134                  * negotiation. Param parsing should happen earlier, but we
135                  * need a way to pass it through the WebSocket code to the
136                  * callback */
137                 RAII_VAR(char *, msg, NULL, ast_json_free);
138                 if (response->message) {
139                         msg = ast_json_dump_string(response->message);
140                 } else {
141                         ast_log(LOG_ERROR, "Missing response message\n");
142                 }
143                 if (msg) {
144                         ast_websocket_write(ws_session,
145                                 AST_WEBSOCKET_OPCODE_TEXT, msg, strlen(msg));
146                 }
147         }
148         ast_free(args.app_parse);
149         ast_free(args.app);
150 }
151
152 /*! \brief REST handler for /api-docs/events.{format} */
153 static struct stasis_rest_handlers events = {
154         .path_segment = "events",
155         .callbacks = {
156         },
157         .num_children = 0,
158         .children = {  }
159 };
160
161 static int load_module(void)
162 {
163         int res = 0;
164         events.ws_server = ast_websocket_server_create();
165         if (!events.ws_server) {
166                 return AST_MODULE_LOAD_FAILURE;
167         }
168         res |= ast_websocket_server_add_protocol(events.ws_server,
169                 "ari", ast_ari_event_websocket_ws_cb);
170         stasis_app_ref();
171         res |= ast_ari_add_handler(&events);
172         return res;
173 }
174
175 static int unload_module(void)
176 {
177         ast_ari_remove_handler(&events);
178         ao2_cleanup(events.ws_server);
179         events.ws_server = NULL;
180         stasis_app_unref();
181         return 0;
182 }
183
184 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - WebSocket resource",
185         .load = load_module,
186         .unload = unload_module,
187         .nonoptreq = "res_ari,res_stasis",
188         );