Asterisk - The Open Source Telephony Project  18.5.0
Data Structures | Functions | Variables
pjsip_global_headers.c File Reference
#include "asterisk.h"
#include <pjsip.h>
#include <pjlib.h>
#include "asterisk/res_pjsip.h"
#include "asterisk/linkedlists.h"
#include "include/res_pjsip_private.h"
Include dependency graph for pjsip_global_headers.c:

Go to the source code of this file.

Data Structures

struct  header
 
struct  header_list
 

Functions

static int add_header (struct header_list *headers, const char *name, const char *value, int replace)
 
static void add_headers_to_message (struct header_list *headers, pjsip_tx_data *tdata)
 
static pj_status_t add_request_headers (pjsip_tx_data *tdata)
 
static pj_status_t add_response_headers (pjsip_tx_data *tdata)
 
static struct header * alloc_header (const char *name, const char *value)
 
int ast_sip_add_global_request_header (const char *name, const char *value, int replace)
 
int ast_sip_add_global_response_header (const char *name, const char *value, int replace)
 
void ast_sip_destroy_global_headers (void)
 
void ast_sip_initialize_global_headers (void)
 
static void destroy_header (struct header *to_destroy)
 
static void destroy_headers (struct header_list *headers)
 
static void remove_header (struct header_list *headers, const char *to_remove)
 

Variables

static pjsip_module global_header_mod
 
static unsigned int handled_id = 0xCA115785
 Indicator we've already handled a specific request/response. More...
 
static struct header_list request_headers
 
static struct header_list response_headers
 

Function Documentation

◆ add_header()

static int add_header ( struct header_list *  headers,
const char *  name,
const char *  value,
int  replace 
)
static

Definition at line 130 of file pjsip_global_headers.c.

References alloc_header(), AST_LIST_INSERT_TAIL, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_strlen_zero, header::next, NULL, and remove_header().

Referenced by ast_sip_add_global_request_header(), and ast_sip_add_global_response_header().

131 {
132  struct header *to_add = NULL;
133 
134  if (!ast_strlen_zero(value)) {
135  to_add = alloc_header(name, value);
136  if (!to_add) {
137  return -1;
138  }
139  }
140 
141  AST_RWLIST_WRLOCK(headers);
142  if (replace) {
143  remove_header(headers, name);
144  }
145  if (to_add) {
146  AST_LIST_INSERT_TAIL(headers, to_add, next);
147  }
148  AST_RWLIST_UNLOCK(headers);
149 
150  return 0;
151 }
header::next
struct header * next
Definition: pjsip_global_headers.c:52
AST_RWLIST_WRLOCK
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:51
AST_RWLIST_UNLOCK
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:150
NULL
#define NULL
Definition: resample.c:96
value
int value
Definition: syslog.c:37
ast_strlen_zero
#define ast_strlen_zero(foo)
Definition: strings.h:52
remove_header
static void remove_header(struct header_list *headers, const char *to_remove)
Definition: pjsip_global_headers.c:117
AST_LIST_INSERT_TAIL
#define AST_LIST_INSERT_TAIL(head, elm, field)
Appends a list entry to the tail of a list.
Definition: linkedlists.h:730
name
static const char name[]
Definition: cdr_mysql.c:74
alloc_header
static struct header * alloc_header(const char *name, const char *value)
Definition: pjsip_global_headers.c:55
replace
static int replace(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
Definition: func_strings.c:790

◆ add_headers_to_message()

static void add_headers_to_message ( struct header_list *  headers,
pjsip_tx_data *  tdata 
)
static

Definition at line 82 of file pjsip_global_headers.c.

References AST_LIST_TRAVERSE, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, ast_sip_add_header(), global_header_mod, handled_id, lock, header::name, header::next, NULL, SCOPED_LOCK, and header::value.

Referenced by add_request_headers(), and add_response_headers().

83 {
84  struct header *iter;
85  SCOPED_LOCK(lock, headers, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK);
86  if (tdata->mod_data[global_header_mod.id] == &handled_id) {
87  return;
88  }
89  AST_LIST_TRAVERSE(headers, iter, next) {
90  pj_str_t name;
91  pjsip_generic_string_hdr *hdr;
92 
93  hdr = pjsip_msg_find_hdr_by_name(tdata->msg, pj_cstr(&name, iter->name), NULL);
94  if (hdr) {
95  continue;
96  }
97 
98  ast_sip_add_header(tdata, iter->name, iter->value);
99  };
100  tdata->mod_data[global_header_mod.id] = &handled_id;
101 }
header::value
const ast_string_field value
Definition: pjsip_global_headers.c:51
header::next
struct header * next
Definition: pjsip_global_headers.c:52
header::name
const ast_string_field name
Definition: pjsip_global_headers.c:51
global_header_mod
static pjsip_module global_header_mod
Definition: pjsip_global_headers.c:40
AST_RWLIST_UNLOCK
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:150
NULL
#define NULL
Definition: resample.c:96
ast_sip_add_header
int ast_sip_add_header(pjsip_tx_data *tdata, const char *name, const char *value)
Add a header to an outbound SIP message.
Definition: res_pjsip.c:5063
AST_RWLIST_RDLOCK
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:77
lock
ast_mutex_t lock
Definition: app_meetme.c:1091
SCOPED_LOCK
#define SCOPED_LOCK(varname, lock, lockfunc, unlockfunc)
Scoped Locks.
Definition: lock.h:581
handled_id
static unsigned int handled_id
Indicator we&#39;ve already handled a specific request/response.
Definition: pjsip_global_headers.c:38
AST_LIST_TRAVERSE
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:490
name
static const char name[]
Definition: cdr_mysql.c:74

◆ add_request_headers()

static pj_status_t add_request_headers ( pjsip_tx_data *  tdata)
static

Definition at line 103 of file pjsip_global_headers.c.

References add_headers_to_message(), and request_headers.

104 {
105  add_headers_to_message(&request_headers, tdata);
106 
107  return PJ_SUCCESS;
108 }
add_headers_to_message
static void add_headers_to_message(struct header_list *headers, pjsip_tx_data *tdata)
Definition: pjsip_global_headers.c:82
request_headers
static struct header_list request_headers
Definition: pjsip_global_headers.c:79

◆ add_response_headers()

static pj_status_t add_response_headers ( pjsip_tx_data *  tdata)
static

Definition at line 110 of file pjsip_global_headers.c.

References add_headers_to_message(), and response_headers.

111 {
112  add_headers_to_message(&response_headers, tdata);
113 
114  return PJ_SUCCESS;
115 }
response_headers
static struct header_list response_headers
Definition: pjsip_global_headers.c:80
add_headers_to_message
static void add_headers_to_message(struct header_list *headers, pjsip_tx_data *tdata)
Definition: pjsip_global_headers.c:82

◆ alloc_header()

static struct header* alloc_header ( const char *  name,
const char *  value 
)
static

Definition at line 55 of file pjsip_global_headers.c.

References ast_calloc_with_stringfields, ast_string_field_set, and NULL.

Referenced by add_header().

56 {
57  struct header *alloc;
58 
59  alloc = ast_calloc_with_stringfields(1, struct header, 32);
60 
61  if (!alloc) {
62  return NULL;
63  }
64 
65  ast_string_field_set(alloc, name, name);
66  ast_string_field_set(alloc, value, value);
67 
68  return alloc;
69 }
ast_calloc_with_stringfields
#define ast_calloc_with_stringfields(n, type, size)
Allocate a structure with embedded stringfields in a single allocation.
Definition: stringfields.h:426
NULL
#define NULL
Definition: resample.c:96
value
int value
Definition: syslog.c:37
name
static const char name[]
Definition: cdr_mysql.c:74
ast_string_field_set
#define ast_string_field_set(x, field, data)
Set a field to a simple string value.
Definition: stringfields.h:514

◆ ast_sip_add_global_request_header()

int ast_sip_add_global_request_header ( const char *  name,
const char *  value,
int  replace 
)

Definition at line 153 of file pjsip_global_headers.c.

References add_header(), and request_headers.

Referenced by global_apply().

154 {
155  return add_header(&request_headers, name, value, replace);
156 }
value
int value
Definition: syslog.c:37
request_headers
static struct header_list request_headers
Definition: pjsip_global_headers.c:79
add_header
static int add_header(struct header_list *headers, const char *name, const char *value, int replace)
Definition: pjsip_global_headers.c:130
name
static const char name[]
Definition: cdr_mysql.c:74
replace
static int replace(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
Definition: func_strings.c:790

◆ ast_sip_add_global_response_header()

int ast_sip_add_global_response_header ( const char *  name,
const char *  value,
int  replace 
)

Definition at line 158 of file pjsip_global_headers.c.

References add_header(), and response_headers.

Referenced by global_apply().

159 {
160  return add_header(&response_headers, name, value, replace);
161 }
response_headers
static struct header_list response_headers
Definition: pjsip_global_headers.c:80
value
int value
Definition: syslog.c:37
add_header
static int add_header(struct header_list *headers, const char *name, const char *value, int replace)
Definition: pjsip_global_headers.c:130
name
static const char name[]
Definition: cdr_mysql.c:74
replace
static int replace(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
Definition: func_strings.c:790

◆ ast_sip_destroy_global_headers()

void ast_sip_destroy_global_headers ( void  )

Definition at line 181 of file pjsip_global_headers.c.

References ast_sip_unregister_service(), destroy_headers(), global_header_mod, request_headers, and response_headers.

Referenced by unload_pjsip().

182 {
183  destroy_headers(&request_headers);
184  destroy_headers(&response_headers);
185 
186  ast_sip_unregister_service(&global_header_mod);
187 }
global_header_mod
static pjsip_module global_header_mod
Definition: pjsip_global_headers.c:40
destroy_headers
static void destroy_headers(struct header_list *headers)
Definition: pjsip_global_headers.c:171
response_headers
static struct header_list response_headers
Definition: pjsip_global_headers.c:80
request_headers
static struct header_list request_headers
Definition: pjsip_global_headers.c:79
ast_sip_unregister_service
void ast_sip_unregister_service(pjsip_module *module)
Definition: res_pjsip.c:3331

◆ ast_sip_initialize_global_headers()

void ast_sip_initialize_global_headers ( void  )

Definition at line 163 of file pjsip_global_headers.c.

References AST_RWLIST_HEAD_INIT, ast_sip_register_service(), global_header_mod, request_headers, and response_headers.

Referenced by load_module().

164 {
165  AST_RWLIST_HEAD_INIT(&request_headers);
166  AST_RWLIST_HEAD_INIT(&response_headers);
167 
168  ast_sip_register_service(&global_header_mod);
169 }
global_header_mod
static pjsip_module global_header_mod
Definition: pjsip_global_headers.c:40
response_headers
static struct header_list response_headers
Definition: pjsip_global_headers.c:80
AST_RWLIST_HEAD_INIT
#define AST_RWLIST_HEAD_INIT(head)
Initializes an rwlist head structure.
Definition: linkedlists.h:638
ast_sip_register_service
int ast_sip_register_service(pjsip_module *module)
Register a SIP service in Asterisk.
Definition: res_pjsip.c:3315
request_headers
static struct header_list request_headers
Definition: pjsip_global_headers.c:79

◆ destroy_header()

static void destroy_header ( struct header *  to_destroy)
static

Definition at line 71 of file pjsip_global_headers.c.

References ast_free, and ast_string_field_free_memory.

Referenced by destroy_headers(), and remove_header().

72 {
73  ast_string_field_free_memory(to_destroy);
74  ast_free(to_destroy);
75 }
ast_free
#define ast_free(a)
Definition: astmm.h:182
ast_string_field_free_memory
#define ast_string_field_free_memory(x)
free all memory - to be called before destroying the object
Definition: stringfields.h:368

◆ destroy_headers()

static void destroy_headers ( struct header_list *  headers)
static

Definition at line 171 of file pjsip_global_headers.c.

References AST_RWLIST_HEAD_DESTROY, AST_RWLIST_REMOVE_HEAD, destroy_header(), and header::next.

Referenced by ast_sip_destroy_global_headers().

172 {
173  struct header *iter;
174 
175  while ((iter = AST_RWLIST_REMOVE_HEAD(headers, next))) {
176  destroy_header(iter);
177  }
178  AST_RWLIST_HEAD_DESTROY(headers);
179 }
AST_RWLIST_HEAD_DESTROY
#define AST_RWLIST_HEAD_DESTROY(head)
Destroys an rwlist head structure.
Definition: linkedlists.h:666
header::next
struct header * next
Definition: pjsip_global_headers.c:52
destroy_header
static void destroy_header(struct header *to_destroy)
Definition: pjsip_global_headers.c:71
AST_RWLIST_REMOVE_HEAD
#define AST_RWLIST_REMOVE_HEAD
Definition: linkedlists.h:843

◆ remove_header()

static void remove_header ( struct header_list *  headers,
const char *  to_remove 
)
static

Definition at line 117 of file pjsip_global_headers.c.

References AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, destroy_header(), header::name, and header::next.

Referenced by add_header().

118 {
119  struct header *iter;
120  AST_LIST_TRAVERSE_SAFE_BEGIN(headers, iter, next) {
121  if (!strcasecmp(iter->name, to_remove)) {
122  AST_LIST_REMOVE_CURRENT(next);
123  destroy_header(iter);
124  break;
125  }
126  }
127  AST_LIST_TRAVERSE_SAFE_END;
128 }
header::next
struct header * next
Definition: pjsip_global_headers.c:52
header::name
const ast_string_field name
Definition: pjsip_global_headers.c:51
AST_LIST_TRAVERSE_SAFE_END
#define AST_LIST_TRAVERSE_SAFE_END
Closes a safe loop traversal block.
Definition: linkedlists.h:614
AST_LIST_REMOVE_CURRENT
#define AST_LIST_REMOVE_CURRENT(field)
Removes the current entry from a list during a traversal.
Definition: linkedlists.h:556
destroy_header
static void destroy_header(struct header *to_destroy)
Definition: pjsip_global_headers.c:71
AST_LIST_TRAVERSE_SAFE_BEGIN
#define AST_LIST_TRAVERSE_SAFE_BEGIN(head, var, field)
Loops safely over (traverses) the entries in a list.
Definition: linkedlists.h:528

Variable Documentation

◆ global_header_mod

pjsip_module global_header_mod
static

Definition at line 40 of file pjsip_global_headers.c.

Referenced by add_headers_to_message(), ast_sip_destroy_global_headers(), and ast_sip_initialize_global_headers().

◆ handled_id

unsigned int handled_id = 0xCA115785
static

Indicator we've already handled a specific request/response.

PJSIP tends to reuse requests and responses. If we already have added headers to a request or response, we mark the message with this value so that we know not to re-add the headers again.

Definition at line 38 of file pjsip_global_headers.c.

Referenced by add_headers_to_message().

◆ request_headers

struct header_list request_headers
static

Definition at line 79 of file pjsip_global_headers.c.

Referenced by add_request_headers(), ast_sip_add_global_request_header(), ast_sip_destroy_global_headers(), ast_sip_initialize_global_headers(), and remove_request_headers().

◆ response_headers

struct header_list response_headers
static

Definition at line 80 of file pjsip_global_headers.c.

Referenced by add_response_headers(), ast_sip_add_global_response_header(), ast_sip_destroy_global_headers(), and ast_sip_initialize_global_headers().

Generated on Sun Aug 8 2021 19:46:15 for Asterisk - The Open Source Telephony Project by   doxygen 1.8.13