MODENDP-179 - Support for SLA, works with Polycom and Snom(Sylantro mode). …

MODENDP-179 - Support for SLA, works with Polycom and Snom(Sylantro mode).  Thank you Matthew Kaufman.  Might still need more work.



git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@11562 d0543943-73ff-0310-b7d9-9358b9ac24b2

conf/sip_profiles/internal.xml

@@ -62,7 +62,7 @@
     <param name="record-template" value="$${base_dir}/recordings/${caller_id_number}.${target_domain}.${strftime(%Y-%m-%d-%H-%M-%S)}.wav"/>
     <!--enable to use presence -->
     <param name="manage-presence" value="true"/>
-
+    <!--<param name="manage-shared-appearance" value="true"/>-->
     <!-- used to share presence info across sofia profiles -->
     <!-- Name of the db to use for this profile -->
     <!--<param name="dbname" value="share_presence"/>-->

src/mod/endpoints/mod_sofia/Makefile.am

@@ -17,7 +17,7 @@ SOFIAUA_DIR=$(SOFIA_DIR)/libsofia-sip-ua
 SOFIALA=$(SOFIAUA_DIR)/libsofia-sip-ua.la
 
 mod_LTLIBRARIES = mod_sofia.la
-mod_sofia_la_SOURCES = mod_sofia.c sofia.c sofia_glue.c sofia_presence.c sofia_reg.c  mod_sofia.h
+mod_sofia_la_SOURCES = mod_sofia.c sofia.c sofia_glue.c sofia_presence.c sofia_reg.c sofia_sla.c  mod_sofia.h
 mod_sofia_la_CFLAGS  = $(AM_CFLAGS) 
 mod_sofia_la_CFLAGS += -I. -I$(SOFIAUA_DIR)/bnf  -I$(SOFIAUA_DIR)/features
 mod_sofia_la_CFLAGS += -I$(SOFIAUA_DIR)/http -I$(SOFIAUA_DIR)/ipt

src/mod/endpoints/mod_sofia/mod_sofia.h

@@ -375,6 +375,7 @@ struct sofia_profile {
 	char *tls_bindurl;
 	char *tcp_contact;
 	char *tls_contact;
+	char *sla_contact;
 	char *sipdomain;
 	char *timer_name;
 	char *hold_music;
@@ -439,6 +440,7 @@ struct sofia_profile {
 	sofia_media_options_t media_options;
 	uint32_t force_subscription_expires;
 	switch_rtp_bug_flag_t auto_rtp_bugs;
+	char manage_shared_appearance;  /* pflags was all full up - MTK */
 };
 
 struct private_object {
@@ -474,7 +476,6 @@ struct private_object {
 	char *from_address;
 	char *to_address;
 	char *callid;
-	char *far_end_contact;
 	char *contact_url;
 	char *from_str;
 	char *rpid;
@@ -771,3 +772,14 @@ const char * sofia_state_string(int state);
 switch_status_t sofia_glue_tech_set_codec(private_object_t *tech_pvt, int force);
 void sofia_wait_for_reply(struct private_object *tech_pvt, nua_event_t event, uint32_t timeout);
 void sofia_glue_set_image_sdp(private_object_t *tech_pvt, switch_t38_options_t *t38_options);
+
+/*
+ * SLA (shared line appearance) entrypoints
+ */
+
+void sofia_sla_handle_register(nua_t *nua, sofia_profile_t *profile, sip_t const *sip);
+void sofia_sla_handle_sip_i_publish(nua_t *nua, sofia_profile_t *profile, nua_handle_t *nh, sip_t const *sip, tagi_t tags[]);
+void sofia_sla_handle_sip_i_subscribe(nua_t *nua, sofia_profile_t *profile, nua_handle_t *nh, sip_t const *sip, tagi_t tags[]);
+void sofia_sla_handle_sip_r_subscribe(nua_t *nua, sofia_profile_t *profile, nua_handle_t *nh, sip_t const *sip, tagi_t tags[]);
+void sofia_sla_handle_sip_i_notify(nua_t *nua, sofia_profile_t *profile, nua_handle_t *nh, sip_t const *sip, tagi_t tags[]);
+

src/mod/endpoints/mod_sofia/sofia.c

@@ -94,8 +94,33 @@ void sofia_handle_sip_i_notify(switch_core_session_t *session, int status,
 		goto error;
 	}
 
+	/* the following could be refactored back to the calling event handler here in sofia.c XXX MTK */
+	/* potentially interesting note: for Linksys shared appearance, we'll probably have to set up to get bare notifies
+	 * and pass them inward to the sla handler. we'll have to set NUTAG_APPL_METHOD("NOTIFY") when creating
+	 * nua, and also pick them off special elsewhere here in sofia.c - MTK
+	 * *and* for Linksys, I believe they use "sa" as their magic appearance agent name for those blind notifies, so
+	 * we'll probably have to change to match
+	*/
+	if (profile->manage_shared_appearance) {
+		
+		if (!strncmp(sip->sip_request->rq_url->url_user, "sla-agent", sizeof("sla-agent"))) {
+			int sub_state;
+			tl_gets(tags, NUTAG_SUBSTATE_REF(sub_state), TAG_END());
+			
+			sofia_sla_handle_sip_i_notify(nua, profile, nh, sip, tags);
+
+			if (sub_state == nua_substate_terminated) {
+				nua_handle_bind(nh, NULL);
+				nua_handle_destroy(nh);
+			}
+
+			return;
+		}
+	}
+
 	/* Automatically return a 200 OK for Event: keep-alive */
 	if (!strcasecmp(sip->sip_event->o_type, "keep-alive")) {
+		/* XXX MTK - is this right? in this case isn't sofia is already sending a 200 itself also? */
 		nua_respond(nh, SIP_200_OK, NUTAG_WITH_THIS(nua), TAG_END());
 		return;
 	}
@@ -305,6 +330,7 @@ void sofia_event_callback(nua_event_t event,
 	switch_channel_t *channel = NULL;
 	sofia_gateway_t *gateway = NULL;
 	int locked = 0;
+	int check_destroy = 1;
 
 	if (sofia_private && sofia_private != &mod_sofia_globals.destroy_private && sofia_private != &mod_sofia_globals.keep_private) {
 		if ((gateway = sofia_private->gateway)) {
@@ -476,8 +502,23 @@ void sofia_event_callback(nua_event_t event,
 
 	switch (event) {
 	case nua_i_subscribe:
+	case nua_r_notify:
+		check_destroy = 0;
+		break;
+
+	case nua_i_notify:
+		
+		if (sip->sip_event && !strcmp(sip->sip_event->o_type, "dialog") && sip->sip_event->o_params && !strcmp(sip->sip_event->o_params[0], "sla")) {
+			check_destroy = 0;
+		}
+
 		break;
 	default:
+		break;
+	}
+
+
+	if (check_destroy) {
 		if (nh && ((sofia_private && sofia_private->destroy_nh) || !nua_handle_magic(nh))) {
 			if (sofia_private) {
 				nua_handle_bind(nh, NULL);
@@ -485,7 +526,6 @@ void sofia_event_callback(nua_event_t event,
 			nua_handle_destroy(nh);
 			nh = NULL;
 		}
-		break;
 	}
 	
 	if (sofia_private && sofia_private->destroy_me) {
@@ -719,9 +759,9 @@ void *SWITCH_THREAD_FUNC sofia_profile_thread_run(switch_thread_t *thread, void
 				   TAG_IF(profile->pres_type, NUTAG_ALLOW("SUBSCRIBE")),
 				   TAG_IF(profile->pres_type, NUTAG_ENABLEMESSAGE(1)),
 				   TAG_IF(profile->pres_type, NUTAG_ALLOW_EVENTS("presence")),
-				   TAG_IF(profile->pres_type, NUTAG_ALLOW_EVENTS("dialog")),
+				   TAG_IF((profile->pres_type || profile->manage_shared_appearance), NUTAG_ALLOW_EVENTS("dialog")),
 				   TAG_IF(profile->pres_type, NUTAG_ALLOW_EVENTS("call-info")),
-				   TAG_IF(profile->pres_type, NUTAG_ALLOW_EVENTS("sla")),
+				   TAG_IF((profile->pres_type || profile->manage_shared_appearance), NUTAG_ALLOW_EVENTS("sla")),
 				   TAG_IF(profile->pres_type, NUTAG_ALLOW_EVENTS("include-session-description")),
 				   TAG_IF(profile->pres_type, NUTAG_ALLOW_EVENTS("presence.winfo")),
 				   TAG_IF(profile->pres_type, NUTAG_ALLOW_EVENTS("message-summary")),
@@ -738,7 +778,6 @@ void *SWITCH_THREAD_FUNC sofia_profile_thread_run(switch_thread_t *thread, void
 
 		nua_set_params(node->nua,
 					   NUTAG_APPL_METHOD("OPTIONS"),
-					   NUTAG_EARLY_MEDIA(1),
 					   NUTAG_AUTOANSWER(0),
 					   NUTAG_AUTOALERT(0),
 					   TAG_IF((profile->mflags & MFLAG_REGISTER), NUTAG_ALLOW("REGISTER")),
@@ -1954,6 +1993,11 @@ switch_status_t config_sofia(int reload, char *profile_name)
 						} else if (switch_true(val)) {
 							profile->pres_type = PRES_TYPE_FULL;
 						} 
+					} else if (!strcasecmp(var, "manage-shared-appearance")) {
+						if (switch_true(val)) {
+							profile->manage_shared_appearance = 1;
+							profile->sla_contact = switch_core_sprintf(profile->pool, "sip:sla-agent@%s", profile->sipip);
+						}
 					} else if (!strcasecmp(var, "unregister-on-options-fail")) {
 						if (switch_true(val)) {
 							profile->pflags |= PFLAG_UNREG_OPTIONS_FAIL;
@@ -4282,7 +4326,78 @@ void sofia_handle_sip_i_invite(nua_t *nua, sofia_profile_t *profile, nua_handle_
 		}
 	}
 
+	if (sip->sip_replaces) {
+		nua_handle_t *bnh;
+		if ((bnh = nua_handle_by_replaces(nua, sip->sip_replaces))) {
+			sofia_private_t *b_private = NULL;
+			if ((b_private = nua_handle_magic(bnh))) {
+				switch_core_session_t *b_session = NULL;
+				if ((b_session = switch_core_session_locate(b_private->uuid))) {
+					switch_channel_t *b_channel = switch_core_session_get_channel(b_session);
+					const char *uuid;
+					int one_leg = 1;
+					private_object_t *b_tech_pvt = NULL;
+					const char *app = switch_channel_get_variable(b_channel, SWITCH_CURRENT_APPLICATION_VARIABLE);
+					const char *data = switch_channel_get_variable(b_channel, SWITCH_CURRENT_APPLICATION_DATA_VARIABLE);
+					
+					if (app && data && !strcasecmp(app, "conference")) {
+						destination_number = switch_core_session_sprintf(b_session, "answer,conference:%s", data);
+						dialplan = "inline";
+					} else {
+						if (switch_core_session_check_interface(b_session, sofia_endpoint_interface)) {
+							b_tech_pvt = switch_core_session_get_private(b_session);
+						}
+
+						if ((uuid = switch_channel_get_variable(b_channel, SWITCH_SIGNAL_BOND_VARIABLE))) {
+							one_leg = 0;
+						} else {
+							uuid = switch_core_session_get_uuid(b_session);
+						}
+					
+						if (uuid) {
+							switch_core_session_t *c_session = NULL;
+							int do_conf = 0;					
+						
+							uuid = switch_core_session_strdup(b_session, uuid);
+
+							if ((c_session = switch_core_session_locate(uuid))) {
+								switch_channel_t *c_channel = switch_core_session_get_channel(c_session);
+								private_object_t *c_tech_pvt = NULL;
+					
+								if (switch_core_session_check_interface(c_session, sofia_endpoint_interface)) {
+									c_tech_pvt = switch_core_session_get_private(c_session);
+								}
+								
+
+								if (!one_leg && 
+									(!b_tech_pvt || !switch_test_flag(b_tech_pvt, TFLAG_SIP_HOLD)) && 
+									(!c_tech_pvt || !switch_test_flag(c_tech_pvt, TFLAG_SIP_HOLD))) {
+									char *ext = switch_core_session_sprintf(b_session, "conference:%s@sla+flags{mintwo}", uuid);
+								
+									switch_channel_set_flag(c_channel, CF_REDIRECT);
+									switch_ivr_session_transfer(b_session, ext, "inline", NULL);
+									switch_ivr_session_transfer(c_session, ext, "inline", NULL);
+									switch_channel_clear_flag(c_channel, CF_REDIRECT);
+									do_conf = 1;
+								}
+								switch_core_session_rwunlock(c_session);
+							}
+						
+							if (do_conf) {
+								destination_number = switch_core_session_sprintf(b_session, "answer,conference:%s@sla+flags{mintwo}", uuid);
+							} else {
+								destination_number = switch_core_session_sprintf(b_session, "answer,intercept:%s", uuid);
+							}
 
+							dialplan = "inline";
+						}
+					}
+					switch_core_session_rwunlock(b_session);
+				}
+			}
+			nua_handle_unref(bnh);
+		}
+	}
 
 	check_decode(displayname, session);
 	tech_pvt->caller_profile = switch_caller_profile_new(switch_core_session_get_pool(session),

src/mod/endpoints/mod_sofia/sofia_glue.c

@@ -3040,6 +3040,16 @@ int sofia_glue_init_sql(sofia_profile_t *profile)
 		"   hostname        VARCHAR(255)\n"
 		");\n";
 
+	/* should we move this glue to sofia_sla or keep it here where all db init happens? XXX MTK */
+	char shared_appearance_sql[] = 
+		"CREATE TABLE sip_shared_appearance_subscriptions (\n"
+		"   subscriber        VARCHAR(255),\n"
+		"   call_id           VARCHAR(255),\n"
+		"   aor               VARCHAR(255),\n"
+		"   profile_name      VARCHAR(255),\n"
+		"   hostname          VARCHAR(255)\n"
+		");\n";
+
 	if (profile->odbc_dsn) {
 #ifdef SWITCH_HAVE_ODBC
 		if (!(profile->master_odbc = switch_odbc_handle_new(profile->odbc_dsn, profile->odbc_user, profile->odbc_pass))) {
@@ -3094,6 +3104,15 @@ int sofia_glue_init_sql(sofia_profile_t *profile)
 		}
 		free(test_sql);
 
+		if (profile->manage_shared_appearance) {
+			test_sql = switch_mprintf("delete from sip_shared_appearance_subscriptions where hostname='%q'", mod_sofia_globals.hostname);
+			if (switch_odbc_handle_exec(profile->master_odbc, test_sql, NULL) != SWITCH_ODBC_SUCCESS) {
+				switch_odbc_handle_exec(profile->master_odbc, "DROP TABLE sip_shared_appearance_subscriptions", NULL);
+				switch_odbc_handle_exec(profile->master_odbc, shared_appearance_sql, NULL);
+			}
+			free(test_sql);
+		}
+
 #else
 		switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "ODBC IS NOT AVAILABLE!\n");
 #endif
@@ -3125,6 +3144,16 @@ int sofia_glue_init_sql(sofia_profile_t *profile)
 		switch_core_db_test_reactive(profile->master_db, test_sql, "DROP TABLE sip_authentication", auth_sql);
 		free(test_sql);
 
+		if(profile->manage_shared_appearance) {
+			test_sql = switch_mprintf("delete from sip_shared_appearance_subscriptions where hostname='%q'", mod_sofia_globals.hostname);
+			switch_core_db_test_reactive(profile->master_db, test_sql, "DROP TABLE sip_shared_appearance_subscriptions", shared_appearance_sql);
+			free(test_sql);
+
+			switch_core_db_exec(profile->master_db, "create index if not exists ssa_hostname on sip_shared_appearance_subscriptions (hostname)", NULL, NULL, NULL);
+			/* XXX MTK create additional index for shared_appearance if necessary */
+		}
+
+
 		switch_core_db_exec(profile->master_db, "create index if not exists sr_call_id on sip_registrations (call_id)", NULL, NULL, NULL);
 		switch_core_db_exec(profile->master_db, "create index if not exists sr_sip_user on sip_registrations (sip_user)", NULL, NULL, NULL);
 		switch_core_db_exec(profile->master_db, "create index if not exists sr_sip_host on sip_registrations (sip_host)", NULL, NULL, NULL);

src/mod/endpoints/mod_sofia/sofia_presence.c

@@ -1423,6 +1423,17 @@ void sofia_presence_handle_sip_i_subscribe(int status,
 			return;
 		}
 
+		/* the following could be refactored back to the calling event handler in sofia.c XXX MTK */
+		if (profile->manage_shared_appearance) {
+			if (!strncmp(sip->sip_request->rq_url->url_user, "sla-agent", sizeof("sla-agent"))) {
+				/* only fire this on <200 to try to avoid resubscribes. probably better ways to do this? */
+				if (status < 200) {
+					sofia_sla_handle_sip_i_subscribe(nua, profile, nh, sip, tags);
+				}
+				return;
+			}
+		}
+
 		get_addr(network_ip, sizeof(network_ip), my_addrinfo->ai_addr, my_addrinfo->ai_addrlen);
 		network_port = ntohs(((struct sockaddr_in *) msg_addrinfo(nua_current_request(nua))->ai_addr)->sin_port);
 
@@ -1767,6 +1778,14 @@ void sofia_presence_handle_sip_r_subscribe(int status,
 		return;
 	}
 
+	/* the following could possibly be refactored back towards the calling event handler in sofia.c XXX MTK */
+	if (profile->manage_shared_appearance) {
+		if (!strcasecmp(o->o_type, "dialog") && msg_params_find(o->o_params, "sla")) {
+			sofia_sla_handle_sip_r_subscribe(nua, profile, nh, sip, tags);
+			return;
+		}
+	}
+
 	if (!sofia_private || !sofia_private->gateway) {
 		switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Gateway information missing\n");
 		return;
@@ -1810,6 +1829,15 @@ void sofia_presence_handle_sip_i_publish(nua_t *nua, sofia_profile_t *profile, n
 		sip_payload_t *payload = sip->sip_payload;
 		char *event_type;
 
+		/* the following could instead be refactored back to the calling event handler in sofia.c XXX MTK */
+		if (profile->manage_shared_appearance) {
+			/* also it probably is unsafe to dereference so many things in a row without testing XXX MTK */
+			if (!strncmp(sip->sip_request->rq_url->url_user, "sla-agent", sizeof("sla-agent"))) {
+				sofia_sla_handle_sip_i_publish(nua, profile, nh, sip, tags);
+				return;
+			}
+		}
+
 		if (from) {
 			from_user = (char *) from->a_url->url_user;
 			from_host = (char *) from->a_url->url_host;

src/mod/endpoints/mod_sofia/sofia_reg.c

@@ -1102,6 +1102,10 @@ uint8_t sofia_reg_handle_register(nua_t *nua, sofia_profile_t *profile, nua_hand
 			switch_event_fire(&s_event);
 		}
 
+		if (profile->manage_shared_appearance) {
+			sofia_sla_handle_register(nua, profile, sip);
+		}
+
 		return 1;
 	}