pjsip_session_reason_header.c File Reference

#include "asterisk.h"
#include "asterisk/res_pjsip_session.h"
#include "asterisk/utils.h"
#include "pjsip_session.h"

Include dependency graph for pjsip_session_reason_header.c:

Go to the source code of this file.

Data Structures
struct	return_reason_data

Macros
#define	RETURN_REASON_DATASTORE_NAME   "pjsip_session_return_reason"

Functions
int	ast_sip_session_add_reason_header (struct ast_sip_session *session, const char *protocol, int code, const char *text)
	Adds a Reason header in the next reponse to an incoming INVITE. More...
void	pjsip_reason_header_load (void)
void	pjsip_reason_header_unload (void)
static void	reason_header_outgoing_response (struct ast_sip_session *session, struct pjsip_tx_data *tdata)
static void	return_reason_destructor (void *obj)

Variables
static const pj_str_t	reason_hdr_str = { "Reason", 6}
static struct ast_sip_session_supplement	reason_header_supplement
static struct ast_datastore_info	return_reason_info

Macro Definition Documentation

RETURN_REASON_DATASTORE_NAME

#define RETURN_REASON_DATASTORE_NAME   "pjsip_session_return_reason"

Definition at line 43 of file pjsip_session_reason_header.c.

Function Documentation

ast_sip_session_add_reason_header()

int ast_sip_session_add_reason_header	(	struct ast_sip_session *	session,
		const char *	protocol,
		int	code,
		const char *	text
	)

Adds a Reason header in the next reponse to an incoming INVITE.

Parameters

session	The session
protocol	Usually "SIP" but may be "STIR" for stir-shaken
code	SIP response code
text	Reason string

Return values

0	the header is accepted
-1	the header is rejected

Definition at line 123 of file pjsip_session_reason_header.c.

{
    struct return_reason_data *rr;
    RAII_VAR(struct ast_datastore *, datastore, NULL, ao2_cleanup);
    const char *tag = ast_sip_session_get_name(session);
    SCOPE_ENTER(4, "%s: Adding Reason header %s %d %s\n",
        tag, S_OR(protocol,"<missing protocol>"),
        code, S_OR(text, "<missing text>"));
 
    if (ast_strlen_zero(protocol) || !text) {
        SCOPE_EXIT_RTN_VALUE(-1, "%s: Missing protocol or text\n", tag);
    }
    rr = ast_calloc(1, sizeof(*rr));
    if (!rr) {
        SCOPE_EXIT_RTN_VALUE(-1, "%s: Failed to allocate datastore\n", tag);
    }
    datastore = ast_sip_session_alloc_datastore(
        &return_reason_info, return_reason_info.type);
    rr->protocol = ast_strdup(protocol);
    rr->response_code = code;
    rr->response_str = ast_strdup(text);
    datastore->data = rr;
    if (ast_sip_session_add_datastore(session, datastore) != 0) {
        SCOPE_EXIT_RTN_VALUE(-1,
            "%s: Failed to add datastore to session\n", tag);
    }
 
    SCOPE_EXIT_RTN_VALUE(0, "%s: Done\n", tag);
}

References ao2_cleanup, ast_calloc, ast_sip_session_add_datastore(), ast_sip_session_alloc_datastore(), ast_sip_session_get_name(), ast_strdup, ast_strlen_zero(), NULL, return_reason_data::protocol, RAII_VAR, return_reason_data::response_code, return_reason_data::response_str, return_reason_info, S_OR, SCOPE_ENTER, SCOPE_EXIT_RTN_VALUE, session, text, and ast_datastore_info::type.

Referenced by process_failure().

pjsip_reason_header_load()

void pjsip_reason_header_load

(

void

)

Definition at line 165 of file pjsip_session_reason_header.c.

{
    ast_sip_session_register_supplement(&reason_header_supplement);
}

References ast_sip_session_register_supplement, and reason_header_supplement.

Referenced by load_module().

pjsip_reason_header_unload()

void pjsip_reason_header_unload

(

void

)

Definition at line 160 of file pjsip_session_reason_header.c.

{
    ast_sip_session_unregister_supplement(&reason_header_supplement);
}

References ast_sip_session_unregister_supplement(), and reason_header_supplement.

Referenced by unload_module().

reason_header_outgoing_response()

static void reason_header_outgoing_response ( struct ast_sip_session *  session, struct pjsip_tx_data *  tdata  )

static

Definition at line 49 of file pjsip_session_reason_header.c.

{
    RAII_VAR(struct ast_datastore *, datastore, NULL, ao2_cleanup);
    pjsip_generic_string_hdr *reason_hdr;
    pj_str_t reason_val;
    RAII_VAR(char *, reason_str, NULL, ast_free);
    struct return_reason_data *rr = NULL;
    int rc = 0;
    struct pjsip_status_line status = tdata->msg->line.status;
    const char *tag = ast_sip_session_get_name(session);
    SCOPE_ENTER(3, "%s: Response Code: %d\n", tag,
        status.code);
 
    /*
     * Include the Reason header if this is a provisional
     * response other than a 100 OR it's a 200.
     */
    if (!((PJSIP_IS_STATUS_IN_CLASS(status.code, 100) && status.code != 100) || status.code == 200)) {
        SCOPE_EXIT_RTN("%s: RC %d not eligible for Reason header\n", tag, status.code);
    }
 
    datastore = ast_sip_session_get_datastore(session, RETURN_REASON_DATASTORE_NAME);
    if (!datastore) {
        SCOPE_EXIT_RTN("%s: No datastore on session.  Nothing to do\n", tag);
    }
    rr = datastore->data;
 
    rc = ast_asprintf(&reason_str, "%s; cause=%d; text=\"%s\"",
        rr->protocol, rr->response_code, rr->response_str);
    if (rc < 0) {
        ast_sip_session_remove_datastore(session, RETURN_REASON_DATASTORE_NAME);
        SCOPE_EXIT_RTN("%s: Failed to create reason string\n", tag);
    }
    reason_val = pj_str(reason_str);
 
    /*
     * pjproject re-uses the tdata for a transaction so if we've
     * already sent the Reason header, it'll get sent again unless
     * we remove it.  It's possible something else is sending a Reason
     * header so we need to ensure we only remove our own.
     */
    if (rr->already_sent) {
        ast_trace(3, "%s: Reason already sent\n", tag);
        reason_hdr = pjsip_msg_find_hdr_by_name(tdata->msg, &reason_hdr_str, NULL);
        while (reason_hdr) {
            ast_trace(3, "%s: Checking old reason: <" PJSTR_PRINTF_SPEC "> - <" PJSTR_PRINTF_SPEC "> \n",
                tag,
                PJSTR_PRINTF_VAR(reason_hdr->hvalue), PJSTR_PRINTF_VAR(reason_val));
            if (pj_strcmp(&reason_hdr->hvalue, &reason_val) == 0) {
                ast_trace(3, "%s: MATCH. Cleaning up old reason\n", tag);
                pj_list_erase(reason_hdr);
                break;
            }
            reason_hdr = pjsip_msg_find_hdr_by_name(tdata->msg, &reason_hdr_str, reason_hdr->next);
        }
        ast_sip_session_remove_datastore(session, RETURN_REASON_DATASTORE_NAME);
        SCOPE_EXIT_RTN("%s: Done\n", tag);
    }
 
    reason_hdr = pjsip_generic_string_hdr_create(tdata->pool, &reason_hdr_str, &reason_val);
    if (reason_hdr) {
        pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *)reason_hdr);
        rr->already_sent = 1;
        ast_trace(1, "%s: Created reason header: Reason: %s\n",
            tag, reason_str);
    } else {
        ast_trace(1, "%s: Failed to create reason header: Reason: %s\n",
            tag, reason_str);
    }
 
    SCOPE_EXIT_RTN("%s: Done\n", tag);
}

References return_reason_data::already_sent, ao2_cleanup, ast_asprintf, ast_free, ast_sip_session_get_datastore(), ast_sip_session_get_name(), ast_sip_session_remove_datastore(), ast_trace, NULL, PJSTR_PRINTF_SPEC, PJSTR_PRINTF_VAR, return_reason_data::protocol, RAII_VAR, reason_hdr_str, return_reason_data::response_code, return_reason_data::response_str, RETURN_REASON_DATASTORE_NAME, SCOPE_ENTER, SCOPE_EXIT_RTN, session, and status.

return_reason_destructor()

static void return_reason_destructor ( void *  obj )

static

Definition at line 33 of file pjsip_session_reason_header.c.

{
    struct return_reason_data *rr = obj;
    SCOPE_ENTER(3, "Destroying RR");
    ast_free(rr->protocol);
    ast_free(rr->response_str);
    ast_free(rr);
    SCOPE_EXIT("Done");
}

References ast_free, return_reason_data::protocol, return_reason_data::response_str, SCOPE_ENTER, and SCOPE_EXIT.

Variable Documentation

reason_hdr_str

const pj_str_t reason_hdr_str = { "Reason", 6}

static

Definition at line 24 of file pjsip_session_reason_header.c.

Referenced by reason_header_outgoing_response().

reason_header_supplement

struct ast_sip_session_supplement reason_header_supplement

static

Initial value:

= {
    .method = "INVITE",
    .priority = AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL + 1, 
    .outgoing_response = reason_header_outgoing_response,
}

Definition at line 154 of file pjsip_session_reason_header.c.

Referenced by pjsip_reason_header_load(), and pjsip_reason_header_unload().

return_reason_info

struct ast_datastore_info return_reason_info

static

Initial value:

= {
    .type = RETURN_REASON_DATASTORE_NAME,
    .destroy = return_reason_destructor,
}

Definition at line 44 of file pjsip_session_reason_header.c.

Referenced by ast_sip_session_add_reason_header().