5983f7b531be94f9dc7ac752ba18349a182e7b78
[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 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 #include "resource_events.h"
33 #include "asterisk/astobj2.h"
34 #include "asterisk/http_websocket.h"
35 #include "asterisk/stasis_app.h"
36 #include "asterisk/vector.h"
37
38 /*! Number of buckets for the event session registry. Remember to keep it a prime number! */
39 #define EVENT_SESSION_NUM_BUCKETS 23
40
41 /*! Number of buckets for a websocket apps container. Remember to keep it a prime number! */
42 #define APPS_NUM_BUCKETS 7
43
44 /*! Initial size of a message queue. */
45 #define MESSAGES_INIT_SIZE 23
46
47
48 /*! \brief A wrapper for the /ref ast_ari_websocket_session. */
49 struct event_session {
50         struct ast_ari_websocket_session *ws_session;   /*!< Handle to the websocket session. */
51         struct ao2_container *websocket_apps;           /*!< List of Stasis apps registered to
52                                                              the websocket session. */
53         AST_VECTOR(, struct ast_json *) message_queue;  /*!< Container for holding delayed messages. */
54         char session_id[];                              /*!< The id for the websocket session. */
55 };
56
57 /*! \brief \ref event_session error types. */
58 enum event_session_error_type {
59         ERROR_TYPE_STASIS_REGISTRATION = 1,  /*!< Stasis failed to register the application. */
60         ERROR_TYPE_OOM = 2,                  /*!< Insufficient memory to create the event
61                                                   session. */
62         ERROR_TYPE_MISSING_APP_PARAM = 3,    /*!< HTTP request was missing an [app] parameter. */
63         ERROR_TYPE_INVALID_APP_PARAM = 4,    /*!< HTTP request contained an invalid [app]
64                                                   parameter. */
65 };
66
67 /*! \brief Local registry for created \ref event_session objects. */
68 static struct ao2_container *event_session_registry;
69
70 /*!
71  * \brief Callback handler for Stasis application messages.
72  *
73  * \internal
74  *
75  * \param data      Void pointer to the event session (\ref event_session).
76  * \param app_name  Name of the Stasis application that dispatched the message.
77  * \param message   The dispatched message.
78  */
79 static void stasis_app_message_handler(
80                 void *data, const char *app_name, struct ast_json *message)
81 {
82         struct event_session *session = data;
83         const char *msg_type, *msg_application;
84
85         ast_assert(session != NULL);
86
87         ao2_lock(session);
88
89         msg_type = S_OR(ast_json_string_get(ast_json_object_get(message, "type")), "");
90         msg_application = S_OR(
91                 ast_json_string_get(ast_json_object_get(message, "application")), "");
92
93         /* If we've been replaced, remove the application from our local
94            websocket_apps container */
95         if (strcmp(msg_type, "ApplicationReplaced") == 0 &&
96                 strcmp(msg_application, app_name) == 0) {
97                 ao2_find(session->websocket_apps, msg_application,
98                         OBJ_UNLINK | OBJ_NODATA);
99         }
100
101         /* Now, we need to determine our state to see how we will handle the message */
102         if (ast_json_object_set(message, "application", ast_json_string_create(app_name))) {
103                 /* We failed to add an application element to our json message */
104                 ast_log(LOG_WARNING,
105                         "Failed to dispatch '%s' message from Stasis app '%s'; could not update message\n",
106                         msg_type,
107                         msg_application);
108         } else if (!session->ws_session) {
109                 /* If the websocket is NULL, the message goes to the queue */
110                 if (!AST_VECTOR_APPEND(&session->message_queue, message)) {
111                         ast_json_ref(message);
112                 }
113                 ast_log(LOG_WARNING,
114                                 "Queued '%s' message for Stasis app '%s'; websocket is not ready\n",
115                                 msg_type,
116                                 msg_application);
117         } else {
118                 if (stasis_app_get_debug_by_name(app_name)) {
119                         char *str = ast_json_dump_string_format(message, ast_ari_json_format());
120
121                         ast_verbose("<--- Sending ARI event to %s --->\n%s\n",
122                                 ast_sockaddr_stringify(ast_ari_websocket_session_get_remote_addr(session->ws_session)),
123                                 str);
124                         ast_json_free(str);
125                 }
126
127                 /* We are ready to publish the message */
128                 ast_ari_websocket_session_write(session->ws_session, message);
129         }
130
131         ao2_unlock(session);
132 }
133
134 /*!
135  * \brief AO2 comparison function for \ref event_session objects.
136  *
137  * \internal
138  *
139  * \param obj    Void pointer to the \ref event_session container.
140  * \param arg    Void pointer to the \ref event_session object.
141  * \param flags  The \ref search_flags to use when creating the hash key.
142  *
143  * \retval 0          The objects are not equal.
144  * \retval CMP_MATCH  The objects are equal.
145  */
146 static int event_session_compare(void *obj, void *arg, int flags)
147 {
148         const struct event_session *object_left = obj;
149         const struct event_session *object_right = arg;
150         const char *right_key = arg;
151         int cmp = 0;
152
153         switch (flags & OBJ_SEARCH_MASK) {
154         case OBJ_SEARCH_OBJECT:
155                 right_key = object_right->session_id;
156                 /* Fall through */
157         case OBJ_SEARCH_KEY:
158                 cmp = strcmp(object_left->session_id, right_key);
159                 break;
160         case OBJ_SEARCH_PARTIAL_KEY:
161                 cmp = strncmp(object_left->session_id, right_key, strlen(right_key));
162                 break;
163         default:
164                 break;
165         }
166
167         return cmp ? 0 : CMP_MATCH;
168 }
169
170 /*!
171  * \brief AO2 hash function for \ref event_session objects.
172  *
173  * \details Computes hash value for the given \ref event_session, with respect to the
174  *          provided search flags.
175  *
176  * \internal
177  *
178  * \param obj    Void pointer to the \ref event_session object.
179  * \param flags  The \ref search_flags to use when creating the hash key.
180  *
181  * \retval > 0  on success
182  * \retval   0  on failure
183  */
184 static int event_session_hash(const void *obj, const int flags)
185 {
186         const struct event_session *session;
187         const char *key;
188
189         switch (flags & OBJ_SEARCH_MASK) {
190         case OBJ_SEARCH_KEY:
191                 key = obj;
192                 break;
193         case OBJ_SEARCH_OBJECT:
194                 session = obj;
195                 key = session->session_id;
196                 break;
197         default:
198                 /* Hash can only work on something with a full key. */
199                 ast_assert(0);
200                 return 0;
201         }
202         return ast_str_hash(key);
203 }
204
205 /*!
206  * \brief Explicitly shutdown a session.
207  *
208  * \details An explicit shutdown is necessary, since the \ref stasis_app has a reference
209  *          to this session. We also need to be sure to null out the \c ws_session field,
210  *          since the websocket is about to go away.
211  *
212  * \internal
213  *
214  * \param session  Event session object (\ref event_session).
215  */
216 static void event_session_shutdown(struct event_session *session)
217 {
218         struct ao2_iterator i;
219         char *app;
220         int j;
221         SCOPED_AO2LOCK(lock, session);
222
223         /* Clean up the websocket_apps container */
224         if (session->websocket_apps) {
225                 i = ao2_iterator_init(session->websocket_apps, 0);
226                 while ((app = ao2_iterator_next(&i))) {
227                         stasis_app_unregister(app);
228                         ao2_cleanup(app);
229                 }
230                 ao2_iterator_destroy(&i);
231                 ao2_cleanup(session->websocket_apps);
232                 session->websocket_apps = NULL;
233         }
234
235         /* Clean up the message_queue container */
236         for (j = 0; j < AST_VECTOR_SIZE(&session->message_queue); j++) {
237                 struct ast_json *msg = AST_VECTOR_GET(&session->message_queue, j);
238                 ast_json_unref(msg);
239         }
240         AST_VECTOR_FREE(&session->message_queue);
241
242         /* Remove the handle to the underlying websocket session */
243         session->ws_session = NULL;
244 }
245
246 /*!
247  * \brief Updates the websocket session for an \ref event_session.
248  *
249  * \details The websocket for the given \ref event_session will be updated to the value
250  *          of the \c ws_session argument.
251  *
252  *          If the value of the \c ws_session is not \c NULL and there are messages in the
253  *          event session's \c message_queue, the messages are dispatched and removed from
254  *          the queue.
255  *
256  * \internal
257  *
258  * \param session     The event session object to update (\ref event_session).
259  * \param ws_session  Handle to the underlying websocket session
260  *                    (\ref ast_ari_websocket_session).
261  */
262 static void event_session_update_websocket(
263                 struct event_session *session, struct ast_ari_websocket_session *ws_session)
264 {
265         int i;
266
267         ast_assert(session != NULL);
268
269         ao2_lock(session);
270
271         session->ws_session = ws_session;
272
273         for (i = 0; i < AST_VECTOR_SIZE(&session->message_queue); i++) {
274                 struct ast_json *msg = AST_VECTOR_GET(&session->message_queue, i);
275                 ast_ari_websocket_session_write(session->ws_session, msg);
276                 ast_json_unref(msg);
277         }
278
279         AST_VECTOR_RESET(&session->message_queue, AST_VECTOR_ELEM_CLEANUP_NOOP);
280         ao2_unlock(session);
281 }
282
283 /*!
284  * \brief Processes cleanup actions for a \ref event_session object.
285  *
286  * \internal
287  *
288  * \param session  The event session object to cleanup (\ref event_session).
289  */
290 static void event_session_cleanup(struct event_session *session)
291 {
292         if (!session) {
293                 return;
294         }
295
296         event_session_shutdown(session);
297         if (event_session_registry) {
298                 ao2_unlink(event_session_registry, session);
299         }
300 }
301
302 /*!
303  * \brief Event session object destructor (\ref event_session).
304  *
305  * \internal
306  *
307  * \param obj  Void pointer to the \ref event_session object.
308  */
309 static void event_session_dtor(void *obj)
310 {
311 #ifdef AST_DEVMODE /* Avoid unused variable warning */
312         struct event_session *session = obj;
313
314 #endif
315
316         /* event_session_shutdown should have been called before now */
317         ast_assert(session->ws_session == NULL);
318         ast_assert(session->websocket_apps == NULL);
319         ast_assert(AST_VECTOR_SIZE(&session->message_queue) == 0);
320 }
321
322 /*!
323  * \brief Handles \ref event_session error processing.
324  *
325  * \internal
326  *
327  * \param session  The \ref event_session object.
328  * \param error    The \ref event_session_error_type to handle.
329  * \param ser      HTTP TCP/TLS Server Session (\ref ast_tcptls_session_instance).
330  *
331  * \retval  -1  Always returns -1.
332  */
333 static int event_session_allocation_error_handler(
334                 struct event_session *session, enum event_session_error_type error,
335                 struct ast_tcptls_session_instance *ser)
336 {
337         /* Notify the client */
338         switch (error) {
339         case ERROR_TYPE_STASIS_REGISTRATION:
340                 ast_http_error(ser, 500, "Internal Server Error",
341                         "Stasis registration failed");
342                 break;
343
344         case ERROR_TYPE_OOM:
345                 ast_http_error(ser, 500, "Internal Server Error",
346                         "Allocation failed");
347                 break;
348
349         case ERROR_TYPE_MISSING_APP_PARAM:
350                 ast_http_error(ser, 400, "Bad Request",
351                         "HTTP request is missing param: [app]");
352                 break;
353
354         case ERROR_TYPE_INVALID_APP_PARAM:
355                 ast_http_error(ser, 400, "Bad Request",
356                         "Invalid application provided in param [app].");
357                 break;
358
359         default:
360                 break;
361         }
362
363         /* Cleanup the session */
364         event_session_cleanup(session);
365         return -1;
366 }
367
368 /*!
369  * \brief Creates an \ref event_session object and registers its apps with Stasis.
370  *
371  * \internal
372  *
373  * \param ser         HTTP TCP/TLS Server Session (\ref ast_tcptls_session_instance).
374  * \param args        The Stasis [app] parameters as parsed from the HTTP request
375  *                    (\ref ast_ari_events_event_websocket_args).
376  * \param session_id  The id for the websocket session that will be created for this
377  *                    event session.
378  *
379  * \retval  0  on success
380  * \retval -1  on failure
381  */
382 static int event_session_alloc(struct ast_tcptls_session_instance *ser,
383                 struct ast_ari_events_event_websocket_args *args, const char *session_id)
384 {
385         RAII_VAR(struct event_session *, session, NULL, ao2_cleanup);
386         int (* register_handler)(const char *, stasis_app_cb handler, void *data);
387         size_t size, i;
388
389         /* The request must have at least one [app] parameter */
390         if (args->app_count == 0) {
391                 return event_session_allocation_error_handler(
392                         session, ERROR_TYPE_MISSING_APP_PARAM, ser);
393         }
394
395         size = sizeof(*session) + strlen(session_id) + 1;
396
397         /* Instantiate the event session */
398         session = ao2_alloc(size, event_session_dtor);
399         if (!session) {
400                 return event_session_allocation_error_handler(session, ERROR_TYPE_OOM, ser);
401         }
402
403         strncpy(session->session_id, session_id, size - sizeof(*session));
404
405         /* Instantiate the hash table for Stasis apps */
406         session->websocket_apps =
407                 ast_str_container_alloc(APPS_NUM_BUCKETS);
408
409         if (!session->websocket_apps) {
410                 return event_session_allocation_error_handler(session, ERROR_TYPE_OOM, ser);
411         }
412
413         /* Instantiate the message queue */
414         if (AST_VECTOR_INIT(&session->message_queue, MESSAGES_INIT_SIZE)) {
415                 return event_session_allocation_error_handler(session, ERROR_TYPE_OOM, ser);
416         }
417
418         /* Register the apps with Stasis */
419         if (args->subscribe_all) {
420                 register_handler = &stasis_app_register_all;
421         } else {
422                 register_handler = &stasis_app_register;
423         }
424
425         for (i = 0; i < args->app_count; ++i) {
426                 const char *app = args->app[i];
427
428                 if (ast_strlen_zero(app)) {
429                         return event_session_allocation_error_handler(
430                                 session, ERROR_TYPE_INVALID_APP_PARAM, ser);
431                 }
432
433                 if (ast_str_container_add(session->websocket_apps, app)) {
434                         return event_session_allocation_error_handler(session, ERROR_TYPE_OOM, ser);
435                 }
436
437                 if (register_handler(app, stasis_app_message_handler, session)) {
438                         ast_log(LOG_WARNING, "Stasis registration failed for application: '%s'\n", app);
439                         return event_session_allocation_error_handler(
440                                 session, ERROR_TYPE_STASIS_REGISTRATION, ser);
441                 }
442         }
443
444         /* Add the event session to the local registry */
445         if (!ao2_link(event_session_registry, session)) {
446                 return event_session_allocation_error_handler(session, ERROR_TYPE_OOM, ser);
447         }
448
449         return 0;
450 }
451
452 static int event_session_shutdown_cb(void *session, void *arg, int flags)
453 {
454         event_session_cleanup(session);
455
456         return 0;
457 }
458
459 void ast_ari_websocket_events_event_websocket_dtor(void)
460 {
461         ao2_callback(event_session_registry, OBJ_MULTIPLE | OBJ_NODATA, event_session_shutdown_cb, NULL);
462
463         ao2_cleanup(event_session_registry);
464         event_session_registry = NULL;
465 }
466
467 int ast_ari_websocket_events_event_websocket_init(void)
468 {
469         /* Try to instantiate the registry */
470         event_session_registry = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0,
471                 EVENT_SESSION_NUM_BUCKETS, event_session_hash, NULL, event_session_compare);
472         if (!event_session_registry) {
473                 /* This is bad, bad. */
474                 ast_log(LOG_WARNING,
475                             "Failed to allocate the local registry for websocket applications\n");
476                 return -1;
477         }
478
479         return 0;
480 }
481
482 int ast_ari_websocket_events_event_websocket_attempted(
483                 struct ast_tcptls_session_instance *ser, struct ast_variable *headers,
484                 struct ast_ari_events_event_websocket_args *args, const char *session_id)
485 {
486         ast_debug(3, "/events WebSocket attempted\n");
487
488         /* Create the event session */
489         return event_session_alloc(ser, args, session_id);
490 }
491
492 void ast_ari_websocket_events_event_websocket_established(
493                 struct ast_ari_websocket_session *ws_session, struct ast_variable *headers,
494                 struct ast_ari_events_event_websocket_args *args)
495 {
496         struct event_session *session;
497
498         struct ast_json *msg;
499         const char *session_id;
500
501         ast_debug(3, "/events WebSocket established\n");
502
503         ast_assert(ws_session != NULL);
504
505         session_id = ast_ari_websocket_session_id(ws_session);
506
507         /* Find the event_session and update its websocket  */
508         session = ao2_find(event_session_registry, session_id, OBJ_SEARCH_KEY);
509         if (session) {
510                 ao2_unlink(event_session_registry, session);
511                 event_session_update_websocket(session, ws_session);
512         } else {
513                 ast_log(LOG_WARNING,
514                         "Failed to locate an event session for the provided websocket session\n");
515         }
516
517         /* We don't process any input, but we'll consume it waiting for EOF */
518         while ((msg = ast_ari_websocket_session_read(ws_session))) {
519                 ast_json_unref(msg);
520         }
521
522         event_session_cleanup(session);
523         ao2_ref(session, -1);
524 }
525
526 void ast_ari_events_user_event(struct ast_variable *headers,
527         struct ast_ari_events_user_event_args *args,
528         struct ast_ari_response *response)
529 {
530         enum stasis_app_user_event_res res;
531         struct ast_json *json_variables = NULL;
532
533         if (args->variables) {
534                 ast_ari_events_user_event_parse_body(args->variables, args);
535                 json_variables = ast_json_object_get(args->variables, "variables");
536         }
537
538         if (ast_strlen_zero(args->application)) {
539                 ast_ari_response_error(response, 400, "Bad Request",
540                         "Missing parameter application");
541                 return;
542         }
543
544         res = stasis_app_user_event(args->application,
545                 args->event_name,
546                 args->source, args->source_count,
547                 json_variables);
548
549         switch (res) {
550         case STASIS_APP_USER_OK:
551                 ast_ari_response_no_content(response);
552                 break;
553
554         case STASIS_APP_USER_APP_NOT_FOUND:
555                 ast_ari_response_error(response, 404, "Not Found",
556                         "Application not found");
557                 break;
558
559         case STASIS_APP_USER_EVENT_SOURCE_NOT_FOUND:
560                 ast_ari_response_error(response, 422, "Unprocessable Entity",
561                         "Event source was not found");
562                 break;
563
564         case STASIS_APP_USER_EVENT_SOURCE_BAD_SCHEME:
565                 ast_ari_response_error(response, 400, "Bad Request",
566                         "Invalid event source URI scheme");
567                 break;
568
569         case STASIS_APP_USER_USEREVENT_INVALID:
570                 ast_ari_response_error(response, 400, "Bad Request",
571                         "Invalid userevnet data");
572                 break;
573
574         case STASIS_APP_USER_INTERNAL_ERROR:
575         default:
576                 ast_ari_response_error(response, 500, "Internal Server Error",
577                         "Error processing request");
578         }
579 }