e5490b54618eecfb4e43ab2081453486636b62e1
[asterisk/asterisk.git] / res / ari / resource_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 /*! \file
20  *
21  * \brief /api-docs/events.{format} implementation- WebSocket resource
22  *
23  * \author David M. Lee, II <dlee@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include "asterisk/astobj2.h"
31 #include "asterisk/stasis_app.h"
32 #include "resource_events.h"
33
34 /*! Number of buckets for the Stasis application hash table. Remember to keep it
35  *  a prime number!
36  */
37 #define APPS_NUM_BUCKETS 7
38
39 /*! \brief A connection to the event WebSocket */
40 struct event_session {
41         struct ast_ari_websocket_session *ws_session;
42         struct ao2_container *websocket_apps;
43 };
44
45 /*!
46  * \brief Explicitly shutdown a session.
47  *
48  * An explicit shutdown is necessary, since stasis-app has a reference to this
49  * session. We also need to be sure to null out the \c ws_session field, since
50  * the websocket is about to go away.
51  *
52  * \param session Session info struct.
53  */
54 static void session_shutdown(struct event_session *session)
55 {
56         struct ao2_iterator i;
57         char *app;
58         SCOPED_AO2LOCK(lock, session);
59
60         i = ao2_iterator_init(session->websocket_apps, 0);
61         while ((app = ao2_iterator_next(&i))) {
62                 stasis_app_unregister(app);
63                 ao2_cleanup(app);
64         }
65         ao2_iterator_destroy(&i);
66         ao2_cleanup(session->websocket_apps);
67
68         session->websocket_apps = NULL;
69         session->ws_session = NULL;
70 }
71
72 static void session_dtor(void *obj)
73 {
74 #ifdef AST_DEVMODE /* Avoid unused variable warning */
75         struct event_session *session = obj;
76 #endif
77
78         /* session_shutdown should have been called before */
79         ast_assert(session->ws_session == NULL);
80         ast_assert(session->websocket_apps == NULL);
81 }
82
83 static void session_cleanup(struct event_session *session)
84 {
85         session_shutdown(session);
86         ao2_cleanup(session);
87 }
88
89 static struct event_session *session_create(
90         struct ast_ari_websocket_session *ws_session)
91 {
92         RAII_VAR(struct event_session *, session, NULL, ao2_cleanup);
93
94         session = ao2_alloc(sizeof(*session), session_dtor);
95
96         session->ws_session = ws_session;
97         session->websocket_apps =
98                 ast_str_container_alloc(APPS_NUM_BUCKETS);
99
100         if (!session->websocket_apps) {
101                 return NULL;
102         }
103
104         ao2_ref(session, +1);
105         return session;
106 }
107
108 /*!
109  * \brief Callback handler for Stasis application messages.
110  */
111 static void app_handler(void *data, const char *app_name,
112                         struct ast_json *message)
113 {
114         struct event_session *session = data;
115         int res;
116         const char *msg_type = S_OR(
117                 ast_json_string_get(ast_json_object_get(message, "type")),
118                 "");
119         const char *msg_application = S_OR(
120                 ast_json_string_get(ast_json_object_get(message, "application")),
121                 "");
122  
123         /* Determine if we've been replaced */
124         if (strcmp(msg_type, "ApplicationReplaced") == 0 &&
125                 strcmp(msg_application, app_name) == 0) {
126                 ao2_find(session->websocket_apps, msg_application,
127                         OBJ_UNLINK | OBJ_NODATA);
128         }
129
130         res = ast_json_object_set(message, "application",
131                                   ast_json_string_create(app_name));
132         if(res != 0) {
133                 return;
134         }
135
136         ao2_lock(session);
137         if (session->ws_session) {
138                 ast_ari_websocket_session_write(session->ws_session, message);
139         }
140         ao2_unlock(session);
141 }
142
143 /*!
144  * \brief Register for all of the apps given.
145  * \param session Session info struct.
146  * \param app_list Comma seperated list of app names to register.
147  */
148 static int session_register_apps(struct event_session *session,
149                                  const char *app_list)
150 {
151         RAII_VAR(char *, to_free, NULL, ast_free);
152         char *apps, *app_name;
153         SCOPED_AO2LOCK(lock, session);
154
155         ast_assert(session->ws_session != NULL);
156         ast_assert(session->websocket_apps != NULL);
157
158         if (!app_list) {
159                 return -1;
160         }
161
162         to_free = apps = ast_strdup(app_list);
163         if (!apps) {
164                 ast_ari_websocket_session_write(session->ws_session, ast_ari_oom_json());
165                 return -1;
166         }
167         while ((app_name = strsep(&apps, ","))) {
168                 if (ast_str_container_add(session->websocket_apps, app_name)) {
169                         ast_ari_websocket_session_write(session->ws_session, ast_ari_oom_json());
170                         return -1;
171                 }
172
173                 stasis_app_register(app_name, app_handler, session);
174         }
175         return 0;
176 }
177
178 void ast_ari_websocket_event_websocket(struct ast_ari_websocket_session *ws_session,
179         struct ast_variable *headers,
180         struct ast_event_websocket_args *args)
181 {
182         RAII_VAR(struct event_session *, session, NULL, session_cleanup);
183         struct ast_json *msg;
184         int res;
185
186         ast_debug(3, "/events WebSocket connection\n");
187
188         session = session_create(ws_session);
189         if (!session) {
190                 ast_ari_websocket_session_write(ws_session, ast_ari_oom_json());
191                 return;
192         }
193
194         if (!args->app) {
195                 RAII_VAR(struct ast_json *, msg, NULL, ast_json_unref);
196
197                 msg = ast_json_pack("{s: s, s: [s]}",
198                         "type", "MissingParams",
199                         "params", "app");
200                 if (!msg) {
201                         msg = ast_json_ref(ast_ari_oom_json());
202                 }
203
204                 ast_ari_websocket_session_write(session->ws_session, msg);
205                 return;
206         }
207
208         res = session_register_apps(session, args->app);
209         if (res != 0) {
210                 ast_ari_websocket_session_write(ws_session, ast_ari_oom_json());
211                 return;
212         }
213
214         /* We don't process any input, but we'll consume it waiting for EOF */
215         while ((msg = ast_ari_websocket_session_read(ws_session))) {
216                 ast_json_unref(msg);
217         }
218 }