$Revision: 1.3.2.1 $
$Date: 2005/06/22 23:12:06 $
User's Guide
Overview
This modules provides offline message storage for the &sername;. It stores received
messages for an offline user and sends them when the user becomes online.
For each message, the modules stores Request-URI
(R-URI
)
only if it is a complete address of record (username@hostname
), &uri;
from To
header, &uri; from From
header, incoming time,
expiration time, content type and body of the message. If R-URI
is not an
address of record (it might be the contact address for current &sip; session) the &uri;
from To
header will be used as R-URI.
When the expiration time passed, the message is discarded from database. Expiration
time is computed based on incoming time and one of the module's parameters.
Every time when a user registers with &ser;, the module is looking in database for offline
messages intended for that user. All of them will be sent to contact address provided in
REGISTER request.
It may happen the &sip; user to be registered but his &sip; User Agent to have no
support for MESSAGE request. In this case it should be used the
failure_route
to store the undelivered requests.
Dependencies
&ser; modules
The following modules must be loaded before this module:
database module - mysql, dbtext or other module
that implements the db
interface and provides support for
storing/receiving data to/from a database system.
TM--transaction module--is used to send &sip;
requests.
External libraries or applications
The following libraries or applications must be installed before running &ser; with
this module:
none.
Exported Parameters
<varname>db_url</varname> (string)
Database &url;.
Default value is mysql://root@localhost/msilo
.
Set the <quote>db_url</quote> parameter
...
modparam("msilo", "db_url", "mysql://user:passwd@host.com/dbname")
...
<varname>db_table</varname> (string)
The name of table where to store the messages.
Default value is silo
.
Set the <quote>db_table</quote> parameter
...
modparam("msilo", "db_table", "silo")
...
<varname>registrar</varname> (string)
The &sip; address used to inform users that destination of their message is not
online and the message will be delivered next time when that user goes online. If
the parameter is not set, the module will not send any notification. All requests
intended for this &sip; address will not be stored for lately delivery.
Default value is NULL
.
Set the <quote>registrar</quote> parameter
...
modparam("msilo", "registrar", "sip:registrar@iptel.org")
...
<varname>expire_time</varname> (int)
Expire time of stored messages - seconds. When this time passed, the message is
silently discarded from database.
Default value is 259200 (72 hours = 3 days)
.
Set the <quote>expire_time</quote> parameter
...
modparam("msilo", "expire_time", 36000)
...
<varname>check_time</varname> (int)
Timer interval to check if dumped messages are sent OK - seconds. The module keeps
each request send by itself for a new online user and if the reply is 2xx then the
message is deleted from database.
Default value is 30
.
Set the <quote>check_time</quote> parameter
...
modparam("msilo", "check_time", 10)
...
<varname>clean_period</varname> (int)
Number of check_time
cycles when to check if
there are expired messages in database.
Default value is 5
.
Set the <quote>clean_period</quote> parameter
...
modparam("msilo", "clean_period", "3")
...
<varname>use_contact</varname> (int)
Turns on/off the usage of the Contact address to send notification back to sender
whose message is stored by MSILO.
Default value is 1 (0 = off, 1 = on)
.
Set the <quote>param_name</quote> parameter
...
modparam("msilo", "use_contact", 0)
...
<varname>use_contact</varname> (int)
Turns on/off the usage of the Contact address to send notification back to sender
whose message is stored by MSILO.
Default value is 1 (0 = off, 1 = on)
.
Set the <quote>param_name</quote> parameter
...
modparam("msilo", "use_contact", 0)
...
<varname>sc_mid</varname> (string)
Name of column in message silo table containing message id.
Default value is "mid".
<varname>sc_from</varname> (string)
Name of column in message silo table containing the contents of From
header field from stored message.
Default value is "src_addr".
<varname>sc_to</varname> (string)
Name of column in message silo table containing the contents of
To header field from stored message.
Default value is "dst_addr".
<varname>sc_uri_user</varname> (string)
Name of column in message silo table containing the username
part extracted from the Request-URI of the stored message.
Default value is "username".
Set the <quote>param_name</quote> parameter
...
modparam("msilo", "use_contact", 0)
...
<varname>sc_uri_host</varname> (string)
Name of column in message silo table containing the hostname
part extracted from the Request-URI of the stored message.
Default value is "domain".
<varname>sc_body</varname> (string)
Name of column in message silo table containing the body
extracted from the stored message.
Default value is "body".
<varname>sc_ctype</varname> (string)
Name of column in message silo table containing the value of
the Content-Type header field extracted from the stored message.
Default value is "ctype".
<varname>sc_exp_time</varname> (string)
Name of column in message silo table containing the expires
value of the stored message.
Default value is "exp_time".
<varname>sc_inc_time</varname> (string)
Name of column in message silo table containing the date and
time of arrival of the stored message.
Default value is "inc_time".
Exported Functions
<function moreinfo="none">m_store(mode)</function>
The method stores certain parts of the current &sip; request (it should be called
when the request type is MESSAGE and the destination user is offline or his &ua does
not support MESSAGE requests). If the user is registered with a UA which does not
support MESSAGE requests you should not use mode=0
if you have
changed the request uri with the contact address of user's &ua;.
Meaning of the parameters is as follows:
mode - specifies what to save as R-URI.
0
- first check if new_uri is an address of
record. If yes, then use it and store it as R-URI, otherwise look at
R-URI and, if necessary, at &uri; from To
header.
1
- look first at R-URI and then at &uri; from
To
header.
2
- look only at &uri; form To
header.
<function moreinfo="none">m_dump()</function>
The method sends stored messages for the &sip; user that is going to register to his
actual contact address. The method should be called when a REGISTER request is
received and the Expire
header has a value greater than zero.
Installation & Running
Database setup
Before running &ser; with msilo, you have to setup the database table where the
module will store the message. For that, if the table was not created by the
installation script or you choose to install everything by yourself you can use the
following SQL script (good for MySQL) as template. Database and
table name can be set with module parameters so they can be changed, but the name of
the columns must be as they are in the next SQL script.
msilo sql script
...
&msilosql;
...
&ser; config file
Next picture displays a sample usage of msilo.
&ser; config script - sample msilo usage
...
&msilocfg;
...