res_pjsip_maintenance.c File Reference

PJSIP Endpoint Maintenance Mode. More...

#include "asterisk.h"
#include <pjsip.h>
#include "asterisk/res_pjsip.h"
#include "asterisk/res_pjsip_session.h"
#include "asterisk/manager.h"
#include "asterisk/module.h"
#include "asterisk/logger.h"
#include "asterisk/cli.h"
#include "asterisk/sorcery.h"
#include "asterisk/astobj2.h"
#include "asterisk/strings.h"

Include dependency graph for res_pjsip_maintenance.c:

Go to the source code of this file.

Enumerations
enum	{ MAINT_HASH_BUCKETS = 53 }

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
static int	ami_maint_entry_cb (void *obj, void *arg, int flags)
	ao2_callback used to emit one PJSIPMaintenanceStatus AMI list entry
static int	ami_set_maintenance (struct mansession *s, const struct message *m)
static int	ami_show_maintenance (struct mansession *s, const struct message *m)
static int	apply_maintenance_state (const char *endpoint_name, int enable)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static char *	cli_complete_endpoint (const char *word)
static int	cli_maint_entry_cb (void *obj, void *arg, int flags)
	ao2_callback used to print one maintenance entry to the CLI
static char *	handle_cli_pjsip_set_maintenance (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_cli_pjsip_show_maintenance (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	load_module (void)
static void	maint_endpoint_deleted (const void *obj)
static int	maint_session_create (struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, const char *location, const char *request_user, struct ast_stream_topology *req_topology)
static int	maint_set_add (const char *endpoint_name)
static int	maint_set_remove (const char *endpoint_name)
static pj_bool_t	maintenance_on_rx_request (pjsip_rx_data *rdata)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "PJSIP Endpoint Maintenance Mode" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_APP_DEPEND, .requires = "res_pjsip,res_pjsip_session", }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct ast_cli_entry	cli_maintenance []
static const struct ast_sorcery_observer	endpoint_observer
static struct pjsip_module	maintenance_pjsip_mod
static struct ast_sip_session_supplement	maintenance_session_supplement
static struct ao2_container *	maintenance_set

Detailed Description

PJSIP Endpoint Maintenance Mode.

Provides a runtime toggle to place individual PJSIP endpoints into maintenance mode. While an endpoint is in maintenance mode:

• New inbound out-of-dialog requests are rejected with "503 Service Unavailable" and a Retry-After: 300 header (except SUBSCRIBE/REGISTER with Expires: 0).
• Outbound originations (Dial, ARI originate) are refused before any SIP session or Asterisk channel is created.
• Active in-progress dialogs (BYE, re-INVITE, UPDATE, etc.) are completely unaffected.
• Existing presence/BLF subscriptions are left to expire naturally.

CLI: pjsip set maintenance <on|off> <endpoint|all> pjsip show maintenance [endpoint]

AMI actions: PJSIPSetMaintenance, PJSIPShowMaintenance

Definition in file res_pjsip_maintenance.c.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
MAINT_HASH_BUCKETS

Definition at line 154 of file res_pjsip_maintenance.c.

     {
    MAINT_HASH_BUCKETS = 53,
};

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 754 of file res_pjsip_maintenance.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 754 of file res_pjsip_maintenance.c.

ami_maint_entry_cb()

static int ami_maint_entry_cb ( void *  obj, void *  arg, int  flags  )

static

ao2_callback used to emit one PJSIPMaintenanceStatus AMI list entry

Definition at line 654 of file res_pjsip_maintenance.c.

{
    const char *name = obj;
    struct ast_sip_ami *ami = arg;
    struct ast_str *buf;
 
    buf = ast_sip_create_ami_event("PJSIPMaintenanceStatus", ami);
    if (!buf) {
        return 0;
    }
    ast_str_append(&buf, 0, "Endpoint: %s\r\nStatus: enabled\r\n", name);
    astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
    ast_free(buf);
    ++ami->count;
 
    return 0;
}

References ast_sip_ami::arg, ast_free, ast_sip_create_ami_event(), ast_str_append(), ast_str_buffer(), astman_append(), buf, ast_sip_ami::count, name, and ast_sip_ami::s.

Referenced by ami_show_maintenance().

ami_set_maintenance()

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

static

Definition at line 562 of file res_pjsip_maintenance.c.

{
    const char *endpoint_name;
    const char *state_str;
    struct ast_sip_endpoint *endpoint;
    struct ao2_container *all_endpoints;
    struct ao2_iterator it;
    int enable;
    int rc;
 
    endpoint_name = astman_get_header(m, "Endpoint");
    state_str = astman_get_header(m, "State");
 
    if (ast_strlen_zero(endpoint_name)) {
        astman_send_error(s, m, "Endpoint parameter missing");
        return 0;
    }
    if (ast_strlen_zero(state_str)) {
        astman_send_error(s, m, "State parameter missing");
        return 0;
    }
 
    if (!strcasecmp(state_str, "on")) {
        enable = 1;
    } else if (!strcasecmp(state_str, "off")) {
        enable = 0;
    } else {
        astman_send_error(s, m, "State must be 'on' or 'off'");
        return 0;
    }
 
    if (!strcasecmp(endpoint_name, "all")) {
        int count = 0;
 
        all_endpoints = ast_sip_get_endpoints();
        if (!all_endpoints) {
            astman_send_error(s, m, "Failed to retrieve endpoint list");
            return 0;
        }
        it = ao2_iterator_init(all_endpoints, 0);
        while ((endpoint = ao2_iterator_next(&it))) {
            if (apply_maintenance_state(ast_sorcery_object_get_id(endpoint), enable) > 0) {
                count++;
            }
            ao2_ref(endpoint, -1);
        }
        ao2_iterator_destroy(&it);
        ao2_ref(all_endpoints, -1);
        if (count > 0) {
            manager_event(EVENT_FLAG_SYSTEM, "PJSIPMaintenanceStatus",
                "Endpoint: all\r\n"
                "Status: %s\r\n",
                enable ? "enabled" : "disabled");
            ast_log(LOG_NOTICE, "PJSIP: Maintenance mode %s for all endpoints "
                "(%d endpoint%s affected)\n",
                enable ? "enabled" : "disabled",
                count, count == 1 ? "" : "s");
        }
        astman_send_ack(s, m,
            enable ? "Maintenance mode enabled for all endpoints"
                   : "Maintenance mode disabled for all endpoints");
        return 0;
    }
 
    endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint", endpoint_name);
    if (!endpoint) {
        astman_send_error_va(s, m, "Endpoint '%s' not found", endpoint_name);
        return 0;
    }
    ao2_ref(endpoint, -1);
 
    rc = apply_maintenance_state(endpoint_name, enable);
    if (rc < 0) {
        astman_send_error_va(s, m, "Failed to %s maintenance mode for endpoint '%s'",
            enable ? "enable" : "disable", endpoint_name);
    } else {
        if (rc > 0) {
            manager_event(EVENT_FLAG_SYSTEM, "PJSIPMaintenanceStatus",
                "Endpoint: %s\r\n"
                "Status: %s\r\n",
                endpoint_name, enable ? "enabled" : "disabled");
            ast_log(LOG_NOTICE, "PJSIP: Maintenance mode %s for endpoint '%s'\n",
                enable ? "enabled" : "disabled", endpoint_name);
        }
        astman_send_ack(s, m,
            enable ? "Maintenance mode enabled" : "Maintenance mode disabled");
    }
 
    return 0;
}

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, apply_maintenance_state(), ast_log, ast_sip_get_endpoints(), ast_sip_get_sorcery(), ast_sorcery_object_get_id(), ast_sorcery_retrieve_by_id(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), astman_send_error_va(), EVENT_FLAG_SYSTEM, LOG_NOTICE, and manager_event.

Referenced by load_module().

ami_show_maintenance()

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

static

Definition at line 672 of file res_pjsip_maintenance.c.

{
    const char *endpoint_name;
    struct ast_sip_ami ami;
    char *entry;
    struct ast_str *buf;
 
    endpoint_name = astman_get_header(m, "Endpoint");
 
    ami.s         = s;
    ami.m         = m;
    ami.action_id = astman_get_header(m, "ActionID");
    ami.arg       = NULL;
    ami.count     = 0;
 
    astman_send_listack(s, m, "Maintenance status events follow", "start");
 
    if (!ast_strlen_zero(endpoint_name)) {
        buf = ast_sip_create_ami_event("PJSIPMaintenanceStatus", &ami);
        if (buf) {
            entry = ao2_find(maintenance_set, endpoint_name, OBJ_SEARCH_KEY);
            ast_str_append(&buf, 0, "Endpoint: %s\r\nStatus: %s\r\n",
                endpoint_name, entry ? "enabled" : "disabled");
            if (entry) {
                ao2_ref(entry, -1);
            }
            astman_append(s, "%s\r\n", ast_str_buffer(buf));
            ast_free(buf);
        }
        ami.count = 1;
    } else {
        ao2_callback(maintenance_set, OBJ_NODATA, ami_maint_entry_cb, &ami);
    }
 
    astman_send_list_complete_start(s, m, "PJSIPMaintenanceStatusComplete", ami.count);
    astman_send_list_complete_end(s);
 
    return 0;
}

References ast_sip_ami::action_id, ami_maint_entry_cb(), ao2_callback, ao2_find, ao2_ref, ast_sip_ami::arg, ast_free, ast_sip_create_ami_event(), ast_str_append(), ast_str_buffer(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_list_complete_end(), astman_send_list_complete_start(), astman_send_listack(), buf, ast_sip_ami::count, ast_sip_ami::m, maintenance_set, NULL, OBJ_NODATA, OBJ_SEARCH_KEY, and ast_sip_ami::s.

Referenced by load_module().

apply_maintenance_state()

static int apply_maintenance_state ( const char *  endpoint_name, int  enable  )

static

Definition at line 212 of file res_pjsip_maintenance.c.

{
    return enable ? maint_set_add(endpoint_name) : maint_set_remove(endpoint_name);
}

References maint_set_add(), and maint_set_remove().

Referenced by ami_set_maintenance(), and handle_cli_pjsip_set_maintenance().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 754 of file res_pjsip_maintenance.c.

cli_complete_endpoint()

static char * cli_complete_endpoint ( const char *  word )

static

Definition at line 348 of file res_pjsip_maintenance.c.

{
    int wordlen = strlen(word);
    struct ao2_container *endpoints;
    struct ast_sip_endpoint *endpoint;
    struct ao2_iterator i;
 
    endpoints = ast_sorcery_retrieve_by_prefix(ast_sip_get_sorcery(),
        "endpoint", word, wordlen);
    if (!endpoints) {
        return NULL;
    }
 
    i = ao2_iterator_init(endpoints, 0);
    while ((endpoint = ao2_iterator_next(&i))) {
        ast_cli_completion_add(ast_strdup(ast_sorcery_object_get_id(endpoint)));
        ao2_cleanup(endpoint);
    }
    ao2_iterator_destroy(&i);
    ao2_ref(endpoints, -1);
 
    return NULL;
}

References ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_cli_completion_add(), ast_sip_get_sorcery(), ast_sorcery_object_get_id(), ast_sorcery_retrieve_by_prefix(), ast_strdup, endpoints, and NULL.

Referenced by handle_cli_pjsip_set_maintenance(), and handle_cli_pjsip_show_maintenance().

cli_maint_entry_cb()

static int cli_maint_entry_cb ( void *  obj, void *  arg, int  flags  )

static

ao2_callback used to print one maintenance entry to the CLI

Definition at line 495 of file res_pjsip_maintenance.c.

{
    const char *name = obj;
    int fd = *(int *)arg;
    ast_cli(fd, "  %-40s  ON\n", name);
    return 0;
}

References ast_cli(), and name.

Referenced by handle_cli_pjsip_show_maintenance().

handle_cli_pjsip_set_maintenance()

static char * handle_cli_pjsip_set_maintenance ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 374 of file res_pjsip_maintenance.c.

{
    struct ast_sip_endpoint *endpoint;
    struct ao2_container *all_endpoints;
    struct ao2_iterator it;
    const char *endpoint_name;
    int enable;
    int rc;
    int count;
    int failed;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "pjsip set maintenance";
        e->usage =
            "Usage: pjsip set maintenance <on|off> <endpoint|all>\n"
            "       Place a PJSIP endpoint into or out of maintenance mode.\n"
            "       Use 'all' to toggle maintenance mode for every endpoint.\n"
            "       While in maintenance mode new inbound out-of-dialog requests\n"
            "       to that endpoint are rejected with 503 (except SUBSCRIBE/\n"
            "       REGISTER with Expires: 0), and outbound originations are\n"
            "       refused.\n";
        return NULL;
    case CLI_GENERATE:
        if (a->pos == 3) {
            static const char * const opts[] = { "on", "off", NULL };
            return ast_cli_complete(a->word, opts, a->n);
        }
        if (a->pos == 4) {
            if (!strncasecmp("all", a->word, strlen(a->word))) {
                ast_cli_completion_add(ast_strdup("all"));
            }
            return cli_complete_endpoint(a->word);
        }
        return NULL;
    }
 
    if (a->argc != 5) {
        return CLI_SHOWUSAGE;
    }
 
    if (!strcasecmp(a->argv[3], "on")) {
        enable = 1;
    } else if (!strcasecmp(a->argv[3], "off")) {
        enable = 0;
    } else {
        return CLI_SHOWUSAGE;
    }
 
    endpoint_name = a->argv[4];
 
    if (!strcasecmp(endpoint_name, "all")) {
        all_endpoints = ast_sip_get_endpoints();
        if (!all_endpoints) {
            ast_cli(a->fd, "Failed to retrieve endpoint list\n");
            return CLI_SUCCESS;
        }
        count = 0;
        failed = 0;
        it = ao2_iterator_init(all_endpoints, 0);
        while ((endpoint = ao2_iterator_next(&it))) {
            rc = apply_maintenance_state(ast_sorcery_object_get_id(endpoint), enable);
            if (rc > 0) {
                count++;
            } else if (rc < 0) {
                failed++;
            }
            ao2_ref(endpoint, -1);
        }
        ao2_iterator_destroy(&it);
        ao2_ref(all_endpoints, -1);
        if (count > 0) {
            manager_event(EVENT_FLAG_SYSTEM, "PJSIPMaintenanceStatus",
                "Endpoint: all\r\n"
                "Status: %s\r\n",
                enable ? "enabled" : "disabled");
            ast_log(LOG_NOTICE, "PJSIP: Maintenance mode %s for all endpoints "
                "(%d endpoint%s affected)\n",
                enable ? "enabled" : "disabled",
                count, count == 1 ? "" : "s");
        }
        ast_cli(a->fd, "Maintenance mode %s for %d endpoint%s%s\n",
            enable ? "ENABLED" : "DISABLED",
            count, count == 1 ? "" : "s",
            failed ? " (some failed)" : "");
        return CLI_SUCCESS;
    }
 
    endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint", endpoint_name);
    if (!endpoint) {
        ast_cli(a->fd, "Endpoint '%s' not found\n", endpoint_name);
        return CLI_SUCCESS;
    }
    ao2_ref(endpoint, -1);
 
    rc = apply_maintenance_state(endpoint_name, enable);
    if (rc > 0) {
        manager_event(EVENT_FLAG_SYSTEM, "PJSIPMaintenanceStatus",
            "Endpoint: %s\r\n"
            "Status: %s\r\n",
            endpoint_name, enable ? "enabled" : "disabled");
        ast_log(LOG_NOTICE, "PJSIP: Maintenance mode %s for endpoint '%s'\n",
            enable ? "enabled" : "disabled", endpoint_name);
        ast_cli(a->fd, "Maintenance mode %s for endpoint '%s'\n",
            enable ? "ENABLED" : "DISABLED", endpoint_name);
    } else if (rc == 0 && enable) {
        ast_cli(a->fd, "Endpoint '%s' is already in maintenance mode\n", endpoint_name);
    } else if (rc == 0) {
        ast_cli(a->fd, "Endpoint '%s' was not in maintenance mode\n", endpoint_name);
    } else {
        ast_cli(a->fd, "Failed to %s maintenance mode for endpoint '%s'\n",
            enable ? "enable" : "disable", endpoint_name);
    }
 
    return CLI_SUCCESS;
}

References a, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, apply_maintenance_state(), ast_cli(), ast_cli_complete(), ast_cli_completion_add(), ast_log, ast_sip_get_endpoints(), ast_sip_get_sorcery(), ast_sorcery_object_get_id(), ast_sorcery_retrieve_by_id(), ast_strdup, cli_complete_endpoint(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, EVENT_FLAG_SYSTEM, LOG_NOTICE, manager_event, NULL, and ast_cli_entry::usage.

handle_cli_pjsip_show_maintenance()

static char * handle_cli_pjsip_show_maintenance ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 503 of file res_pjsip_maintenance.c.

{
    const char *endpoint_name;
    char *entry;
    int fd;
    int count;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "pjsip show maintenance";
        e->usage =
            "Usage: pjsip show maintenance [endpoint]\n"
            "       Display endpoints currently in maintenance mode.\n"
            "       If [endpoint] is given, show the status for that endpoint only.\n";
        return NULL;
    case CLI_GENERATE:
        if (a->pos == 3) {
            return cli_complete_endpoint(a->word);
        }
        return NULL;
    }
 
    if (a->argc == 4) {
        endpoint_name = a->argv[3];
        entry = ao2_find(maintenance_set, endpoint_name, OBJ_SEARCH_KEY);
        if (entry) {
            ast_cli(a->fd, "Endpoint '%s' is in maintenance mode\n", endpoint_name);
            ao2_ref(entry, -1);
        } else {
            ast_cli(a->fd, "Endpoint '%s' is NOT in maintenance mode\n", endpoint_name);
        }
        return CLI_SUCCESS;
    }
 
    if (a->argc != 3) {
        return CLI_SHOWUSAGE;
    }
 
    ast_cli(a->fd, "\n");
    ast_cli(a->fd, "  %-40s  %s\n", "Endpoint", "State");
    ast_cli(a->fd, "  %-40s  -----\n", "----------------------------------------");
    fd = a->fd;
    ao2_callback(maintenance_set, OBJ_NODATA, cli_maint_entry_cb, &fd);
 
    count = ao2_container_count(maintenance_set);
    ast_cli(a->fd, "\n  %d endpoint%s in maintenance mode\n\n",
        count, count == 1 ? "" : "s");
 
    return CLI_SUCCESS;
}

References a, ao2_callback, ao2_container_count(), ao2_find, ao2_ref, ast_cli(), cli_complete_endpoint(), CLI_GENERATE, CLI_INIT, cli_maint_entry_cb(), CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, maintenance_set, NULL, OBJ_NODATA, OBJ_SEARCH_KEY, and ast_cli_entry::usage.

load_module()

static int load_module ( void  )

static

Definition at line 714 of file res_pjsip_maintenance.c.

{
    maintenance_set = ast_str_container_alloc_options(AO2_ALLOC_OPT_LOCK_RWLOCK,
        MAINT_HASH_BUCKETS);
    if (!maintenance_set) {
        ast_log(LOG_ERROR, "res_pjsip_maintenance: failed to allocate maintenance set\n");
        return AST_MODULE_LOAD_DECLINE;
    }
 
    ast_sorcery_observer_add(ast_sip_get_sorcery(), "endpoint", &endpoint_observer);
    ast_sip_register_service(&maintenance_pjsip_mod);
    ast_sip_session_register_supplement(&maintenance_session_supplement);
    ast_manager_register_xml("PJSIPSetMaintenance",
        EVENT_FLAG_SYSTEM, ami_set_maintenance);
    ast_manager_register_xml("PJSIPShowMaintenance",
        EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, ami_show_maintenance);
    ast_cli_register_multiple(cli_maintenance, ARRAY_LEN(cli_maintenance));
 
    return AST_MODULE_LOAD_SUCCESS;
}

References ami_set_maintenance(), ami_show_maintenance(), AO2_ALLOC_OPT_LOCK_RWLOCK, ARRAY_LEN, ast_cli_register_multiple, ast_log, ast_manager_register_xml, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, ast_sip_get_sorcery(), ast_sip_register_service(), ast_sip_session_register_supplement, ast_sorcery_observer_add(), ast_str_container_alloc_options(), cli_maintenance, endpoint_observer, EVENT_FLAG_REPORTING, EVENT_FLAG_SYSTEM, LOG_ERROR, MAINT_HASH_BUCKETS, maintenance_pjsip_mod, maintenance_session_supplement, and maintenance_set.

maint_endpoint_deleted()

static void maint_endpoint_deleted ( const void *  obj )

static

Definition at line 333 of file res_pjsip_maintenance.c.

{
    maint_set_remove(ast_sorcery_object_get_id(obj));
}

References ast_sorcery_object_get_id(), and maint_set_remove().

maint_session_create()

static int maint_session_create ( struct ast_sip_endpoint *  endpoint, struct ast_sip_contact *  contact, const char *  location, const char *  request_user, struct ast_stream_topology *  req_topology  )

static

Definition at line 226 of file res_pjsip_maintenance.c.

{
    const char *endpoint_name = ast_sorcery_object_get_id(endpoint);
    char *entry = ao2_find(maintenance_set, endpoint_name, OBJ_SEARCH_KEY);
 
    if (entry) {
        ao2_ref(entry, -1);
        ast_log(LOG_NOTICE, "PJSIP: Refusing outbound call to endpoint '%s': maintenance mode active\n",
            endpoint_name);
        return 1;
    }
    return 0;
}

References ao2_find, ao2_ref, ast_log, ast_sorcery_object_get_id(), LOG_NOTICE, maintenance_set, and OBJ_SEARCH_KEY.

maint_set_add()

static int maint_set_add ( const char *  endpoint_name )

static

Definition at line 171 of file res_pjsip_maintenance.c.

{
    char *entry;
 
    entry = ao2_find(maintenance_set, endpoint_name, OBJ_SEARCH_KEY);
    if (entry) {
        ao2_ref(entry, -1);
        return 0; /* already in maintenance */
    }
    return ast_str_container_add(maintenance_set, endpoint_name) ? -1 : 1;
}

References ao2_find, ao2_ref, ast_str_container_add(), maintenance_set, and OBJ_SEARCH_KEY.

Referenced by apply_maintenance_state().

maint_set_remove()

static int maint_set_remove ( const char *  endpoint_name )

static

Definition at line 189 of file res_pjsip_maintenance.c.

{
    char *entry;
 
    entry = ao2_find(maintenance_set, endpoint_name, OBJ_SEARCH_KEY | OBJ_UNLINK);
    if (!entry) {
        return 0;
    }
    ao2_ref(entry, -1);
    return 1;
}

References ao2_find, ao2_ref, maintenance_set, OBJ_SEARCH_KEY, and OBJ_UNLINK.

Referenced by apply_maintenance_state(), and maint_endpoint_deleted().

maintenance_on_rx_request()

static pj_bool_t maintenance_on_rx_request ( pjsip_rx_data *  rdata )

static

Definition at line 254 of file res_pjsip_maintenance.c.

{
    pjsip_msg *msg = rdata->msg_info.msg;
    const pjsip_method *method = &msg->line.req.method;
    pjsip_to_hdr *to;
    pjsip_expires_hdr *expires_hdr;
    struct ast_sip_endpoint *endpoint;
    char *entry;
    pjsip_hdr hdr_list;
    pjsip_generic_int_hdr *retry_after;
    static const pj_str_t str_retry_after = { "Retry-After", 11 };
    int is_subscribe;
    int is_register;
 
    is_subscribe = pjsip_method_cmp(method, pjsip_get_subscribe_method()) == 0;
    is_register = pjsip_method_cmp(method, pjsip_get_register_method()) == 0;
 
    /* Any in-dialog request is always allowed through. */
    to = rdata->msg_info.to;
    if (to->tag.slen > 0) {
        return PJ_FALSE;
    }
 
    /* SUBSCRIBE or REGISTER with Expires: 0: allow un-subscribe / de-register. */
    if (is_subscribe || is_register) {
        expires_hdr = pjsip_msg_find_hdr(msg, PJSIP_H_EXPIRES, NULL);
        if (expires_hdr && expires_hdr->ivalue == 0) {
            return PJ_FALSE;
        }
    }
 
    endpoint = ast_pjsip_rdata_get_endpoint(rdata);
    if (!endpoint) {
        return PJ_FALSE;
    }
 
    entry = ao2_find(maintenance_set, ast_sorcery_object_get_id(endpoint), OBJ_SEARCH_KEY);
    if (!entry) {
        ao2_ref(endpoint, -1);
        return PJ_FALSE;
    }
    ao2_ref(entry, -1);
 
    ast_log(LOG_NOTICE, "PJSIP: Endpoint '%s' is in maintenance mode; rejecting new %.*s from %s\n",
        ast_sorcery_object_get_id(endpoint),
        (int)method->name.slen, method->name.ptr,
        rdata->pkt_info.src_name);
 
    ao2_ref(endpoint, -1);
 
    pj_list_init(&hdr_list);
    retry_after = pjsip_generic_int_hdr_create(rdata->tp_info.pool,
        &str_retry_after, 300);
    if (retry_after) {
        pj_list_push_back(&hdr_list, retry_after);
    }
 
    pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 503, NULL,
        retry_after ? &hdr_list : NULL, NULL);
 
    return PJ_TRUE;
}

References ao2_find, ao2_ref, ast_log, ast_pjsip_rdata_get_endpoint(), ast_sip_get_pjsip_endpoint(), ast_sorcery_object_get_id(), LOG_NOTICE, maintenance_set, method, NULL, and OBJ_SEARCH_KEY.

unload_module()

static int unload_module ( void  )

static

Definition at line 735 of file res_pjsip_maintenance.c.

{
    ast_cli_unregister_multiple(cli_maintenance, ARRAY_LEN(cli_maintenance));
    ast_manager_unregister("PJSIPShowMaintenance");
    ast_manager_unregister("PJSIPSetMaintenance");
    ast_sip_session_unregister_supplement(&maintenance_session_supplement);
    ast_sip_unregister_service(&maintenance_pjsip_mod);
    ast_sorcery_observer_remove(ast_sip_get_sorcery(), "endpoint", &endpoint_observer);
    ao2_cleanup(maintenance_set);
    maintenance_set = NULL;
    return 0;
}

References ao2_cleanup, ARRAY_LEN, ast_cli_unregister_multiple(), ast_manager_unregister(), ast_sip_get_sorcery(), ast_sip_session_unregister_supplement(), ast_sip_unregister_service(), ast_sorcery_observer_remove(), cli_maintenance, endpoint_observer, maintenance_pjsip_mod, maintenance_session_supplement, maintenance_set, and NULL.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "PJSIP Endpoint Maintenance Mode" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_APP_DEPEND, .requires = "res_pjsip,res_pjsip_session", }

static

Definition at line 754 of file res_pjsip_maintenance.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 754 of file res_pjsip_maintenance.c.

cli_maintenance

struct ast_cli_entry cli_maintenance[]

static

Initial value:

= {
    { .handler =  handle_cli_pjsip_set_maintenance , .summary =  "Set PJSIP endpoint maintenance mode" ,},
    { .handler =  handle_cli_pjsip_show_maintenance , .summary =  "Show PJSIP endpoint maintenance status" ,},
}

Definition at line 555 of file res_pjsip_maintenance.c.

                                                {
    AST_CLI_DEFINE(handle_cli_pjsip_set_maintenance,  "Set PJSIP endpoint maintenance mode"),
    AST_CLI_DEFINE(handle_cli_pjsip_show_maintenance, "Show PJSIP endpoint maintenance status"),
};

Referenced by load_module(), and unload_module().

endpoint_observer

const struct ast_sorcery_observer endpoint_observer

static

Initial value:

= {
    .deleted = maint_endpoint_deleted,
}

Definition at line 338 of file res_pjsip_maintenance.c.

                                                             {
    .deleted = maint_endpoint_deleted,
};

Referenced by load_module(), and unload_module().

maintenance_pjsip_mod

struct pjsip_module maintenance_pjsip_mod

static

Definition at line 317 of file res_pjsip_maintenance.c.

                                                   {
    .name     = { "Maintenance Module", 18 },
    /*
     * Run after endpoint identification (endpoint_mod,
     * PJSIP_MOD_PRIORITY_TSX_LAYER - 3) so that
     * ast_pjsip_rdata_get_endpoint() returns the identified endpoint,
     * but before the request authenticator
     * (PJSIP_MOD_PRIORITY_APPLICATION - 2) so that a maintenance
     * endpoint receives 503 rather than a 401 challenge.
     */
    .priority = PJSIP_MOD_PRIORITY_APPLICATION - 3,
    .on_rx_request = maintenance_on_rx_request,
};

Referenced by load_module(), and unload_module().

maintenance_session_supplement

struct ast_sip_session_supplement maintenance_session_supplement

static

Initial value:

= {
    .session_create = maint_session_create,
    .priority = AST_SIP_SUPPLEMENT_PRIORITY_FIRST,
}

Definition at line 242 of file res_pjsip_maintenance.c.

                                                                          {
    .session_create = maint_session_create,
    .priority = AST_SIP_SUPPLEMENT_PRIORITY_FIRST,
};

Referenced by load_module(), and unload_module().

maintenance_set

struct ao2_container* maintenance_set

static

Endpoints currently in maintenance mode. Protected by the container's own internal RWLOCK. No other locks are ever held simultaneously with this container.

Definition at line 162 of file res_pjsip_maintenance.c.

Referenced by ami_show_maintenance(), handle_cli_pjsip_show_maintenance(), load_module(), maint_session_create(), maint_set_add(), maint_set_remove(), maintenance_on_rx_request(), and unload_module().