2013-05-08 13:39:08 +00:00
|
|
|
/*
|
|
|
|
* Asterisk -- An open source telephony toolkit.
|
|
|
|
*
|
|
|
|
* Copyright (C) 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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*! \file
|
|
|
|
*
|
|
|
|
* \brief Stasis endpoint API.
|
|
|
|
*
|
|
|
|
* \author David M. Lee, II <dlee@digium.com>
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*** MODULEINFO
|
|
|
|
<support_level>core</support_level>
|
|
|
|
***/
|
|
|
|
|
|
|
|
#include "asterisk.h"
|
|
|
|
|
git migration: Refactor the ASTERISK_FILE_VERSION macro
Git does not support the ability to replace a token with a version
string during check-in. While it does have support for replacing a
token on clone, this is somewhat sub-optimal: the token is replaced
with the object hash, which is not particularly easy for human
consumption. What's more, in practice, the source file version was often
not terribly useful. Generally, when triaging bugs, the overall version
of Asterisk is far more useful than an individual SVN version of a file. As a
result, this patch removes Asterisk's support for showing source file
versions.
Specifically, it does the following:
* Rename ASTERISK_FILE_VERSION macro to ASTERISK_REGISTER_FILE, and
remove passing the version in with the macro. Other facilities
than 'core show file version' make use of the file names, such as
setting a debug level only on a specific file. As such, the act of
registering source files with the Asterisk core still has use. The
macro rename now reflects the new macro purpose.
* main/asterisk:
- Refactor the file_version structure to reflect that it no longer
tracks a version field.
- Remove the "core show file version" CLI command. Without the file
version, it is no longer useful.
- Remove the ast_file_version_find function. The file version is no
longer tracked.
- Rename ast_register_file_version/ast_unregister_file_version to
ast_register_file/ast_unregister_file, respectively.
* main/manager: Remove value from the Version key of the ModuleCheck
Action. The actual key itself has not been removed, as doing so would
absolutely constitute a backwards incompatible change. However, since
the file version is no longer tracked, there is no need to attempt to
include it in the Version key.
* UPGRADE: Add notes for:
- Modification to the ModuleCheck AMI Action
- Removal of the "core show file version" CLI command
Change-Id: I6cf0ff280e1668bf4957dc21f32a5ff43444a40e
2015-04-12 02:38:22 +00:00
|
|
|
ASTERISK_REGISTER_FILE()
|
2013-05-08 13:39:08 +00:00
|
|
|
|
|
|
|
#include "asterisk/astobj2.h"
|
|
|
|
#include "asterisk/stasis.h"
|
|
|
|
#include "asterisk/stasis_endpoints.h"
|
|
|
|
|
2013-06-22 12:40:16 +00:00
|
|
|
/*** DOCUMENTATION
|
|
|
|
<managerEvent language="en_US" name="PeerStatus">
|
|
|
|
<managerEventInstance class="EVENT_FLAG_SYSTEM">
|
|
|
|
<synopsis>Raised when the state of a peer changes.</synopsis>
|
|
|
|
<syntax>
|
|
|
|
<parameter name="ChannelType">
|
|
|
|
<para>The channel technology of the peer.</para>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="Peer">
|
|
|
|
<para>The name of the peer (including channel technology).</para>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="PeerStatus">
|
|
|
|
<para>New status of the peer.</para>
|
|
|
|
<enumlist>
|
|
|
|
<enum name="Unknown"/>
|
|
|
|
<enum name="Registered"/>
|
|
|
|
<enum name="Unregistered"/>
|
|
|
|
<enum name="Rejected"/>
|
|
|
|
<enum name="Lagged"/>
|
|
|
|
</enumlist>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="Cause">
|
|
|
|
<para>The reason the status has changed.</para>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="Address">
|
|
|
|
<para>New address of the peer.</para>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="Port">
|
|
|
|
<para>New port for the peer.</para>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="Time">
|
|
|
|
<para>Time it takes to reach the peer and receive a response.</para>
|
|
|
|
</parameter>
|
|
|
|
</syntax>
|
|
|
|
</managerEventInstance>
|
|
|
|
</managerEvent>
|
2015-05-21 22:21:01 +00:00
|
|
|
<managerEvent language="en_US" name="ContactStatus">
|
|
|
|
<managerEventInstance class="EVENT_FLAG_SYSTEM">
|
|
|
|
<synopsis>Raised when the state of a contact changes.</synopsis>
|
|
|
|
<syntax>
|
|
|
|
<parameter name="URI">
|
|
|
|
<para>This contact's URI.</para>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="ContactStatus">
|
|
|
|
<para>New status of the contact.</para>
|
|
|
|
<enumlist>
|
|
|
|
<enum name="Unknown"/>
|
|
|
|
<enum name="Unreachable"/>
|
|
|
|
<enum name="Reachable"/>
|
|
|
|
<enum name="Created"/>
|
|
|
|
<enum name="Removed"/>
|
2016-05-05 20:16:16 +00:00
|
|
|
<enum name="Updated"/>
|
2015-05-21 22:21:01 +00:00
|
|
|
</enumlist>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="AOR">
|
|
|
|
<para>The name of the associated aor.</para>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="EndpointName">
|
|
|
|
<para>The name of the associated endpoint.</para>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="RoundtripUsec">
|
|
|
|
<para>The RTT measured during the last qualify.</para>
|
|
|
|
</parameter>
|
2016-05-05 20:16:16 +00:00
|
|
|
<parameter name="UserAgent">
|
|
|
|
<para>Content of the User-Agent header in REGISTER request</para>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="RegExpire">
|
|
|
|
<para>Absolute time that this contact is no longer valid after</para>
|
|
|
|
</parameter>
|
2016-05-19 19:56:26 +00:00
|
|
|
<parameter name="ViaAddress">
|
|
|
|
<para>IP address:port of the last Via header in REGISTER request</para>
|
|
|
|
</parameter>
|
|
|
|
<parameter name="CallID">
|
|
|
|
<para>Content of the Call-ID header in REGISTER request</para>
|
|
|
|
</parameter>
|
2015-05-21 22:21:01 +00:00
|
|
|
</syntax>
|
|
|
|
</managerEventInstance>
|
|
|
|
</managerEvent>
|
2013-06-22 12:40:16 +00:00
|
|
|
***/
|
|
|
|
|
2013-08-01 13:49:34 +00:00
|
|
|
static struct stasis_cp_all *endpoint_cache_all;
|
|
|
|
|
|
|
|
struct stasis_cp_all *ast_endpoint_cache_all(void)
|
|
|
|
{
|
|
|
|
return endpoint_cache_all;
|
|
|
|
}
|
|
|
|
|
|
|
|
struct stasis_cache *ast_endpoint_cache(void)
|
|
|
|
{
|
|
|
|
return stasis_cp_all_cache(endpoint_cache_all);
|
|
|
|
}
|
|
|
|
|
|
|
|
struct stasis_topic *ast_endpoint_topic_all(void)
|
|
|
|
{
|
|
|
|
return stasis_cp_all_topic(endpoint_cache_all);
|
|
|
|
}
|
|
|
|
|
|
|
|
struct stasis_topic *ast_endpoint_topic_all_cached(void)
|
|
|
|
{
|
|
|
|
return stasis_cp_all_topic_cached(endpoint_cache_all);
|
|
|
|
}
|
|
|
|
|
2013-05-15 02:37:22 +00:00
|
|
|
STASIS_MESSAGE_TYPE_DEFN(ast_endpoint_snapshot_type);
|
2013-05-08 13:39:08 +00:00
|
|
|
|
2013-06-22 12:40:16 +00:00
|
|
|
static struct ast_manager_event_blob *peerstatus_to_ami(struct stasis_message *msg)
|
|
|
|
{
|
|
|
|
struct ast_endpoint_blob *obj = stasis_message_data(msg);
|
|
|
|
RAII_VAR(struct ast_str *, peerstatus_event_string, ast_str_create(64), ast_free);
|
|
|
|
const char *value;
|
|
|
|
|
|
|
|
/* peer_status is the only *required* thing */
|
|
|
|
if (!(value = ast_json_string_get(ast_json_object_get(obj->blob, "peer_status")))) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
ast_str_append(&peerstatus_event_string, 0, "PeerStatus: %s\r\n", value);
|
|
|
|
|
|
|
|
if ((value = ast_json_string_get(ast_json_object_get(obj->blob, "cause")))) {
|
|
|
|
ast_str_append(&peerstatus_event_string, 0, "Cause: %s\r\n", value);
|
|
|
|
}
|
|
|
|
if ((value = ast_json_string_get(ast_json_object_get(obj->blob, "address")))) {
|
|
|
|
ast_str_append(&peerstatus_event_string, 0, "Address: %s\r\n", value);
|
|
|
|
}
|
|
|
|
if ((value = ast_json_string_get(ast_json_object_get(obj->blob, "port")))) {
|
|
|
|
ast_str_append(&peerstatus_event_string, 0, "Port: %s\r\n", value);
|
|
|
|
}
|
|
|
|
if ((value = ast_json_string_get(ast_json_object_get(obj->blob, "time")))) {
|
|
|
|
ast_str_append(&peerstatus_event_string, 0, "Time: %s\r\n", value);
|
|
|
|
}
|
|
|
|
|
|
|
|
return ast_manager_event_blob_create(EVENT_FLAG_SYSTEM, "PeerStatus",
|
|
|
|
"ChannelType: %s\r\n"
|
|
|
|
"Peer: %s/%s\r\n"
|
|
|
|
"%s",
|
|
|
|
obj->snapshot->tech,
|
|
|
|
obj->snapshot->tech,
|
|
|
|
obj->snapshot->resource,
|
|
|
|
ast_str_buffer(peerstatus_event_string));
|
|
|
|
}
|
|
|
|
|
2015-09-04 02:19:21 +00:00
|
|
|
static struct ast_json *peerstatus_to_json(struct stasis_message *msg, const struct stasis_message_sanitizer *sanitize)
|
|
|
|
{
|
|
|
|
struct ast_endpoint_blob *obj = stasis_message_data(msg);
|
|
|
|
struct ast_json *json_endpoint;
|
|
|
|
struct ast_json *json_peer;
|
|
|
|
struct ast_json *json_final;
|
|
|
|
const struct timeval *tv = stasis_message_timestamp(msg);
|
2015-05-21 22:21:01 +00:00
|
|
|
|
2015-09-04 02:19:21 +00:00
|
|
|
json_endpoint = ast_endpoint_snapshot_to_json(obj->snapshot, NULL);
|
|
|
|
if (!json_endpoint) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
json_peer = ast_json_object_create();
|
|
|
|
if (!json_peer) {
|
|
|
|
ast_json_unref(json_endpoint);
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Copy all fields from the blob */
|
|
|
|
ast_json_object_update(json_peer, obj->blob);
|
|
|
|
|
|
|
|
json_final = ast_json_pack("{s: s, s: o, s: o, s: o }",
|
|
|
|
"type", "PeerStatusChange",
|
|
|
|
"timestamp", ast_json_timeval(*tv, NULL),
|
|
|
|
"endpoint", json_endpoint,
|
|
|
|
"peer", json_peer);
|
|
|
|
if (!json_final) {
|
|
|
|
ast_json_unref(json_endpoint);
|
|
|
|
ast_json_unref(json_peer);
|
|
|
|
}
|
|
|
|
|
|
|
|
return json_final;
|
|
|
|
}
|
|
|
|
|
|
|
|
STASIS_MESSAGE_TYPE_DEFN(ast_endpoint_state_type,
|
|
|
|
.to_ami = peerstatus_to_ami,
|
|
|
|
.to_json = peerstatus_to_json,
|
2015-05-21 22:21:01 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
static struct ast_manager_event_blob *contactstatus_to_ami(struct stasis_message *msg)
|
|
|
|
{
|
|
|
|
struct ast_endpoint_blob *obj = stasis_message_data(msg);
|
|
|
|
RAII_VAR(struct ast_str *, contactstatus_event_string, ast_str_create(64), ast_free);
|
|
|
|
const char *value;
|
|
|
|
|
|
|
|
if (!(value = ast_json_string_get(ast_json_object_get(obj->blob, "uri")))) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
ast_str_append(&contactstatus_event_string, 0, "URI: %s\r\n", value);
|
|
|
|
|
|
|
|
if (!(value = ast_json_string_get(ast_json_object_get(obj->blob, "contact_status")))) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
ast_str_append(&contactstatus_event_string, 0, "ContactStatus: %s\r\n", value);
|
|
|
|
|
|
|
|
if (!(value = ast_json_string_get(ast_json_object_get(obj->blob, "aor")))) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
ast_str_append(&contactstatus_event_string, 0, "AOR: %s\r\n", value);
|
|
|
|
|
|
|
|
if (!(value = ast_json_string_get(ast_json_object_get(obj->blob, "endpoint_name")))) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
ast_str_append(&contactstatus_event_string, 0, "EndpointName: %s\r\n", value);
|
|
|
|
|
|
|
|
if ((value = ast_json_string_get(ast_json_object_get(obj->blob, "roundtrip_usec")))) {
|
|
|
|
ast_str_append(&contactstatus_event_string, 0, "RoundtripUsec: %s\r\n", value);
|
|
|
|
}
|
|
|
|
|
|
|
|
return ast_manager_event_blob_create(EVENT_FLAG_SYSTEM, "ContactStatus",
|
|
|
|
"%s", ast_str_buffer(contactstatus_event_string));
|
|
|
|
}
|
|
|
|
|
2015-09-04 02:19:21 +00:00
|
|
|
static struct ast_json *contactstatus_to_json(struct stasis_message *msg, const struct stasis_message_sanitizer *sanitize)
|
|
|
|
{
|
|
|
|
struct ast_endpoint_blob *obj = stasis_message_data(msg);
|
|
|
|
struct ast_json *json_endpoint;
|
|
|
|
struct ast_json *json_final;
|
2016-07-08 16:46:04 +00:00
|
|
|
const char *rtt;
|
2015-09-04 02:19:21 +00:00
|
|
|
const struct timeval *tv = stasis_message_timestamp(msg);
|
|
|
|
|
|
|
|
json_endpoint = ast_endpoint_snapshot_to_json(obj->snapshot, NULL);
|
|
|
|
if (!json_endpoint) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2016-07-08 16:46:04 +00:00
|
|
|
/* The roundtrip time is optional. */
|
|
|
|
rtt = ast_json_string_get(ast_json_object_get(obj->blob, "roundtrip_usec"));
|
|
|
|
if (!ast_strlen_zero(rtt)) {
|
|
|
|
json_final = ast_json_pack("{s: s, s: o, s: o, s: { s: s, s: s, s: s, s: s } } ",
|
|
|
|
"type", "ContactStatusChange",
|
|
|
|
"timestamp", ast_json_timeval(*tv, NULL),
|
|
|
|
"endpoint", json_endpoint,
|
|
|
|
"contact_info",
|
|
|
|
"uri", ast_json_string_get(ast_json_object_get(obj->blob, "uri")),
|
|
|
|
"contact_status", ast_json_string_get(ast_json_object_get(obj->blob,
|
|
|
|
"contact_status")),
|
|
|
|
"aor", ast_json_string_get(ast_json_object_get(obj->blob, "aor")),
|
|
|
|
"roundtrip_usec", rtt);
|
|
|
|
} else {
|
|
|
|
json_final = ast_json_pack("{s: s, s: o, s: o, s: { s: s, s: s, s: s } } ",
|
|
|
|
"type", "ContactStatusChange",
|
|
|
|
"timestamp", ast_json_timeval(*tv, NULL),
|
|
|
|
"endpoint", json_endpoint,
|
|
|
|
"contact_info",
|
|
|
|
"uri", ast_json_string_get(ast_json_object_get(obj->blob, "uri")),
|
|
|
|
"contact_status", ast_json_string_get(ast_json_object_get(obj->blob,
|
|
|
|
"contact_status")),
|
|
|
|
"aor", ast_json_string_get(ast_json_object_get(obj->blob, "aor")));
|
|
|
|
}
|
2015-09-04 02:19:21 +00:00
|
|
|
if (!json_final) {
|
|
|
|
ast_json_unref(json_endpoint);
|
|
|
|
}
|
|
|
|
|
|
|
|
return json_final;
|
|
|
|
}
|
|
|
|
|
|
|
|
STASIS_MESSAGE_TYPE_DEFN(ast_endpoint_contact_state_type,
|
|
|
|
.to_ami = contactstatus_to_ami,
|
|
|
|
.to_json = contactstatus_to_json
|
|
|
|
);
|
|
|
|
|
2013-06-22 12:40:16 +00:00
|
|
|
static void endpoint_blob_dtor(void *obj)
|
|
|
|
{
|
|
|
|
struct ast_endpoint_blob *event = obj;
|
|
|
|
ao2_cleanup(event->snapshot);
|
|
|
|
ast_json_unref(event->blob);
|
|
|
|
}
|
|
|
|
|
|
|
|
struct stasis_message *ast_endpoint_blob_create(struct ast_endpoint *endpoint,
|
|
|
|
struct stasis_message_type *type, struct ast_json *blob)
|
|
|
|
{
|
|
|
|
RAII_VAR(struct ast_endpoint_blob *, obj, NULL, ao2_cleanup);
|
|
|
|
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
|
|
|
|
|
2014-08-06 12:55:28 +00:00
|
|
|
if (!type) {
|
|
|
|
return NULL;
|
|
|
|
}
|
2013-06-22 12:40:16 +00:00
|
|
|
if (!blob) {
|
|
|
|
blob = ast_json_null();
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!(obj = ao2_alloc(sizeof(*obj), endpoint_blob_dtor))) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (endpoint) {
|
|
|
|
if (!(obj->snapshot = ast_endpoint_snapshot_create(endpoint))) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
obj->blob = ast_json_ref(blob);
|
|
|
|
|
|
|
|
if (!(msg = stasis_message_create(type, obj))) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
ao2_ref(msg, +1);
|
|
|
|
return msg;
|
|
|
|
}
|
|
|
|
|
|
|
|
void ast_endpoint_blob_publish(struct ast_endpoint *endpoint, struct stasis_message_type *type,
|
|
|
|
struct ast_json *blob)
|
|
|
|
{
|
|
|
|
RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
|
|
|
|
if (blob) {
|
|
|
|
message = ast_endpoint_blob_create(endpoint, type, blob);
|
|
|
|
}
|
|
|
|
if (message) {
|
|
|
|
stasis_publish(ast_endpoint_topic(endpoint), message);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-05-08 13:39:08 +00:00
|
|
|
struct ast_endpoint_snapshot *ast_endpoint_latest_snapshot(const char *tech,
|
2013-10-02 22:22:17 +00:00
|
|
|
const char *name)
|
2013-05-08 13:39:08 +00:00
|
|
|
{
|
|
|
|
RAII_VAR(char *, id, NULL, ast_free);
|
|
|
|
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
|
|
|
|
struct ast_endpoint_snapshot *snapshot;
|
|
|
|
|
2014-05-22 16:09:51 +00:00
|
|
|
if (ast_strlen_zero(name)) {
|
|
|
|
ast_asprintf(&id, "%s", tech);
|
|
|
|
} else {
|
|
|
|
ast_asprintf(&id, "%s/%s", tech, name);
|
|
|
|
}
|
2013-05-08 13:39:08 +00:00
|
|
|
if (!id) {
|
|
|
|
return NULL;
|
|
|
|
}
|
2014-02-14 21:44:57 +00:00
|
|
|
ast_tech_to_upper(id);
|
2013-05-08 13:39:08 +00:00
|
|
|
|
2013-08-01 13:49:34 +00:00
|
|
|
msg = stasis_cache_get(ast_endpoint_cache(),
|
|
|
|
ast_endpoint_snapshot_type(), id);
|
2013-05-08 13:39:08 +00:00
|
|
|
if (!msg) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
snapshot = stasis_message_data(msg);
|
|
|
|
ast_assert(snapshot != NULL);
|
|
|
|
|
|
|
|
ao2_ref(snapshot, +1);
|
|
|
|
return snapshot;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* \brief Callback extract a unique identity from a snapshot message.
|
|
|
|
*
|
|
|
|
* This identity is unique to the underlying object of the snapshot, such as the
|
|
|
|
* UniqueId field of a channel.
|
|
|
|
*
|
|
|
|
* \param message Message to extract id from.
|
|
|
|
* \return String representing the snapshot's id.
|
|
|
|
* \return \c NULL if the message_type of the message isn't a handled snapshot.
|
|
|
|
* \since 12
|
|
|
|
*/
|
|
|
|
static const char *endpoint_snapshot_get_id(struct stasis_message *message)
|
|
|
|
{
|
|
|
|
struct ast_endpoint_snapshot *snapshot;
|
|
|
|
|
|
|
|
if (ast_endpoint_snapshot_type() != stasis_message_type(message)) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
snapshot = stasis_message_data(message);
|
|
|
|
|
|
|
|
return snapshot->id;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
struct ast_json *ast_endpoint_snapshot_to_json(
|
2013-11-22 20:10:46 +00:00
|
|
|
const struct ast_endpoint_snapshot *snapshot,
|
|
|
|
const struct stasis_message_sanitizer *sanitize)
|
2013-05-08 13:39:08 +00:00
|
|
|
{
|
|
|
|
RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
|
|
|
|
struct ast_json *channel_array;
|
|
|
|
int i;
|
|
|
|
|
|
|
|
json = ast_json_pack("{s: s, s: s, s: s, s: []}",
|
|
|
|
"technology", snapshot->tech,
|
|
|
|
"resource", snapshot->resource,
|
|
|
|
"state", ast_endpoint_state_to_string(snapshot->state),
|
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
|
|
|
"channel_ids");
|
2013-05-08 13:39:08 +00:00
|
|
|
|
|
|
|
if (json == NULL) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (snapshot->max_channels != -1) {
|
|
|
|
int res = ast_json_object_set(json, "max_channels",
|
|
|
|
ast_json_integer_create(snapshot->max_channels));
|
|
|
|
if (res != 0) {
|
|
|
|
return 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
|
|
|
channel_array = ast_json_object_get(json, "channel_ids");
|
2013-05-08 13:39:08 +00:00
|
|
|
ast_assert(channel_array != NULL);
|
|
|
|
for (i = 0; i < snapshot->num_channels; ++i) {
|
2013-11-22 20:10:46 +00:00
|
|
|
int res;
|
|
|
|
|
|
|
|
if (sanitize && sanitize->channel_id
|
|
|
|
&& sanitize->channel_id(snapshot->channel_ids[i])) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
res = ast_json_array_append(channel_array,
|
2013-08-21 16:09:09 +00:00
|
|
|
ast_json_string_create(snapshot->channel_ids[i]));
|
2013-05-08 13:39:08 +00:00
|
|
|
if (res != 0) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return ast_json_ref(json);
|
|
|
|
}
|
|
|
|
|
2013-08-01 13:49:34 +00:00
|
|
|
static void endpoints_stasis_cleanup(void)
|
2013-05-17 21:10:32 +00:00
|
|
|
{
|
2013-08-01 13:49:34 +00:00
|
|
|
STASIS_MESSAGE_TYPE_CLEANUP(ast_endpoint_snapshot_type);
|
|
|
|
STASIS_MESSAGE_TYPE_CLEANUP(ast_endpoint_state_type);
|
2015-05-21 22:21:01 +00:00
|
|
|
STASIS_MESSAGE_TYPE_CLEANUP(ast_endpoint_contact_state_type);
|
2013-05-17 21:10:32 +00:00
|
|
|
|
2013-08-01 13:49:34 +00:00
|
|
|
ao2_cleanup(endpoint_cache_all);
|
|
|
|
endpoint_cache_all = NULL;
|
2013-05-17 21:10:32 +00:00
|
|
|
}
|
|
|
|
|
2013-05-08 13:39:08 +00:00
|
|
|
int ast_endpoint_stasis_init(void)
|
|
|
|
{
|
2013-08-01 13:49:34 +00:00
|
|
|
int res = 0;
|
|
|
|
ast_register_cleanup(endpoints_stasis_cleanup);
|
2013-05-27 00:06:40 +00:00
|
|
|
|
2013-08-01 13:49:34 +00:00
|
|
|
endpoint_cache_all = stasis_cp_all_create("endpoint_topic_all",
|
|
|
|
endpoint_snapshot_get_id);
|
|
|
|
if (!endpoint_cache_all) {
|
2013-05-08 13:39:08 +00:00
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
2013-08-01 13:49:34 +00:00
|
|
|
res |= STASIS_MESSAGE_TYPE_INIT(ast_endpoint_snapshot_type);
|
|
|
|
res |= STASIS_MESSAGE_TYPE_INIT(ast_endpoint_state_type);
|
2015-05-21 22:21:01 +00:00
|
|
|
res |= STASIS_MESSAGE_TYPE_INIT(ast_endpoint_contact_state_type);
|
2013-06-22 12:40:16 +00:00
|
|
|
|
2013-08-01 13:49:34 +00:00
|
|
|
return res;
|
2013-05-08 13:39:08 +00:00
|
|
|
}
|