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 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...

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. More...

#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. More...

Functions
static void	__reg_module (void)

static void	__unreg_module (void)

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)

	AST_VECTOR (string_vector, char *)
	A generic char * vector definition. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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

static void	wizard_mapped_observer (const char name, struct ast_sorcery sorcery, const char object_type, struct ast_sorcery_wizard wizard, const char wizard_args, void wizard_data)
	When each wizard is mapped, save it off to the vector. More...

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 = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "30ef0c93b36035ec78c9cfd712d36d9b" , .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_REALTIME_DRIVER, }

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 278 of file res_pjsip_config_wizard.c.

Referenced by add_extension(), add_hints(), and delete_extens().

◆ 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 276 of file res_pjsip_config_wizard.c.

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

◆ NOT_EQUALS

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

Referenced by unload_module(), and wizard_apply_handler().

◆ OTW_DELETE_CB

#define OTW_DELETE_CB ( otw )

Value:

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

Referenced by unload_module().

◆ 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 375 of file res_pjsip_config_wizard.c.

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

Function Documentation

◆ __reg_module()

static void __reg_module ( void )

static

Definition at line 1351 of file res_pjsip_config_wizard.c.

◆ __unreg_module()

static void __unreg_module ( void )

static

Definition at line 1351 of file res_pjsip_config_wizard.c.

◆ add_extension()

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

static

Definition at line 422 of file res_pjsip_config_wizard.c.

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, NULL, paren, pbx_find_extension(), and pbx_find_info::stacklen.

Referenced by add_hints().

 {
    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;
    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;
 }

◆ add_hints()

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

static

Definition at line 484 of file res_pjsip_config_wizard.c.

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().

 {
    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;
 }

◆ AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM ( void )

Definition at line 1351 of file res_pjsip_config_wizard.c.

◆ AST_VECTOR()

AST_VECTOR	(	string_vector	,
		char *
	)

A generic char * vector definition.

◆ AST_VECTOR_RW()

static AST_VECTOR_RW	(		object_type_wizards,
		struct object_type_wizard *
	)

static

Definition at line 291 of file res_pjsip_config_wizard.c.

References NULL.

                             { \
    ast_config_destroy(otw->last_config); \
    ast_free(otw); \
 })
 
 const static char *object_types[] = {"phoneprov", "registration", "identify", "endpoint", "aor", "auth", 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 333 of file res_pjsip_config_wizard.c.

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

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

 {
    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;
 }

◆ delete_existing_cb()

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

static

Definition at line 837 of file res_pjsip_config_wizard.c.

References ast_sorcery_object_get_extended(), ast_strlen_zero, CMP_MATCH, context, ast_sorcery_wizard::delete, delete_extens(), exten, 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().

 {
    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;
 }

◆ delete_extens()

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

static

Definition at line 407 of file res_pjsip_config_wizard.c.

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().

 {
    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;
 }

◆ find_wizard()

static struct object_type_wizard* find_wizard ( const char * object_type )

static

Finds the otw for the object type.

Definition at line 315 of file res_pjsip_config_wizard.c.

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().

 {
    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;
 }

◆ 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 388 of file res_pjsip_config_wizard.c.

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

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

 {
    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;
 }

◆ 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 603 of file res_pjsip_config_wizard.c.

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, 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().

 {
    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;
 }

◆ 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 533 of file res_pjsip_config_wizard.c.

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, ast_sorcery_wizard::update, variable_list_append_return, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by handle_auths().

 {
    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;
 }

◆ handle_auths()

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

static

Definition at line 591 of file res_pjsip_config_wizard.c.

References handle_auth().

Referenced by wizard_apply_handler().

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

◆ handle_endpoint()

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

static

Definition at line 661 of file res_pjsip_config_wizard.c.

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, ast_sorcery_wizard::update, variable_list_append_return, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by wizard_apply_handler().

 {
    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;
 }

◆ handle_export_primitives()

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

static

Definition at line 1230 of file res_pjsip_config_wizard.c.

References ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_cli_args::argc, ast_cli_args::argv, 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, ast_cli_args::fd, LOG_ERROR, ast_variable::name, ast_variable::next, NULL, object_type_wizard::object_type, object_type_wizard::sorcery, ast_cli_entry::usage, and ast_variable::value.

 {
    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;
 }

◆ 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 731 of file res_pjsip_config_wizard.c.

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(), host, is_variable_true(), LOG_ERROR, MAX_ID_SUFFIX, NULL, RAII_VAR, ast_sorcery_wizard::retrieve_id, ast_sorcery_wizard::update, variable_list_append_return, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by wizard_apply_handler().

 {
    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++) {
          char *rhost = AST_VECTOR_GET(remote_hosts_vector, host_counter);
          char host[strlen(rhost) + 1];
          char *colon;
 
          /* If there's a :port specified, we have to remove it. */
          strcpy(host, rhost); /* Safe */
          colon = strchr(host, ':');
          if (colon) {
             *colon = '\0';
          }
 
          variable_list_append_return(&vars, "match", host);
       }
    }
 
    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;
 }

◆ handle_phoneprov()

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

static

Definition at line 795 of file res_pjsip_config_wizard.c.

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, ast_sorcery_wizard::update, variable_list_append_return, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by wizard_apply_handler().

 {
    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;
 }

◆ 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 854 of file res_pjsip_config_wizard.c.

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, ast_sorcery_wizard::update, variable_list_append_return, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by wizard_apply_handler().

 {
    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;
 }

◆ 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 1208 of file res_pjsip_config_wizard.c.

References ast_module_ref, ast_sorcery_instance_observer_add(), and ast_module_info::self.

Referenced by wizard_apply_handler().

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

◆ 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 1220 of file res_pjsip_config_wizard.c.

References ast_module_unref, ast_sorcery_instance_observer_remove(), and ast_module_info::self.

Referenced by wizard_apply_handler().

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

◆ is_one_of()

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

static

Definition at line 302 of file res_pjsip_config_wizard.c.

Referenced by object_type_registered_observer(), and wizard_mapped_observer().

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

◆ 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 353 of file res_pjsip_config_wizard.c.

References ast_true(), and ast_variable_find_last_in_list().

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

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

◆ load_module()

static int load_module ( void )

static

Definition at line 1327 of file res_pjsip_config_wizard.c.

References ARRAY_LEN, ast_cli_register_multiple, AST_MODULE_LOAD_SUCCESS, ast_sorcery_global_observer_add(), and AST_VECTOR_RW_INIT.

Referenced by unload_module().

 {
    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));
 
    return AST_MODULE_LOAD_SUCCESS;
 }

◆ 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 1063 of file res_pjsip_config_wizard.c.

References 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, object_type_wizard::last_config, LOG_ERROR, NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_UNLINK, RAII_VAR, ast_sorcery_wizard::retrieve_multiple, object_type_wizard::wizard, wizard_apply_handler(), and object_type_wizard::wizard_data.

Referenced by wizard_apply_handler().

 {
    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;
    }
 
    if (reloaded && otw->last_config) {
       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 (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;
 }

◆ 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 1196 of file res_pjsip_config_wizard.c.

References ast_sorcery_apply_wizard_mapping, and is_one_of().

Referenced by wizard_apply_handler().

 {
    if (is_one_of(object_type, object_types)) {
       ast_sorcery_apply_wizard_mapping(sorcery, object_type, "memory", "pjsip_wizard", 0);
    }
 }

◆ unload_module()

static int unload_module ( void )

static

Definition at line 1336 of file res_pjsip_config_wizard.c.

References ARRAY_LEN, ast_cli_unregister_multiple(), AST_MODFLAG_GLOBAL_SYMBOLS, AST_MODFLAG_LOAD_ORDER, AST_MODPRI_REALTIME_DRIVER, AST_MODULE_INFO(), AST_MODULE_SUPPORT_CORE, ast_sorcery_global_observer_remove(), AST_VECTOR_REMOVE_ALL_CMP_UNORDERED, AST_VECTOR_RW_FREE, ASTERISK_GPL_KEY, load_module(), NOT_EQUALS, NULL, and OTW_DELETE_CB.

 {
    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;
 }

◆ 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 359 of file res_pjsip_config_wizard.c.

References ast_log, ast_variable_list_append, ast_variable_new, and LOG_ERROR.

Referenced by get_object_variables(), and handle_aor().

 {
    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;
 }

◆ 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 991 of file res_pjsip_config_wizard.c.

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(), host, instance_created_observer(), instance_destroying_observer(), name, NOT_EQUALS, NULL, object_type_wizard::object_type, object_type_loaded_observer(), object_type_registered_observer(), object_type_wizard::sorcery, object_type_wizard::wizard, object_type_wizard::wizard_data, and wizard_mapped_observer().

Referenced by object_type_loaded_observer().

 {
    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;
 }

◆ wizard_mapped_observer()

static void wizard_mapped_observer	(	const char *	name,
		struct ast_sorcery *	sorcery,
		const char *	object_type,
		struct ast_sorcery_wizard *	wizard,
		const char *	wizard_args,
		void *	wizard_data
	)

static

When each wizard is mapped, save it off to the vector.

Definition at line 1162 of file res_pjsip_config_wizard.c.

References ast_debug, ast_free, ast_malloc, AST_VECTOR_APPEND, AST_VECTOR_RW_UNLOCK, AST_VECTOR_RW_WRLOCK, is_one_of(), object_type_wizard::last_config, NULL, object_type_wizard::object_type, object_type_wizard::sorcery, object_type_wizard::wizard, and object_type_wizard::wizard_data.

Referenced by wizard_apply_handler().

 {
    struct object_type_wizard *otw;
 
    if (!is_one_of(object_type, object_types)) {
       /* Not interested. */
       return;
    }
 
    /* We're only interested in memory wizards with the pjsip_wizard tag. */
    if (wizard_args && !strcmp(wizard_args, "pjsip_wizard")) {
       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);
    }
 }

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 = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "30ef0c93b36035ec78c9cfd712d36d9b" , .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_REALTIME_DRIVER, }

static

Definition at line 1351 of file res_pjsip_config_wizard.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 1351 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 1323 of file res_pjsip_config_wizard.c.

◆ 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 1051 of file res_pjsip_config_wizard.c.

◆ observer

struct ast_sorcery_instance_observer observer

Initial value:

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

Definition at line 1056 of file res_pjsip_config_wizard.c.

Referenced by ast_sorcery_observer_add(), sorcery_generic_observer_remove(), sorcery_observer_notify_create(), sorcery_observer_notify_delete(), sorcery_observer_notify_loaded(), sorcery_observer_notify_update(), and sorcery_observer_remove().

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ BASE_REGISTRAR

◆ MAX_ID_SUFFIX

◆ NOT_EQUALS

◆ OTW_DELETE_CB

◆ variable_list_append_return

Function Documentation

◆ __reg_module()

◆ __unreg_module()

◆ add_extension()

◆ add_hints()

◆ AST_MODULE_SELF_SYM()

◆ AST_VECTOR()

◆ AST_VECTOR_RW()

◆ create_object()

◆ delete_existing_cb()

◆ delete_extens()

◆ find_wizard()

◆ get_object_variables()

◆ handle_aor()

◆ handle_auth()

◆ handle_auths()

◆ handle_endpoint()

◆ handle_export_primitives()

◆ handle_identify()

◆ handle_phoneprov()

◆ handle_registrations()

◆ instance_created_observer()

◆ instance_destroying_observer()

◆ is_one_of()

◆ is_variable_true()

◆ load_module()

◆ object_type_loaded_observer()

◆ object_type_registered_observer()

◆ unload_module()

◆ variable_list_append()

◆ wizard_apply_handler()

◆ wizard_mapped_observer()

Variable Documentation

◆ __mod_info

◆ ast_module_info

◆ config_wizard_cli

◆ global_observer

◆ observer