$Revision: 1.4 $
$Date: 2004/11/15 10:19:39 $
User's Guide
Overview
AVPops (AVP-operations) modules implements a set of script
functions which allow access and manipulation of user AVPs
(preferences). AVPs are a powerful tool for implementing
services/preferences per user/domain. Now they are usable
directly from configuration script. Functions for interfacing DB
resources (loading/storing/removing), functions for swapping
information between AVPs and SIP messages, function for
testing/checking the value of an AVP.
An up-to-date tutorial providing more information (detailed
explanations and commented examples) can be found on Voice Sistem
documentation web page at http://voice-system.ro/docs/avpops .
Dependencies
&ser; Modules
The following modules must be loaded before this module:
Optionally a database module
External Libraries or Applications
The following libraries or applications must be installed
before running &ser; with this module loaded:
None
Exported Parameters
<varname>avp_url</varname> (string)
DB URL for database connection.
This parameter is optional, it's default value being NULL.
Set <varname>avp_url</varname> parameter
...
modparam("avpops","avp_url","mysql://user:passwd@host/database")
...
<varname>avp_table</varname> (string)
DB table to be used.
This parameter is optional, it's default value being NULL.
Set <varname>avp_table</varname> parameter
...
modparam("avpops","avp_table","avptable")
...
<varname>avp_aliases</varname> (string)
Contains a multiple definition of aliases for AVP names.
This parameter is optional.
Set <varname>avp_aliases</varname> parameter
...
modparam("avpops","avp_aliases","uuid=I:660;email=s:email_addr;fwd=i:753")
...
<varname>use_domain</varname> (integer)
If the domain part of the an URI should be used for
identifying an AVP in DB operations.
Default value is 0 (no)
.
Set <varname>use_domain</varname> parameter
...
modparam("avpops","use_domain","1")
...
<varname>uuid_column</varname> (string)
Name of column containing the uuid (unique user id).
Default value is uuid
.
Set <varname>uuid_column</varname> parameter
...
modparam("avpops","uuid_column","uuid")
...
<varname>username_column</varname> (string)
Name of column containing the username.
Default value is username
.
Set <varname>username_column</varname> parameter
...
modparam("avpops","username_column","username")
...
<varname>domain_column</varname> (string)
Name of column containing the domain name.
Default value is domain
.
Set <varname>domain_column</varname> parameter
...
modparam("avpops","domain_column","domain")
...
<varname>attribute_column</varname> (string)
Name of column containing the attribute name (AVP name).
Default value is attribute
.
Set <varname>attribute_column</varname> parameter
...
modparam("avpops","attribute_column","attribute")
...
<varname>value_column</varname> (string)
Name of column containing the AVP value.
Default value is value
.
Set <varname>value_column</varname> parameter
...
modparam("avpops","value_column","value")
...
<varname>type_column</varname> (string)
Name of column containing the AVP type.
Default value is type
.
Set <varname>type_column</varname> parameter
...
modparam("avpops","type_column","type")
...
<varname>db_scheme</varname> (string)
Definition of a DB schemeto be used for non-standard
access to Database information.
Default value is NULL
.
Set <varname>db_scheme</varname> parameter
...
modparam("avpops","db_scheme",
"scheme1:table=subscriber;uuid_column=uuid;value_column=first_name")
...
Exported Functions
<function moreinfo="none">avp_db_load(source,name)
</function>
Loads from DB into memory the AVPs corresponding to the given
source.
Meaning of the parameters is as follows:
source - what info is used for
identifying the AVPs. Parameter syntax:
source = (sip_uri)['/'('username'|'domain')]) |
(avp_alias) | str_value
sip_uri = '$from' | '$to' | '$ruri'
name - which AVPs will be loaded
from DB into memory. Parameter syntax is:
name = avp_spec['/'(table_name|'$'db_scheme)]
avp_spec = ''|'s:'|'i:'|avp_name|avp_alias
<function>avp_db_load</function> usage
...
avp_db_load("$from","i:678");
avp_db_load("$ruri/domain","i:/domain_preferences");
avp_db_load("$uuid","s:404fwd/fwd_table");
avp_db_load("$ruri","i:123/$some_scheme");
...
<function moreinfo="none">avp_db_store(source,name)</function>
Stores to DB the AVPs corresponding to the given
source.
The meaning and usage of the parameters are identical as for
avp_db_load(source,name)
function. Please refer to its description.
<function>avp_db_store</function> usage
...
avp_db_store("$to","i:678");
avp_db_store("$ruri/username","$email");
...
<function moreinfo="none">avp_db_delete(source,name)</function>
Deletes from DB the AVPs corresponding to the given
source.
The meaning and usage of the parameters are identical as for
avp_db_load(source,name)
function. Please refer to its description.
<function>avp_db_delete</function> usage
...
avp_db_delete("$to","i:678");
avp_db_delete("$ruri/username","$email");
avp_db_delete("$uuid","s:404fwd/fwd_table");
...
<function moreinfo="none">avp_write(value,name)</function>
The function writes some value (given) or some information from
the SIP message into a new AVP.
Meaning of the parameters is as follows:
value - the value to be written into
the AVP.
Parameter syntax:
value = (variable) | (fix_value)
variable = '$src_ip' | (sip_uri)['/'('username'|'domain')])
sip_uri = '$from' | '$to' | '$ruri'
fix_value = 'i:'integer | 's:'string | string
name - the name of the new written
AVP.
Parameter syntax is:
name = avp_name | avp_alias
<function>avp_write</function> usage
...
avp_write("$to","i:678");
avp_write("$ruri/username","$email");
avp_write("$src_ip","s:ip");
avp_write("i:333","i:6");
...
<function moreinfo="none">avp_delete(name)
</function>
Deletes from memory the AVPs with name or,
if empty, all AVPs.
Meaning of the parameters is as follows:
name - which AVPs will be deleted
from memory.
Parameter syntax is:
name = (''|'s:'|'i:'|avp_name|avp_alias)['/'flag]
flag = 'g'|'G'
<function>avp_delete</function> usage
...
avp_delete("i:678/g");
avp_delete("$email");
avp_delete("i:");
avp_delete("");
...
<function moreinfo="none">avp_pushto(destination,name)
</function>
Pushes the value of AVP(s) into the SIP message.
Meaning of the parameters is as follows:
destination - as what will be the
AVP value pushed into SIP message.
Parameter syntax:
destination = ruri_dst | hdr_dst
ruri_dst = '$ruri'['/'('username'|'domain')]
hdr_dst = 'hdr_name'['/'('request'|'reply')]
name - which AVP(s) should be pushed
into the SIP message.
Parameter syntax is:
name = ( avp_name | avp_alias )['/'flags]
flags = 'g'
<function>avp_pushto</function> usage
...
avp_pushto("$ruri","i:678");
avp_pushto("$ruri/domain","s:backup_domains/g");
avp_pushto("Email/reply","s:email");
avp_pushto("Foo","$bar/g");
...
<function moreinfo="none">avp_check(name,op_value)
</function>
Checks the value of the AVP(s) against an operator and value.
Meaning of the parameters is as follows:
name - which AVP(s) should be
checked.
Parameter syntax is:
name = ( avp_name | avp_alias )
op_value - define the operator,
the value and flags for checking.
Parameter syntax is:
op_value = operator '/' value ['/'flags]
operator = 'eq' | 'lt' | 'gt' | 're'
value = variable | fix_value
variable = '$from'|'$ruri'|'$from'|'$src_ip'|avp_alias
fix_value = 'i:'integer | 's:'string | string
flags = 'g' | 'G' | 'i' | 'I'
<function>avp_check</function> usage
...
avp_check("i:678", "lt/i:345/g");
avp_check("s:person","eq/$from/I");
avp_check("s:foo","gt/$bar/g");
avp_check("s:foo","re/sip:.*@bar.net/g");
...
<function moreinfo="none">avp_print()
</function>
Prints the list with all the AVPs from memory. This is only a
helper/debug function.
<function>avp_print</function> usage
...
avp_print();
...
Installation & Running
The AVPOPS module requires one more column in the
usr_preferences table than how it is created
now by ser_mysql script. The missing column is
"type". Till the discrepancy is fixed, please
add by hand the column "type" integer, not null, default 0
.