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