b2b_entities: add support for using extra_params for ua_server_init

Author: razvancrainea

modules/b2b_entities/b2b_entities.c

@@ -101,6 +101,7 @@ static const cmd_export_t cmds[] = {
 		{CMD_PARAM_VAR|CMD_PARAM_OPT, 0, 0},
 		{CMD_PARAM_STR|CMD_PARAM_OPT|CMD_PARAM_FIX_NULL,
 			fixup_ua_flags, fixup_free_ua_flags},
+		{CMD_PARAM_STR|CMD_PARAM_OPT, 0, 0},
 		{0,0,0}},
 		REQUEST_ROUTE},
 	{"ua_session_update", (cmd_function)b2b_ua_update, {

modules/b2b_entities/dlg.c

@@ -1361,7 +1361,7 @@ int b2b_prescript_f(struct sip_msg *msg, void *uparam)
 		}
 
 		if (ua_ev_type != -1 && raise_ua_sess_event(&b2b_key, etype, ua_ev_type,
-			ua_flags, msg) < 0) {
+			ua_flags, msg, NULL) < 0) {
 			LM_ERR("Failed to raise E_UA_SESSION event\n");
 			return SCB_DROP_MSG;
 		}
@@ -3673,7 +3673,7 @@ void b2b_tm_cback(struct cell *t, b2b_table htable, struct tmcb_params *ps)
 		else
 			ua_ev_type = UA_SESS_EV_REJECTED;
 
-		if (raise_ua_sess_event(b2b_key, etype, ua_ev_type, ua_flags, msg) < 0) {
+		if (raise_ua_sess_event(b2b_key, etype, ua_ev_type, ua_flags, msg, NULL) < 0) {
 			LM_ERR("Failed to raise E_UA_SESSION event\n");
 			goto error1;
 		}

modules/b2b_entities/doc/b2b_entities_admin.xml

@@ -375,7 +375,7 @@ modparam("b2b_entities", "ua_default_timeout", 7200)
 		<title>Exported Functions</title>
 	<section id="func_ua_session_server_init" xreflabel="ua_session_server_init()">
 		<title>
-		<function moreinfo="none">ua_session_server_init([key], [flags])</function>
+		<function moreinfo="none">ua_session_server_init([key], [flags], [extra_params])</function>
 		</title>
 		<para>
 		This function initializes a new UA session by processing an initial INVITE.
@@ -429,6 +429,11 @@ modparam("b2b_entities", "ua_default_timeout", 7200)
 					</para></listitem>
 				</itemizedlist>
 			</para></listitem>
+			<listitem><para>
+				<emphasis>extra_params (string, optional)</emphasis> - An arbitrary
+				value to be passed to the <emphasis>extra_params</emphasis> parameter
+				in the <xref linkend="event_E_UA_SESSION"/> event.
+			</para></listitem>
 		</itemizedlist>
 		<para>
 		This function can be used from REQUEST_ROUTE.
@@ -875,6 +880,12 @@ opensips-cli -x mi ua_session_terminate key=B2B.436.1925389.1649338095
 				<emphasis>headers</emphasis> - full list of all SIP headers in the
 				message.
 			</para></listitem>
+			<listitem><para>
+				<emphasis>extra_params</emphasis> - an arbitrary value. Currently only
+				the <xref linkend="func_ua_session_server_init"/> function passes this
+				if the <emphasis>extra_params</emphasis> argument is used, and it only
+				appears in the <emphasis>NEW</emphasis> event_type.
+			</para></listitem>
 		</itemizedlist>
 	</section>
 

modules/b2b_entities/ua_api.c

@@ -58,7 +58,7 @@ static str evi_ua_sess_name = str_init("E_UA_SESSION");
 static evi_params_p evi_ua_sess_params;
 static evi_param_p evi_key_param, evi_ev_type_param, evi_ent_type_param,
 	evi_status_param, evi_reason_param, evi_method_param, evi_body_param,
-	evi_headers_param;
+	evi_headers_param, evi_extra_param;
 
 static str evi_key_pname = str_init("key");
 static str evi_ent_type_pname = str_init("entity_type");
@@ -68,6 +68,7 @@ static str evi_reason_pname = str_init("reason");
 static str evi_method_pname = str_init("method");
 static str evi_body_pname = str_init("body");
 static str evi_headers_pname = str_init("headers");
+static str evi_extra_pname = str_init("extra_params");
 
 int ua_evi_init(void)
 {
@@ -116,6 +117,10 @@ int ua_evi_init(void)
 		&evi_headers_pname);
 	if (evi_headers_param == NULL)
 		goto error;
+	evi_extra_param = evi_param_create(evi_ua_sess_params,
+		&evi_extra_pname);
+	if (evi_extra_param == NULL)
+		goto error;
 
 	return 0;
 error:
@@ -164,7 +169,7 @@ static str event_type_str[] = {
 static str entity_type_str[] = {str_init("UAS"), str_init("UAC")};
 
 int raise_ua_sess_event(str *key, enum b2b_entity_type ent_type,
-	enum ua_sess_event_type ev_type, unsigned int flags, struct sip_msg *msg)
+	enum ua_sess_event_type ev_type, unsigned int flags, struct sip_msg *msg, str *extra)
 {
 	str body = {0,0};
 	str hdrs = {0,0};
@@ -232,6 +237,11 @@ int raise_ua_sess_event(str *key, enum b2b_entity_type ent_type,
 		goto error;
 	}
 
+	if (evi_param_set_str(evi_extra_param, (extra?extra:&empty)) < 0) {
+		LM_ERR("cannot set event extra parameter\n");
+		goto error;
+	}
+
 	if (evi_raise_event(evi_ua_sess_id, evi_ua_sess_params) < 0) {
 		LM_ERR("cannot raise event\n");
 		goto error;
@@ -774,7 +784,7 @@ int b2b_ua_reply(struct sip_msg *msg, str *key, str *method, int *code,
 }
 
 int b2b_ua_server_init(struct sip_msg *msg, pv_spec_t *key_spec,
-	struct ua_sess_init_params *init_params)
+	struct ua_sess_init_params *init_params, str *extra)
 {
 	pv_value_t key_pval;
 	str *key_ret = NULL;
@@ -810,7 +820,7 @@ int b2b_ua_server_init(struct sip_msg *msg, pv_spec_t *key_spec,
 
 	if (!(init_params->flags&UA_FL_SUPPRESS_NEW) &&
 		raise_ua_sess_event(key_ret, B2B_SERVER, UA_SESS_EV_NEW,
-		init_params->flags, msg) < 0) {
+		init_params->flags, msg, NULL) < 0) {
 		LM_ERR("Failed to raise E_UA_SESSION event\n");
 		goto error;
 	}

modules/b2b_entities/ua_api.h

@@ -92,7 +92,7 @@ int fixup_ua_flags(void** param);
 int fixup_free_ua_flags(void** param);
 
 int b2b_ua_server_init(struct sip_msg *msg, pv_spec_t *key_spec,
-	struct ua_sess_init_params *init_params);
+	struct ua_sess_init_params *init_params, str *extra);
 int b2b_ua_update(struct sip_msg *msg, str *key, str *method, str *body,
 	str *extra_headers, str *content_type);
 int b2b_ua_reply(struct sip_msg *msg, str *key, str *method, int *code,
@@ -112,6 +112,6 @@ mi_response_t *b2b_ua_session_list(const mi_params_t *params,
 
 int ua_evi_init(void);
 int raise_ua_sess_event(str *key, enum b2b_entity_type ent_type,
-	enum ua_sess_event_type ev_type, unsigned int flags, struct sip_msg *msg);
+	enum ua_sess_event_type ev_type, unsigned int flags, struct sip_msg *msg, str *extra);
 
-#endif
+#endif