Asterisk - The Open Source Telephony Project  18.5.0
Functions | Variables
func_pjsip_endpoint.c File Reference

Get information about a PJSIP endpoint. More...

#include "asterisk.h"
#include <pjsip.h>
#include <pjlib.h>
#include "asterisk/app.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/sorcery.h"
#include "asterisk/res_pjsip.h"
Include dependency graph for func_pjsip_endpoint.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_endpoint_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 endpoint" , .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, .requires = "res_pjsip", }
 
static const struct ast_module_infoast_module_info = &__mod_info
 
static struct ast_custom_function pjsip_endpoint_function
 

Detailed Description

Get information about a PJSIP endpoint.

Author
Matt Jordan <[email protected]> 

Definition in file func_pjsip_endpoint.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 164 of file func_pjsip_endpoint.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 164 of file func_pjsip_endpoint.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM ( void  )

Definition at line 164 of file func_pjsip_endpoint.c.

◆ load_module()

static int load_module ( void  )
static

Definition at line 154 of file func_pjsip_endpoint.c.

References ast_custom_function_register, AST_MODFLAG_DEFAULT, AST_MODULE_INFO(), AST_MODULE_SUPPORT_CORE, ASTERISK_GPL_KEY, and unload_module().

155 {
157 }
static struct ast_custom_function pjsip_endpoint_function
#define ast_custom_function_register(acf)
Register a custom function.
Definition: pbx.h:1508

◆ pjsip_endpoint_function_read()

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

Definition at line 71 of file func_pjsip_endpoint.c.

References ao2_cleanup, args, AST_APP_ARG, AST_DECLARE_APP_ARGS, ast_log, AST_LOG_ERROR, AST_LOG_WARNING, 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(), ast_variable::name, ast_variable::next, NULL, RAII_VAR, and ast_variable::value.

73 {
74  struct ast_sorcery *pjsip_sorcery;
75  char *parsed_data = ast_strdupa(data);
76  RAII_VAR(void *, endpoint_obj, NULL, ao2_cleanup);
77  struct ast_variable *change_set;
78  struct ast_variable *it_change_set;
79  int res;
80 
82  AST_APP_ARG(endpoint_name);
83  AST_APP_ARG(field_name);
84  );
85 
86  /* Check for zero arguments */
87  if (ast_strlen_zero(parsed_data)) {
88  ast_log(AST_LOG_ERROR, "Cannot call %s without arguments\n", cmd);
89  return -1;
90  }
91 
92  AST_STANDARD_APP_ARGS(args, parsed_data);
93 
94  if (ast_strlen_zero(args.endpoint_name)) {
95  ast_log(AST_LOG_ERROR, "Cannot call %s without an endpoint name to query\n", cmd);
96  return -1;
97  }
98 
99  if (ast_strlen_zero(args.field_name)) {
100  ast_log(AST_LOG_ERROR, "Cannot call %s with an empty field name to query\n", cmd);
101  return -1;
102  }
103 
104  pjsip_sorcery = ast_sip_get_sorcery();
105  if (!pjsip_sorcery) {
106  ast_log(AST_LOG_ERROR, "Unable to retrieve PJSIP configuration: sorcery object is NULL\n");
107  return -1;
108  }
109 
110  endpoint_obj = ast_sorcery_retrieve_by_id(pjsip_sorcery, "endpoint", args.endpoint_name);
111  if (!endpoint_obj) {
112  ast_log(AST_LOG_WARNING, "Failed to retrieve information for endpoint '%s'\n", args.endpoint_name);
113  return -1;
114  }
115 
116  change_set = ast_sorcery_objectset_create(pjsip_sorcery, endpoint_obj);
117  if (!change_set) {
118  ast_log(AST_LOG_WARNING, "Failed to retrieve information for endpoint '%s': change set is NULL\n", args.endpoint_name);
119  return -1;
120  }
121 
122  for (it_change_set = change_set; it_change_set; it_change_set = it_change_set->next) {
123  if (!strcmp(it_change_set->name, args.field_name)) {
124  if (!strcmp(it_change_set->name, "disallow")) {
125  ast_str_set(buf, len, "!%s", it_change_set->value);
126  } else {
127  ast_str_set(buf, len, "%s", it_change_set->value);
128  }
129  break;
130  }
131  }
132 
133  res = it_change_set ? 0 : 1;
134  if (res) {
135  ast_log(AST_LOG_WARNING, "Unknown property '%s' for PJSIP endpoint\n", args.field_name);
136  }
137 
138  ast_variables_destroy(change_set);
139 
140  return res;
141 }
struct ast_variable * next
void ast_variables_destroy(struct ast_variable *var)
Free variable list.
Definition: extconf.c:1263
#define AST_STANDARD_APP_ARGS(args, parse)
Performs the &#39;standard&#39; argument separation process for an application.
Structure for variables, used for configurations and for channel variables.
#define AST_LOG_WARNING
Definition: logger.h:279
Full structure for sorcery.
Definition: sorcery.c:230
const char * args
#define NULL
Definition: resample.c:96
#define ast_strlen_zero(foo)
Definition: strings.h:52
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_set(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Set a dynamic string using variable arguments.
Definition: strings.h:1065
#define ast_log
Definition: astobj2.c:42
#define AST_LOG_ERROR
Definition: logger.h:290
#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:911
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:300
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
#define ast_sorcery_objectset_create(sorcery, object)
Create an object set (KVP list) for an object.
Definition: sorcery.h:1136
struct ast_sorcery * ast_sip_get_sorcery(void)
Get a pointer to the SIP sorcery structure.
#define ao2_cleanup(obj)
Definition: astobj2.h:1958
#define AST_DECLARE_APP_ARGS(name, arglist)
Declare a structure to hold an application&#39;s arguments.
#define AST_APP_ARG(name)
Define an application argument.

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 149 of file func_pjsip_endpoint.c.

References ast_custom_function_unregister().

Referenced by load_module().

150 {
152 }
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.
static struct ast_custom_function pjsip_endpoint_function

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Get information about a PJSIP endpoint" , .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, .requires = "res_pjsip", }
static

Definition at line 164 of file func_pjsip_endpoint.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 164 of file func_pjsip_endpoint.c.

◆ pjsip_endpoint_function

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

Definition at line 144 of file func_pjsip_endpoint.c.