f5a3facd62ae0ae3e9b1aa319cfbf262f4470b3f
[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
153 /*! \brief REST handler for /api-docs/events.{format} */
154 static struct stasis_rest_handlers events = {
155         .path_segment = "events",
156         .callbacks = {
157         },
158         .num_children = 0,
159         .children = {  }
160 };
161
162 static int load_module(void)
163 {
164         int res = 0;
165         events.ws_server = ast_websocket_server_create();
166         if (!events.ws_server) {
167                 return AST_MODULE_LOAD_FAILURE;
168         }
169         res |= ast_websocket_server_add_protocol(events.ws_server,
170                 "ari", ast_ari_events_event_websocket_ws_cb);
171         stasis_app_ref();
172         res |= ast_ari_add_handler(&events);
173         return res;
174 }
175
176 static int unload_module(void)
177 {
178         ast_ari_remove_handler(&events);
179         ao2_cleanup(events.ws_server);
180         events.ws_server = NULL;
181         stasis_app_unref();
182         return 0;
183 }
184
185 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - WebSocket resource",
186         .load = load_module,
187         .unload = unload_module,
188         .nonoptreq = "res_ari,res_stasis",
189         );