Asterisk - The Open Source Telephony Project GIT-master-55f4e6d
Functions | Variables
func_pjsip_aor.c File Reference

Get information about a PJSIP AOR. More...

#include "asterisk.h"
#include <pjsip.h>
#include <pjlib.h>
#include "asterisk/app.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/sorcery.h"
#include "asterisk/res_pjsip.h"
Include dependency graph for func_pjsip_aor.c:

Go to the source code of this file.

Functions

static void __reg_module (void)
 
static void __unreg_module (void)
 
struct ast_moduleAST_MODULE_SELF_SYM (void)
 
static int load_module (void)
 
static int pjsip_aor_function_read (struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
 
static int unload_module (void)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Get information about a PJSIP AOR" , .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 = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .requires = "res_pjsip", }
 
static const struct ast_module_infoast_module_info = &__mod_info
 
static struct ast_custom_function pjsip_aor_function
 

Detailed Description

Get information about a PJSIP AOR.

Author
Joshua Colp <jcolp@digium.com> 

Definition in file func_pjsip_aor.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 189 of file func_pjsip_aor.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 189 of file func_pjsip_aor.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void  )

Definition at line 189 of file func_pjsip_aor.c.

◆ load_module()

static int load_module ( void  )
static

Definition at line 179 of file func_pjsip_aor.c.

180{
182}
static struct ast_custom_function pjsip_aor_function
#define ast_custom_function_register(acf)
Register a custom function.
Definition: pbx.h:1558

References ast_custom_function_register, and pjsip_aor_function.

◆ pjsip_aor_function_read()

static int pjsip_aor_function_read ( struct ast_channel chan,
const char *  cmd,
char *  data,
struct ast_str **  buf,
ssize_t  len 
)
static

Definition at line 70 of file func_pjsip_aor.c.

72{
73 struct ast_sorcery *pjsip_sorcery;
74 char *parsed_data = ast_strdupa(data);
75 RAII_VAR(struct ast_sip_aor *, aor_obj, NULL, ao2_cleanup);
76 int res = 0;
77
79 AST_APP_ARG(aor_name);
80 AST_APP_ARG(field_name);
81 );
82
83 /* Check for zero arguments */
84 if (ast_strlen_zero(parsed_data)) {
85 ast_log(AST_LOG_ERROR, "Cannot call %s without arguments\n", cmd);
86 return -1;
87 }
88
89 AST_STANDARD_APP_ARGS(args, parsed_data);
90
91 if (ast_strlen_zero(args.aor_name)) {
92 ast_log(AST_LOG_ERROR, "Cannot call %s without an AOR name to query\n", cmd);
93 return -1;
94 }
95
96 if (ast_strlen_zero(args.field_name)) {
97 ast_log(AST_LOG_ERROR, "Cannot call %s with an empty field name to query\n", cmd);
98 return -1;
99 }
100
101 pjsip_sorcery = ast_sip_get_sorcery();
102 if (!pjsip_sorcery) {
103 ast_log(AST_LOG_ERROR, "Unable to retrieve PJSIP configuration: sorcery object is NULL\n");
104 return -1;
105 }
106
107 aor_obj = ast_sorcery_retrieve_by_id(pjsip_sorcery, "aor", args.aor_name);
108 if (!aor_obj) {
109 ast_log(AST_LOG_WARNING, "Failed to retrieve information for AOR '%s'\n", args.aor_name);
110 return -1;
111 }
112
113 if (!strcmp(args.field_name, "contact")) {
114 /* The multiple fields handler for contact does not provide a list of contact object names, which is what we want, so we
115 * handle contact specifically to provide this.
116 */
117 RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
118 struct ao2_iterator i;
119 struct ast_sip_contact *contact;
120 int first = 1;
121
122 contacts = ast_sip_location_retrieve_aor_contacts(aor_obj);
123 if (!contacts) {
124 ast_log(LOG_WARNING, "Failed to retrieve contacts for AOR '%s'\n", args.aor_name);
125 return -1;
126 }
127
128 i = ao2_iterator_init(contacts, 0);
129 while ((contact = ao2_iterator_next(&i))) {
130 if (!first) {
131 ast_str_append(buf, len, "%s", ",");
132 }
133
135 first = 0;
136
137 ao2_ref(contact, -1);
138 }
140 } else {
141 struct ast_variable *change_set;
142 struct ast_variable *it_change_set;
143
144 change_set = ast_sorcery_objectset_create(pjsip_sorcery, aor_obj);
145 if (!change_set) {
146 ast_log(AST_LOG_WARNING, "Failed to retrieve information for AOR '%s': change set is NULL\n", args.aor_name);
147 return -1;
148 }
149
150 for (it_change_set = change_set; it_change_set; it_change_set = it_change_set->next) {
151 if (!strcmp(it_change_set->name, args.field_name)) {
152 ast_str_set(buf, len, "%s", it_change_set->value);
153 break;
154 }
155 }
156
157 if (!it_change_set) {
158 ast_log(AST_LOG_WARNING, "Unknown property '%s' for PJSIP AOR\n", args.field_name);
159 res = 1;
160 }
161
162 ast_variables_destroy(change_set);
163 }
164
165 return res;
166}
struct sla_ringing_trunk * first
Definition: app_sla.c:332
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:298
#define ast_log
Definition: astobj2.c:42
#define ao2_iterator_next(iter)
Definition: astobj2.h:1911
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
#define AST_APP_ARG(name)
Define an application argument.
#define AST_DECLARE_APP_ARGS(name, arglist)
Declare a structure to hold an application's arguments.
#define AST_STANDARD_APP_ARGS(args, parse)
Performs the 'standard' argument separation process for an application.
void ast_variables_destroy(struct ast_variable *var)
Free variable list.
Definition: extconf.c:1262
#define AST_LOG_WARNING
#define AST_LOG_ERROR
#define LOG_WARNING
struct ast_sorcery * ast_sip_get_sorcery(void)
Get a pointer to the SIP sorcery structure.
struct ao2_container * ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor)
Retrieve all contacts currently available for an AOR.
Definition: location.c:247
#define NULL
Definition: resample.c:96
const char * ast_sorcery_object_get_id(const void *object)
Get the unique identifier of a sorcery object.
Definition: sorcery.c:2317
#define ast_sorcery_objectset_create(sorcery, object)
Create an object set (KVP list) for an object.
Definition: sorcery.h:1137
void * ast_sorcery_retrieve_by_id(const struct ast_sorcery *sorcery, const char *type, const char *id)
Retrieve an object using its unique identifier.
Definition: sorcery.c:1853
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition: strings.h:1139
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
int ast_str_set(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Set a dynamic string using variable arguments.
Definition: strings.h:1113
Generic container type.
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition: astobj2.h:1821
A SIP address of record.
Definition: res_pjsip.h:478
Contact associated with an address of record.
Definition: res_pjsip.h:392
Full structure for sorcery.
Definition: sorcery.c:230
Structure for variables, used for configurations and for channel variables.
struct ast_variable * next
const char * args
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:941

References ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, args, AST_APP_ARG, AST_DECLARE_APP_ARGS, ast_log, AST_LOG_ERROR, AST_LOG_WARNING, ast_sip_get_sorcery(), ast_sip_location_retrieve_aor_contacts(), ast_sorcery_object_get_id(), ast_sorcery_objectset_create, ast_sorcery_retrieve_by_id(), AST_STANDARD_APP_ARGS, ast_str_append(), ast_str_set(), ast_strdupa, ast_strlen_zero(), ast_variables_destroy(), buf, first, len(), LOG_WARNING, ast_variable::name, ast_variable::next, NULL, RAII_VAR, and ast_variable::value.

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 174 of file func_pjsip_aor.c.

175{
177}
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.

References ast_custom_function_unregister(), and pjsip_aor_function.

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Get information about a PJSIP AOR" , .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 = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .requires = "res_pjsip", }
static

Definition at line 189 of file func_pjsip_aor.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 189 of file func_pjsip_aor.c.

◆ pjsip_aor_function

struct ast_custom_function pjsip_aor_function
static
Initial value:
= {
.name = "PJSIP_AOR",
}
static int pjsip_aor_function_read(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)

Definition at line 169 of file func_pjsip_aor.c.

Referenced by load_module(), and unload_module().