Presence User Agent for XMPP (Presence gateway between SIP and XMPP)

Anca-Maria Vamanu

Edited by

Anca-Maria Vamanu

   Copyright © 2007 Voice Sistem SRL
   Revision History
   Revision $Revision: 8740 $ $Date$
     __________________________________________________________

   Table of Contents

   1. Admin Guide

        1.1. Overview
        1.2. Dependencies

              1.2.1. OpenSIPS Modules
              1.2.2. External Libraries or Applications

        1.3. Exported Parameters

              1.3.1. server_address(str)
              1.3.2. presence_server (str)

        1.4. Exported Functions

              1.4.1. pua_xmpp_notify()
              1.4.2. pua_xmpp_req_winfo(char* request_uri, char*
                      expires)

        1.5. Filtering

   2. Developer Guide

   List of Examples

   1.1. Set server_address parameter
   1.2. Set presence_server parameter
   1.3. Notify2Xmpp usage
   1.4. xmpp_send_winfo usage

Chapter 1. Admin Guide

1.1. Overview

   This module is a gateway for presence between SIP and XMPP.

   It translates one format into another and uses xmpp, pua and
   presence modules to manage the transmition of presence state
   information.

1.2. Dependencies

1.2.1. OpenSIPS Modules

   The following modules must be loaded before this module:
     * presence.
     * pua.
     * xmpp.

1.2.2. External Libraries or Applications

   The following libraries or applications must be installed
   before running OpenSIPS with this module loaded:
     * libxml.

1.3. Exported Parameters

1.3.1. server_address(str)

   The IP address of the server.

   Example 1.1. Set server_address parameter
...
modparam("pua_xmpp", "server_address", "sip:sa@opensips.org:5060")
...

1.3.2. presence_server (str)

   The the address of the presence server. If set, it will be used
   as outbound proxy when sending PUBLISH requests.

   Example 1.2. Set presence_server parameter
...
modparam("pua_xmpp", "presence_server", "sip:pa@opensips.org:5075")
...

1.4. Exported Functions

   Functions exported to be used in configuration file.

1.4.1.  pua_xmpp_notify()

   Function that handles Notify messages addressed to a user from
   an xmpp domain. It requires filtering after method and domain
   in configuration file. If the function is successful, a 2xx
   reply must be sent.

   This function can be used from REQUEST_ROUTE.

   Example 1.3. Notify2Xmpp usage
...
        if( is_method("NOTIFY") && uri=~"sip:.+@sip-xmpp.siphub.ro")
        {
                if(Notify2Xmpp())
                        t_reply("200", "OK");
                exit;
        }
...

1.4.2.  pua_xmpp_req_winfo(char* request_uri, char* expires)

   Function called when a Subscribe addressed to a user from a
   xmpp domain is received. It calls sending a Subscribe for winfo
   for the user, and the following Notify with dialog-info is
   translated into a subscription in xmpp. It also requires
   filtering in configuration file, after method, domain and
   event(only for presence).

   It takes 2 parameters: request_uri and the value of Expires
   header field in received Subscribe.

   This function can be used from REQUEST_ROUTE.

   Example 1.4. xmpp_send_winfo usage
...
        if( is_method("SUBSCRIBE"))
        {
                handle_subscribe();
                if(uri=~"sip:.+@sip-xmpp.siphub.ro" && $hdr(Event)== "pr
esence")
                {
                        pua_xmpp_req_winfo("$ruri", "$hdr(Expires)");
                }
                t_release();
        }

...

1.5.  Filtering

   Instead of "sip-xmpp.siphub.ro" in the example you should use
   the value set for the xmpp module parameter named
   'gateway_domain'.

Chapter 2. Developer Guide

   The module provides no function to be used in other OpenSIPS
   modules.
