res_pjsip_config_wizard.c File Reference

PJSIP Configuration Wizard. More...

#include "asterisk.h"
#include <regex.h>
#include <pjsip.h>
#include "asterisk/astobj2.h"
#include "asterisk/cli.h"
#include "asterisk/res_pjsip.h"
#include "asterisk/module.h"
#include "asterisk/pbx.h"
#include "asterisk/sorcery.h"
#include "asterisk/vector.h"
#include "asterisk/stasis.h"
#include "asterisk/acl.h"
#include "asterisk/security_events.h"

Include dependency graph for res_pjsip_config_wizard.c:

Go to the source code of this file.

Data Structures
struct	object_type_wizard
	Keeps track of the sorcery wizard and last config for each object type. More...
struct	string_vector
	A generic char * vector definition. More...

Macros
#define	BASE_REGISTRAR   "res_pjsip_config_wizard"
#define	MAX_ID_SUFFIX   20
	Defines the maximum number of characters that can be added to a wizard id.
#define	NOT_EQUALS(a, b)   (a != b)
#define	OTW_DELETE_CB(otw)
#define	variable_list_append_return(existing, name, value)
	Appends a variable to the end of an existing list. On failure, cause the calling function to return -1.

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
static void	acl_change_stasis_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
	Callback for Named ACL changed.
static int	add_extension (struct ast_context *context, const char *exten, int priority, const char *application)
static int	add_hints (const char *context, const char *exten, const char *application, const char *id)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static	AST_VECTOR_RW (object_type_wizards, struct object_type_wizard *)
static void *	create_object (const struct ast_sorcery *sorcery, const char *id, const char *type, struct ast_variable *vars)
	Creates a sorcery object and applies a variable list.
static int	delete_existing_cb (void *obj, void *arg, int flags)
static int	delete_extens (const char *context, const char *exten)
static struct object_type_wizard *	find_wizard (const char *object_type)
	Finds the otw for the object type.
static struct ast_variable *	get_object_variables (struct ast_variable *vars, char *prefix)
	We need to strip off the prefix from the name of each variable so they're suitable for objectset_apply. I.E. will transform outbound_auth/username to username.
static int	handle_aor (const struct ast_sorcery *sorcery, struct object_type_wizard *otw, struct ast_category *wiz, struct string_vector *remote_hosts_vector)
static int	handle_auth (const struct ast_sorcery *sorcery, struct object_type_wizard *otw, struct ast_category *wiz, char *direction)
static int	handle_auths (const struct ast_sorcery *sorcery, struct object_type_wizard *otw, struct ast_category *wiz)
static int	handle_endpoint (const struct ast_sorcery *sorcery, struct object_type_wizard *otw, struct ast_category *wiz)
static char *	handle_export_primitives (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	handle_identify (const struct ast_sorcery *sorcery, struct object_type_wizard *otw, struct ast_category *wiz, struct string_vector *remote_hosts_vector)
static int	handle_phoneprov (const struct ast_sorcery *sorcery, struct object_type_wizard *otw, struct ast_category *wiz)
static int	handle_registrations (const struct ast_sorcery *sorcery, struct object_type_wizard *otw, struct ast_category *wiz, struct string_vector *remote_hosts_vector)
static void	instance_created_observer (const char *name, struct ast_sorcery *sorcery)
	When the res_pjsip instance is created, add an observer to it and initialize the wizard vector. Also, bump the module's ref count so it can't be unloaded before the sorcery instance is destroyed.
static void	instance_destroying_observer (const char *name, struct ast_sorcery *sorcery)
	When the res_pjsip instance is destroyed, remove the observer and unref the module. This should then allow this module to unload cleanly.
static int	is_one_of (const char *needle, const char *haystack[])
static int	is_variable_true (struct ast_variable *vars, const char *name)
	Finds the last variable in a list and tests it.
static int	load_module (void)
static void	object_type_loaded_observer (const char *name, const struct ast_sorcery *sorcery, const char *object_type, int reloaded)
	Called after an object type is loaded/reloaded.
static void	object_type_registered_observer (const char *name, struct ast_sorcery *sorcery, const char *object_type)
	When each object type is registered, map a memory wizard to it.
static int	reload_module (void)
static int	unload_module (void)
static int	variable_list_append (struct ast_variable **existing, const char *name, const char *value)
	Appends a variable to the end of an existing list.
static int	wizard_apply_handler (const struct ast_sorcery *sorcery, struct object_type_wizard *otw, struct ast_category *wiz)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "PJSIP Config Wizard" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .reload = reload_module, .unload = unload_module, .load_pri = AST_MODPRI_REALTIME_DRIVER, }
static int	acl_change_detected = 0
static struct stasis_subscription *	acl_change_sub
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct ast_cli_entry	config_wizard_cli []
static const struct ast_sorcery_global_observer	global_observer
struct ast_sorcery_instance_observer	observer

Detailed Description

PJSIP Configuration Wizard.

Author

George Joseph georg.nosp@m.e.jo.nosp@m.seph@.nosp@m.fair.nosp@m.view5.nosp@m..com

Definition in file res_pjsip_config_wizard.c.

Macro Definition Documentation

BASE_REGISTRAR

#define BASE_REGISTRAR   "res_pjsip_config_wizard"

Definition at line 279 of file res_pjsip_config_wizard.c.

MAX_ID_SUFFIX

#define MAX_ID_SUFFIX   20

Defines the maximum number of characters that can be added to a wizard id.

Definition at line 277 of file res_pjsip_config_wizard.c.

NOT_EQUALS

#define NOT_EQUALS	(		a,
			b
	)		(a != b)

OTW_DELETE_CB

#define OTW_DELETE_CB

(

otw

)

Value:

    ({ \
    ast_config_destroy(otw->last_config); \
    ast_free(otw); \
})

variable_list_append_return

#define variable_list_append_return	(		existing,
			name,
			value
	)

Appends a variable to the end of an existing list. On failure, cause the calling function to return -1.

Definition at line 392 of file res_pjsip_config_wizard.c.

                                                            { \
    struct ast_variable *new = ast_variable_new(name, value, ""); \
    if (!new) { \
        ast_log(LOG_ERROR, "Unable to allocate memory for new variable '%s'.\n", name); \
        return -1; \
    } \
    ast_variable_list_append(existing, new); \
})

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 1399 of file res_pjsip_config_wizard.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 1399 of file res_pjsip_config_wizard.c.

acl_change_stasis_cb()

static void acl_change_stasis_cb ( void *  data, struct stasis_subscription *  sub, struct stasis_message *  message  )

static

Callback for Named ACL changed.

Definition at line 307 of file res_pjsip_config_wizard.c.

{
    if (stasis_message_type(message) != ast_named_acl_change_type()) {
        return;
    }
 
    ast_debug(3, "PJSIP Wizard: Named ACL change detected via Stasis. Triggering reload.\n");
    acl_change_detected = 1;
    ast_sorcery_reload(ast_sip_get_sorcery());
    acl_change_detected = 0;
}

References acl_change_detected, ast_debug, ast_named_acl_change_type(), ast_sip_get_sorcery(), and ast_sorcery_reload().

Referenced by load_module().

add_extension()

static int add_extension ( struct ast_context *  context, const char *  exten, int  priority, const char *  application  )

static

Definition at line 439 of file res_pjsip_config_wizard.c.

{
    struct pbx_find_info find_info = { .stacklen = 0 }; /* the rest is reset in pbx_find_extension */
    struct ast_exten *existing_exten;
    char *data = NULL;
    char *app = NULL;
    void *free_ptr = NULL;
    const char *paren;
    const char *context_name;
 
    if (!context || ast_strlen_zero(exten) || ast_strlen_zero(application)) {
        return -1;
    }
 
    /* The incoming application has to be split into the app name and the
     * arguments (data).  The app name can be any storage type as add_extension
     * copies it into its own buffer.  Data however, needs to be dynamically
     * allocated and a free function provided.
     */
 
    paren = strchr(application, '(');
    if (!paren) {
        app = (char *)application;
    } else {
        app = ast_strdupa(application);
        app[paren - application] = '\0';
        data = ast_strdup(paren + 1);
        if (!data) {
            return -1;
        }
        data[strlen(data) - 1] = '\0';
        free_ptr = ast_free_ptr;
        if (ast_strlen_zero(app) || ast_strlen_zero(data)) {
            ast_free(data);
            return -1;
        }
    }
 
    /* Don't disturb existing, exact-match, entries. */
    context_name = ast_get_context_name(context);
    if ((existing_exten = pbx_find_extension(NULL, NULL, &find_info, context_name, exten,
        priority, NULL, NULL, E_MATCH))) {
        const char *existing_app = ast_get_extension_app(existing_exten);
        const char *existing_data = ast_get_extension_app_data(existing_exten);
        if (!strcmp(existing_app, app)
            && !strcmp(existing_data ? existing_data : "", data ? data : "")) {
            ast_free(data);
            return 0;
        }
 
        ast_context_remove_extension2(context, exten, priority, BASE_REGISTRAR, 1);
    }
 
    if (ast_add_extension2_nolock(context, 0, exten, priority, NULL, NULL,
            app, data, free_ptr, BASE_REGISTRAR, NULL, 0)) {
        return -1;
    }
 
    return 0;
}

References app, ast_add_extension2_nolock(), ast_context_remove_extension2(), ast_free, ast_free_ptr(), ast_get_context_name(), ast_get_extension_app(), ast_get_extension_app_data(), ast_strdup, ast_strdupa, ast_strlen_zero(), BASE_REGISTRAR, context_name, ast_exten::data, E_MATCH, ast_exten::exten, NULL, paren, pbx_find_extension(), priority, and pbx_find_info::stacklen.

Referenced by add_hints().

add_hints()

static int add_hints ( const char *  context, const char *  exten, const char *  application, const char *  id  )

static

Definition at line 501 of file res_pjsip_config_wizard.c.

{
    struct ast_context *hint_context;
    char *hint_device;
 
    hint_device = ast_alloca(strlen("PJSIP/") + strlen(id) + 1);
    sprintf(hint_device, "PJSIP/%s", id);
 
    /* We need the contexts list locked to safely be able to both read and lock the specific context within */
    if (ast_wrlock_contexts()) {
        ast_log(LOG_ERROR, "Failed to lock the contexts list.\n");
        return -1;
    }
 
    if (!(hint_context = ast_context_find_or_create(NULL, NULL, context, BASE_REGISTRAR))) {
        ast_log(LOG_ERROR, "Unable to find or create hint context '%s'\n", context);
        if (ast_unlock_contexts()) {
            ast_assert(0);
        }
        return -1;
    }
 
    /* Transfer the all-contexts lock to the specific context */
    if (ast_wrlock_context(hint_context)) {
        ast_unlock_contexts();
        ast_log(LOG_ERROR, "failed to obtain write lock on context\n");
        return -1;
    }
    ast_unlock_contexts();
 
    if (add_extension(hint_context, exten, PRIORITY_HINT, hint_device)) {
        ast_log(LOG_ERROR, "Failed to add hint '%s@%s' to the PBX.\n",
                exten, context);
    }
 
    if (!ast_strlen_zero(application)) {
        if (add_extension(hint_context, exten, 1, application)) {
            ast_log(LOG_ERROR, "Failed to add hint '%s@%s' to the PBX.\n",
                    exten, context);
        }
    } else {
        ast_context_remove_extension2(hint_context, exten, 1, BASE_REGISTRAR, 1);
    }
 
    ast_unlock_context(hint_context);
 
    return 0;
}

References add_extension(), ast_alloca, ast_assert, ast_context_find_or_create(), ast_context_remove_extension2(), ast_log, ast_strlen_zero(), ast_unlock_context(), ast_unlock_contexts(), ast_wrlock_context(), ast_wrlock_contexts(), BASE_REGISTRAR, LOG_ERROR, NULL, and PRIORITY_HINT.

Referenced by handle_endpoint().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 1399 of file res_pjsip_config_wizard.c.

AST_VECTOR_RW()

static AST_VECTOR_RW (   object_type_wizards, struct object_type_wizard *    )

static

Definition at line 292 of file res_pjsip_config_wizard.c.

                            { \
    ast_config_destroy(otw->last_config); \
    ast_free(otw); \
})
 
const static char *object_types[] = {"phoneprov", "registration", "identify", "endpoint", "aor", "auth", NULL};

References NULL.

create_object()

static void * create_object ( const struct ast_sorcery *  sorcery, const char *  id, const char *  type, struct ast_variable *  vars  )

static

Creates a sorcery object and applies a variable list.

Definition at line 350 of file res_pjsip_config_wizard.c.

{
    struct ast_sorcery_object *obj = ast_sorcery_alloc(sorcery, type, id);
 
    if (!obj) {
        ast_log(LOG_ERROR, "Unable to allocate an object of type '%s' with id '%s'.\n", type, id);
        return NULL;
    }
 
    if (ast_sorcery_objectset_apply(sorcery, obj, vars)) {
        ast_log(LOG_ERROR, "Unable to apply object type '%s' with id '%s'.  Check preceeding errors.\n", type, id);
        ao2_ref(obj, -1);
        return NULL;
    }
 
    return obj;
}

References ao2_ref, ast_log, ast_sorcery_alloc(), ast_sorcery_objectset_apply(), LOG_ERROR, NULL, sorcery, and type.

Referenced by handle_aor(), handle_auth(), handle_endpoint(), handle_identify(), handle_phoneprov(), and handle_registrations().

delete_existing_cb()

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

static

Definition at line 844 of file res_pjsip_config_wizard.c.

{
    struct object_type_wizard *otw = arg;
 
    if (!strcmp(otw->object_type, "endpoint")) {
        const char *context = ast_sorcery_object_get_extended(obj, "hint_context");
        const char *exten = ast_sorcery_object_get_extended(obj, "hint_exten");
        if (!ast_strlen_zero(context) && !ast_strlen_zero(exten)) {
            delete_extens(context, exten);
        }
    }
 
    otw->wizard->delete(otw->sorcery, otw->wizard_data, obj);
 
    return CMP_MATCH;
}

References ast_sorcery_object_get_extended(), ast_strlen_zero(), CMP_MATCH, ast_sorcery_wizard::delete, delete_extens(), object_type_wizard::object_type, object_type_wizard::sorcery, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by handle_registrations(), and object_type_loaded_observer().

delete_extens()

static int delete_extens ( const char *  context, const char *  exten  )

static

Definition at line 424 of file res_pjsip_config_wizard.c.

{
    struct pbx_find_info find_info = { .stacklen = 0 }; /* the rest is reset in pbx_find_extension */
 
    if (pbx_find_extension(NULL, NULL, &find_info, context, exten, PRIORITY_HINT, NULL, NULL, E_MATCH)) {
        ast_context_remove_extension(context, exten, PRIORITY_HINT, BASE_REGISTRAR);
    }
 
    if (pbx_find_extension(NULL, NULL, &find_info, context, exten, 1, NULL, NULL, E_MATCH)) {
        ast_context_remove_extension(context, exten, 1, BASE_REGISTRAR);
    }
 
    return 0;
}

References ast_context_remove_extension(), BASE_REGISTRAR, E_MATCH, NULL, pbx_find_extension(), PRIORITY_HINT, and pbx_find_info::stacklen.

Referenced by delete_existing_cb(), and handle_endpoint().

find_wizard()

static struct object_type_wizard * find_wizard ( const char *  object_type )

static

Finds the otw for the object type.

Definition at line 332 of file res_pjsip_config_wizard.c.

{
    int idx;
 
    AST_VECTOR_RW_RDLOCK(&object_type_wizards);
    for(idx = 0; idx < AST_VECTOR_SIZE(&object_type_wizards); idx++) {
        struct object_type_wizard *otw = AST_VECTOR_GET(&object_type_wizards, idx);
        if (!strcmp(otw->object_type, object_type)) {
            AST_VECTOR_RW_UNLOCK(&object_type_wizards);
            return otw;
        }
    }
    AST_VECTOR_RW_UNLOCK(&object_type_wizards);
 
    return NULL;
}

References AST_VECTOR_GET, AST_VECTOR_RW_RDLOCK, AST_VECTOR_RW_UNLOCK, AST_VECTOR_SIZE, NULL, and object_type_wizard::object_type.

Referenced by object_type_loaded_observer().

get_object_variables()

static struct ast_variable * get_object_variables ( struct ast_variable *  vars, char *  prefix  )

static

We need to strip off the prefix from the name of each variable so they're suitable for objectset_apply. I.E. will transform outbound_auth/username to username.

Definition at line 405 of file res_pjsip_config_wizard.c.

{
    struct ast_variable *return_vars = NULL;
    struct ast_variable *v = vars;
    int plen = strlen(prefix);
 
    for(; v; v = v->next) {
        if (ast_begins_with(v->name, prefix) && strlen(v->name) > plen) {
            if (variable_list_append(&return_vars, v->name + plen, v->value)) {
                ast_variables_destroy(return_vars);
                return NULL;
            }
        }
    }
 
    return return_vars;
}

References ast_begins_with(), ast_variables_destroy(), ast_variable::name, ast_variable::next, NULL, prefix, ast_variable::value, and variable_list_append().

Referenced by handle_aor(), handle_auth(), handle_endpoint(), handle_identify(), handle_phoneprov(), and handle_registrations().

handle_aor()

static int handle_aor ( const struct ast_sorcery *  sorcery, struct object_type_wizard *  otw, struct ast_category *  wiz, struct string_vector *  remote_hosts_vector  )

static

Definition at line 620 of file res_pjsip_config_wizard.c.

{
    struct ast_variable *wizvars = ast_category_first(wiz);
    struct ast_sorcery_object *obj = NULL;
    const char *id = ast_category_get_name(wiz);
    const char *contact_pattern;
    const char *outbound_proxy = ast_variable_find_last_in_list(wizvars, "outbound_proxy");
    int host_count = AST_VECTOR_SIZE(remote_hosts_vector);
    RAII_VAR(struct ast_variable *, vars, get_object_variables(wizvars, "aor/"), ast_variables_destroy);
 
    variable_list_append(&vars, "@pjsip_wizard", id);
 
    if (!ast_strlen_zero(outbound_proxy)) {
        variable_list_append_return(&vars, "outbound_proxy", outbound_proxy);
    }
 
    /* If the user explicitly specified an aor/contact, don't use remote hosts. */
    if (!ast_variable_find_last_in_list(vars, "contact")) {
        if (!(contact_pattern = ast_variable_find_last_in_list(wizvars, "contact_pattern"))) {
            contact_pattern = "sip:${REMOTE_HOST}";
        }
 
        if (host_count > 0 && !ast_strlen_zero(contact_pattern)) {
            int host_counter;
 
            /* ast_str_substitute_variables operate on a varshead list so we have
             * to create one to hold the REPORT_HOST substitution, do the substitution,
             * then append the result to the ast_variable list.
             */
            for (host_counter = 0; host_counter < host_count; host_counter++) {
                RAII_VAR(struct ast_str *, new_str, ast_str_create(64), ast_free);
                RAII_VAR(struct varshead *, subst_vars, ast_var_list_create(), ast_var_list_destroy);
                struct ast_var_t *var = ast_var_assign("REMOTE_HOST",
                    AST_VECTOR_GET(remote_hosts_vector, host_counter));
 
                AST_VAR_LIST_INSERT_TAIL(subst_vars, var);
                ast_str_substitute_variables_varshead(&new_str, 0, subst_vars,
                    contact_pattern);
 
                variable_list_append_return(&vars, "contact", ast_str_buffer(new_str));
            }
        }
    }
 
    obj = create_object(sorcery, id, "aor", vars);
    if (!obj) {
        return -1;
    }
 
    if (otw->wizard->update(sorcery, otw->wizard_data, obj)) {
        otw->wizard->create(sorcery, otw->wizard_data, obj);
    }
    ao2_ref(obj, -1);
 
    return 0;
}

References ao2_ref, ast_category_first(), ast_category_get_name(), ast_free, ast_str_buffer(), ast_str_create, ast_str_substitute_variables_varshead(), ast_strlen_zero(), ast_var_assign, ast_var_list_create(), ast_var_list_destroy(), AST_VAR_LIST_INSERT_TAIL(), ast_variable_find_last_in_list(), ast_variables_destroy(), AST_VECTOR_GET, AST_VECTOR_SIZE, ast_sorcery_wizard::create, create_object(), get_object_variables(), NULL, RAII_VAR, sorcery, ast_sorcery_wizard::update, var, variable_list_append(), variable_list_append_return, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by wizard_apply_handler().

handle_auth()

static int handle_auth ( const struct ast_sorcery *  sorcery, struct object_type_wizard *  otw, struct ast_category *  wiz, char *  direction  )

static

Definition at line 550 of file res_pjsip_config_wizard.c.

{
    struct ast_variable *wizvars = ast_category_first(wiz);
    struct ast_sorcery_object *obj = NULL;
    const char *id = ast_category_get_name(wiz);
    char new_id[strlen(id) + MAX_ID_SUFFIX];
    char prefix[strlen(direction) + strlen("_auth/") + 1];
    char *test_variable = NULL;
    RAII_VAR(struct ast_variable *, vars, NULL, ast_variables_destroy);
 
    snprintf(prefix, sizeof(prefix), "%s_auth/", direction);
    vars = get_object_variables(wizvars, prefix);
 
    if (!strcmp(direction, "outbound")) {
        snprintf(new_id, sizeof(new_id), "%s-oauth", id);
        test_variable = "sends_auth";
    } else {
        snprintf(new_id, sizeof(new_id), "%s-iauth", id);
        test_variable = "accepts_auth";
    }
 
    if (is_variable_true(wizvars, test_variable)) {
        if (!ast_variable_find_last_in_list(vars, "username")) {
            ast_log(LOG_ERROR,
                "Wizard '%s' must have '%s_auth/username' if it %s.\n", id, direction, test_variable);
            return -1;
        }
    } else {
        /* Delete auth if sends or accepts is now false. */
        obj = otw->wizard->retrieve_id(sorcery, otw->wizard_data, "auth", new_id);
        if (obj) {
            otw->wizard->delete(sorcery, otw->wizard_data, obj);
            ao2_ref(obj, -1);
        }
        return 0;
    }
 
    variable_list_append_return(&vars, "@pjsip_wizard", id);
 
    /* If the user set auth_type, don't override it. */
    if (!ast_variable_find_last_in_list(vars, "auth_type")) {
        variable_list_append_return(&vars, "auth_type", "userpass");
    }
 
    obj = create_object(sorcery, new_id, "auth", vars);
    if (!obj) {
        return -1;
    }
 
    if (otw->wizard->update(sorcery, otw->wizard_data, obj)) {
        otw->wizard->create(sorcery, otw->wizard_data, obj);
    }
    ao2_ref(obj, -1);
 
    return 0;
}

References ao2_ref, ast_category_first(), ast_category_get_name(), ast_log, ast_variable_find_last_in_list(), ast_variables_destroy(), ast_sorcery_wizard::create, create_object(), ast_sorcery_wizard::delete, get_object_variables(), is_variable_true(), LOG_ERROR, MAX_ID_SUFFIX, NULL, prefix, RAII_VAR, ast_sorcery_wizard::retrieve_id, sorcery, ast_sorcery_wizard::update, variable_list_append_return, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by handle_auths().

handle_auths()

static int handle_auths ( const struct ast_sorcery *  sorcery, struct object_type_wizard *  otw, struct ast_category *  wiz  )

static

Definition at line 608 of file res_pjsip_config_wizard.c.

{
    int rc;
 
    if ((rc = handle_auth(sorcery, otw, wiz, "outbound"))) {
        return rc;
    }
 
    return handle_auth(sorcery, otw, wiz, "inbound");
}

References handle_auth(), and sorcery.

Referenced by wizard_apply_handler().

handle_endpoint()

static int handle_endpoint ( const struct ast_sorcery *  sorcery, struct object_type_wizard *  otw, struct ast_category *  wiz  )

static

Definition at line 678 of file res_pjsip_config_wizard.c.

{
    struct ast_variable *wizvars = ast_category_first(wiz);
    struct ast_sorcery_object *obj = NULL;
    const char *id = ast_category_get_name(wiz);
    const char *outbound_proxy = ast_variable_find_last_in_list(wizvars, "outbound_proxy");
    const char *transport = ast_variable_find_last_in_list(wizvars, "transport");
    const char *hint_context = hint_context = ast_variable_find_last_in_list(wizvars, "hint_context");
    const char *hint_exten = ast_variable_find_last_in_list(wizvars, "hint_exten");
    const char *hint_application= ast_variable_find_last_in_list(wizvars, "hint_application");
    char new_id[strlen(id) + MAX_ID_SUFFIX];
    RAII_VAR(struct ast_variable *, vars, get_object_variables(wizvars, "endpoint/"), ast_variables_destroy);
 
    variable_list_append_return(&vars, "@pjsip_wizard", id);
    variable_list_append_return(&vars, "aors", id);
 
    if (!ast_strlen_zero(outbound_proxy)) {
        variable_list_append_return(&vars, "outbound_proxy", outbound_proxy);
    }
 
    if (ast_strlen_zero(hint_context)) {
        hint_context = ast_variable_find_last_in_list(vars, "context");
    }
 
    if (ast_strlen_zero(hint_context)) {
        hint_context = "default";
    }
 
    if (!ast_strlen_zero(hint_exten)) {
        /* These are added so we can find and delete the hints when the endpoint gets deleted */
        variable_list_append_return(&vars, "@hint_context", hint_context);
        variable_list_append_return(&vars, "@hint_exten", hint_exten);
    }
 
    if (!ast_strlen_zero(transport)) {
        variable_list_append_return(&vars, "transport", transport);
    }
 
    if (is_variable_true(wizvars, "sends_auth")) {
        snprintf(new_id, sizeof(new_id), "%s-oauth", id);
        variable_list_append_return(&vars, "outbound_auth", new_id);
    }
 
    if (is_variable_true(wizvars, "accepts_auth")) {
        snprintf(new_id, sizeof(new_id), "%s-iauth", id);
        variable_list_append_return(&vars, "auth", new_id);
    }
 
    obj = create_object(sorcery, id, "endpoint", vars);
    if (!obj) {
        return -1;
    }
 
    if (otw->wizard->update(sorcery, otw->wizard_data, obj)) {
        otw->wizard->create(sorcery, otw->wizard_data, obj);
    }
    ao2_ref(obj, -1);
 
    if (!ast_strlen_zero(hint_exten)) {
        if (is_variable_true(wizvars, "has_hint")) {
            add_hints(hint_context, hint_exten, hint_application, id);
        } else {
            delete_extens(hint_context, hint_exten);
        }
    }
 
    return 0;
}

References add_hints(), ao2_ref, ast_category_first(), ast_category_get_name(), ast_strlen_zero(), ast_variable_find_last_in_list(), ast_variables_destroy(), ast_sorcery_wizard::create, create_object(), delete_extens(), get_object_variables(), is_variable_true(), MAX_ID_SUFFIX, NULL, RAII_VAR, sorcery, ast_sorcery_wizard::update, variable_list_append_return, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by wizard_apply_handler().

handle_export_primitives()

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

static

Definition at line 1237 of file res_pjsip_config_wizard.c.

{
    struct ast_sorcery *sorcery;
    int idx;
    FILE *f = NULL;
    const char *fn = NULL;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "pjsip export config_wizard primitives [to]";
        e->usage =
            "Usage: pjsip export config_wizard primitives [ to <filename ]\n"
            "       Export the config_wizard objects as pjsip primitives to\n"
            "       the console or to <filename>\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc > 5) {
        char date[256]="";
        time_t t;
        fn = a->argv[5];
 
        time(&t);
        ast_copy_string(date, ctime(&t), sizeof(date));
        f = fopen(fn, "w");
        if (!f) {
            ast_log(LOG_ERROR, "Unable to write %s (%s)\n", fn, strerror(errno));
            return CLI_FAILURE;
        }
 
        fprintf(f, ";!\n");
        fprintf(f, ";! Automatically generated configuration file\n");
        fprintf(f, ";! Filename: %s\n", fn);
        fprintf(f, ";! Generator: %s\n", "'pjsip export config_wizard primitives'");
        fprintf(f, ";! Creation Date: %s", date);
        fprintf(f, ";!\n");
    }
 
    sorcery = ast_sip_get_sorcery();
 
    AST_VECTOR_RW_RDLOCK(&object_type_wizards);
    for(idx = 0; idx < AST_VECTOR_SIZE(&object_type_wizards); idx++) {
        struct object_type_wizard *otw = AST_VECTOR_GET(&object_type_wizards, idx);
        struct ao2_container *container;
        struct ao2_iterator i;
        void *o;
 
        container = ast_sorcery_retrieve_by_fields(sorcery, otw->object_type, AST_RETRIEVE_FLAG_MULTIPLE, NULL);
        if (!container) {
            continue;
        }
 
        i = ao2_iterator_init(container, 0);
        while ((o = ao2_iterator_next(&i))) {
            struct ast_variable *vars;
            struct ast_variable *v;
 
            vars = ast_sorcery_objectset_create(sorcery, o);
            if (vars && ast_variable_find_in_list(vars, "@pjsip_wizard")) {
                if (f) {
                    fprintf(f, "\n[%s]\ntype = %s\n", ast_sorcery_object_get_id(o), otw->object_type);
                } else {
                    ast_cli(a->fd, "\n[%s]\ntype = %s\n", ast_sorcery_object_get_id(o), otw->object_type);
                }
                for (v = vars; v; v = v->next) {
                    if (!ast_strlen_zero(v->value)) {
                        if (f) {
                            fprintf(f, "%s = %s\n", v->name, v->value);
                        } else {
                            ast_cli(a->fd, "%s = %s\n", v->name, v->value);
                        }
                    }
                }
            }
            ast_variables_destroy(vars);
            ao2_ref(o, -1);
        }
        ao2_iterator_destroy(&i);
        ao2_cleanup(container);
    }
    AST_VECTOR_RW_UNLOCK(&object_type_wizards);
 
    if (f) {
        fclose(f);
        ast_cli(a->fd, "Wrote configuration to %s\n", fn);
    }
 
 
    return CLI_SUCCESS;
}

References a, ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_cli(), ast_copy_string(), ast_log, AST_RETRIEVE_FLAG_MULTIPLE, ast_sip_get_sorcery(), ast_sorcery_object_get_id(), ast_sorcery_objectset_create, ast_sorcery_retrieve_by_fields(), ast_strlen_zero(), ast_variable_find_in_list(), ast_variables_destroy(), AST_VECTOR_GET, AST_VECTOR_RW_RDLOCK, AST_VECTOR_RW_UNLOCK, AST_VECTOR_SIZE, CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, container, errno, LOG_ERROR, ast_variable::name, ast_variable::next, NULL, object_type_wizard::object_type, sorcery, ast_cli_entry::usage, and ast_variable::value.

handle_identify()

static int handle_identify ( const struct ast_sorcery *  sorcery, struct object_type_wizard *  otw, struct ast_category *  wiz, struct string_vector *  remote_hosts_vector  )

static

Definition at line 748 of file res_pjsip_config_wizard.c.

{
    struct ast_variable *wizvars = ast_category_first(wiz);
    struct ast_sorcery_object *obj = NULL;
    const char *id = ast_category_get_name(wiz);
    char new_id[strlen(id) + MAX_ID_SUFFIX];
    int host_count = AST_VECTOR_SIZE(remote_hosts_vector);
    int host_counter;
    RAII_VAR(struct ast_variable *, vars, get_object_variables(wizvars, "identify/"), ast_variables_destroy);
 
    snprintf(new_id, sizeof(new_id), "%s-identify", id);
 
    /* If accepting registrations or we're sending line, we don't need an identify. */
    if (is_variable_true(wizvars, "accepts_registrations")
        || is_variable_true(wizvars, "sends_line_with_registrations")) {
        /* If one exists, delete it. */
        obj = otw->wizard->retrieve_id(sorcery, otw->wizard_data, "identify", new_id);
        if (obj) {
            otw->wizard->delete(sorcery, otw->wizard_data, obj);
            ao2_ref(obj, -1);
        }
        return 0;
    }
 
    if (!host_count) {
        ast_log(LOG_ERROR,
            "Wizard '%s' must have 'remote_hosts' if it doesn't accept registrations.\n", id);
        return -1;
    }
 
    variable_list_append_return(&vars, "endpoint", id);
    variable_list_append_return(&vars, "@pjsip_wizard", id);
 
    if (!ast_variable_find_last_in_list(vars, "match")) {
        for (host_counter = 0; host_counter < host_count; host_counter++) {
            variable_list_append_return(&vars, "match",
                AST_VECTOR_GET(remote_hosts_vector, host_counter));
        }
    }
 
    obj = create_object(sorcery, new_id, "identify", vars);
    if (!obj) {
        return -1;
    }
 
    if (otw->wizard->update(sorcery, otw->wizard_data, obj)) {
        otw->wizard->create(sorcery, otw->wizard_data, obj);
    }
    ao2_ref(obj, -1);
 
    return 0;
}

References ao2_ref, ast_category_first(), ast_category_get_name(), ast_log, ast_variable_find_last_in_list(), ast_variables_destroy(), AST_VECTOR_GET, AST_VECTOR_SIZE, ast_sorcery_wizard::create, create_object(), ast_sorcery_wizard::delete, get_object_variables(), is_variable_true(), LOG_ERROR, MAX_ID_SUFFIX, NULL, RAII_VAR, ast_sorcery_wizard::retrieve_id, sorcery, ast_sorcery_wizard::update, variable_list_append_return, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by wizard_apply_handler().

handle_phoneprov()

static int handle_phoneprov ( const struct ast_sorcery *  sorcery, struct object_type_wizard *  otw, struct ast_category *  wiz  )

static

Definition at line 802 of file res_pjsip_config_wizard.c.

{
    struct ast_variable *wizvars = ast_category_first(wiz);
    struct ast_sorcery_object *obj = NULL;
    const char *id = ast_category_get_name(wiz);
    char new_id[strlen(id) + MAX_ID_SUFFIX];
    RAII_VAR(struct ast_variable *, vars, get_object_variables(wizvars, "phoneprov/"), ast_variables_destroy);
 
    snprintf(new_id, sizeof(new_id), "%s-phoneprov", id);
 
    if (!is_variable_true(wizvars, "has_phoneprov")) {
        obj = otw->wizard->retrieve_id(sorcery, otw->wizard_data, "phoneprov", new_id);
        if (obj) {
            otw->wizard->delete(sorcery, otw->wizard_data, obj);
            ao2_ref(obj, -1);
        }
        return 0;
    }
 
    if (!ast_variable_find_last_in_list(wizvars, "phoneprov/MAC")) {
        ast_log(LOG_ERROR,
            "Wizard '%s' must have 'phoneprov/MAC' if it has_phoneprov.\n", id);
        return -1;
    }
 
    variable_list_append_return(&vars, "endpoint", id);
    variable_list_append_return(&vars, "@pjsip_wizard", id);
 
    obj = create_object(sorcery, new_id, "phoneprov", vars);
    if (!obj) {
        return -1;
    }
 
    if (otw->wizard->update(sorcery, otw->wizard_data, obj)) {
        otw->wizard->create(sorcery, otw->wizard_data, obj);
    }
    ao2_ref(obj, -1);
 
    return 0;
}

References ao2_ref, ast_category_first(), ast_category_get_name(), ast_log, ast_variable_find_last_in_list(), ast_variables_destroy(), ast_sorcery_wizard::create, create_object(), ast_sorcery_wizard::delete, get_object_variables(), is_variable_true(), LOG_ERROR, MAX_ID_SUFFIX, NULL, RAII_VAR, ast_sorcery_wizard::retrieve_id, sorcery, ast_sorcery_wizard::update, variable_list_append_return, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by wizard_apply_handler().

handle_registrations()

static int handle_registrations ( const struct ast_sorcery *  sorcery, struct object_type_wizard *  otw, struct ast_category *  wiz, struct string_vector *  remote_hosts_vector  )

static

Definition at line 861 of file res_pjsip_config_wizard.c.

{
    struct ast_variable *search;
    struct ast_variable *wizvars = ast_category_first(wiz);
    const char *id = ast_category_get_name(wiz);
    const char *server_uri_pattern;
    const char *client_uri_pattern;
    const char *outbound_proxy = ast_variable_find_last_in_list(wizvars, "outbound_proxy");
    const char *transport = ast_variable_find_last_in_list(wizvars, "transport");
    const char *username;
    char new_id[strlen(id) + MAX_ID_SUFFIX];
    int host_count = AST_VECTOR_SIZE(remote_hosts_vector);
    int host_counter;
    RAII_VAR(struct ast_variable *, vars, get_object_variables(wizvars, "registration/"), ast_variables_destroy);
    RAII_VAR(struct ao2_container *, existing,
        ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, NULL, NULL), ao2_cleanup);
 
    if (!existing) {
        return -1;
    }
 
    /* Find any existing registrations. */
    search = ast_variable_new("@pjsip_wizard", id, "");
    if (!search) {
        return -1;
    }
 
    if (!ast_strlen_zero(outbound_proxy)) {
        variable_list_append_return(&vars, "outbound_proxy", outbound_proxy);
    }
 
    otw->wizard->retrieve_multiple(sorcery, otw->wizard_data, "registration", existing, search);
    ast_variables_destroy(search);
 
    /* If not sending registrations, delete ALL existing registrations for this wizard. */
    if (!is_variable_true(wizvars, "sends_registrations")) {
        if (ao2_container_count(existing) > 0) {
            ao2_callback(existing, OBJ_NODATA | OBJ_UNLINK | OBJ_MULTIPLE, delete_existing_cb, otw);
        }
        return 0;
    }
 
    if (!host_count) {
        ast_log(LOG_ERROR, "Wizard '%s' must have 'remote_hosts' if it sends registrations.\n", id);
        return -1;
    }
 
    variable_list_append_return(&vars, "@pjsip_wizard", id);
 
    if (!(server_uri_pattern = ast_variable_find_last_in_list(wizvars, "server_uri_pattern"))) {
        server_uri_pattern = "sip:${REMOTE_HOST}";
    }
 
    if (!(client_uri_pattern = ast_variable_find_last_in_list(wizvars, "client_uri_pattern"))) {
        client_uri_pattern = "sip:${USERNAME}@${REMOTE_HOST}";
    }
 
    if (is_variable_true(wizvars, "sends_auth")) {
        if (!(username = ast_variable_find_last_in_list(wizvars, "outbound_auth/username"))) {
            ast_log(LOG_ERROR, "Wizard '%s' must have 'outbound_auth/username' if it sends"
                " authentication.\n", id);
            return -1;
        }
    } else {
        username = id;
    }
 
 
    /* Unlike aor and identify, we need to create a separate registration object
     * for each remote host.
     */
    for (host_counter = 0; host_counter < host_count; host_counter++) {
        struct ast_var_t *rh = ast_var_assign("REMOTE_HOST",
            AST_VECTOR_GET(remote_hosts_vector, host_counter));
        struct ast_var_t *un = ast_var_assign("USERNAME", username);
        struct ast_sorcery_object *obj;
        RAII_VAR(struct ast_str *, uri, ast_str_create(64), ast_free);
        RAII_VAR(struct varshead *, subst_vars, ast_var_list_create(), ast_var_list_destroy);
        RAII_VAR(struct ast_variable *, registration_vars, vars ? ast_variables_dup(vars) : NULL, ast_variables_destroy);
 
        AST_VAR_LIST_INSERT_TAIL(subst_vars, rh);
        AST_VAR_LIST_INSERT_TAIL(subst_vars, un);
 
        if (!ast_strlen_zero(server_uri_pattern)) {
            ast_str_substitute_variables_varshead(&uri, 0, subst_vars,
                server_uri_pattern);
            variable_list_append_return(&registration_vars, "server_uri", ast_str_buffer(uri));
        }
 
        if (!ast_strlen_zero(client_uri_pattern)) {
            ast_str_reset(uri);
            ast_str_substitute_variables_varshead(&uri, 0, subst_vars,
                client_uri_pattern);
            variable_list_append_return(&registration_vars, "client_uri", ast_str_buffer(uri));
        }
 
        if (is_variable_true(wizvars, "sends_auth")) {
            snprintf(new_id, sizeof(new_id), "%s-oauth", id);
            variable_list_append_return(&registration_vars, "outbound_auth", new_id);
        }
 
        if (!ast_strlen_zero(transport)) {
            variable_list_append_return(&registration_vars, "transport", transport);
        }
 
        if (is_variable_true(wizvars, "sends_line_with_registrations")) {
            variable_list_append_return(&registration_vars, "line", "yes");
            variable_list_append_return(&registration_vars, "endpoint", id);
        }
 
        snprintf(new_id, sizeof(new_id), "%s-reg-%d", id, host_counter);
 
        obj = create_object(sorcery, new_id, "registration", registration_vars);
        if (!obj) {
            return -1;
        }
 
        if (otw->wizard->update(sorcery, otw->wizard_data, obj)) {
            otw->wizard->create(sorcery, otw->wizard_data, obj);
        }
        ao2_ref(obj, -1);
 
        /* Unlink it from the 'existing' container.  Any left will be deleted from
         * sorcery.  If it wasn't in the existing container, no harm.
         */
        ao2_callback(existing, OBJ_NODATA | OBJ_UNLINK | OBJ_SEARCH_KEY, ast_sorcery_object_id_compare, new_id);
    }
 
    /* If there are any excess registrations, delete them. */
    if (ao2_container_count(existing) > 0) {
        ao2_callback(existing, OBJ_NODATA | OBJ_UNLINK | OBJ_MULTIPLE, delete_existing_cb, otw);
    }
 
    return 0;
}

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_callback, ao2_cleanup, ao2_container_alloc_list, ao2_container_count(), ao2_ref, ast_category_first(), ast_category_get_name(), ast_free, ast_log, ast_sorcery_object_id_compare(), ast_str_buffer(), ast_str_create, ast_str_reset(), ast_str_substitute_variables_varshead(), ast_strlen_zero(), ast_var_assign, ast_var_list_create(), ast_var_list_destroy(), AST_VAR_LIST_INSERT_TAIL(), ast_variable_find_last_in_list(), ast_variable_new, ast_variables_destroy(), ast_variables_dup(), AST_VECTOR_GET, AST_VECTOR_SIZE, ast_sorcery_wizard::create, create_object(), delete_existing_cb(), get_object_variables(), id, is_variable_true(), LOG_ERROR, MAX_ID_SUFFIX, NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_SEARCH_KEY, OBJ_UNLINK, RAII_VAR, ast_sorcery_wizard::retrieve_multiple, rh, sorcery, ast_sorcery_wizard::update, variable_list_append_return, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by wizard_apply_handler().

instance_created_observer()

static void instance_created_observer ( const char *  name, struct ast_sorcery *  sorcery  )

static

When the res_pjsip instance is created, add an observer to it and initialize the wizard vector. Also, bump the module's ref count so it can't be unloaded before the sorcery instance is destroyed.

Definition at line 1215 of file res_pjsip_config_wizard.c.

{
    if (strcmp(name, "res_pjsip")) {
        return;
    }
    ast_module_ref(ast_module_info->self);
    ast_sorcery_instance_observer_add(sorcery, &observer);
}

References ast_module_ref, ast_sorcery_instance_observer_add(), name, observer, ast_module_info::self, and sorcery.

instance_destroying_observer()

static void instance_destroying_observer ( const char *  name, struct ast_sorcery *  sorcery  )

static

When the res_pjsip instance is destroyed, remove the observer and unref the module. This should then allow this module to unload cleanly.

Definition at line 1227 of file res_pjsip_config_wizard.c.

{
    if (strcmp(name, "res_pjsip")) {
        return;
    }
 
    ast_sorcery_instance_observer_remove(sorcery, &observer);
    ast_module_unref(ast_module_info->self);
}

References ast_module_unref, ast_sorcery_instance_observer_remove(), name, observer, ast_module_info::self, and sorcery.

is_one_of()

static int is_one_of ( const char *  needle, const char *  haystack[]  )

static

Definition at line 319 of file res_pjsip_config_wizard.c.

{
    int i;
    for (i = 0; haystack[i]; i++) {
        if (!strcmp(needle, haystack[i])) {
            return 1;
        }
    }
 
    return 0;
}

Referenced by object_type_registered_observer().

is_variable_true()

static int is_variable_true ( struct ast_variable *  vars, const char *  name  )

static

Finds the last variable in a list and tests it.

Definition at line 370 of file res_pjsip_config_wizard.c.

{
    return ast_true(ast_variable_find_last_in_list(vars, name));
}

References ast_true(), ast_variable_find_last_in_list(), and name.

Referenced by handle_auth(), handle_endpoint(), handle_identify(), handle_phoneprov(), and handle_registrations().

load_module()

static int load_module ( void  )

static

Definition at line 1340 of file res_pjsip_config_wizard.c.

{
    AST_VECTOR_RW_INIT(&object_type_wizards, 12);
    ast_sorcery_global_observer_add(&global_observer);
    ast_cli_register_multiple(config_wizard_cli, ARRAY_LEN(config_wizard_cli));
 
    acl_change_sub = stasis_subscribe(ast_security_topic(), acl_change_stasis_cb, NULL);
 
    /* If the PJSIP sorcery instance exists it means that we have been explicitly
     * loaded and things are potentially already set up. Since we won't receive any
     * observer callbacks informing us of this we add ourselves to the instance
     * as an observer in case it goes away, and determine which object types have
     * been registered and synthesize the observer callbacks for them. Once done
     * we force a reload so we are aware of the state of things.
     */
    if (ast_sip_get_sorcery()) {
        int i;
 
        ast_module_ref(ast_module_info->self);
        ast_sorcery_instance_observer_add(ast_sip_get_sorcery(), &observer);
 
        /* See which object types already exist */
        for (i = 0; i < ARRAY_LEN(object_types); ++i) {
            if (!object_types[i]) {
                break;
            } else if (!ast_sorcery_get_object_type(ast_sip_get_sorcery(), object_types[i])) {
                continue;
            }
 
            object_type_registered_observer("res_pjsip", ast_sip_get_sorcery(),
                object_types[i]);
        }
 
        ast_sorcery_reload(ast_sip_get_sorcery());
    }
 
    return AST_MODULE_LOAD_SUCCESS;
}

References acl_change_stasis_cb(), acl_change_sub, ARRAY_LEN, ast_cli_register_multiple, AST_MODULE_LOAD_SUCCESS, ast_module_ref, ast_security_topic(), ast_sip_get_sorcery(), ast_sorcery_get_object_type(), ast_sorcery_global_observer_add(), ast_sorcery_instance_observer_add(), ast_sorcery_reload(), AST_VECTOR_RW_INIT, config_wizard_cli, global_observer, NULL, object_type_registered_observer(), observer, ast_module_info::self, and stasis_subscribe.

object_type_loaded_observer()

static void object_type_loaded_observer ( const char *  name, const struct ast_sorcery *  sorcery, const char *  object_type, int  reloaded  )

static

Called after an object type is loaded/reloaded.

Definition at line 1066 of file res_pjsip_config_wizard.c.

{
    struct ast_category *category = NULL;
    struct object_type_wizard *otw = NULL;
    char *filename = "pjsip_wizard.conf";
    struct ast_flags flags = { 0 };
    struct ast_config *cfg;
 
    if (!strstr("auth aor endpoint identify registration phoneprov", object_type)) {
        /* Not interested. */
        return;
    }
 
    otw = find_wizard(object_type);
    if (!otw) {
        ast_log(LOG_ERROR, "There was no wizard for object type '%s'\n", object_type);
        return;
    }
 
    /* Only use the FILEUNCHANGED optimization if the ACLs haven't changed.
     * If ACLs changed, we force a reload of the config file to re-evaluate rules. */
    if (reloaded && otw->last_config && !acl_change_detected) {
        flags.flags = CONFIG_FLAG_FILEUNCHANGED;
    }
 
    cfg = ast_config_load2(filename, object_type, flags);
 
    if (!cfg) {
        ast_log(LOG_ERROR, "Unable to load config file '%s'\n", filename);
        return;
    } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
        ast_debug(2, "Config file '%s' was unchanged for '%s'.\n", filename, object_type);
        return;
    } else if (cfg == CONFIG_STATUS_FILEINVALID) {
        ast_log(LOG_ERROR, "Contents of config file '%s' are invalid and cannot be parsed\n", filename);
        return;
    }
 
    while ((category = ast_category_browse_filtered(cfg, NULL, category, "type=^wizard$"))) {
        const char *id = ast_category_get_name(category);
        struct ast_category *last_cat = NULL;
        int changes = 0;
 
        if (otw->last_config) {
            last_cat = ast_category_get(otw->last_config, id, "type=^wizard$");
            changes = !ast_variable_lists_match(ast_category_first(category), ast_category_first(last_cat), 1);
 
            /* If the ACL has changed, we assume EVERYTHING might have changed.
             * We force an update for all wizard objects. */
            if (!changes && reloaded && acl_change_detected) {
                ast_debug(3, "Forcing update of wizard '%s' due to global ACL change.\n", id);
                changes = 1;
            }
 
            if (last_cat) {
                ast_category_delete(otw->last_config, last_cat);
            }
        }
 
        if (!last_cat || changes) {
            ast_debug(3, "%s: %s(s) for wizard '%s'\n", reloaded ? "Reload" : "Load", object_type, id);
            if (wizard_apply_handler(sorcery, otw, category)) {
                ast_log(LOG_ERROR, "Unable to create objects for wizard '%s'\n", id);
            }
        }
    }
 
    if (!otw->last_config) {
        otw->last_config = cfg;
        return;
    }
 
    /* Only wizards that weren't in the new config are left in last_config now so we need to delete
     * all objects belonging to them.
     */
    category = NULL;
    while ((category = ast_category_browse_filtered(otw->last_config, NULL, category, "type=^wizard$"))) {
        const char *id = ast_category_get_name(category);
        struct ast_variable *search;
        RAII_VAR(struct ao2_container *, existing,
            ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, NULL, NULL), ao2_cleanup);
 
        if (!existing) {
            ast_log(LOG_ERROR, "Unable to allocate temporary container.\n");
            break;
        }
 
        search = ast_variable_new("@pjsip_wizard", id, "");
        if (!search) {
            ast_log(LOG_ERROR, "Unable to allocate memory for vaiable '@pjsip_wizard'.\n");
            break;
        }
        otw->wizard->retrieve_multiple(sorcery, otw->wizard_data, object_type, existing, search);
        ast_variables_destroy(search);
 
        if (ao2_container_count(existing) > 0) {
            ast_debug(3, "Delete on %s: %d %s(s) for wizard: %s\n",
                reloaded ? "Reload" : "Load", ao2_container_count(existing), object_type, id);
            ao2_callback(existing, OBJ_NODATA | OBJ_UNLINK | OBJ_MULTIPLE,
                delete_existing_cb, otw);
        }
    }
 
    ast_config_destroy(otw->last_config);
    otw->last_config = cfg;
}

References acl_change_detected, AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_callback, ao2_cleanup, ao2_container_alloc_list, ao2_container_count(), ast_category_browse_filtered(), ast_category_delete(), ast_category_first(), ast_category_get(), ast_category_get_name(), ast_config_destroy(), ast_config_load2(), ast_debug, ast_log, ast_variable_lists_match(), ast_variable_new, ast_variables_destroy(), CONFIG_FLAG_FILEUNCHANGED, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEUNCHANGED, delete_existing_cb(), find_wizard(), ast_flags::flags, id, object_type_wizard::last_config, LOG_ERROR, NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_UNLINK, RAII_VAR, ast_sorcery_wizard::retrieve_multiple, sorcery, object_type_wizard::wizard, wizard_apply_handler(), and object_type_wizard::wizard_data.

object_type_registered_observer()

static void object_type_registered_observer ( const char *  name, struct ast_sorcery *  sorcery, const char *  object_type  )

static

When each object type is registered, map a memory wizard to it.

Definition at line 1175 of file res_pjsip_config_wizard.c.

{
    struct ast_sorcery_wizard *wizard;
    void *wizard_data;
    struct object_type_wizard *otw;
 
    if (is_one_of(object_type, object_types)) {
        if (ast_sorcery_object_type_apply_wizard(sorcery, object_type,
            "memory", "pjsip_wizard", AST_SORCERY_WIZARD_APPLY_READONLY | AST_SORCERY_WIZARD_APPLY_ALLOW_DUPLICATE,
            &wizard, &wizard_data) != AST_SORCERY_APPLY_SUCCESS) {
            ast_log(LOG_ERROR, "Unable to apply sangoma wizard to object type '%s'\n", object_type);
            return;
        }
 
        otw = ast_malloc(sizeof(*otw) + strlen(object_type) + 1);
        if (!otw) {
            return;
        }
 
        otw->sorcery = sorcery;
        otw->wizard = wizard;
        otw->wizard_data = wizard_data;
        otw->last_config = NULL;
        strcpy(otw->object_type, object_type); /* Safe */
        AST_VECTOR_RW_WRLOCK(&object_type_wizards);
        if (AST_VECTOR_APPEND(&object_type_wizards, otw)) {
            ast_free(otw);
        } else {
            ast_debug(1, "Wizard mapped for object_type '%s'\n", object_type);
        }
        AST_VECTOR_RW_UNLOCK(&object_type_wizards);
 
    }
}

References ast_debug, ast_free, ast_log, ast_malloc, AST_SORCERY_APPLY_SUCCESS, ast_sorcery_object_type_apply_wizard, AST_SORCERY_WIZARD_APPLY_ALLOW_DUPLICATE, AST_SORCERY_WIZARD_APPLY_READONLY, AST_VECTOR_APPEND, AST_VECTOR_RW_UNLOCK, AST_VECTOR_RW_WRLOCK, is_one_of(), object_type_wizard::last_config, LOG_ERROR, NULL, object_type_wizard::object_type, sorcery, object_type_wizard::sorcery, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by load_module().

reload_module()

static int reload_module ( void  )

static

Definition at line 1334 of file res_pjsip_config_wizard.c.

{
    ast_sorcery_reload(ast_sip_get_sorcery());
    return 0;
}

References ast_sip_get_sorcery(), and ast_sorcery_reload().

unload_module()

static int unload_module ( void  )

static

Definition at line 1379 of file res_pjsip_config_wizard.c.

{
    if (acl_change_sub) {
        acl_change_sub = stasis_unsubscribe_and_join(acl_change_sub);
    }
 
    ast_cli_unregister_multiple(config_wizard_cli, ARRAY_LEN(config_wizard_cli));
    ast_sorcery_global_observer_remove(&global_observer);
    AST_VECTOR_REMOVE_ALL_CMP_UNORDERED(&object_type_wizards, NULL, NOT_EQUALS, OTW_DELETE_CB);
    AST_VECTOR_RW_FREE(&object_type_wizards);
 
    return 0;
}

References acl_change_sub, ARRAY_LEN, ast_cli_unregister_multiple(), ast_sorcery_global_observer_remove(), AST_VECTOR_REMOVE_ALL_CMP_UNORDERED, AST_VECTOR_RW_FREE, config_wizard_cli, global_observer, NOT_EQUALS, NULL, OTW_DELETE_CB, and stasis_unsubscribe_and_join().

variable_list_append()

static int variable_list_append ( struct ast_variable **  existing, const char *  name, const char *  value  )

static

Appends a variable to the end of an existing list.

Definition at line 376 of file res_pjsip_config_wizard.c.

{
    struct ast_variable *new = ast_variable_new(name, value, "");
 
    if (!new) {
        ast_log(LOG_ERROR, "Unable to allocate memory for new variable '%s'.\n", name);
        return -1;
    }
 
    ast_variable_list_append(existing, new);
 
    return 0;
}

References ast_log, ast_variable_list_append, ast_variable_new, LOG_ERROR, name, and value.

Referenced by get_object_variables(), and handle_aor().

wizard_apply_handler()

static int wizard_apply_handler ( const struct ast_sorcery *  sorcery, struct object_type_wizard *  otw, struct ast_category *  wiz  )

static

Definition at line 998 of file res_pjsip_config_wizard.c.

{
    struct ast_variable *wizvars = ast_category_first(wiz);
    struct string_vector remote_hosts_vector;
    const char *remote_hosts;
    int rc = -1;
 
    AST_VECTOR_INIT(&remote_hosts_vector, 16);
    remote_hosts = ast_variable_find_last_in_list(wizvars, "remote_hosts");
 
    if (!ast_strlen_zero(remote_hosts)) {
        char *host;
        char *hosts = ast_strdupa(remote_hosts);
 
        while ((host = ast_strsep(&hosts, ',', AST_STRSEP_TRIM))) {
            host = ast_strdup(host);
            if (host && AST_VECTOR_APPEND(&remote_hosts_vector, host)) {
                ast_free(host);
            }
        }
    }
 
    ast_debug(4, "%s handler starting.\n", otw->object_type);
 
    if (!strcmp(otw->object_type, "auth")) {
        rc = handle_auths(sorcery, otw, wiz);
    } else if (!strcmp(otw->object_type, "aor")) {
        rc = handle_aor(sorcery, otw, wiz, &remote_hosts_vector);
    } else if (!strcmp(otw->object_type, "endpoint")) {
        rc = handle_endpoint(sorcery, otw, wiz);
    } else if (!strcmp(otw->object_type, "identify")) {
        rc = handle_identify(sorcery, otw, wiz, &remote_hosts_vector);
    } else if (!strcmp(otw->object_type, "phoneprov")) {
        rc = handle_phoneprov(sorcery, otw, wiz);
    } else if (!strcmp(otw->object_type, "registration")) {
        rc = handle_registrations(sorcery, otw, wiz, &remote_hosts_vector);
    }
 
    AST_VECTOR_REMOVE_ALL_CMP_UNORDERED(&remote_hosts_vector, NULL, NOT_EQUALS, ast_free);
    AST_VECTOR_FREE(&remote_hosts_vector);
 
    ast_debug(4, "%s handler complete.  rc: %d\n", otw->object_type, rc);
 
    return rc;
}

References ast_category_first(), ast_debug, ast_free, ast_strdup, ast_strdupa, ast_strlen_zero(), ast_strsep(), AST_STRSEP_TRIM, ast_variable_find_last_in_list(), AST_VECTOR_APPEND, AST_VECTOR_FREE, AST_VECTOR_INIT, AST_VECTOR_REMOVE_ALL_CMP_UNORDERED, handle_aor(), handle_auths(), handle_endpoint(), handle_identify(), handle_phoneprov(), handle_registrations(), NOT_EQUALS, NULL, object_type_wizard::object_type, and sorcery.

Referenced by object_type_loaded_observer().

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "PJSIP Config Wizard" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .reload = reload_module, .unload = unload_module, .load_pri = AST_MODPRI_REALTIME_DRIVER, }

static

Definition at line 1399 of file res_pjsip_config_wizard.c.

acl_change_detected

int acl_change_detected = 0

static

Definition at line 303 of file res_pjsip_config_wizard.c.

Referenced by acl_change_stasis_cb(), and object_type_loaded_observer().

acl_change_sub

struct stasis_subscription* acl_change_sub

static

Definition at line 304 of file res_pjsip_config_wizard.c.

Referenced by load_module(), and unload_module().

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 1399 of file res_pjsip_config_wizard.c.

config_wizard_cli

struct ast_cli_entry config_wizard_cli[]

static

Initial value:

= {
    { .handler =  handle_export_primitives , .summary =  "Export config wizard primitives" ,},
}

Definition at line 1330 of file res_pjsip_config_wizard.c.

                                                  {
    AST_CLI_DEFINE(handle_export_primitives, "Export config wizard primitives"),
};

Referenced by load_module(), and unload_module().

global_observer

const struct ast_sorcery_global_observer global_observer

static

Initial value:

= {
    .instance_created = instance_created_observer,
    .instance_destroying = instance_destroying_observer,
}

Definition at line 1055 of file res_pjsip_config_wizard.c.

                                                                  {
    .instance_created = instance_created_observer,
    .instance_destroying = instance_destroying_observer,
};

Referenced by load_module(), and unload_module().

observer

struct ast_sorcery_instance_observer observer

Initial value:

= {
    .object_type_registered = object_type_registered_observer,
    .object_type_loaded = object_type_loaded_observer,
}

Definition at line 1060 of file res_pjsip_config_wizard.c.

                                                {
    .object_type_registered = object_type_registered_observer,
    .object_type_loaded = object_type_loaded_observer,
};

Referenced by ast_mwi_add_observer(), ast_mwi_remove_observer(), ast_sorcery_observer_add(), instance_created_observer(), instance_destroying_observer(), load_module(), sorcery_generic_observer_remove(), sorcery_observer_notify_create(), sorcery_observer_notify_delete(), sorcery_observer_notify_loaded(), sorcery_observer_notify_update(), sorcery_observer_remove(), stasis_state_add_observer(), and stasis_state_remove_observer().