主页 > 原创 | 整理 | 学习笔记 > opensips启用presence(状态更新)功能

opensips启用presence(状态更新)功能

opensips presence模块用来更新客户端联系人在线状态。逻辑过程如下图所示:

presence-schema

1.处理过程
参考链接:http://www.opensips.org/Documentation/Tutorials-Presence-PresenceServer
客户端A发布自己的状态A-presence及订阅列表A-watch-list(订阅客户B)到presence服务器(模块),presence服务器将客户端状态(在线)A-presence存储到数据库presentity表中,将客户端订阅列表A-watch-list解析存储在数据库watchers、active_watchers表中。当另一被订阅客户端B发布状态B-presence及订阅列表B-watch-list(订阅客户A)时,presence服务器查询presentity表是否有B-watch-list订阅客户A的状态,如果A-presence状态没有过期则通知B客户端的A在线(A-presence)。
这个过程中,假设B订阅列表中包含订阅另一个客户端C,则在C登陆后并不会再向B发出C在线的通知,需要开启rls模块来实现这个功能。
参考链接:http://www.opensips.org/Documentation/Tutorials-RLS

2.配置文件
增加如下内容

loadmodule "presence.so"
loadmodule "presence_xml.so"

modparam("presence","db_url","mysql://opensips:opensipsrw@localhost/opensips")
modparam("presence", "server_address", "sip:sa@192.168.163.50:15060")
modparam("presence_xml", "force_active", 1)
modparam("xcap", "integrated_xcap_server", 1)


# -- pua and rls parameters --
loadmodule "pua.so"
modparam("pua","db_url","mysql://opensips:opensipsrw@localhost/opensips")

loadmodule "rls.so"
modparam("rls", "server_address", "sip:192.168.163.50:15060")
modparam("rls", "presence_server", "sip:192.168.163.50:15060")
modparam("rls", "to_presence_code", 10)

route修改如下内容

if (is_method("SUBSCRIBE") && uri==myself) {
       # in-dialog subscribe requests
                xlog("presence, SUBSCRIBE\n");
       route(handle_presence);
       exit;
     }
 if (is_method("PUBLISH|SUBSCRIBE"))
 {
        xlog("presence, PUBLISH|SUBSCRIBE\n");
    route(handle_presence);
   exit;
 }
 
  if (is_method("NOTIFY")) {
    t_newtran();
    rls_handle_notify();
    exit;
 }

route[handle_presence]
{
  if(!t_newtran()){
   sl_reply_error();
   exit;
 }

 if (is_method("PUBLISH")) {
        xlog("presence PUBLISH");
    handle_publish();
 } else

  if (is_method("SUBSCRIBE")) {
        xlog("presence SUBSCRIBE");
    rls_handle_subscribe();
   if ( $rc==10 )
      # SUBSCRIBE not hanled by RLS
   handle_subscribe();
 }

 exit;
}

完成内容参考如下(部分模块如xcap, xcap-diff为特性定制,与presence无关):

#
# $Id$
#
# OpenSIPS residential configuration script
#     by OpenSIPS Solutions <team@opensips-solutions.com>
#
# This script was generated via "make menuconfig", from
#   the "Residential" scenario.
# You can enable / disable more features / functionalities by
#   re-generating the scenario with different options.#
#
# Please refer to the Core CookBook at:
#      http://www.opensips.org/Resources/DocsCookbooks
# for a explanation of possible statements, functions and parameters.
#


####### Global Parameters #########

debug=4
log_stderror=no
log_facility=LOG_LOCAL0
#memlog=4
#mem_dump=4

fork=yes
children=4

/* uncomment the following lines to enable debugging */
#debug=6
#fork=no
#log_stderror=yes

/* uncomment the next line to enable the auto temporary blacklisting of
   not available destinations (default disabled) */
#disable_dns_blacklist=no

/* uncomment the next line to enable IPv6 lookup after IPv4 dns
   lookup failures (default disabled) */
#dns_try_ipv6=yes

/* comment the next line to enable the auto discovery of local aliases
   based on revers DNS on IPs */
auto_aliases=no


listen=udp:192.168.163.50:15060   # CUSTOMIZE ME

disable_tcp=no
listen=tcp:192.168.163.50:15060   # CUSTOMIZE ME

disable_tls=yes


####### Modules Section ########

#set module path
mpath="/lib64/opensips/modules/"

#### SIGNALING module
loadmodule "signaling.so"

#### StateLess module
loadmodule "sl.so"

#### Transaction Module
loadmodule "tm.so"
modparam("tm", "fr_timeout", 5)
modparam("tm", "fr_inv_timeout", 30)
modparam("tm", "restart_fr_on_each_reply", 0)
modparam("tm", "onreply_avp_mode", 1)

#### Record Route Module
loadmodule "rr.so"
/* do not append from tag to the RR (no need for this script) */
modparam("rr", "append_fromtag", 0)

#### MAX ForWarD module
loadmodule "maxfwd.so"

#### SIP MSG OPerationS module
loadmodule "sipmsgops.so"

#### FIFO Management Interface
loadmodule "mi_fifo.so"
modparam("mi_fifo", "fifo_name", "/tmp/opensips_fifo")
modparam("mi_fifo", "fifo_mode", 0666)


#### URI module
loadmodule "uri.so"
modparam("uri", "use_uri_table", 0)
modparam("uri", "db_url", "mysql://opensips:opensipsrw@localhost/opensips")






#### MYSQL module
loadmodule "db_mysql.so"



#### USeR LOCation module
loadmodule "usrloc.so"
modparam("usrloc", "nat_bflag", "NAT")
modparam("usrloc", "db_mode",   2)
modparam("usrloc", "db_url",
 "mysql://opensips:opensipsrw@localhost/opensips") # CUSTOMIZE ME


#### REGISTRAR module
loadmodule "registrar.so"
modparam("registrar", "tcp_persistent_flag", "TCP_PERSISTENT")
modparam("registrar", "received_avp", "$avp(received_nh)")
/* uncomment the next line not to allow more than 10 contacts per AOR */
#modparam("registrar", "max_contacts", 10)

#### ACCounting module
loadmodule "acc.so"
/* what special events should be accounted ? */
modparam("acc", "early_media", 0)
modparam("acc", "report_cancels", 0)
/* by default we do not adjust the direct of the sequential requests.
   if you enable this parameter, be sure the enable "append_fromtag"
   in "rr" module */
modparam("acc", "detect_direction", 0)
modparam("acc", "failed_transaction_flag", "ACC_FAILED")
/* account triggers (flags) */
modparam("acc", "db_flag", "ACC_DO")
modparam("acc", "db_missed_flag", "ACC_MISSED")
modparam("acc", "db_url",
  "mysql://opensips:opensipsrw@localhost/opensips") # CUSTOMIZE ME


#### AUTHentication modules
#loadmodule "auth.so"
#loadmodule "auth_db.so"
#modparam("auth_db", "calculate_ha1", yes)
#modparam("auth_db", "password_column", "password")
#modparam("auth_db", "db_url",
#  "mysql://opensips:opensipsrw@localhost/opensips") # CUSTOMIZE ME
#modparam("auth_db", "load_credentials", "")

#### AUTHentication modules
loadmodule "auth_proxy.so"
loadmodule "auth_xcap.so"
modparam("auth_xcap", "calculate_ha1", yes)
modparam("auth_xcap", "password_column", "password")
modparam("auth_xcap", "db_url",
  "mysql://opensips:opensipsrw@localhost/opensips") # CUSTOMIZE ME
modparam("auth_xcap", "load_credentials", "")
modparam("auth_xcap", "auth_xcap_host", "192.168.162.29:8082")
modparam("auth_xcap", "auth_xcap_prefix", "mis/poc.safecode/global")



#### ALIAS module
loadmodule "alias_db.so"
modparam("alias_db", "db_url",
  "mysql://opensips:opensipsrw@localhost/opensips") # CUSTOMIZE ME






#### DIALOG module
loadmodule "dialog.so"
modparam("dialog", "dlg_match_mode", 1)
modparam("dialog", "default_timeout", 21600)  # 6 hours timeout
modparam("dialog", "db_mode", 2)
modparam("dialog", "db_url",
  "mysql://opensips:opensipsrw@localhost/opensips") # CUSTOMIZE ME


####  NAT modules
loadmodule "nathelper.so"
modparam("nathelper", "natping_interval", 10)
modparam("nathelper", "ping_nated_only", 1)
modparam("nathelper", "received_avp", "$avp(received_nh)")

#loadmodule "rtpproxy.so"
#modparam("rtpproxy", "rtpproxy_sock", "udp:localhost:12221") # CUSTOMIZE ME



loadmodule "xcap.so"
#loadmodule "xcap_client.so"
loadmodule "xcap_control.so"
 
modparam("xcap", "db_url", "mysql://opensips:opensipsrw@localhost/opensips")
modparam("xcap", "xcap_table", "xcap")
#modparam("xcap_client", "periodical_query", 1)
#modparam("xcap_client", "query_period", 50)
modparam("xcap_control", "periodical_query", 20)
modparam("xcap_control", "query_period", 6000000)
modparam("xcap_control", "xcap_server_url", " ")
modparam("xcap_control", "xcap_ctl_db_url", "mysql://opensips:opensipsrw@localhost/opensips")
modparam("xcap_control", "xcap_ctl_db_table", "group_user")
modparam("xcap_control", "xcap_ctl_db_ge_table", "group_extension")
modparam("xcap_control", "xcap_curl_proxy", "")
modparam("xcap_control", "xcap_curl_resolve", "www.example.com:8080:192.168.162.20")


loadmodule "httpd.so"
modparam("httpd", "ip", "192.168.163.50")
modparam("httpd", "port", 8000)
modparam("httpd", "buf_size", 524288)
modparam("httpd", "post_buf_size", 40960)

loadmodule "mi_xmlrpc_ng.so"
modparam("mi_xmlrpc_ng", "mi_xmlrpc_ng_root", "xmlrpc")

loadmodule "xcap_diff.so"
modparam("xcap_diff", "xcap_diff_db_url", "mysql://opensips:opensipsrw@localhost/opensips")
modparam("xcap_diff", "xcap_diff_db_table", "group_user")
modparam("xcap_diff", "xcap_diff_db_ge_table", "group_extension")

loadmodule "presence.so"
loadmodule "presence_xml.so"

modparam("presence","db_url","mysql://opensips:opensipsrw@localhost/opensips")
modparam("presence", "server_address", "sip:sa@192.168.163.50:15060")
modparam("presence_xml", "force_active", 1)
modparam("xcap", "integrated_xcap_server", 1)


# -- pua and rls parameters --
loadmodule "pua.so"
modparam("pua","db_url","mysql://opensips:opensipsrw@localhost/opensips")

loadmodule "rls.so"
modparam("rls", "server_address", "sip:192.168.163.50:15060")
modparam("rls", "presence_server", "sip:192.168.163.50:15060")
modparam("rls", "to_presence_code", 10)

####### Routing Logic ########

# main request routing logic

route{
  force_rport();
  if (nat_uac_test("23")) {
   if (is_method("REGISTER")) {
      fix_nated_register();
     setbflag(NAT);
    } else {
      fix_nated_contact();
      setflag(NAT);
   }
 }
   

  if (!mf_process_maxfwd_header("10")) {
    sl_send_reply("483","Too Many Hops");
   exit;
 }

 if (has_totag()) {
    # sequential request withing a dialog should
    # take the path determined by record-routing
    if (loose_route()) {
     
      # validate the sequential request against dialog
      if ( $DLG_status!=NULL && !validate_dialog() ) {
        xlog("In-Dialog $rm from $si (callid=$ci) is not valid according to dialog\n");
        ## exit;
      }
     
      if (is_method("BYE")) {
       setflag(ACC_DO); # do accounting ...
        setflag(ACC_FAILED); # ... even if the transaction fails
      } else if (is_method("INVITE")) {
       # even if in most of the cases is useless, do RR for
        # re-INVITEs alos, as some buggy clients do change route set
        # during the dialog.
        record_route();
     }

     if (check_route_param("nat=yes"))
        setflag(NAT);

     # route it out to whatever destination was set by loose_route()
     # in $du (destination URI).
     route(relay);
   } else {
      if (is_method("SUBSCRIBE") && uri==myself) {
        # in-dialog subscribe requests
                xlog("presence, SUBSCRIBE\n");
       route(handle_presence);
       exit;
     } else if ( is_method("ACK") ) {
        if ( t_check_trans() ) {
          # non loose-route, but stateful ACK; must be an ACK after
          # a 487 or e.g. 404 from upstream server
          t_relay();
          exit;
       } else {
          # ACK without matching transaction ->
         # ignore and discard
          exit;
       }
     }
     sl_send_reply("404","Not here");
    }
   exit;
 }

 # CANCEL processing
 if (is_method("CANCEL"))
  {
   if (t_check_trans())
      t_relay();
    exit;
 }

 t_check_trans();

  if ( !(is_method("REGISTER")  ) ) {
   
    if (from_uri==myself)
   
    {
     
      # authenticate if from local subscriber
     # authenticate all initial non-REGISTER request that pretend to be
      # generated by local subscriber (domain from FROM URI is local)
     if (!proxy_xcap_authorize("", "subscriber")) {
        proxy_challenge("", "0");
       exit;
     }
     if (!db_check_from()) {
       sl_send_reply("403","Forbidden auth ID");
       exit;
     }
   
      consume_credentials();
      # caller authenticated
     
    } else {
      # if caller is not local, then called number must be local
     
      if (!uri==myself) {
       send_reply("403","Rely forbidden");
       exit;
     }
   }

 }

 # preloaded route checking
  if (loose_route()) {
    xlog("L_ERR",
   "Attempt to route with preloaded Route's [$fu/$tu/$ru/$ci]");
    if (!is_method("ACK"))
      sl_send_reply("403","Preload Route denied");
    exit;
 }

 # record routing
  if (!is_method("REGISTER|MESSAGE"))
   record_route();

 # account only INVITEs
  if (is_method("INVITE")) {
   
    # create dialog with timeout
    if ( !create_dialog("B") ) {
      send_reply("500","Internal Server Error");
      exit;
   }
   
    setflag(ACC_DO); # do accounting
  }

 
  if (!uri==myself) {
   append_hf("P-hint: outbound\r\n");
   
    route(relay);
 }

 # requests for my domain
 
  if (is_method("PUBLISH|SUBSCRIBE"))
 {
        xlog("presence, PUBLISH|SUBSCRIBE\n");
    route(handle_presence);
   exit;
 }
 
  if (is_method("NOTIFY")) {
    t_newtran();
    rls_handle_notify();
    exit;
 }


 if (is_method("REGISTER"))
  {
   # authenticate the REGISTER requests
    if (!www_xcap_authorize("", "subscriber"))
    {
     www_challenge("", "0");
     exit;
   }
   
    if (!db_check_to())
    {
     sl_send_reply("403","Forbidden auth ID");
     exit;
   }

   if ( proto==TCP ||  0 ) setflag(TCP_PERSISTENT);

    if (!save("location"))
      sl_reply_error();

   exit;
 }

 if ($rU==NULL) {
    # request with no Username in RURI
    sl_send_reply("484","Address Incomplete");
    exit;
 }

 
  # apply DB based aliases
  alias_db_lookup("dbaliases");

 

   

 # do lookup with method filtering
 if (!lookup("location","m")) {
    if (!db_does_uri_exist()) {
     send_reply("420","Bad Extension");
      exit;
   }
   
    t_newtran();
    t_reply("404", "Not Found");
    exit;
 }

  if (isbflagset(NAT)) setflag(NAT);

  # when routing via usrloc, log the missed calls also
  setflag(ACC_MISSED);
  route(relay);
}


route[relay] {
  # for INVITEs enable some additional helper routes
  if (is_method("INVITE")) {
   
    if (isflagset(NAT)) {
     #rtpproxy_offer("ro");
    }

   t_on_branch("per_branch_ops");
    t_on_reply("handle_nat");
   t_on_failure("missed_call");
  }

 if (isflagset(NAT)) {
   add_rr_param(";nat=yes");
   }

 if (!t_relay()) {
   send_reply("500","Internal Error");
 };
  exit;
}

route[handle_presence]
{
 if(!t_newtran()){
   sl_reply_error();
   exit;
 }

 if (is_method("PUBLISH")) {
        xlog("presence PUBLISH");
    handle_publish();
 } else

  if (is_method("SUBSCRIBE")) {
        xlog("presence SUBSCRIBE");
    rls_handle_subscribe();
   if ( $rc==10 )
      # SUBSCRIBE not hanled by RLS
   handle_subscribe();
 }

 exit;
}


branch_route[per_branch_ops] {
  xlog("new branch at $ru\n");
}


onreply_route[handle_nat] {
 if (nat_uac_test("1"))
    fix_nated_contact();
  if ( isflagset(NAT) )
   #rtpproxy_answer("ro");
 xlog("incoming reply\n");
}


failure_route[missed_call] {
 if (t_was_cancelled()) {
    exit;
 }

 # uncomment the following lines if you want to block client
  # redirect based on 3xx replies.
  ##if (t_check_status("3[0-9][0-9]")) {
  ##t_reply("404","Not found");
 ##  exit;
 ##}

 
}

local_route {
  if (is_method("BYE") && $DLG_dir=="UPSTREAM") {
   
    acc_db_request("200 Dialog Timeout", "acc");
   
  }
}

3.客户端验证
linux主机下使用linphone、SFLphone客户端验证登陆状态,如下图所示:
a

b

c

Tags: opensips presence presence-xml rls

评论:2

  1. 李山 回复
    2015 年 12 月 17 日 于 下午 3:53

    请问下,我配置完opensips后,如果多个客户端同时登录一个帐号的话,会造成多个客户端同时接到电话,怎么配置才能做到同一个帐号同时只能在一个客户端登录呢,也就是说,登录帐号,把其他客户端登录的踢掉。
    我找了好多资料没有介绍,看到你这个文章后,有了一线希望,希望能给指条明路,跪谢!

    • tianyu 回复
      2015 年 12 月 17 日 于 下午 4:02

      隔太久了我也不知道要怎么弄,试试 modparam(“registrar”, “max_contact”, 1),具体看模块的文档吧

发表评论

电子邮件地址不会被公开。 必填项已用*标注