Asterisk - The Open Source Telephony Project GIT-master-b023714
Loading...
Searching...
No Matches
Macros | Functions | Variables
res_pjsip_pidf_body_generator.c File Reference
#include "asterisk.h"
#include <pjsip.h>
#include <pjsip_simple.h>
#include <pjlib.h>
#include "asterisk/module.h"
#include "asterisk/res_pjsip.h"
#include "asterisk/res_pjsip_pubsub.h"
#include "asterisk/res_pjsip_presence_xml.h"
#include "asterisk/res_pjsip_body_generator_types.h"
Include dependency graph for res_pjsip_pidf_body_generator.c:

Go to the source code of this file.

Macros

#define MAX_STRING_GROWTHS   5
 

Functions

static void __reg_module (void)
 
static void __unreg_module (void)
 
struct ast_moduleAST_MODULE_SELF_SYM (void)
 
static int load_module (void)
 
static void * pidf_allocate_body (void *data)
 
static int pidf_generate_body_content (void *body, void *data)
 
static void pidf_to_string (void *body, struct ast_str **str)
 
static int unload_module (void)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "PJSIP Extension State PIDF Provider" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_CHANNEL_DEPEND, .requires = "res_pjsip,res_pjsip_pubsub", }
 
static const struct ast_module_infoast_module_info = &__mod_info
 
static struct ast_sip_pubsub_body_generator pidf_body_generator
 

Macro Definition Documentation

◆ MAX_STRING_GROWTHS

#define MAX_STRING_GROWTHS   5

Definition at line 83 of file res_pjsip_pidf_body_generator.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 137 of file res_pjsip_pidf_body_generator.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 137 of file res_pjsip_pidf_body_generator.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void  )

Definition at line 137 of file res_pjsip_pidf_body_generator.c.

◆ load_module()

static int load_module ( void  )
static

Definition at line 117 of file res_pjsip_pidf_body_generator.c.

118{
121 }
123}
@ AST_MODULE_LOAD_SUCCESS
Definition module.h:70
@ AST_MODULE_LOAD_DECLINE
Module has failed to load, may be in an inconsistent state.
Definition module.h:78
static struct ast_sip_pubsub_body_generator pidf_body_generator
int ast_sip_pubsub_register_body_generator(struct ast_sip_pubsub_body_generator *generator)
Register a body generator with the pubsub core.

References AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, ast_sip_pubsub_register_body_generator(), and pidf_body_generator.

◆ pidf_allocate_body()

static void * pidf_allocate_body ( void *  data)
static

Definition at line 38 of file res_pjsip_pidf_body_generator.c.

39{
40 struct ast_sip_exten_state_data *state_data = data;
41 char *local = ast_strdupa(state_data->local);
42 pjpidf_pres *pres;
43 pj_str_t entity;
44
45 pres = pjpidf_create(state_data->pool, pj_cstr(&entity, ast_strip_quoted(local, "<", ">")));
46
47 return pres;
48}
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition astmm.h:298
char * ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes)
Strip leading/trailing whitespace and quotes from a string.
Definition utils.c:1854
structure used for presence XML bodies

References ast_strdupa, ast_strip_quoted(), ast_sip_exten_state_data::local, and ast_sip_exten_state_data::pool.

◆ pidf_generate_body_content()

static int pidf_generate_body_content ( void *  body,
void *  data 
)
static

Definition at line 50 of file res_pjsip_pidf_body_generator.c.

51{
52 pjpidf_tuple *tuple;
53 pj_str_t note, id, contact, priority;
54 char *statestring = NULL, *pidfstate = NULL, *pidfnote = NULL;
55 enum ast_sip_pidf_state local_state;
56 char sanitized[PJSIP_MAX_URL_SIZE];
57 pjpidf_pres *pres = body;
58 struct ast_sip_exten_state_data *state_data = data;
59
60 ast_sip_presence_exten_state_to_str(state_data->exten_state, &statestring,
61 &pidfstate, &pidfnote, &local_state, 0);
62
63 if (!pjpidf_pres_add_note(state_data->pool, pres, pj_cstr(&note, pidfnote))) {
64 ast_log(LOG_WARNING, "Unable to add note to PIDF presence\n");
65 return -1;
66 }
67
68 if (!(tuple = pjpidf_pres_add_tuple(state_data->pool, pres,
69 pj_cstr(&id, state_data->exten)))) {
70 ast_log(LOG_WARNING, "Unable to create PIDF tuple\n");
71 return -1;
72 }
73
74 ast_sip_sanitize_xml(state_data->remote, sanitized, sizeof(sanitized));
75 pjpidf_tuple_set_contact(state_data->pool, tuple, pj_cstr(&contact, sanitized));
76 pjpidf_tuple_set_contact_prio(state_data->pool, tuple, pj_cstr(&priority, "1"));
77 pjpidf_status_set_basic_open(pjpidf_tuple_get_status(tuple),
78 local_state == NOTIFY_OPEN || local_state == NOTIFY_INUSE);
79
80 return 0;
81}
enum queue_result id
Definition app_queue.c:1767
#define ast_log
Definition astobj2.c:42
static int priority
#define LOG_WARNING
void ast_sip_sanitize_xml(const char *input, char *output, size_t len)
Replace offensive XML characters with XML entities.
void ast_sip_presence_exten_state_to_str(int state, char **statestring, char **pidfstate, char **pidfnote, enum ast_sip_pidf_state *local_state, unsigned int notify_early_inuse_ringing)
Convert extension state to relevant PIDF strings.
#define NULL
Definition resample.c:96
enum ast_extension_states exten_state

References ast_log, ast_sip_presence_exten_state_to_str(), ast_sip_sanitize_xml(), ast_sip_exten_state_data::exten, ast_sip_exten_state_data::exten_state, id, LOG_WARNING, NOTIFY_INUSE, NOTIFY_OPEN, NULL, ast_sip_exten_state_data::pool, priority, and ast_sip_exten_state_data::remote.

◆ pidf_to_string()

static void pidf_to_string ( void *  body,
struct ast_str **  str 
)
static

Definition at line 85 of file res_pjsip_pidf_body_generator.c.

86{
87 pjpidf_pres *pres = body;
88 int growths = 0;
89 int size;
90
91 do {
92 size = pjpidf_print(pres, ast_str_buffer(*str), ast_str_size(*str) - 1);
93 if (size <= AST_PJSIP_XML_PROLOG_LEN) {
95 ++growths;
96 }
97 } while (size <= AST_PJSIP_XML_PROLOG_LEN && growths < MAX_STRING_GROWTHS);
98 if (size <= AST_PJSIP_XML_PROLOG_LEN) {
99 ast_log(LOG_WARNING, "PIDF body text too large\n");
100 return;
101 }
102
103 *(ast_str_buffer(*str) + size) = '\0';
105}
const char * str
Definition app_jack.c:150
#define MAX_STRING_GROWTHS
#define AST_PJSIP_XML_PROLOG_LEN
Length of the XML prolog when printing presence or other XML in PJSIP.
#define ast_str_make_space(buf, new_len)
Definition strings.h:828
void ast_str_update(struct ast_str *buf)
Update the length of the buffer, after using ast_str merely as a buffer.
Definition strings.h:703
char *attribute_pure ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition strings.h:761
size_t attribute_pure ast_str_size(const struct ast_str *buf)
Returns the current maximum length (without reallocation) of the current buffer.
Definition strings.h:742

References ast_log, AST_PJSIP_XML_PROLOG_LEN, ast_str_buffer(), ast_str_make_space, ast_str_size(), ast_str_update(), LOG_WARNING, MAX_STRING_GROWTHS, and str.

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 125 of file res_pjsip_pidf_body_generator.c.

126{
128 return 0;
129}
void ast_sip_pubsub_unregister_body_generator(struct ast_sip_pubsub_body_generator *generator)
Unregister a body generator with the pubsub core.

References ast_sip_pubsub_unregister_body_generator(), and pidf_body_generator.

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "PJSIP Extension State PIDF Provider" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_CHANNEL_DEPEND, .requires = "res_pjsip,res_pjsip_pubsub", }
static

Definition at line 137 of file res_pjsip_pidf_body_generator.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 137 of file res_pjsip_pidf_body_generator.c.

◆ pidf_body_generator

struct ast_sip_pubsub_body_generator pidf_body_generator
static

Definition at line 107 of file res_pjsip_pidf_body_generator.c.

107 {
108 .type = "application",
109 .subtype = "pidf+xml",
110 .body_type = AST_SIP_EXTEN_STATE_DATA,
111 .allocate_body = pidf_allocate_body,
112 .generate_body_content = pidf_generate_body_content,
113 .to_string = pidf_to_string,
114 /* No need for a destroy_body callback since we use a pool */
115};
static void pidf_to_string(void *body, struct ast_str **str)
static void * pidf_allocate_body(void *data)
static int pidf_generate_body_content(void *body, void *data)
#define AST_SIP_EXTEN_STATE_DATA

Referenced by load_module(), and unload_module().