$Revision: 1741 $
$Date: 2007-03-04 22:06:21 +0200 (Sun, 04 Mar 2007) $
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://openser:openserrw@localhost/openser
.
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@example.org")
...
<varname>reminder</varname> (string)
The &sip; address used to send reminder messages. If this value
is not set, the reminder feature is disabled.
Default value is NULL
.
Set the <quote>reminder</quote> parameter
...
modparam("msilo", "reminder", "sip:registrar@example.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>send_time</varname> (int)
Timer interval in seconds to check if there are reminder messages.
The module takes all reminder messages that must be sent at that moment
or before that moment.
If the value is 0, the reminder feature is disabled.
Default value is 0
.
Set the <quote>send_time</quote> parameter
...
modparam("msilo", "send_time", 60)
...
<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>use_contact</quote> parameter
...
modparam("msilo", "use_contact", 0)
...
<varname>sc_mid</varname> (string)
The name of the column in silo table, storing message id.
Default value is mid
.
Set the <quote>sc_mid</quote> parameter
...
modparam("msilo", "sc_mid", "other_mid")
...
<varname>sc_from</varname> (string)
The name of the column in silo table, storing the source address.
Default value is src_addr
.
Set the <quote>sc_from</quote> parameter
...
modparam("msilo", "sc_from", "source_address")
...
<varname>sc_to</varname> (string)
The name of the column in silo table, storing the destination address.
Default value is dst_addr
.
Set the <quote>sc_to</quote> parameter
...
modparam("msilo", "sc_to", "destination_address")
...
<varname>sc_uri_user</varname> (string)
The name of the column in silo table, storing the user name.
Default value is username
.
Set the <quote>sc_uri_user</quote> parameter
...
modparam("msilo", "sc_uri_user", "user")
...
<varname>sc_uri_host</varname> (string)
The name of the column in silo table, storing the domain.
Default value is domain
.
Set the <quote>sc_uri_host</quote> parameter
...
modparam("msilo", "sc_uri_host", "domain")
...
<varname>sc_body</varname> (string)
The name of the column storing the message body in silo table.
Default value is body
.
Set the <quote>sc_body</quote> parameter
...
modparam("msilo", "sc_body", "message_body")
...
<varname>sc_ctype</varname> (string)
The name of the column in silo table, storing content type.
Default value is ctype
.
Set the <quote>sc_ctype</quote> parameter
...
modparam("msilo", "sc_body", "content_type")
...
<varname>sc_exp_time</varname> (string)
The name of the column in silo table, storing the expire time of the message.
Default value is exp_time
.
Set the <quote>sc_exp_time</quote> parameter
...
modparam("msilo", "sc_exp_time", "expire_time")
...
<varname>sc_inc_time</varname> (string)
The name of the column in silo table, storing the incoming time of the message.
Default value is inc_time
.
Set the <quote>sc_inc_time</quote> parameter
...
modparam("msilo", "sc_inc_time", "incoming_time")
...
<varname>sc_snd_time</varname> (string)
The name of the column in silo table, storing the send time for the reminder.
Default value is snd_time
.
Set the <quote>sc_snd_time</quote> parameter
...
modparam("msilo", "sc_inc_time", "send_reminder_time")
...
<varname>snd_time_avp</varname> (str)
The name of an AVP which may contain the time when to sent
the received message as reminder.The AVP is used ony by m_store().
If the parameter is not set, the module does not look for this AVP. If
the value is set to a valid AVP name, then the module expects in the AVP
to be a time value in format YYYYMMDDHHMMSS (e.g., 20060101201500).
Default value is null
.
Set the <quote>snd_time_avp</quote> parameter
...
modparam("msilo", "snd_time_avp", "$avp(i:123)")
...
<varname>add_date</varname> (int)
Wheter to add as prefix the date when the message was stored.
Default value is 1
(1==on/0==off).
Set the <quote>add_date</quote> parameter
...
modparam("msilo", "add_date", "0")
...
<varname>max_messages</varname> (int)
Maximum number of stored message for an AoR. Value 0
equals to no limit.
Default value is 0.
Set the <quote>max_messages</quote> parameter
...
modparam("msilo", "max_messages", 0)
...
Exported Functions
<function moreinfo="none">m_store([owner])</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:
owner - is a string that must contain
a SIP URI in whose inbox the message will be stored. It can have
any pseudo variable. If "owner" is missing, the SIP address is
taken from R-URI.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
<function>m_store</function> usage
...
m_store();
m_store("$tu");
...
<function moreinfo="none">m_dump([owner])</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.
Meaning of the parameters is as follows:
owner - is a string that must contain
a SIP URI whose inbox will be dumped. It can have
any pseudo variable. If "owner" is missing, the SIP address is
taken from To URI.
This function can be used from REQUEST_ROUTE.
<function>m_dump</function> usage
...
m_store();
m_store("$fu");
...
Exported Statistics
stored_messages
The number of messages stored by msilo.
dumped_messages
The number of dumped messages.
failed_messages
The number of failed dumped messages.
dumped_reminders
The number of dumped reminder messages.
failed_reminders
The number of failed reminder messages.
Installation & Running
&ser; config file
Next picture displays a sample usage of msilo.
&ser; config script - sample msilo usage
...
&msilocfg;
...