2013-04-22 14:58:53 +00:00
|
|
|
/*
|
|
|
|
|
* Asterisk -- An open source telephony toolkit.
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2012 - 2013, Digium, Inc.
|
|
|
|
|
*
|
|
|
|
|
* David M. Lee, II <dlee@digium.com>
|
|
|
|
|
*
|
|
|
|
|
* See http://www.asterisk.org for more information about
|
|
|
|
|
* the Asterisk project. Please do not directly contact
|
|
|
|
|
* any of the maintainers of this project for assistance;
|
|
|
|
|
* the project provides a web site, mailing lists and IRC
|
|
|
|
|
* channels for your use.
|
|
|
|
|
*
|
|
|
|
|
* This program is free software, distributed under the terms of
|
|
|
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
|
|
|
* at the top of the source tree.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
|
* !!!!! DO NOT EDIT !!!!!
|
|
|
|
|
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
|
* This file is generated by a mustache template. Please see the original
|
2013-07-27 23:11:02 +00:00
|
|
|
* template in rest-api-templates/res_ari_resource.c.mustache
|
2013-04-22 14:58:53 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*! \file
|
|
|
|
|
*
|
|
|
|
|
* \brief WebSocket resource
|
|
|
|
|
*
|
|
|
|
|
* \author David M. Lee, II <dlee@digium.com>
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*** MODULEINFO
|
2013-07-27 23:11:02 +00:00
|
|
|
<depend type="module">res_ari</depend>
|
2015-04-29 11:46:44 +00:00
|
|
|
<depend type="module">res_ari_model</depend>
|
2013-05-10 17:12:57 +00:00
|
|
|
<depend type="module">res_stasis</depend>
|
2018-01-18 15:01:26 +00:00
|
|
|
<depend type="module">res_http_websocket</depend>
|
2013-04-22 14:58:53 +00:00
|
|
|
<support_level>core</support_level>
|
|
|
|
|
***/
|
|
|
|
|
|
|
|
|
|
#include "asterisk.h"
|
|
|
|
|
|
2013-08-02 14:36:32 +00:00
|
|
|
#include "asterisk/app.h"
|
2013-04-22 14:58:53 +00:00
|
|
|
#include "asterisk/module.h"
|
2013-05-10 17:12:57 +00:00
|
|
|
#include "asterisk/stasis_app.h"
|
2013-07-27 23:11:02 +00:00
|
|
|
#include "ari/resource_events.h"
|
Update events to use Swagger 1.3 subtyping, and related aftermath
This patch started with the simple idea of changing the /events data
model to be more sane. The original model would send out events like:
{ "stasis_start": { "args": [], "channel": { ... } } }
The event discriminator was the field name instead of being a value in
the object, due to limitations in how Swagger 1.1 could model objects.
While technically sufficient in communicating event information, it was
really difficult to deal with in terms of client side JSON handling.
This patch takes advantage of a proposed extension[1] to Swagger which
allows type variance through the use of a discriminator field. This had
a domino effect that made this a surprisingly large patch.
[1]: https://groups.google.com/d/msg/wordnik-api/EC3rGajE0os/ey_5dBI_jWcJ
In changing the models, I also had to change the swagger_model.py
processor so it can handle the type discriminator and subtyping. I took
that a big step forward, and using that information to generate an
ari_model module, which can validate a JSON object against the Swagger
model.
The REST and WebSocket generators were changed to take advantage of the
validators. If compiled with AST_DEVMODE enabled, JSON objects that
don't match their corresponding models will not be sent out. For REST
API calls, a 500 Internal Server response is sent. For WebSockets, the
invalid JSON message is replaced with an error message.
Since this took over about half of the job of the existing JSON
generators, and the .to_json virtual function on messages took over the
other half, I reluctantly removed the generators.
The validators turned up all sorts of errors and inconsistencies in our
data models, and the code. These were cleaned up, with checks in the
code generator avoid some of the consistency problems in the future.
* The model for a channel snapshot was trimmed down to match the
information sent via AMI. Many of the field being sent were not
useful in the general case.
* The model for a bridge snapshot was updated to be more consistent
with the other ARI models.
Another impact of introducing subtyping was that the swagger-codegen
documentation generator was insufficient (at least until it catches up
with Swagger 1.2). I wanted it to be easier to generate docs for the API
anyways, so I ported the wiki pages to use the Asterisk Swagger
generator. In the process, I was able to clean up many of the model
links, which would occasionally give inconsistent results on the wiki. I
also added error responses to the wiki docs, making the wiki
documentation more complete.
Finally, since Stasis-HTTP will now be named Asterisk REST Interface
(ARI), any new functions and files I created carry the ari_ prefix. I
changed a few stasis_http references to ari where it was non-intrusive
and made sense.
(closes issue ASTERISK-21885)
Review: https://reviewboard.asterisk.org/r/2639/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@393529 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2013-07-03 16:32:41 +00:00
|
|
|
#if defined(AST_DEVMODE)
|
2013-07-27 23:11:02 +00:00
|
|
|
#include "ari/ari_model_validators.h"
|
Update events to use Swagger 1.3 subtyping, and related aftermath
This patch started with the simple idea of changing the /events data
model to be more sane. The original model would send out events like:
{ "stasis_start": { "args": [], "channel": { ... } } }
The event discriminator was the field name instead of being a value in
the object, due to limitations in how Swagger 1.1 could model objects.
While technically sufficient in communicating event information, it was
really difficult to deal with in terms of client side JSON handling.
This patch takes advantage of a proposed extension[1] to Swagger which
allows type variance through the use of a discriminator field. This had
a domino effect that made this a surprisingly large patch.
[1]: https://groups.google.com/d/msg/wordnik-api/EC3rGajE0os/ey_5dBI_jWcJ
In changing the models, I also had to change the swagger_model.py
processor so it can handle the type discriminator and subtyping. I took
that a big step forward, and using that information to generate an
ari_model module, which can validate a JSON object against the Swagger
model.
The REST and WebSocket generators were changed to take advantage of the
validators. If compiled with AST_DEVMODE enabled, JSON objects that
don't match their corresponding models will not be sent out. For REST
API calls, a 500 Internal Server response is sent. For WebSockets, the
invalid JSON message is replaced with an error message.
Since this took over about half of the job of the existing JSON
generators, and the .to_json virtual function on messages took over the
other half, I reluctantly removed the generators.
The validators turned up all sorts of errors and inconsistencies in our
data models, and the code. These were cleaned up, with checks in the
code generator avoid some of the consistency problems in the future.
* The model for a channel snapshot was trimmed down to match the
information sent via AMI. Many of the field being sent were not
useful in the general case.
* The model for a bridge snapshot was updated to be more consistent
with the other ARI models.
Another impact of introducing subtyping was that the swagger-codegen
documentation generator was insufficient (at least until it catches up
with Swagger 1.2). I wanted it to be easier to generate docs for the API
anyways, so I ported the wiki pages to use the Asterisk Swagger
generator. In the process, I was able to clean up many of the model
links, which would occasionally give inconsistent results on the wiki. I
also added error responses to the wiki docs, making the wiki
documentation more complete.
Finally, since Stasis-HTTP will now be named Asterisk REST Interface
(ARI), any new functions and files I created carry the ari_ prefix. I
changed a few stasis_http references to ari where it was non-intrusive
and made sense.
(closes issue ASTERISK-21885)
Review: https://reviewboard.asterisk.org/r/2639/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@393529 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2013-07-03 16:32:41 +00:00
|
|
|
#endif
|
optional_api: Fix linking problems between modules that export global symbols
With the new work in Asterisk 12, there are some uses of the
optional_api that are prone to failure. The details are rather involved,
and captured on [the wiki][1].
This patch addresses the issue by removing almost all of the magic from
the optional API implementation. Instead of relying on weak symbol
resolution, a new optional_api.c module was added to Asterisk core.
For modules providing an optional API, the pointer to the implementation
function is registered with the core. For modules that use an optional
API, a pointer to a stub function, along with a optional_ref function
pointer are registered with the core. The optional_ref function pointers
is set to the implementation function when it's provided, or the stub
function when it's now.
Since the implementation no longer relies on magic, it is now supported
on all platforms. In the spirit of choice, an OPTIONAL_API flag was
added, so we can disable the optional_api if needed (maybe it's buggy on
some bizarre platform I haven't tested on)
The AST_OPTIONAL_API*() macros themselves remained unchanged, so
existing code could remain unchanged. But to help with debugging the
optional_api, the patch limits the #include of optional API's to just
the modules using the API. This also reduces resource waste maintaining
optional_ref pointers that aren't used.
Other changes made as a part of this patch:
* The stubs for http_websocket that wrap system calls set errno to
ENOSYS.
* res_http_websocket now properly increments module use count.
* In loader.c, the while() wrappers around dlclose() were removed. The
while(!dlclose()) is actually an anti-pattern, which can lead to
infinite loops if the module you're attempting to unload exports a
symbol that was directly linked to.
* The special handling of nonoptreq on systems without weak symbol
support was removed, since we no longer rely on weak symbols for
optional_api.
[1]: https://wiki.asterisk.org/wiki/x/wACUAQ
(closes issue ASTERISK-22296)
Reported by: Matt Jordan
Review: https://reviewboard.asterisk.org/r/2797/
........
Merged revisions 397989 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@397990 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2013-08-30 13:40:27 +00:00
|
|
|
#include "asterisk/http_websocket.h"
|
2013-04-22 14:58:53 +00:00
|
|
|
|
2013-08-02 14:36:32 +00:00
|
|
|
#define MAX_VALS 128
|
|
|
|
|
|
2015-07-31 16:27:23 +00:00
|
|
|
static int ast_ari_events_event_websocket_ws_attempted_cb(struct ast_tcptls_session_instance *ser,
|
|
|
|
|
struct ast_variable *get_params, struct ast_variable *headers, const char *session_id)
|
2015-05-18 01:36:41 +00:00
|
|
|
{
|
|
|
|
|
struct ast_ari_events_event_websocket_args args = {};
|
|
|
|
|
int res = 0;
|
|
|
|
|
RAII_VAR(struct ast_ari_response *, response, NULL, ast_free);
|
|
|
|
|
struct ast_variable *i;
|
|
|
|
|
|
|
|
|
|
response = ast_calloc(1, sizeof(*response));
|
|
|
|
|
if (!response) {
|
|
|
|
|
ast_log(LOG_ERROR, "Failed to create response.\n");
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for (i = get_params; i; i = i->next) {
|
|
|
|
|
if (strcmp(i->name, "app") == 0) {
|
|
|
|
|
/* Parse comma separated list */
|
|
|
|
|
char *vals[MAX_VALS];
|
|
|
|
|
size_t j;
|
|
|
|
|
|
|
|
|
|
args.app_parse = ast_strdup(i->value);
|
|
|
|
|
if (!args.app_parse) {
|
|
|
|
|
ast_ari_response_alloc_failed(response);
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (strlen(args.app_parse) == 0) {
|
|
|
|
|
/* ast_app_separate_args can't handle "" */
|
|
|
|
|
args.app_count = 1;
|
|
|
|
|
vals[0] = args.app_parse;
|
|
|
|
|
} else {
|
|
|
|
|
args.app_count = ast_app_separate_args(
|
|
|
|
|
args.app_parse, ',', vals,
|
|
|
|
|
ARRAY_LEN(vals));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (args.app_count == 0) {
|
|
|
|
|
ast_ari_response_alloc_failed(response);
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (args.app_count >= MAX_VALS) {
|
|
|
|
|
ast_ari_response_error(response, 400,
|
|
|
|
|
"Bad Request",
|
|
|
|
|
"Too many values for app");
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
args.app = ast_malloc(sizeof(*args.app) * args.app_count);
|
|
|
|
|
if (!args.app) {
|
|
|
|
|
ast_ari_response_alloc_failed(response);
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for (j = 0; j < args.app_count; ++j) {
|
|
|
|
|
args.app[j] = (vals[j]);
|
|
|
|
|
}
|
|
|
|
|
} else
|
2015-09-04 17:25:07 +00:00
|
|
|
if (strcmp(i->name, "subscribeAll") == 0) {
|
|
|
|
|
args.subscribe_all = ast_true(i->value);
|
|
|
|
|
} else
|
2015-05-18 01:36:41 +00:00
|
|
|
{}
|
|
|
|
|
}
|
|
|
|
|
|
2015-07-31 16:27:23 +00:00
|
|
|
res = ast_ari_websocket_events_event_websocket_attempted(ser, headers, &args, session_id);
|
2015-05-18 01:36:41 +00:00
|
|
|
|
|
|
|
|
fin: __attribute__((unused))
|
|
|
|
|
if (!response) {
|
|
|
|
|
ast_http_error(ser, 500, "Server Error", "Memory allocation error");
|
|
|
|
|
res = -1;
|
|
|
|
|
} else if (response->response_code != 0) {
|
|
|
|
|
/* Param parsing failure */
|
|
|
|
|
RAII_VAR(char *, msg, NULL, ast_json_free);
|
|
|
|
|
if (response->message) {
|
|
|
|
|
msg = ast_json_dump_string(response->message);
|
|
|
|
|
} else {
|
|
|
|
|
ast_log(LOG_ERROR, "Missing response message\n");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (msg) {
|
|
|
|
|
ast_http_error(ser, response->response_code, response->response_text, msg);
|
|
|
|
|
}
|
|
|
|
|
res = -1;
|
|
|
|
|
}
|
|
|
|
|
ast_free(args.app_parse);
|
|
|
|
|
ast_free(args.app);
|
|
|
|
|
return res;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static void ast_ari_events_event_websocket_ws_established_cb(struct ast_websocket *ws_session,
|
2013-07-03 16:32:00 +00:00
|
|
|
struct ast_variable *get_params, struct ast_variable *headers)
|
2013-04-22 14:58:53 +00:00
|
|
|
{
|
2013-11-07 21:10:31 +00:00
|
|
|
struct ast_ari_events_event_websocket_args args = {};
|
2013-08-02 14:36:32 +00:00
|
|
|
RAII_VAR(struct ast_ari_response *, response, NULL, ast_free);
|
2013-04-22 14:58:53 +00:00
|
|
|
struct ast_variable *i;
|
2013-08-02 14:36:32 +00:00
|
|
|
RAII_VAR(struct ast_websocket *, s, ws_session, ast_websocket_unref);
|
|
|
|
|
RAII_VAR(struct ast_ari_websocket_session *, session, NULL, ao2_cleanup);
|
2013-04-22 14:58:53 +00:00
|
|
|
|
2019-10-24 10:21:31 +00:00
|
|
|
SCOPED_MODULE_USE(ast_module_info->self);
|
|
|
|
|
|
2013-08-02 14:36:32 +00:00
|
|
|
response = ast_calloc(1, sizeof(*response));
|
|
|
|
|
if (!response) {
|
|
|
|
|
ast_log(LOG_ERROR, "Failed to create response.\n");
|
|
|
|
|
goto fin;
|
2013-04-22 14:58:53 +00:00
|
|
|
}
|
2013-08-02 14:36:32 +00:00
|
|
|
|
Update events to use Swagger 1.3 subtyping, and related aftermath
This patch started with the simple idea of changing the /events data
model to be more sane. The original model would send out events like:
{ "stasis_start": { "args": [], "channel": { ... } } }
The event discriminator was the field name instead of being a value in
the object, due to limitations in how Swagger 1.1 could model objects.
While technically sufficient in communicating event information, it was
really difficult to deal with in terms of client side JSON handling.
This patch takes advantage of a proposed extension[1] to Swagger which
allows type variance through the use of a discriminator field. This had
a domino effect that made this a surprisingly large patch.
[1]: https://groups.google.com/d/msg/wordnik-api/EC3rGajE0os/ey_5dBI_jWcJ
In changing the models, I also had to change the swagger_model.py
processor so it can handle the type discriminator and subtyping. I took
that a big step forward, and using that information to generate an
ari_model module, which can validate a JSON object against the Swagger
model.
The REST and WebSocket generators were changed to take advantage of the
validators. If compiled with AST_DEVMODE enabled, JSON objects that
don't match their corresponding models will not be sent out. For REST
API calls, a 500 Internal Server response is sent. For WebSockets, the
invalid JSON message is replaced with an error message.
Since this took over about half of the job of the existing JSON
generators, and the .to_json virtual function on messages took over the
other half, I reluctantly removed the generators.
The validators turned up all sorts of errors and inconsistencies in our
data models, and the code. These were cleaned up, with checks in the
code generator avoid some of the consistency problems in the future.
* The model for a channel snapshot was trimmed down to match the
information sent via AMI. Many of the field being sent were not
useful in the general case.
* The model for a bridge snapshot was updated to be more consistent
with the other ARI models.
Another impact of introducing subtyping was that the swagger-codegen
documentation generator was insufficient (at least until it catches up
with Swagger 1.2). I wanted it to be easier to generate docs for the API
anyways, so I ported the wiki pages to use the Asterisk Swagger
generator. In the process, I was able to clean up many of the model
links, which would occasionally give inconsistent results on the wiki. I
also added error responses to the wiki docs, making the wiki
documentation more complete.
Finally, since Stasis-HTTP will now be named Asterisk REST Interface
(ARI), any new functions and files I created carry the ari_ prefix. I
changed a few stasis_http references to ari where it was non-intrusive
and made sense.
(closes issue ASTERISK-21885)
Review: https://reviewboard.asterisk.org/r/2639/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@393529 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2013-07-03 16:32:41 +00:00
|
|
|
#if defined(AST_DEVMODE)
|
2013-07-27 23:11:02 +00:00
|
|
|
session = ast_ari_websocket_session_create(ws_session,
|
|
|
|
|
ast_ari_validate_message_fn());
|
Update events to use Swagger 1.3 subtyping, and related aftermath
This patch started with the simple idea of changing the /events data
model to be more sane. The original model would send out events like:
{ "stasis_start": { "args": [], "channel": { ... } } }
The event discriminator was the field name instead of being a value in
the object, due to limitations in how Swagger 1.1 could model objects.
While technically sufficient in communicating event information, it was
really difficult to deal with in terms of client side JSON handling.
This patch takes advantage of a proposed extension[1] to Swagger which
allows type variance through the use of a discriminator field. This had
a domino effect that made this a surprisingly large patch.
[1]: https://groups.google.com/d/msg/wordnik-api/EC3rGajE0os/ey_5dBI_jWcJ
In changing the models, I also had to change the swagger_model.py
processor so it can handle the type discriminator and subtyping. I took
that a big step forward, and using that information to generate an
ari_model module, which can validate a JSON object against the Swagger
model.
The REST and WebSocket generators were changed to take advantage of the
validators. If compiled with AST_DEVMODE enabled, JSON objects that
don't match their corresponding models will not be sent out. For REST
API calls, a 500 Internal Server response is sent. For WebSockets, the
invalid JSON message is replaced with an error message.
Since this took over about half of the job of the existing JSON
generators, and the .to_json virtual function on messages took over the
other half, I reluctantly removed the generators.
The validators turned up all sorts of errors and inconsistencies in our
data models, and the code. These were cleaned up, with checks in the
code generator avoid some of the consistency problems in the future.
* The model for a channel snapshot was trimmed down to match the
information sent via AMI. Many of the field being sent were not
useful in the general case.
* The model for a bridge snapshot was updated to be more consistent
with the other ARI models.
Another impact of introducing subtyping was that the swagger-codegen
documentation generator was insufficient (at least until it catches up
with Swagger 1.2). I wanted it to be easier to generate docs for the API
anyways, so I ported the wiki pages to use the Asterisk Swagger
generator. In the process, I was able to clean up many of the model
links, which would occasionally give inconsistent results on the wiki. I
also added error responses to the wiki docs, making the wiki
documentation more complete.
Finally, since Stasis-HTTP will now be named Asterisk REST Interface
(ARI), any new functions and files I created carry the ari_ prefix. I
changed a few stasis_http references to ari where it was non-intrusive
and made sense.
(closes issue ASTERISK-21885)
Review: https://reviewboard.asterisk.org/r/2639/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@393529 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2013-07-03 16:32:41 +00:00
|
|
|
#else
|
2013-07-27 23:11:02 +00:00
|
|
|
session = ast_ari_websocket_session_create(ws_session, NULL);
|
Update events to use Swagger 1.3 subtyping, and related aftermath
This patch started with the simple idea of changing the /events data
model to be more sane. The original model would send out events like:
{ "stasis_start": { "args": [], "channel": { ... } } }
The event discriminator was the field name instead of being a value in
the object, due to limitations in how Swagger 1.1 could model objects.
While technically sufficient in communicating event information, it was
really difficult to deal with in terms of client side JSON handling.
This patch takes advantage of a proposed extension[1] to Swagger which
allows type variance through the use of a discriminator field. This had
a domino effect that made this a surprisingly large patch.
[1]: https://groups.google.com/d/msg/wordnik-api/EC3rGajE0os/ey_5dBI_jWcJ
In changing the models, I also had to change the swagger_model.py
processor so it can handle the type discriminator and subtyping. I took
that a big step forward, and using that information to generate an
ari_model module, which can validate a JSON object against the Swagger
model.
The REST and WebSocket generators were changed to take advantage of the
validators. If compiled with AST_DEVMODE enabled, JSON objects that
don't match their corresponding models will not be sent out. For REST
API calls, a 500 Internal Server response is sent. For WebSockets, the
invalid JSON message is replaced with an error message.
Since this took over about half of the job of the existing JSON
generators, and the .to_json virtual function on messages took over the
other half, I reluctantly removed the generators.
The validators turned up all sorts of errors and inconsistencies in our
data models, and the code. These were cleaned up, with checks in the
code generator avoid some of the consistency problems in the future.
* The model for a channel snapshot was trimmed down to match the
information sent via AMI. Many of the field being sent were not
useful in the general case.
* The model for a bridge snapshot was updated to be more consistent
with the other ARI models.
Another impact of introducing subtyping was that the swagger-codegen
documentation generator was insufficient (at least until it catches up
with Swagger 1.2). I wanted it to be easier to generate docs for the API
anyways, so I ported the wiki pages to use the Asterisk Swagger
generator. In the process, I was able to clean up many of the model
links, which would occasionally give inconsistent results on the wiki. I
also added error responses to the wiki docs, making the wiki
documentation more complete.
Finally, since Stasis-HTTP will now be named Asterisk REST Interface
(ARI), any new functions and files I created carry the ari_ prefix. I
changed a few stasis_http references to ari where it was non-intrusive
and made sense.
(closes issue ASTERISK-21885)
Review: https://reviewboard.asterisk.org/r/2639/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@393529 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2013-07-03 16:32:41 +00:00
|
|
|
#endif
|
2013-07-03 16:32:00 +00:00
|
|
|
if (!session) {
|
|
|
|
|
ast_log(LOG_ERROR, "Failed to create ARI session\n");
|
2013-08-02 14:36:32 +00:00
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for (i = get_params; i; i = i->next) {
|
|
|
|
|
if (strcmp(i->name, "app") == 0) {
|
|
|
|
|
/* Parse comma separated list */
|
|
|
|
|
char *vals[MAX_VALS];
|
|
|
|
|
size_t j;
|
|
|
|
|
|
|
|
|
|
args.app_parse = ast_strdup(i->value);
|
|
|
|
|
if (!args.app_parse) {
|
|
|
|
|
ast_ari_response_alloc_failed(response);
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
ARI: WebSocket event cleanup
Stasis events (which get distributed over the ARI WebSocket) are created
by subscribing to the channel_all_cached and bridge_all_cached topics,
filtering out events for channels/bridges currently subscribed to.
There are two issues with that. First was a race condition, where
messages in-flight to the master subscribe-to-all-things topic would get
sent out, even though the events happened before the channel was put
into Stasis. Secondly, as the number of channels and bridges grow in the
system, the work spent filtering messages becomes excessive.
Since r395954, individual channels and bridges have caching topics, and
can be subscribed to individually. This patch takes advantage, so that
channels and bridges are subscribed to on demand, instead of filtering
the global topics.
The one case where filtering is still required is handling BridgeMerge
messages, which are published directly to the bridge_all topic.
Other than the change to how subscriptions work, this patch mostly just
moves code around. Most of the work generating JSON objects from
messages was moved to .to_json handlers on the message types. The
callback functions handling app subscriptions were moved from res_stasis
(b/c they were global to the model) to stasis/app.c (b/c they are local
to the app now).
(closes issue ASTERISK-21969)
Reported by: Matt Jordan
Review: https://reviewboard.asterisk.org/r/2754/
........
Merged revisions 397816 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@397820 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2013-08-27 19:19:36 +00:00
|
|
|
if (strlen(args.app_parse) == 0) {
|
|
|
|
|
/* ast_app_separate_args can't handle "" */
|
|
|
|
|
args.app_count = 1;
|
|
|
|
|
vals[0] = args.app_parse;
|
|
|
|
|
} else {
|
|
|
|
|
args.app_count = ast_app_separate_args(
|
|
|
|
|
args.app_parse, ',', vals,
|
|
|
|
|
ARRAY_LEN(vals));
|
|
|
|
|
}
|
|
|
|
|
|
2013-08-02 14:36:32 +00:00
|
|
|
if (args.app_count == 0) {
|
|
|
|
|
ast_ari_response_alloc_failed(response);
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (args.app_count >= MAX_VALS) {
|
|
|
|
|
ast_ari_response_error(response, 400,
|
|
|
|
|
"Bad Request",
|
|
|
|
|
"Too many values for app");
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
args.app = ast_malloc(sizeof(*args.app) * args.app_count);
|
|
|
|
|
if (!args.app) {
|
|
|
|
|
ast_ari_response_alloc_failed(response);
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for (j = 0; j < args.app_count; ++j) {
|
|
|
|
|
args.app[j] = (vals[j]);
|
|
|
|
|
}
|
|
|
|
|
} else
|
2015-09-04 17:25:07 +00:00
|
|
|
if (strcmp(i->name, "subscribeAll") == 0) {
|
|
|
|
|
args.subscribe_all = ast_true(i->value);
|
|
|
|
|
} else
|
2013-08-02 14:36:32 +00:00
|
|
|
{}
|
2013-07-03 16:32:00 +00:00
|
|
|
}
|
2013-08-02 14:36:32 +00:00
|
|
|
|
2015-05-18 01:36:41 +00:00
|
|
|
ast_ari_websocket_events_event_websocket_established(session, headers, &args);
|
2013-08-02 14:36:32 +00:00
|
|
|
|
|
|
|
|
fin: __attribute__((unused))
|
|
|
|
|
if (response && response->response_code != 0) {
|
|
|
|
|
/* Param parsing failure */
|
ARI: WebSocket event cleanup
Stasis events (which get distributed over the ARI WebSocket) are created
by subscribing to the channel_all_cached and bridge_all_cached topics,
filtering out events for channels/bridges currently subscribed to.
There are two issues with that. First was a race condition, where
messages in-flight to the master subscribe-to-all-things topic would get
sent out, even though the events happened before the channel was put
into Stasis. Secondly, as the number of channels and bridges grow in the
system, the work spent filtering messages becomes excessive.
Since r395954, individual channels and bridges have caching topics, and
can be subscribed to individually. This patch takes advantage, so that
channels and bridges are subscribed to on demand, instead of filtering
the global topics.
The one case where filtering is still required is handling BridgeMerge
messages, which are published directly to the bridge_all topic.
Other than the change to how subscriptions work, this patch mostly just
moves code around. Most of the work generating JSON objects from
messages was moved to .to_json handlers on the message types. The
callback functions handling app subscriptions were moved from res_stasis
(b/c they were global to the model) to stasis/app.c (b/c they are local
to the app now).
(closes issue ASTERISK-21969)
Reported by: Matt Jordan
Review: https://reviewboard.asterisk.org/r/2754/
........
Merged revisions 397816 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@397820 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2013-08-27 19:19:36 +00:00
|
|
|
RAII_VAR(char *, msg, NULL, ast_json_free);
|
2013-08-02 14:36:32 +00:00
|
|
|
if (response->message) {
|
|
|
|
|
msg = ast_json_dump_string(response->message);
|
|
|
|
|
} else {
|
ARI: WebSocket event cleanup
Stasis events (which get distributed over the ARI WebSocket) are created
by subscribing to the channel_all_cached and bridge_all_cached topics,
filtering out events for channels/bridges currently subscribed to.
There are two issues with that. First was a race condition, where
messages in-flight to the master subscribe-to-all-things topic would get
sent out, even though the events happened before the channel was put
into Stasis. Secondly, as the number of channels and bridges grow in the
system, the work spent filtering messages becomes excessive.
Since r395954, individual channels and bridges have caching topics, and
can be subscribed to individually. This patch takes advantage, so that
channels and bridges are subscribed to on demand, instead of filtering
the global topics.
The one case where filtering is still required is handling BridgeMerge
messages, which are published directly to the bridge_all topic.
Other than the change to how subscriptions work, this patch mostly just
moves code around. Most of the work generating JSON objects from
messages was moved to .to_json handlers on the message types. The
callback functions handling app subscriptions were moved from res_stasis
(b/c they were global to the model) to stasis/app.c (b/c they are local
to the app now).
(closes issue ASTERISK-21969)
Reported by: Matt Jordan
Review: https://reviewboard.asterisk.org/r/2754/
........
Merged revisions 397816 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@397820 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2013-08-27 19:19:36 +00:00
|
|
|
ast_log(LOG_ERROR, "Missing response message\n");
|
|
|
|
|
}
|
|
|
|
|
if (msg) {
|
|
|
|
|
ast_websocket_write(ws_session,
|
|
|
|
|
AST_WEBSOCKET_OPCODE_TEXT, msg, strlen(msg));
|
2013-08-02 14:36:32 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
ast_free(args.app_parse);
|
|
|
|
|
ast_free(args.app);
|
2013-04-22 14:58:53 +00:00
|
|
|
}
|
2014-05-22 16:09:51 +00:00
|
|
|
int ast_ari_events_user_event_parse_body(
|
|
|
|
|
struct ast_json *body,
|
|
|
|
|
struct ast_ari_events_user_event_args *args)
|
|
|
|
|
{
|
|
|
|
|
struct ast_json *field;
|
|
|
|
|
/* Parse query parameters out of it */
|
|
|
|
|
field = ast_json_object_get(body, "application");
|
|
|
|
|
if (field) {
|
|
|
|
|
args->application = ast_json_string_get(field);
|
|
|
|
|
}
|
|
|
|
|
field = ast_json_object_get(body, "source");
|
|
|
|
|
if (field) {
|
|
|
|
|
/* If they were silly enough to both pass in a query param and a
|
|
|
|
|
* JSON body, free up the query value.
|
|
|
|
|
*/
|
|
|
|
|
ast_free(args->source);
|
|
|
|
|
if (ast_json_typeof(field) == AST_JSON_ARRAY) {
|
|
|
|
|
/* Multiple param passed as array */
|
|
|
|
|
size_t i;
|
|
|
|
|
args->source_count = ast_json_array_size(field);
|
|
|
|
|
args->source = ast_malloc(sizeof(*args->source) * args->source_count);
|
|
|
|
|
|
|
|
|
|
if (!args->source) {
|
|
|
|
|
return -1;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for (i = 0; i < args->source_count; ++i) {
|
|
|
|
|
args->source[i] = ast_json_string_get(ast_json_array_get(field, i));
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
/* Multiple param passed as single value */
|
|
|
|
|
args->source_count = 1;
|
|
|
|
|
args->source = ast_malloc(sizeof(*args->source) * args->source_count);
|
|
|
|
|
if (!args->source) {
|
|
|
|
|
return -1;
|
|
|
|
|
}
|
|
|
|
|
args->source[0] = ast_json_string_get(field);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/*!
|
|
|
|
|
* \brief Parameter parsing callback for /events/user/{eventName}.
|
2021-11-17 12:18:32 +00:00
|
|
|
* \param ser TCP/TLS session object
|
2014-05-22 16:09:51 +00:00
|
|
|
* \param get_params GET parameters in the HTTP request.
|
|
|
|
|
* \param path_vars Path variables extracted from the request.
|
|
|
|
|
* \param headers HTTP headers.
|
2021-11-17 12:18:32 +00:00
|
|
|
* \param body
|
2014-05-22 16:09:51 +00:00
|
|
|
* \param[out] response Response to the HTTP request.
|
|
|
|
|
*/
|
|
|
|
|
static void ast_ari_events_user_event_cb(
|
|
|
|
|
struct ast_tcptls_session_instance *ser,
|
|
|
|
|
struct ast_variable *get_params, struct ast_variable *path_vars,
|
2017-01-19 15:05:36 +00:00
|
|
|
struct ast_variable *headers, struct ast_json *body, struct ast_ari_response *response)
|
2014-05-22 16:09:51 +00:00
|
|
|
{
|
|
|
|
|
struct ast_ari_events_user_event_args args = {};
|
|
|
|
|
struct ast_variable *i;
|
|
|
|
|
#if defined(AST_DEVMODE)
|
|
|
|
|
int is_valid;
|
|
|
|
|
int code;
|
|
|
|
|
#endif /* AST_DEVMODE */
|
|
|
|
|
|
|
|
|
|
for (i = get_params; i; i = i->next) {
|
|
|
|
|
if (strcmp(i->name, "application") == 0) {
|
|
|
|
|
args.application = (i->value);
|
|
|
|
|
} else
|
|
|
|
|
if (strcmp(i->name, "source") == 0) {
|
|
|
|
|
/* Parse comma separated list */
|
|
|
|
|
char *vals[MAX_VALS];
|
|
|
|
|
size_t j;
|
|
|
|
|
|
|
|
|
|
args.source_parse = ast_strdup(i->value);
|
|
|
|
|
if (!args.source_parse) {
|
|
|
|
|
ast_ari_response_alloc_failed(response);
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (strlen(args.source_parse) == 0) {
|
|
|
|
|
/* ast_app_separate_args can't handle "" */
|
|
|
|
|
args.source_count = 1;
|
|
|
|
|
vals[0] = args.source_parse;
|
|
|
|
|
} else {
|
|
|
|
|
args.source_count = ast_app_separate_args(
|
|
|
|
|
args.source_parse, ',', vals,
|
|
|
|
|
ARRAY_LEN(vals));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (args.source_count == 0) {
|
|
|
|
|
ast_ari_response_alloc_failed(response);
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (args.source_count >= MAX_VALS) {
|
|
|
|
|
ast_ari_response_error(response, 400,
|
|
|
|
|
"Bad Request",
|
|
|
|
|
"Too many values for source");
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
args.source = ast_malloc(sizeof(*args.source) * args.source_count);
|
|
|
|
|
if (!args.source) {
|
|
|
|
|
ast_ari_response_alloc_failed(response);
|
|
|
|
|
goto fin;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
for (j = 0; j < args.source_count; ++j) {
|
|
|
|
|
args.source[j] = (vals[j]);
|
|
|
|
|
}
|
|
|
|
|
} else
|
|
|
|
|
{}
|
|
|
|
|
}
|
|
|
|
|
for (i = path_vars; i; i = i->next) {
|
|
|
|
|
if (strcmp(i->name, "eventName") == 0) {
|
|
|
|
|
args.event_name = (i->value);
|
|
|
|
|
} else
|
|
|
|
|
{}
|
|
|
|
|
}
|
2015-01-23 15:21:56 +00:00
|
|
|
args.variables = body;
|
2014-05-22 16:09:51 +00:00
|
|
|
ast_ari_events_user_event(headers, &args, response);
|
|
|
|
|
#if defined(AST_DEVMODE)
|
|
|
|
|
code = response->response_code;
|
|
|
|
|
|
|
|
|
|
switch (code) {
|
|
|
|
|
case 0: /* Implementation is still a stub, or the code wasn't set */
|
|
|
|
|
is_valid = response->message == NULL;
|
|
|
|
|
break;
|
|
|
|
|
case 500: /* Internal Server Error */
|
|
|
|
|
case 501: /* Not Implemented */
|
|
|
|
|
case 404: /* Application does not exist. */
|
|
|
|
|
case 422: /* Event source not found. */
|
|
|
|
|
case 400: /* Invalid even tsource URI or userevent data. */
|
|
|
|
|
is_valid = 1;
|
|
|
|
|
break;
|
|
|
|
|
default:
|
|
|
|
|
if (200 <= code && code <= 299) {
|
|
|
|
|
is_valid = ast_ari_validate_void(
|
|
|
|
|
response->message);
|
|
|
|
|
} else {
|
|
|
|
|
ast_log(LOG_ERROR, "Invalid error response %d for /events/user/{eventName}\n", code);
|
|
|
|
|
is_valid = 0;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (!is_valid) {
|
|
|
|
|
ast_log(LOG_ERROR, "Response validation failed for /events/user/{eventName}\n");
|
|
|
|
|
ast_ari_response_error(response, 500,
|
|
|
|
|
"Internal Server Error", "Response validation failed");
|
|
|
|
|
}
|
|
|
|
|
#endif /* AST_DEVMODE */
|
|
|
|
|
|
|
|
|
|
fin: __attribute__((unused))
|
|
|
|
|
ast_free(args.source_parse);
|
|
|
|
|
ast_free(args.source);
|
|
|
|
|
return;
|
|
|
|
|
}
|
2013-04-22 14:58:53 +00:00
|
|
|
|
2016-08-18 22:02:24 +00:00
|
|
|
/*! \brief REST handler for /api-docs/events.json */
|
2014-05-22 16:09:51 +00:00
|
|
|
static struct stasis_rest_handlers events_user_eventName = {
|
|
|
|
|
.path_segment = "eventName",
|
|
|
|
|
.is_wildcard = 1,
|
2013-04-22 14:58:53 +00:00
|
|
|
.callbacks = {
|
2014-05-22 16:09:51 +00:00
|
|
|
[AST_HTTP_POST] = ast_ari_events_user_event_cb,
|
2013-04-22 14:58:53 +00:00
|
|
|
},
|
|
|
|
|
.num_children = 0,
|
|
|
|
|
.children = { }
|
|
|
|
|
};
|
2016-08-18 22:02:24 +00:00
|
|
|
/*! \brief REST handler for /api-docs/events.json */
|
2014-05-22 16:09:51 +00:00
|
|
|
static struct stasis_rest_handlers events_user = {
|
|
|
|
|
.path_segment = "user",
|
|
|
|
|
.callbacks = {
|
|
|
|
|
},
|
|
|
|
|
.num_children = 1,
|
|
|
|
|
.children = { &events_user_eventName, }
|
|
|
|
|
};
|
2016-08-18 22:02:24 +00:00
|
|
|
/*! \brief REST handler for /api-docs/events.json */
|
2014-05-22 16:09:51 +00:00
|
|
|
static struct stasis_rest_handlers events = {
|
|
|
|
|
.path_segment = "events",
|
|
|
|
|
.callbacks = {
|
|
|
|
|
},
|
|
|
|
|
.num_children = 1,
|
|
|
|
|
.children = { &events_user, }
|
|
|
|
|
};
|
2013-04-22 14:58:53 +00:00
|
|
|
|
2017-04-11 16:07:39 +00:00
|
|
|
static int unload_module(void)
|
|
|
|
|
{
|
|
|
|
|
ast_ari_remove_handler(&events);
|
|
|
|
|
ao2_cleanup(events.ws_server);
|
|
|
|
|
events.ws_server = NULL;
|
2017-04-12 12:47:59 +00:00
|
|
|
ast_ari_websocket_events_event_websocket_dtor();
|
2017-04-11 16:07:39 +00:00
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
|
2013-04-22 14:58:53 +00:00
|
|
|
static int load_module(void)
|
|
|
|
|
{
|
2013-07-03 16:32:00 +00:00
|
|
|
int res = 0;
|
2015-05-18 01:36:41 +00:00
|
|
|
|
2017-12-29 08:57:17 +00:00
|
|
|
struct ast_websocket_protocol *protocol;
|
2015-07-31 16:27:23 +00:00
|
|
|
|
2017-12-29 08:57:17 +00:00
|
|
|
if (ast_ari_websocket_events_event_websocket_init() == -1) {
|
|
|
|
|
return AST_MODULE_LOAD_DECLINE;
|
|
|
|
|
}
|
2017-06-13 16:33:34 +00:00
|
|
|
|
2017-12-29 08:57:17 +00:00
|
|
|
events.ws_server = ast_websocket_server_create();
|
|
|
|
|
if (!events.ws_server) {
|
|
|
|
|
ast_ari_websocket_events_event_websocket_dtor();
|
|
|
|
|
return AST_MODULE_LOAD_DECLINE;
|
|
|
|
|
}
|
2017-06-13 16:33:34 +00:00
|
|
|
|
2017-12-29 08:57:17 +00:00
|
|
|
protocol = ast_websocket_sub_protocol_alloc("ari");
|
|
|
|
|
if (!protocol) {
|
|
|
|
|
ao2_ref(events.ws_server, -1);
|
|
|
|
|
events.ws_server = NULL;
|
|
|
|
|
ast_ari_websocket_events_event_websocket_dtor();
|
|
|
|
|
return AST_MODULE_LOAD_DECLINE;
|
2015-05-18 01:36:41 +00:00
|
|
|
}
|
2017-12-29 08:57:17 +00:00
|
|
|
protocol->session_attempted = ast_ari_events_event_websocket_ws_attempted_cb;
|
|
|
|
|
protocol->session_established = ast_ari_events_event_websocket_ws_established_cb;
|
|
|
|
|
res |= ast_websocket_server_add_protocol2(events.ws_server, protocol);
|
2017-06-13 16:33:34 +00:00
|
|
|
|
2013-07-27 23:11:02 +00:00
|
|
|
res |= ast_ari_add_handler(&events);
|
2017-04-11 16:07:39 +00:00
|
|
|
if (res) {
|
|
|
|
|
unload_module();
|
|
|
|
|
return AST_MODULE_LOAD_DECLINE;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return AST_MODULE_LOAD_SUCCESS;
|
2013-04-22 14:58:53 +00:00
|
|
|
}
|
|
|
|
|
|
2013-06-24 21:40:52 +00:00
|
|
|
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - WebSocket resource",
|
2014-07-25 16:47:17 +00:00
|
|
|
.support_level = AST_MODULE_SUPPORT_CORE,
|
2013-04-22 14:58:53 +00:00
|
|
|
.load = load_module,
|
|
|
|
|
.unload = unload_module,
|
2018-01-18 15:01:26 +00:00
|
|
|
.requires = "res_ari,res_ari_model,res_stasis,res_http_websocket",
|
2015-05-06 00:49:04 +00:00
|
|
|
);
|
