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


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
3. Contributors
3.1. By Commit Statistics
3.2. By Commit Activity
4. Documentation
4.1. Contributors

List of Tables

3.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
3.2. Most recently active contributors(1) to this module

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

Chapter1.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.

Example1.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.

Example1.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.

Example1.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.

Example1.4.xmpp_send_winfo usage

...
	if( is_method("SUBSCRIBE"))
	{
		handle_subscribe();
		if(uri=~"sip:.+@sip-xmpp.siphub.ro" && $hdr(Event)== "presence")
		{
			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'.

Chapter2.Developer Guide

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

Chapter3.Contributors

3.1.By Commit Statistics

Table3.1.Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)

NameDevScoreCommitsLines ++Lines --
1. Anca Vamanu58173287806
2. Bogdan-Andrei Iancu (@bogdan-iancu)16135881
3. Daniel-Constantin Mierla (@miconda)1082721
4. Liviu Chircu (@liviuchircu)862546
5. Razvan Crainea (@razvancrainea)531216
6. Ovidiu Sas (@ovidiusas)31142
7. Sergio Gutierrez3155
8. Vlad Paiu (@vladpaiu)31414
9. Konstantin Bokarius3135
10. Juha Heinanen (@juha-h)3133

All remaining contributors: Walter Doekes (@wdoekes), Edson Gellert Schubert, Stanislaw Pitucha.

(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)

(2) including any documentation-related commits, excluding merge commits. Regarding imported patches/code, we do our best to count the work on behalf of the proper owner, as per the "fix_authors" and "mod_renames" arrays in opensips/doc/build-contrib.sh. If you identify any patches/commits which do not get properly attributed to you, please submit a pull request which extends "fix_authors" and/or "mod_renames".

(3) ignoring whitespace edits, renamed files and auto-generated files

3.2.By Commit Activity

Table3.2.Most recently active contributors(1) to this module

NameCommit Activity
1. Bogdan-Andrei Iancu (@bogdan-iancu)Jul 2007 - Jun 2018
2. Liviu Chircu (@liviuchircu)Mar 2014 - Jun 2018
3. Razvan Crainea (@razvancrainea)Feb 2012 - Jan 2016
4. Ovidiu Sas (@ovidiusas)Jan 2013 - Jan 2013
5. Vlad Paiu (@vladpaiu)Aug 2011 - Aug 2011
6. Stanislaw PituchaJul 2010 - Jul 2010
7. Walter Doekes (@wdoekes)Apr 2010 - Apr 2010
8. Anca VamanuApr 2007 - Mar 2010
9. Sergio GutierrezNov 2008 - Nov 2008
10. Daniel-Constantin Mierla (@miconda)Sep 2007 - Mar 2008

All remaining contributors: Konstantin Bokarius, Edson Gellert Schubert, Juha Heinanen (@juha-h).

(1) including any documentation-related commits, excluding merge commits

Chapter4.Documentation

4.1.Contributors

Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Liviu Chircu (@liviuchircu), Razvan Crainea (@razvancrainea), Anca Vamanu, Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert.

doc copyrights:

Copyright 2007 Voice Sistem SRL