1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351 |
- /*
- * Asterisk -- An open source telephony toolkit.
- *
- * Copyright (C) 2014, Fairview 5 Engineering, LLC
- *
- * George Joseph <george.joseph@fairview5.com>
- *
- * See http://www.asterisk.org for more information about
- * the Asterisk project. Please do not directly contact
- * any of the maintainers of this project for assistance;
- * the project provides a web site, mailing lists and IRC
- * channels for your use.
- *
- * This program is free software, distributed under the terms of
- * the GNU General Public License Version 2. See the LICENSE file
- * at the top of the source tree.
- */
- /*! \file
- *
- * \brief PJSIP Configuration Wizard
- *
- * \author George Joseph <george.joseph@fairview5.com>
- */
- /*! \li \ref res_pjsip_config_wizard.c uses the configuration file \ref pjsip_wizard.conf
- */
- /*!
- * \page pjsip_wizard.conf pjsip_wizard.conf
- * \verbinclude pjsip_wizard.conf.sample
- */
- /*** MODULEINFO
- <depend>pjproject</depend>
- <depend>res_pjsip</depend>
- <support_level>core</support_level>
- ***/
- #include "asterisk.h"
- ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
- #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"
- /*** DOCUMENTATION
- <configInfo name="res_pjsip_config_wizard" language="en_US">
- <synopsis>Module that privides simple configuration wizard capabilities.</synopsis>
- <description><para>
- <emphasis>PJSIP Configuration Wizard</emphasis>
- </para>
- <para>This module allows creation of common PJSIP configuration scenarios
- without having to specify individual endpoint, aor, auth, identify and registration objects.
- </para>
- <para> </para>
- <para>For example, the following configuration snippet would create the
- endpoint, aor, contact, auth and phoneprov objects necessary for a phone to
- get phone provisioning information, register, and make and receive calls.
- A hint is also created in the default context for extension 1000.</para>
- <para> </para>
- <para>[myphone]</para>
- <para>type = wizard</para>
- <para>sends_auth = no</para>
- <para>accepts_auth = yes</para>
- <para>sends_registrations = no</para>
- <para>accepts_registrations = yes</para>
- <para>has_phoneprov = yes</para>
- <para>transport = ipv4</para>
- <para>has_hint = yes</para>
- <para>hint_exten = 1000</para>
- <para>inbound_auth/username = testname</para>
- <para>inbound_auth/password = test password</para>
- <para>endpoint/allow = ulaw</para>
- <para>endpoint/context = default</para>
- <para>phoneprov/MAC = 001122aa4455</para>
- <para>phoneprov/PROFILE = profile1</para>
- <para> </para>
- <para>The first 8 items are specific to the wizard. The rest of the items
- are passed verbatim to the underlying objects.</para>
- <para> </para>
- <para>The following configuration snippet would create the
- endpoint, aor, contact, auth, identify and registration objects necessary for a trunk
- to another pbx or ITSP that requires registration.</para>
- <para> </para>
- <para>[mytrunk]</para>
- <para>type = wizard</para>
- <para>sends_auth = yes</para>
- <para>accepts_auth = no</para>
- <para>sends_registrations = yes</para>
- <para>accepts_registrations = no</para>
- <para>transport = ipv4</para>
- <para>remote_hosts = sip1.myitsp.com:5060,sip2.myitsp.com:5060</para>
- <para>outbound_auth/username = testname</para>
- <para>outbound_auth/password = test password</para>
- <para>endpoint/allow = ulaw</para>
- <para>endpoint/context = default</para>
- <para> </para>
- <para>Of course, any of the items in either example could be placed into
- templates and shared among wizard objects.</para>
- <para> </para>
- <para>For more information, visit:</para>
- <para><literal>https://wiki.asterisk.org/wiki/display/AST/PJSIP+Configuration+Wizard</literal></para>
- </description>
- <configFile name="pjsip_wizard.conf">
- <configObject name="wizard">
- <synopsis>Provides config wizard.</synopsis>
- <description>
- <para>For more information, visit:</para>
- <para><literal>https://wiki.asterisk.org/wiki/display/AST/PJSIP+Configuration+Wizard</literal></para>
- </description>
- <configOption name="type">
- <synopsis>Must be 'wizard'.</synopsis>
- </configOption>
- <configOption name="transport">
- <synopsis>The name of a transport to use for this object.</synopsis>
- <description><para>If not specified,
- the default will be used.</para></description>
- </configOption>
- <configOption name="remote_hosts">
- <synopsis>List of remote hosts.</synopsis>
- <description><para>A comma-separated list of remote hosts in the form of
- <replaceable>host</replaceable>[:<replaceable>port</replaceable>].
- If set, an aor static contact and an identify match will be created for each
- entry in the list. If send_registrations is also set, a registration will
- also be created for each.</para></description>
- </configOption>
- <configOption name="outbound_proxy">
- <synopsis>Shortcut for specifying proxy on individual objects.</synopsis>
- <description><para>Shortcut for specifying endpoint/outbound_proxy,
- aor/outbound_proxy, and registration/outbound_proxy individually.
- </para></description>
- </configOption>
- <configOption name="sends_auth" default="no">
- <synopsis>Send outbound authentication to remote hosts.</synopsis>
- <description><para>At least outbound_auth/username is required.</para></description>
- </configOption>
- <configOption name="accepts_auth" default="no">
- <synopsis>Accept incoming authentication from remote hosts.</synopsis>
- <description><para>At least inbound_auth/username is required.</para></description>
- </configOption>
- <configOption name="sends_registrations" default="no">
- <synopsis>Send outbound registrations to remote hosts.</synopsis>
- <description><para>remote_hosts is required and a registration object will
- be created for each host in the remote _hosts string. If authentication is required,
- sends_auth and an outbound_auth/username must also be supplied.</para></description>
- </configOption>
- <configOption name="sends_line_with_registrations" default="no">
- <synopsis>Sets "line" and "endpoint parameters on registrations.</synopsis>
- <description><para>Setting this to true will cause the wizard to skip the
- creation of an identify object to match incoming requests to the endpoint and
- instead add the line and endpoint parameters to the outbound registration object.
- </para></description>
- </configOption>
- <configOption name="accepts_registrations" default="no">
- <synopsis>Accept inbound registration from remote hosts.</synopsis>
- <description><para>An AOR with dynamic contacts will be created. If
- the number of contacts nneds to be limited, set aor/max_contacts.</para></description>
- </configOption>
- <configOption name="has_phoneprov" default="no">
- <synopsis>Create a phoneprov object for this endpoint.</synopsis>
- <description><para>A phoneprov object will be created. phoneprov/MAC
- must be specified.</para></description>
- </configOption>
- <configOption name="server_uri_pattern" default="sip:${REMOTE_HOST}">
- <synopsis>A pattern to use for constructing outbound registration server_uris.</synopsis>
- <description><para>
- The literal <literal>${REMOTE_HOST}</literal> will be substituted with the
- appropriate remote_host for each registration.</para></description>
- </configOption>
- <configOption name="client_uri_pattern" default="sip:${USERNAME}@${REMOTE_HOST}">
- <synopsis>A pattern to use for constructing outbound registration client_uris.</synopsis>
- <description><para>
- The literals <literal>${REMOTE_HOST}</literal> and <literal>${USERNAME}</literal>
- will be substituted with the appropriate remote_host and outbound_auth/username.</para></description>
- </configOption>
- <configOption name="contact_pattern" default="sip:${REMOTE_HOST}">
- <synopsis>A pattern to use for constructing outbound contact uris.</synopsis>
- <description><para>
- The literal <literal>${REMOTE_HOST}</literal> will be substituted with the
- appropriate remote_host for each contact.</para></description>
- </configOption>
- <configOption name="has_hint" default="no">
- <synopsis>Create hint and optionally a default application.</synopsis>
- <description><para>Create hint and optionally a default application.</para></description>
- </configOption>
- <configOption name="hint_context" default="endpoint/context or 'default'">
- <synopsis>The context in which to place hints.</synopsis>
- <description>
- <para>Ignored if <literal>hint_exten</literal> is not specified otherwise specifies the
- context into which the dialplan hints will be placed. If not specified,
- defaults to the endpoint's context or <literal>default</literal> if that isn't
- found.
- </para></description>
- </configOption>
- <configOption name="hint_exten">
- <synopsis>Extension to map a PJSIP hint to.</synopsis>
- <description>
- <para>Will create the following entry in <literal>hint_context</literal>:</para>
- <para> <literal>exten => <hint_exten>,hint,PJSIP/<wizard_id></literal></para>
- <para> </para>
- <para>Normal dialplan precedence rules apply so if there's already a hint for
- this extension in <literal>hint_context</literal>, this one will be ignored.
- For more information, visit: </para>
- <para><literal>https://wiki.asterisk.org/wiki/display/AST/PJSIP+Configuration+Wizard</literal></para>
- </description>
- </configOption>
- <configOption name="hint_application">
- <synopsis>Application to call when 'hint_exten' is dialed.</synopsis>
- <description>
- <para>Ignored if <literal>hint_exten</literal> isn't specified otherwise
- will create the following priority 1 extension in <literal>hint_context</literal>:</para>
- <para> <literal>exten => <hint_exten>,1,<hint_application></literal></para>
- <para> </para>
- <para>You can specify any valid extensions.conf application expression.</para>
- <para>Examples: </para>
- <para> <literal>Dial(${HINT})</literal></para>
- <para> <literal>Gosub(stdexten,${EXTEN},1(${HINT}))</literal></para>
- <para> </para>
- <para>Any extensions.conf style variables specified are passed directly to the
- dialplan.</para>
- <para> </para>
- <para>Normal dialplan precedence rules apply so if there's already a priority 1
- application for this specific extension in <literal>hint_context</literal>,
- this one will be ignored. For more information, visit: </para>
- <para><literal>https://wiki.asterisk.org/wiki/display/AST/PJSIP+Configuration+Wizard</literal></para>
- </description>
- </configOption>
- <configOption name="endpoint/*">
- <synopsis>Variables to be passed directly to the endpoint.</synopsis>
- </configOption>
- <configOption name="aor/*">
- <synopsis>Variables to be passed directly to the aor.</synopsis>
- <description><para>If an aor/contact is explicitly defined then remote_hosts
- will not be used to create contacts automatically.</para></description>
- </configOption>
- <configOption name="inbound_auth/*">
- <synopsis>Variables to be passed directly to the inbound auth.</synopsis>
- </configOption>
- <configOption name="outbound_auth/*">
- <synopsis>Variables to be passed directly to the outbound auth.</synopsis>
- </configOption>
- <configOption name="identify/*">
- <synopsis>Variables to be passed directly to the identify.</synopsis>
- <description><para>If an identify/match is explicitly defined then remote_hosts
- will not be used to create matches automatically.</para></description>
- </configOption>
- <configOption name="registration/*">
- <synopsis>Variables to be passed directly to the outbound registrations.</synopsis>
- </configOption>
- <configOption name="phoneprov/*">
- <synopsis>Variables to be passed directly to the phoneprov object.</synopsis>
- <description><para>
- To activate phoneprov, at least phoneprov/MAC must be set.</para></description>
- </configOption>
- </configObject>
- </configFile>
- </configInfo>
- ***/
- /*! \brief Defines the maximum number of characters that can be added to a wizard id. */
- #define MAX_ID_SUFFIX 20
- #define BASE_REGISTRAR "res_pjsip_config_wizard"
- /*! \brief A generic char * vector definition. */
- AST_VECTOR(string_vector, char *);
- /*! \brief Keeps track of the sorcery wizard and last config for each object type */
- struct object_type_wizard {
- struct ast_sorcery *sorcery;
- struct ast_sorcery_wizard *wizard;
- void *wizard_data;
- struct ast_config *last_config;
- char object_type[];
- };
- static AST_VECTOR_RW(object_type_wizards, struct object_type_wizard *) object_type_wizards;
- /*! \brief Callbacks for vector deletes */
- #define NOT_EQUALS(a, b) (a != b)
- #define OTW_DELETE_CB(otw) ({ \
- ast_config_destroy(otw->last_config); \
- ast_free(otw); \
- })
- const static char *object_types[] = {"phoneprov", "registration", "identify", "endpoint", "aor", "auth", NULL};
- static int is_one_of(const char *needle, const char *haystack[])
- {
- int i;
- for (i = 0; haystack[i]; i++) {
- if (!strcmp(needle, haystack[i])) {
- return 1;
- }
- }
- return 0;
- }
- /*! \brief Finds the otw for the object type */
- static struct object_type_wizard *find_wizard(const char *object_type)
- {
- 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;
- }
- /*! \brief Creates a sorcery object and applies a variable list */
- static void *create_object(const struct ast_sorcery *sorcery,
- const char *id, const char *type, struct ast_variable *vars)
- {
- 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;
- }
- /*! \brief Finds the last variable in a list and tests it */
- static int is_variable_true(struct ast_variable *vars, const char *name)
- {
- return ast_true(ast_variable_find_last_in_list(vars, name));
- }
- /*! \brief Appends a variable to the end of an existing list */
- static int variable_list_append(struct ast_variable **existing, const char *name, const char *value)
- {
- 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;
- }
- /*! \brief Appends a variable to the end of an existing list. On failure, cause the calling
- * function to return -1 */
- #define variable_list_append_return(existing, name, value) ({ \
- 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); \
- })
- /*! \brief 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 struct ast_variable *get_object_variables(struct ast_variable *vars, char *prefix)
- {
- 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;
- }
- /* Don't call while holding context locks. */
- static int delete_extens(const char *context, const char *exten)
- {
- 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;
- }
- static int add_extension(struct ast_context *context, const char *exten,
- int priority, const char *application)
- {
- 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)) {
- ast_free(data);
- return -1;
- }
- return 0;
- }
- static int add_hints(const char *context, const char *exten, const char *application, const char *id)
- {
- 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;
- }
- static int handle_auth(const struct ast_sorcery *sorcery, struct object_type_wizard *otw,
- struct ast_category *wiz, char *direction)
- {
- 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;
- }
- static int handle_auths(const struct ast_sorcery *sorcery, struct object_type_wizard *otw,
- struct ast_category *wiz)
- {
- int rc;
- if ((rc = handle_auth(sorcery, otw, wiz, "outbound"))) {
- return rc;
- }
- return handle_auth(sorcery, otw, wiz, "inbound");
- }
- static int handle_aor(const struct ast_sorcery *sorcery, struct object_type_wizard *otw,
- struct ast_category *wiz, struct string_vector *remote_hosts_vector)
- {
- 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;
- }
- static int handle_endpoint(const struct ast_sorcery *sorcery, struct object_type_wizard *otw,
- struct ast_category *wiz)
- {
- 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;
- }
- static int handle_identify(const struct ast_sorcery *sorcery, struct object_type_wizard *otw,
- struct ast_category *wiz, struct string_vector *remote_hosts_vector)
- {
- 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;
- }
- static int handle_phoneprov(const struct ast_sorcery *sorcery, struct object_type_wizard *otw,
- struct ast_category *wiz)
- {
- 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;
- }
- static int delete_existing_cb(void *obj, void *arg, int flags)
- {
- 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;
- }
- static int handle_registrations(const struct ast_sorcery *sorcery, struct object_type_wizard *otw,
- struct ast_category *wiz, struct string_vector *remote_hosts_vector)
- {
- 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")) {
- username = ast_variable_find_last_in_list(wizvars, "outbound_auth/username");
- } 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(®istration_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(®istration_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(®istration_vars, "outbound_auth", new_id);
- }
- if (!ast_strlen_zero(transport)) {
- variable_list_append_return(®istration_vars, "transport", transport);
- }
- if (is_variable_true(wizvars, "sends_line_with_registrations")) {
- variable_list_append_return(®istration_vars, "line", "yes");
- variable_list_append_return(®istration_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;
- }
- static int wizard_apply_handler(const struct ast_sorcery *sorcery, struct object_type_wizard *otw,
- struct ast_category *wiz)
- {
- 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;
- }
- /*
- * Everything below are the sorcery observers.
- */
- static void instance_created_observer(const char *name, struct ast_sorcery *sorcery);
- static void instance_destroying_observer(const char *name, struct ast_sorcery *sorcery);
- static void object_type_loaded_observer(const char *name,
- const struct ast_sorcery *sorcery, const char *object_type, int reloaded);
- 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 void object_type_registered_observer(const char *name,
- struct ast_sorcery *sorcery, const char *object_type);
- const static struct ast_sorcery_global_observer global_observer = {
- .instance_created = instance_created_observer,
- .instance_destroying = instance_destroying_observer,
- };
- struct ast_sorcery_instance_observer observer = {
- .wizard_mapped = wizard_mapped_observer,
- .object_type_registered = object_type_registered_observer,
- .object_type_loaded = object_type_loaded_observer,
- };
- /*! \brief Called after an object type is loaded/reloaded */
- static void object_type_loaded_observer(const char *name,
- const struct ast_sorcery *sorcery, const char *object_type, int reloaded)
- {
- 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;
- struct ast_variable *change_set = NULL;
- if (otw->last_config) {
- last_cat = ast_category_get(otw->last_config, id, "type=^wizard$");
- ast_sorcery_changeset_create(ast_category_first(category), ast_category_first(last_cat), &change_set);
- if (last_cat) {
- ast_category_delete(otw->last_config, last_cat);
- }
- }
- if (!last_cat || change_set) {
- ast_variables_destroy(change_set);
- 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;
- }
- /*! \brief When each wizard is mapped, save it off to the vector. */
- 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)
- {
- 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);
- }
- }
- /*! \brief When each object type is registered, map a memory wizard to it. */
- static void object_type_registered_observer(const char *name,
- struct ast_sorcery *sorcery, const char *object_type)
- {
- if (is_one_of(object_type, object_types)) {
- ast_sorcery_apply_wizard_mapping(sorcery, object_type, "memory", "pjsip_wizard", 0);
- }
- }
- /*! \brief 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_created_observer(const char *name, struct ast_sorcery *sorcery)
- {
- if (strcmp(name, "res_pjsip")) {
- return;
- }
- ast_module_ref(ast_module_info->self);
- ast_sorcery_instance_observer_add(sorcery, &observer);
- }
- /*! \brief When the res_pjsip instance is destroyed, remove the observer
- * and unref the module. This should then allow this module to unload cleanly.
- */
- static void instance_destroying_observer(const char *name, struct ast_sorcery *sorcery)
- {
- if (strcmp(name, "res_pjsip")) {
- return;
- }
- ast_sorcery_instance_observer_remove(sorcery, &observer);
- ast_module_unref(ast_module_info->self);
- }
- static char *handle_export_primitives(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
- {
- 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;
- }
- static struct ast_cli_entry config_wizard_cli[] = {
- AST_CLI_DEFINE(handle_export_primitives, "Export config wizard primitives"),
- };
- static int load_module(void)
- {
- 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;
- }
- static int unload_module(void)
- {
- 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;
- }
- AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "PJSIP Config Wizard",
- .support_level = AST_MODULE_SUPPORT_CORE,
- .load = load_module,
- .unload = unload_module,
- .load_pri = AST_MODPRI_REALTIME_DRIVER,
- );
|