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

Get information about a PJSIP contact. 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_contact.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 contact_function_get_permanent (void *obj, void *arg, int flags)
 
static int load_module (void)
 
static int pjsip_contact_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 contact" , .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_contact_function
 

Detailed Description

Get information about a PJSIP contact.

Author
Joshua Colp <jcolp@digium.com> 

Definition in file func_pjsip_contact.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 212 of file func_pjsip_contact.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 212 of file func_pjsip_contact.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void  )

Definition at line 212 of file func_pjsip_contact.c.

◆ contact_function_get_permanent()

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

Definition at line 75 of file func_pjsip_contact.c.

76{
77 const char *id = arg;
78
79 if (!strcmp(ast_sorcery_object_get_id(obj), id)) {
80 return CMP_MATCH | CMP_STOP;
81 }
82
83 return 0;
84}
@ CMP_MATCH
Definition: astobj2.h:1027
@ CMP_STOP
Definition: astobj2.h:1028
const char * ast_sorcery_object_get_id(const void *object)
Get the unique identifier of a sorcery object.
Definition: sorcery.c:2317

References ast_sorcery_object_get_id(), CMP_MATCH, and CMP_STOP.

Referenced by pjsip_contact_function_read().

◆ load_module()

static int load_module ( void  )
static

Definition at line 202 of file func_pjsip_contact.c.

203{
205}
static struct ast_custom_function pjsip_contact_function
#define ast_custom_function_register(acf)
Register a custom function.
Definition: pbx.h:1558

References ast_custom_function_register, and pjsip_contact_function.

◆ pjsip_contact_function_read()

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

Definition at line 86 of file func_pjsip_contact.c.

88{
89 struct ast_sorcery *pjsip_sorcery;
90 char *parsed_data = ast_strdupa(data);
91 char *contact_name;
92 RAII_VAR(struct ast_sip_contact *, contact_obj, NULL, ao2_cleanup);
93 RAII_VAR(struct ast_sip_contact_status *, contact_status, NULL, ao2_cleanup);
94 int res = 0;
95
97 AST_APP_ARG(contact_name);
98 AST_APP_ARG(field_name);
99 );
100
101 /* Check for zero arguments */
102 if (ast_strlen_zero(parsed_data)) {
103 ast_log(AST_LOG_ERROR, "Cannot call %s without arguments\n", cmd);
104 return -1;
105 }
106
107 AST_STANDARD_APP_ARGS(args, parsed_data);
108
109 if (ast_strlen_zero(args.contact_name)) {
110 ast_log(AST_LOG_ERROR, "Cannot call %s without a contact name to query\n", cmd);
111 return -1;
112 }
113
114 if (ast_strlen_zero(args.field_name)) {
115 ast_log(AST_LOG_ERROR, "Cannot call %s with an empty field name to query\n", cmd);
116 return -1;
117 }
118
119 pjsip_sorcery = ast_sip_get_sorcery();
120 if (!pjsip_sorcery) {
121 ast_log(AST_LOG_ERROR, "Unable to retrieve PJSIP configuration: sorcery object is NULL\n");
122 return -1;
123 }
124
125 /* Determine if this is a permanent contact or a normal contact */
126 if ((contact_name = strstr(args.contact_name, "@@"))) {
127 size_t aor_name_len = contact_name - args.contact_name;
128 char aor_name[aor_name_len + 1];
129 RAII_VAR(struct ast_sip_aor *, aor_obj, NULL, ao2_cleanup);
130
131 /* Grab only the AOR name so we can retrieve the AOR which will give us the contact */
132 strncpy(aor_name, args.contact_name, aor_name_len);
133 aor_name[aor_name_len] = '\0';
134
135 aor_obj = ast_sorcery_retrieve_by_id(pjsip_sorcery, "aor", aor_name);
136 if (!aor_obj) {
137 ast_log(AST_LOG_WARNING, "Failed to retrieve information for contact '%s'\n", args.contact_name);
138 return -1;
139 }
140
141 contact_obj = ao2_callback(aor_obj->permanent_contacts, 0, contact_function_get_permanent, args.contact_name);
142 } else {
143 contact_obj = ast_sorcery_retrieve_by_id(pjsip_sorcery, "contact", args.contact_name);
144 }
145
146 if (!contact_obj) {
147 ast_log(AST_LOG_WARNING, "Failed to retrieve information for contact '%s'\n", args.contact_name);
148 return -1;
149 }
150
151 contact_status = ast_sip_get_contact_status(contact_obj);
152
153 if (!strcmp(args.field_name, "status")) {
154 ast_str_set(buf, len, "%s", ast_sip_get_contact_status_label(contact_status ? contact_status->status : UNKNOWN));
155 } else if (!strcmp(args.field_name, "rtt")) {
156 if (!contact_status || contact_status->status != AVAILABLE) {
157 ast_str_set(buf, len, "%s", "N/A");
158 } else {
159 ast_str_set(buf, len, "%" PRId64, contact_status->rtt);
160 }
161 } else {
162 struct ast_variable *change_set;
163 struct ast_variable *it_change_set;
164
165 change_set = ast_sorcery_objectset_create(pjsip_sorcery, contact_obj);
166
167 if (!change_set) {
168 ast_log(AST_LOG_WARNING, "Failed to retrieve information for contact '%s': change set is NULL\n", args.contact_name);
169 return -1;
170 }
171
172 for (it_change_set = change_set; it_change_set; it_change_set = it_change_set->next) {
173 if (!strcmp(it_change_set->name, args.field_name)) {
174 ast_str_set(buf, len, "%s", it_change_set->value);
175 break;
176 }
177 }
178
179 if (!it_change_set) {
180 ast_log(AST_LOG_WARNING, "Unknown property '%s' for PJSIP contact\n", args.field_name);
181
182 res = 1;
183 }
184
185 ast_variables_destroy(change_set);
186 }
187
188 return res;
189}
#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_callback(c, flags, cb_fn, arg)
ao2_callback() is a generic function that applies cb_fn() to all objects in a container,...
Definition: astobj2.h:1693
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
static int contact_function_get_permanent(void *obj, void *arg, int flags)
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
struct ast_sorcery * ast_sip_get_sorcery(void)
Get a pointer to the SIP sorcery structure.
struct ast_sip_contact_status * ast_sip_get_contact_status(const struct ast_sip_contact *contact)
Retrieve the current status for a contact.
const char * ast_sip_get_contact_status_label(const enum ast_sip_contact_status_type status)
translate ast_sip_contact_status_type to character string.
@ AVAILABLE
Definition: res_pjsip.h:438
@ UNKNOWN
Definition: res_pjsip.h:440
#define NULL
Definition: resample.c:96
#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
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
A SIP address of record.
Definition: res_pjsip.h:478
A contact's status.
Definition: res_pjsip.h:451
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_callback, ao2_cleanup, args, AST_APP_ARG, AST_DECLARE_APP_ARGS, ast_log, AST_LOG_ERROR, AST_LOG_WARNING, ast_sip_get_contact_status(), ast_sip_get_contact_status_label(), ast_sip_get_sorcery(), ast_sorcery_objectset_create, ast_sorcery_retrieve_by_id(), AST_STANDARD_APP_ARGS, ast_str_set(), ast_strdupa, ast_strlen_zero(), ast_variables_destroy(), AVAILABLE, buf, contact_function_get_permanent(), len(), ast_variable::name, ast_variable::next, NULL, RAII_VAR, UNKNOWN, and ast_variable::value.

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 197 of file func_pjsip_contact.c.

198{
200}
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.

References ast_custom_function_unregister(), and pjsip_contact_function.

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Get information about a PJSIP contact" , .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 212 of file func_pjsip_contact.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 212 of file func_pjsip_contact.c.

◆ pjsip_contact_function

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

Definition at line 192 of file func_pjsip_contact.c.

Referenced by load_module(), and unload_module().