Files
asterisk/apps/confbridge/confbridge_manager.c
Matt Jordan 4a58261694 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-13 03:48:57 -04:00

550 lines
15 KiB
C

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2013, Digium, Inc.
*
* Jonathan Rose <jrose@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 Confbridge manager events for stasis messages
*
* \author Jonathan Rose <jrose@digium.com>
*/
#include "asterisk.h"
ASTERISK_REGISTER_FILE()
#include "asterisk/channel.h"
#include "asterisk/bridge.h"
#include "asterisk/stasis.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/stasis_bridges.h"
#include "asterisk/manager.h"
#include "asterisk/stasis_message_router.h"
#include "include/confbridge.h"
/*** DOCUMENTATION
<managerEvent language="en_US" name="ConfbridgeStart">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a conference starts.</synopsis>
<syntax>
<parameter name="Conference">
<para>The name of the Confbridge conference.</para>
</parameter>
<bridge_snapshot/>
</syntax>
<see-also>
<ref type="managerEvent">ConfbridgeEnd</ref>
<ref type="application">ConfBridge</ref>
</see-also>
</managerEventInstance>
</managerEvent>
<managerEvent language="en_US" name="ConfbridgeEnd">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a conference ends.</synopsis>
<syntax>
<parameter name="Conference">
<para>The name of the Confbridge conference.</para>
</parameter>
<bridge_snapshot/>
</syntax>
<see-also>
<ref type="managerEvent">ConfbridgeStart</ref>
<ref type="application">ConfBridge</ref>
</see-also>
</managerEventInstance>
</managerEvent>
<managerEvent language="en_US" name="ConfbridgeJoin">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a channel joins a Confbridge conference.</synopsis>
<syntax>
<parameter name="Conference">
<para>The name of the Confbridge conference.</para>
</parameter>
<bridge_snapshot/>
<channel_snapshot/>
<parameter name="Admin">
<para>Identifies this user as an admin user.</para>
<enumlist>
<enum name="Yes"/>
<enum name="No"/>
</enumlist>
</parameter>
</syntax>
<see-also>
<ref type="managerEvent">ConfbridgeLeave</ref>
<ref type="application">ConfBridge</ref>
</see-also>
</managerEventInstance>
</managerEvent>
<managerEvent language="en_US" name="ConfbridgeLeave">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a channel leaves a Confbridge conference.</synopsis>
<syntax>
<parameter name="Conference">
<para>The name of the Confbridge conference.</para>
</parameter>
<bridge_snapshot/>
<channel_snapshot/>
<parameter name="Admin">
<para>Identifies this user as an admin user.</para>
<enumlist>
<enum name="Yes"/>
<enum name="No"/>
</enumlist>
</parameter>
</syntax>
<see-also>
<ref type="managerEvent">ConfbridgeJoin</ref>
<ref type="application">ConfBridge</ref>
</see-also>
</managerEventInstance>
</managerEvent>
<managerEvent language="en_US" name="ConfbridgeRecord">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a conference starts recording.</synopsis>
<syntax>
<parameter name="Conference">
<para>The name of the Confbridge conference.</para>
</parameter>
<bridge_snapshot/>
</syntax>
<see-also>
<ref type="managerEvent">ConfbridgeStopRecord</ref>
<ref type="application">ConfBridge</ref>
</see-also>
</managerEventInstance>
</managerEvent>
<managerEvent language="en_US" name="ConfbridgeStopRecord">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a conference that was recording stops recording.</synopsis>
<syntax>
<parameter name="Conference">
<para>The name of the Confbridge conference.</para>
</parameter>
<bridge_snapshot/>
</syntax>
<see-also>
<ref type="managerEvent">ConfbridgeRecord</ref>
<ref type="application">ConfBridge</ref>
</see-also>
</managerEventInstance>
</managerEvent>
<managerEvent language="en_US" name="ConfbridgeMute">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a Confbridge participant mutes.</synopsis>
<syntax>
<parameter name="Conference">
<para>The name of the Confbridge conference.</para>
</parameter>
<bridge_snapshot/>
<channel_snapshot/>
<parameter name="Admin">
<para>Identifies this user as an admin user.</para>
<enumlist>
<enum name="Yes"/>
<enum name="No"/>
</enumlist>
</parameter>
</syntax>
<see-also>
<ref type="managerEvent">ConfbridgeUnmute</ref>
<ref type="application">ConfBridge</ref>
</see-also>
</managerEventInstance>
</managerEvent>
<managerEvent language="en_US" name="ConfbridgeUnmute">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a confbridge participant unmutes.</synopsis>
<syntax>
<parameter name="Conference">
<para>The name of the Confbridge conference.</para>
</parameter>
<bridge_snapshot/>
<channel_snapshot/>
<parameter name="Admin">
<para>Identifies this user as an admin user.</para>
<enumlist>
<enum name="Yes"/>
<enum name="No"/>
</enumlist>
</parameter>
</syntax>
<see-also>
<ref type="managerEvent">ConfbridgeMute</ref>
<ref type="application">ConfBridge</ref>
</see-also>
</managerEventInstance>
</managerEvent>
<managerEvent language="en_US" name="ConfbridgeTalking">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a confbridge participant unmutes.</synopsis>
<syntax>
<parameter name="Conference">
<para>The name of the Confbridge conference.</para>
</parameter>
<bridge_snapshot/>
<channel_snapshot/>
<parameter name="TalkingStatus">
<enumlist>
<enum name="on"/>
<enum name="off"/>
</enumlist>
</parameter>
<parameter name="Admin">
<para>Identifies this user as an admin user.</para>
<enumlist>
<enum name="Yes"/>
<enum name="No"/>
</enumlist>
</parameter>
</syntax>
<see-also>
<ref type="application">ConfBridge</ref>
</see-also>
</managerEventInstance>
</managerEvent>
***/
static struct stasis_message_router *bridge_state_router;
static struct stasis_message_router *channel_state_router;
static void confbridge_publish_manager_event(
struct stasis_message *message,
const char *event,
struct ast_str *extra_text)
{
struct ast_bridge_blob *blob = stasis_message_data(message);
const char *conference_name;
RAII_VAR(struct ast_str *, bridge_text, NULL, ast_free);
RAII_VAR(struct ast_str *, channel_text, NULL, ast_free);
ast_assert(blob != NULL);
ast_assert(event != NULL);
bridge_text = ast_manager_build_bridge_state_string(blob->bridge);
if (!bridge_text) {
return;
}
conference_name = ast_json_string_get(ast_json_object_get(blob->blob, "conference"));
ast_assert(conference_name != NULL);
if (blob->channel) {
channel_text = ast_manager_build_channel_state_string(blob->channel);
}
manager_event(EVENT_FLAG_CALL, event,
"Conference: %s\r\n"
"%s"
"%s"
"%s",
conference_name,
ast_str_buffer(bridge_text),
S_COR(channel_text, ast_str_buffer(channel_text), ""),
S_COR(extra_text, ast_str_buffer(extra_text), ""));
}
static int get_admin_header(struct ast_str **extra_text, struct stasis_message *message)
{
const struct ast_bridge_blob *blob = stasis_message_data(message);
const struct ast_json *admin = ast_json_object_get(blob->blob, "admin");
if (!admin) {
return -1;
}
return ast_str_append_event_header(extra_text, "Admin",
S_COR(ast_json_is_true(admin), "Yes", "No"));
}
static void confbridge_start_cb(void *data, struct stasis_subscription *sub,
struct stasis_message *message)
{
confbridge_publish_manager_event(message, "ConfbridgeStart", NULL);
}
static void confbridge_end_cb(void *data, struct stasis_subscription *sub,
struct stasis_message *message)
{
confbridge_publish_manager_event(message, "ConfbridgeEnd", NULL);
}
static void confbridge_leave_cb(void *data, struct stasis_subscription *sub,
struct stasis_message *message)
{
struct ast_str *extra_text = NULL;
if (!get_admin_header(&extra_text, message)) {
confbridge_publish_manager_event(message, "ConfbridgeLeave", extra_text);
}
ast_free(extra_text);
}
static void confbridge_join_cb(void *data, struct stasis_subscription *sub,
struct stasis_message *message)
{
struct ast_str *extra_text = NULL;
if (!get_admin_header(&extra_text, message)) {
confbridge_publish_manager_event(message, "ConfbridgeJoin", extra_text);
}
ast_free(extra_text);
}
static void confbridge_start_record_cb(void *data, struct stasis_subscription *sub,
struct stasis_message *message)
{
confbridge_publish_manager_event(message, "ConfbridgeRecord", NULL);
}
static void confbridge_stop_record_cb(void *data, struct stasis_subscription *sub,
struct stasis_message *message)
{
confbridge_publish_manager_event(message, "ConfbridgeStopRecord", NULL);
}
static void confbridge_mute_cb(void *data, struct stasis_subscription *sub,
struct stasis_message *message)
{
struct ast_str *extra_text = NULL;
if (!get_admin_header(&extra_text, message)) {
confbridge_publish_manager_event(message, "ConfbridgeMute", extra_text);
}
ast_free(extra_text);
}
static void confbridge_unmute_cb(void *data, struct stasis_subscription *sub,
struct stasis_message *message)
{
struct ast_str *extra_text = NULL;
if (!get_admin_header(&extra_text, message)) {
confbridge_publish_manager_event(message, "ConfbridgeUnmute", extra_text);
}
ast_free(extra_text);
}
static void confbridge_talking_cb(void *data, struct stasis_subscription *sub,
struct stasis_message *message)
{
RAII_VAR(struct ast_str *, extra_text, NULL, ast_free);
const struct ast_bridge_blob *blob = stasis_message_data(message);
const char *talking_status = ast_json_string_get(ast_json_object_get(blob->blob, "talking_status"));
if (!talking_status) {
return;
}
ast_str_append_event_header(&extra_text, "TalkingStatus", talking_status);
if (!extra_text) {
return;
}
if (!get_admin_header(&extra_text, message)) {
confbridge_publish_manager_event(message, "ConfbridgeTalking", extra_text);
}
}
STASIS_MESSAGE_TYPE_DEFN(confbridge_start_type);
STASIS_MESSAGE_TYPE_DEFN(confbridge_end_type);
STASIS_MESSAGE_TYPE_DEFN(confbridge_join_type);
STASIS_MESSAGE_TYPE_DEFN(confbridge_leave_type);
STASIS_MESSAGE_TYPE_DEFN(confbridge_start_record_type);
STASIS_MESSAGE_TYPE_DEFN(confbridge_stop_record_type);
STASIS_MESSAGE_TYPE_DEFN(confbridge_mute_type);
STASIS_MESSAGE_TYPE_DEFN(confbridge_unmute_type);
STASIS_MESSAGE_TYPE_DEFN(confbridge_talking_type);
void manager_confbridge_shutdown(void) {
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_start_type);
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_end_type);
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_join_type);
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_leave_type);
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_start_record_type);
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_stop_record_type);
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_mute_type);
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_unmute_type);
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_talking_type);
if (bridge_state_router) {
stasis_message_router_unsubscribe(bridge_state_router);
bridge_state_router = NULL;
}
if (channel_state_router) {
stasis_message_router_unsubscribe(channel_state_router);
channel_state_router = NULL;
}
}
int manager_confbridge_init(void)
{
STASIS_MESSAGE_TYPE_INIT(confbridge_start_type);
STASIS_MESSAGE_TYPE_INIT(confbridge_end_type);
STASIS_MESSAGE_TYPE_INIT(confbridge_join_type);
STASIS_MESSAGE_TYPE_INIT(confbridge_leave_type);
STASIS_MESSAGE_TYPE_INIT(confbridge_start_record_type);
STASIS_MESSAGE_TYPE_INIT(confbridge_stop_record_type);
STASIS_MESSAGE_TYPE_INIT(confbridge_mute_type);
STASIS_MESSAGE_TYPE_INIT(confbridge_unmute_type);
STASIS_MESSAGE_TYPE_INIT(confbridge_talking_type);
bridge_state_router = stasis_message_router_create(
ast_bridge_topic_all_cached());
if (!bridge_state_router) {
return -1;
}
if (stasis_message_router_add(bridge_state_router,
confbridge_start_type(),
confbridge_start_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(bridge_state_router,
confbridge_end_type(),
confbridge_end_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(bridge_state_router,
confbridge_join_type(),
confbridge_join_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(bridge_state_router,
confbridge_leave_type(),
confbridge_leave_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(bridge_state_router,
confbridge_start_record_type(),
confbridge_start_record_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(bridge_state_router,
confbridge_stop_record_type(),
confbridge_stop_record_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(bridge_state_router,
confbridge_mute_type(),
confbridge_mute_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(bridge_state_router,
confbridge_unmute_type(),
confbridge_unmute_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(bridge_state_router,
confbridge_talking_type(),
confbridge_talking_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
channel_state_router = stasis_message_router_create(
ast_channel_topic_all_cached());
if (!channel_state_router) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(channel_state_router,
confbridge_start_type(),
confbridge_start_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(channel_state_router,
confbridge_end_type(),
confbridge_end_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(channel_state_router,
confbridge_join_type(),
confbridge_join_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(channel_state_router,
confbridge_leave_type(),
confbridge_leave_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(channel_state_router,
confbridge_start_record_type(),
confbridge_start_record_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(channel_state_router,
confbridge_stop_record_type(),
confbridge_stop_record_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(channel_state_router,
confbridge_mute_type(),
confbridge_mute_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(channel_state_router,
confbridge_unmute_type(),
confbridge_unmute_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
if (stasis_message_router_add(channel_state_router,
confbridge_talking_type(),
confbridge_talking_cb,
NULL)) {
manager_confbridge_shutdown();
return -1;
}
return 0;
}