freeswitch修改mod_sofia模块并上报自定义头域
概述
在之前的文章中，我们介绍了如何使用fs的event事件机制来获取呼叫的各种信息。
这些event事件一般都是底层模块定义好的，其中的各种信息已经很完备了，日常的开发需求都可以满足。
但是，总有一些场景是无法完全满足的，例如，在fs的注册事件中，就没有X-自定义头域的信息。
在定制化的sip交互过程中，freeswitch是支持自定义头域的，头域格式要满足“X-***”的模式。而当我们订阅了"sofia::register"事件，在事件中是无法获得自定义头域的信息的。
本文从fs的核心模块mod_sofia的代码出发，分析如何增加对自定义头域的信息的获取和事件上报。
环境
centos：CentOS release 7.0 (Final)或以上版本
freeswitch：v1.8.7
GCC：4.8.5
mod_sofia模块
mod_sofia模块是fs在sofia-sip库的基础上实现的SIP终端模块，fs中所有的sip消息处理和上报都要通过mod_sofia模块来对接。
我们可以在 src\mod\endpoints\mod_sofia\sofia_reg.c 文件中，找到注册消息的处理函数“sofia_reg_handle_register_token”，并在函数中找到“MY_EVENT_REGISTER "sofia::register"”事件的创建和上报流程。
if (switch_event_create_subclass(&s_event, SWITCH_EVENT_CUSTOM, MY_EVENT_REGISTER) == SWITCH_STATUS_SUCCESS) {
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "profile-name", profile->name);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "from-user", to_user);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "from-host", reg_host);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "presence-hosts", profile->presence_hosts ? profile->presence_hosts : "n/a");
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "contact", contact_str);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "call-id", call_id);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "rpid", rpid);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "status", reg_desc);
switch_event_add_header(s_event, SWITCH_STACK_BOTTOM, "expires", "%ld", (long) exptime);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "to-user", from_user);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "to-host", from_host);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "network-ip", network_ip);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "network-port", network_port_c);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "username", username);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "realm", realm);
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "user-agent", agent);
if (update_registration) {
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, "update-reg", "true");
}
if (v_event && *v_event) {
switch_event_merge(s_event, *v_event);
}
//add by zr 20220121
for (sip_unknown_t *un = sip->sip_unknown; un; un = un->un_next) {
switch_event_add_header_string(s_event, SWITCH_STACK_BOTTOM, un->un_name, un->un_value);
}
switch_event_fire(&s_event);
}
从上面的代码中，我们可以看到“sofia::register”事件中包含的所有头域内容。
sofia sip协议栈会解析所有的头域，并把非标准的头域都放到“sip->sip_unknown”中。
在红色新增的代码中，我们把所有unknown的头域都放到register上报事件中。
编译
cd freeswitch-1.8.7/src/mod/endpoints/mod_sofia
make
make install
测试
启动freeswitch，使用sip终端注册1002账户。
使用api命令“/event plain ALL”打开fs的事件打印，可以在屏显中看到如下信息：
RECV EVENT
Event-Subclass: sofia::register
Event-Name: CUSTOM
Core-UUID: b95d5721-38f1-406d-b6f1-8c056394d63e
FreeSWITCH-Hostname: localhost.localdomain
FreeSWITCH-Switchname: localhost.localdomain
FreeSWITCH-IPv4: 192.168.0.152
FreeSWITCH-IPv6: ::1
Event-Date-Local: 2022-01-21 17:15:14
Event-Date-GMT: Fri, 21 Jan 2022 09:15:14 GMT
Event-Date-Timestamp: 1642756514420767
Event-Calling-File: sofia_reg.c
Event-Calling-Function: sofia_reg_handle_register_token
Event-Calling-Line-Number: 2011
Event-Sequence: 902
profile-name: internal
from-user: 1002
from-host: 192.168.0.152
presence-hosts: 192.168.0.152,192.168.0.152
contact: "1002" <sip:1002@10.9.136.138:1666;fs_nat=yes;fs_path=sip:1002@10.9.136.138:1666>
call-id: 1378235421@10.9.136.138
rpid: unknown
status: Registered(UDP-NAT)
expires: 3600
to-user: 1002
to-host: 192.168.0.152
network-ip: 10.9.136.138
network-port: 1666
username: 1002
realm: 192.168.0.152
user-agent: FaramAndroid/1.5.9
sip_number_alias: 1002
sip_auth_username: 1002
sip_auth_realm: 192.168.0.152
number_alias: 1002
user_name: 1002
domain_name: 192.168.0.152
record_stereo: true
default_gateway: example.com
default_areacode: 918
transfer_fallback_extension: operator
toll_allow: domestic,international,local
accountcode: 1002
user_context: default
effective_caller_id_name: Extension 1002
effective_caller_id_number: 1002
outbound_caller_id_name: FreeSWITCH
outbound_caller_id_number: 0000000000
callgroup: techsupport
X-Packet: com.sipp
X-Brand: huawei
X-Osver: 29
X-Token: IQAAAACy0eGUAAAWdHyqUVfb0b
X-Jgtoken: 190e35f7e0
X-Olduser: 12345678
我们可以在事件信息的最后看到“X-”开头的自定义头域信息打印。
总结
本文从fs的sip协议栈出发，修改了mod_sofia模块代码，增加自定义消息头域的事件上报，对sip消息的定制有一定参考意义。
但是，在日常的VOIP中，我们应该尽量避免自定义头域的使用，以避免兼容性的问题。
空空如常
求真得真
