res_manager_devicestate.c File Reference

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/manager.h"
#include "asterisk/stasis.h"
#include "asterisk/devicestate.h"
#include "asterisk/mwi.h"
#include "asterisk/conversions.h"

Include dependency graph for res_manager_devicestate.c:

Go to the source code of this file.

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
static int	action_devicestatechange (struct mansession *s, const struct message *m)
static int	action_devicestatelist (struct mansession *s, const struct message *m)
static int	action_mailboxstatechange (struct mansession *s, const struct message *m)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	load_module (void)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Manager Device State Topic Forwarder" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEVSTATE_CONSUMER, }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct stasis_forward *	topic_forwarder

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 348 of file res_manager_devicestate.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 348 of file res_manager_devicestate.c.

action_devicestatechange()

static int action_devicestatechange ( struct mansession *  s, const struct message *  m  )

static

Definition at line 199 of file res_manager_devicestate.c.

{
    struct ast_eid eid;
    enum ast_device_state state_val;
    const char *device = astman_get_header(m, "Device");
    const char *state = astman_get_header(m, "State");
    const char *cachable = astman_get_header(m, "Cachable");
    const char *entity_id = astman_get_header(m, "EntityID");
 
    if (ast_strlen_zero(device) || ast_strlen_zero(state)) {
        astman_send_error(s, m, "Missing device or device state");
        return 0;
    }
    if (ast_strlen_zero(entity_id) || ast_str_to_eid(&eid, entity_id)) {
        astman_send_error(s, m, "Missing or invalid entity ID");
        return 0;
    }
    if (!strchr(device, '/') && !strchr(device, ':')) {
        astman_send_error(s, m, "Invalid device name");
        return 0;
    }
 
    state_val = ast_devstate_val(state);
    /* ast_devstate_val returns AST_DEVICE_UNKNOWN if the device state value is not valid,
     * but AST_DEVICE_UNKNOWN is also a legitimate value, so allow it if that's what the input actually was. */
    if (state_val == AST_DEVICE_UNKNOWN && strcasecmp(state, "UNKNOWN")) {
        astman_send_error(s, m, "Invalid device state value");
        return 0;
    }
 
    if (!ast_eid_cmp(&ast_eid_default, &eid)) {
        astman_send_error(s, m, "Entity ID is ourself (must be from a different Asterisk system)");
        return 0;
    }
 
    if (ast_publish_device_state_full(device, state_val, ast_false(cachable) ? AST_DEVSTATE_NOT_CACHABLE : AST_DEVSTATE_CACHABLE, &eid)) {
        astman_send_error(s, m, "Failed to publish device state update");
        return 0;
    }
 
    astman_send_ack(s, m, "Updated or set device state");
    return 0;
}

References AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, AST_DEVSTATE_NOT_CACHABLE, ast_devstate_val(), ast_eid_cmp(), ast_eid_default, ast_false(), ast_publish_device_state_full(), ast_str_to_eid(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), and ast_eid::eid.

Referenced by load_module().

action_devicestatelist()

static int action_devicestatelist ( struct mansession *  s, const struct message *  m  )

static

Definition at line 157 of file res_manager_devicestate.c.

{
    RAII_VAR(struct ao2_container *, device_states, NULL, ao2_cleanup);
    const char *action_id = astman_get_header(m, "ActionID");
    struct stasis_message *msg;
    struct ao2_iterator it_states;
    int count = 0;
 
    device_states = stasis_cache_dump_by_eid(ast_device_state_cache(),
        ast_device_state_message_type(), NULL);
    if (!device_states) {
        astman_send_error(s, m, "Memory Allocation Failure");
        return 0;
    }
 
    astman_send_listack(s, m, "Device State Changes will follow", "start");
 
    it_states = ao2_iterator_init(device_states, 0);
    for (; (msg = ao2_iterator_next(&it_states)); ao2_ref(msg, -1)) {
        struct ast_manager_event_blob *blob = stasis_message_to_ami(msg);
 
        if (!blob) {
            continue;
        }
 
        count++;
 
        astman_append(s, "Event: %s\r\n", blob->manager_event);
        if (!ast_strlen_zero(action_id)) {
            astman_append(s, "ActionID: %s\r\n", action_id);
        }
        astman_append(s, "%s\r\n", blob->extra_fields);
        ao2_ref(blob, -1);
    }
    ao2_iterator_destroy(&it_states);
 
    astman_send_list_complete_start(s, m, "DeviceStateListComplete", count);
    astman_send_list_complete_end(s);
 
    return 0;
}

References ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_device_state_cache(), ast_device_state_message_type(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_send_list_complete_end(), astman_send_list_complete_start(), astman_send_listack(), ast_manager_event_blob::extra_fields, ast_manager_event_blob::manager_event, NULL, RAII_VAR, stasis_cache_dump_by_eid(), and stasis_message_to_ami().

Referenced by load_module().

action_mailboxstatechange()

static int action_mailboxstatechange ( struct mansession *  s, const struct message *  m  )

static

Definition at line 243 of file res_manager_devicestate.c.

{
    struct ast_eid eid;
    int new_msgs, old_msgs;
    char *context, *mailbox;
    const char *mbox = astman_get_header(m, "Mailbox");
    const char *newmsgs = astman_get_header(m, "NewMessages");
    const char *oldmsgs = astman_get_header(m, "OldMessages");
    const char *entity_id = astman_get_header(m, "EntityID");
 
    if (ast_strlen_zero(mbox) || ast_strlen_zero(newmsgs) || ast_strlen_zero(oldmsgs)) {
        astman_send_error(s, m, "Missing required parameters");
        return 0;
    }
    if (ast_strlen_zero(entity_id) || ast_str_to_eid(&eid, entity_id)) {
        astman_send_error(s, m, "Missing or invalid entity ID");
        return 0;
    }
 
    if (ast_str_to_int(newmsgs, &new_msgs) || ast_str_to_int(oldmsgs, &old_msgs)) {
        astman_send_error(s, m, "Invalid mailbox counts");
        return 0;
    }
    if (new_msgs < 0 || old_msgs < 0) {
        astman_send_error(s, m, "Invalid mailbox counts (must be non-negative)");
        return 0;
    }
 
    if (!ast_eid_cmp(&ast_eid_default, &eid)) {
        astman_send_error(s, m, "Entity ID is ourself (must be from a different Asterisk system)");
        return 0;
    }
 
    context = ast_strdupa(mbox);
    mailbox = strsep(&context, "@");
 
    /* Mailbox is mandatory, context is optional */
    if (ast_strlen_zero(mailbox)) {
        astman_send_error(s, m, "A mailbox is required");
        return 0;
    }
 
    if (ast_publish_mwi_state_full(mailbox, context, new_msgs, old_msgs, NULL, &eid)) {
        astman_send_error(s, m, "Failed to publish mailbox state update");
        return 0;
    }
 
    astman_send_ack(s, m, "Updated mailbox state");
    return 0;
}

References ast_eid_cmp(), ast_eid_default, ast_publish_mwi_state_full(), ast_str_to_eid(), ast_str_to_int(), ast_strdupa, ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), ast_eid::eid, mbox(), NULL, and strsep().

Referenced by load_module().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 348 of file res_manager_devicestate.c.

load_module()

static int load_module ( void  )

static

Definition at line 304 of file res_manager_devicestate.c.

{
    struct stasis_topic *manager_topic;
 
    if (ast_eid_is_empty(&ast_eid_default)) {
        ast_log(LOG_ERROR, "Entity ID is not set.\n");
        return AST_MODULE_LOAD_DECLINE;
    }
 
    manager_topic = ast_manager_get_topic();
    if (!manager_topic) {
        return AST_MODULE_LOAD_DECLINE;
    }
    topic_forwarder = stasis_forward_all(ast_device_state_topic_all(), manager_topic);
    if (!topic_forwarder) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    if (ast_manager_register_xml("DeviceStateList", EVENT_FLAG_CALL | EVENT_FLAG_REPORTING,
                                 action_devicestatelist)) {
        topic_forwarder = stasis_forward_cancel(topic_forwarder);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    if (ast_manager_register_xml("DeviceStateChange", EVENT_FLAG_CALL | EVENT_FLAG_REPORTING, action_devicestatechange)) {
        topic_forwarder = stasis_forward_cancel(topic_forwarder);
        ast_manager_unregister("DeviceStateList");
        return AST_MODULE_LOAD_DECLINE;
    }
    if (ast_manager_register_xml("MailboxStateChange", EVENT_FLAG_CALL | EVENT_FLAG_REPORTING, action_mailboxstatechange)) {
        topic_forwarder = stasis_forward_cancel(topic_forwarder);
        ast_manager_unregister("DeviceStateList");
        ast_manager_unregister("DeviceStateChange");
        return AST_MODULE_LOAD_DECLINE;
    }
 
    return AST_MODULE_LOAD_SUCCESS;
}

References action_devicestatechange(), action_devicestatelist(), action_mailboxstatechange(), ast_device_state_topic_all(), ast_eid_default, ast_eid_is_empty(), ast_log, ast_manager_get_topic(), ast_manager_register_xml, ast_manager_unregister(), AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, EVENT_FLAG_CALL, EVENT_FLAG_REPORTING, LOG_ERROR, manager_topic, stasis_forward_all(), stasis_forward_cancel(), and topic_forwarder.

unload_module()

static int unload_module ( void  )

static

Definition at line 294 of file res_manager_devicestate.c.

{
    topic_forwarder = stasis_forward_cancel(topic_forwarder);
    ast_manager_unregister("DeviceStateList");
    ast_manager_unregister("DeviceStateChange");
    ast_manager_unregister("MailboxStateChange");
 
    return 0;
}

References ast_manager_unregister(), stasis_forward_cancel(), and topic_forwarder.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Manager Device State Topic Forwarder" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEVSTATE_CONSUMER, }

static

Definition at line 348 of file res_manager_devicestate.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 348 of file res_manager_devicestate.c.

topic_forwarder

struct stasis_forward* topic_forwarder

static

Definition at line 155 of file res_manager_devicestate.c.

Referenced by load_module(), and unload_module().