Table of Contents
avp_db_load(source, name, [db_id], [prefix]])
avp_db_store(source, name, [db_id])
avp_db_delete(source, name, [db_id])
avp_db_query(query, [res_col_avps], [db_id])
avp_delete(name)
avp_pushto(destination, name)
avp_check(name, op_value)
avp_copy(from_avp, to_avp)
avp_subst(avps, subst)
avp_op(name, op_value)
is_avp_set(name)
avp_shuffle(name)
avp_print()
List of Tables
List of Examples
avp_url
parameteravp_table
parameteruse_domain
parameter
uuid_column
parameterusername_column
parameterdomain_column
parameterattribute_column
parameter
value_column
parameter
type_column
parameter
db_scheme
parameter
avp_db_load
usageavp_db_store
usageavp_db_delete
usageavp_db_query
usageavp_delete
usageavp_pushto
usageavp_check
usageavp_copy
usageavp_subst
usageavp_op
usageis_avp_set
usageavp_shuffle
usageavp_print
usageasync avp_db_query
usageAVPops (AVP-operations) modules implements a set of script functions which allow access and manipulation of user AVPs (preferences) and pseudo-variables. 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.
AVPs are persistent per SIP transaction, being available in "route", "branch_route" and "failure_route". To make them available in "onreply_route" armed via TM module, set "onreply_avp_mode" parameter of TM module (note that in the default "onreply_route", the AVPs of the transaction are not available).
The following modules must be loaded before this module:
Optionally a database module
The format of the parameters specifying an AVP in functions exported by this module is: $avp(avp_name).
avp_name = string | integer
string - might be any alphanumeric string, wich contain following characters: [a-z] [A-Z] [0-9] '_'
Example 1.1. AVP naming examples
... $avp(11) - the AVP identified by name 11 $avp(foo) - the AVP identified by the string 'foo' ...
DB URL for database connection. As the module allows the usage of multiple DBs (DB URLs), the actual DB URL may be preceded by an reference number. This reference number is to be passed to AVPOPS function that what to explicitly use this DB connection. If no reference number is given, 0 is assumed - this is the default DB URL.
This parameter is optional, it's default value being NULL.
Example 1.2. Set avp_url
parameter
... # default URL modparam("avpops","db_url","mysql://user:passwd@host/database") # an additional DB URL modparam("avpops","db_url","1 postgres://user:passwd@host2/opensips") ...
DB table to be used.
This parameter is optional, it's default value being NULL.
If the domain part of the an URI should be used for identifying an AVP in DB operations.
Default value is 0 (no).
Name of column containing the uuid (unique user id).
Default value is “uuid”.
Name of column containing the username.
Default value is “username”.
Name of column containing the domain name.
Default value is “domain”.
Name of column containing the attribute name (AVP name).
Default value is “attribute”.
Example 1.8. Set attribute_column
parameter
... modparam("avpops","attribute_column","attribute") ...
Name of column containing the AVP value.
Default value is “value”.
Name of column containing the AVP type.
Default value is “type”.
Definition of a DB scheme to be used for non-standard access to Database information.
Definition of a DB scheme. Scheme syntax is:
db_scheme = name':'element[';'element]*
element =
'uuid_col='string
'username_col='string
'domain_col='string
'value_col='string
'value_type='('integer'|'string')
'table='string
Default value is “NULL”.
Example 1.11. Set db_scheme
parameter
... modparam("avpops","db_scheme", "scheme1:table=subscriber;uuid_col=uuid;value_col=first_name") ...
Loads from DB into memory the AVPs corresponding to the given source. If given, it sets the script flags for loaded AVPs. It returns true if it loaded some values in AVPs, false otherwise (db error, no avp loaded ...).
AVPs may be preceded by an optional prefix, in order to avoid some conflicts.
Meaning of the parameters is as follows:
source (string, no expand) - what info is used for identifying the AVPs. Parameter syntax:
source = (pvar|str_value) ['/'('username'|'domain'|'uri'|'uuid')])
pvar = any pseudo variable defined in OpenSIPS. If the pvar is $ru (request uri), $fu (from uri), $tu (to uri) or $ou (original uri), then the implicit flag is 'uri'. Otherwise, the implicit flag is 'uuid'.
name (string, no expand) - which AVPs will be loaded from DB into memory. Parameter syntax is:
name = avp_spec['/'(table_name|'$'db_scheme)]
avp_spec = matching_flags|$avp(avp_name)|$avp(avp_alias)
matching_flags = 'a' | 'A' | 'i' | 'I' | 's' | 'S' [script_flags]
'a' or 'A' means matching any of AVP name types ('i' and 's'), the rest have the meaning descriped in 'AVP naming format' chapter.
db_id (int, optional) - reference to a defined DB URL (a numerical id) - see the “db_url” module parameter.
prefix (string, optional) - static string which will precede the names of the AVPs populated by this function.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.12. avp_db_load
usage
... avp_db_load("$fu", "$avp(678)"); avp_db_load("$ru/domain", "i/domain_preferences"); avp_db_load("$avp(uuid)", "$avp(404fwd)/fwd_table"); avp_db_load("$ru", "$avp(123)/$some_scheme"); # use DB URL id 3 avp_db_load("$ru", "$avp(1)", 3); # precede all loaded AVPs by the "caller_" prefix avp_db_load("$ru", "$avp(100)", , "caller_"); xlog("Loaded: $avp(caller_100)\n"); ...
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.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.13. avp_db_store
usage
... avp_db_store("$tu", "$avp(678)"); avp_db_store("$ru/username", "$avp(email)"); # use DB URL id 3 avp_db_store("$ru", "$avp(1)", 3); ...
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.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.14. avp_db_delete
usage
... avp_db_delete("$tu", "$avp(678)"); avp_db_delete("$ru/username", "$avp(email)"); avp_db_delete("$avp(uuid)", "$avp(404fwd)/fwd_table"); # use DB URL id 3 avp_db_delete("$ru", "$avp(1)", 3); ...
Make a database query and store the result in AVPs.
The meaning and usage of the parameters:
query (string) - must be a valid SQL query. The parameter can contain pseudo-variables.
You must escape any pseudo-variables manually to prevent SQL injection attacks. You can use the existing transformations escape.common and unescape.common to escape and unescape the content of any pseudo-variable. Failing to escape the variables used in the query makes you vulnerable to SQL injection, e.g. make it possible for an outside attacker to alter your database content. The function returns true if the query was successful, -2 in case the query returned an empty result set, and -1 for all other types of errors
res_col_avps (string, optional, no expand) - a list with AVP names where to store the result. The format is “$avp(name1);$avp(name2);...”. If this parameter is omitted, the result is stored in “$avp(1);$avp(2);...”. If the result consists of multiple rows, then multiple AVPs with corresponding names will be added. The value type of the AVP (string or integer) will be derived from the type of the columns. If the value in the database is NULL, the returned avp will be a string with the <null> value.
db_id (int, optional) - reference to a defined DB URL (a numerical id) - see the “db_url” module parameter. It can be either a constant, or a string/int variable.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.15. avp_db_query
usage
... avp_db_query("SELECT password, ha1 FROM subscriber WHERE username='$tu'", "$avp(pass);$avp(hash)"); avp_db_query("DELETE FROM subscriber"); avp_db_query("DELETE FROM subscriber", , 2); $avp(id) = 2; avp_db_query("DELETE FROM subscriber", , $avp(id)); ...
Deletes from memory the AVPs with name or, if *, all AVPs.
Meaning of the parameters is as follows:
name (string, no expand) - which AVPs will be deleted from memory. Parameter syntax is:
name = (matching_flags|avp_name|avp_alias)['/'flag]
matching_flags = please refer to avp_db_load() function
flag = 'g'|'G'
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.16. avp_delete
usage
... avp_delete("$avp(email)"); # delete topmost (lastly set) value from $avp(email) avp_delete("$avp(678)/g"); # fully purge $avp(678) avp_delete("i"); avp_delete("a3"); ...
Pushes the value of AVP(s) into the SIP message.
Meaning of the parameters is as follows:
destination (string, no expand) - as what will be the AVP value pushed into SIP message. Parameter syntax:
destination = '$ru' ['/'('username'|'domain')] | '$du' | '$br'
$ru '['/'('username'|'domain')] - write the AVP in the request URI or in username/domain part of it
$du - write the AVP in 'dst_uri' field
$br - write the AVP directly as a new branch (does not affect RURI)
name (string, no expand) - which AVP(s)/pseudo-variable should be pushed into the SIP message. Parameter syntax is:
name = ( avp_name | avp_alias | pvar_name )['/'flags]
flags = 'g' - effective only with AVPs
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.17. avp_pushto
usage
... avp_pushto("$ru/domain", "$fd"); avp_pushto("$ru", "$avp(678)"); avp_pushto("$ru/domain", "$avp(backup_domains)/g"); avp_pushto("$du", "$avp(679)"); avp_pushto("$br", "$avp(680)"); ...
Checks the value of the AVP(s) against an operator and value.
Meaning of the parameters is as follows:
name (string, no expand) - which AVP(s) should be checked. Parameter syntax is:
name = ( pseudo-variable )
op_value (string, no expand) - define the operator, the value and flags for checking. Parameter syntax is:
op_value = operator '/' value ['/'flags]
operator = 'eq' | 'ne' | 'lt' | 'le' | 'gt' | 'ge' | 're' | 'fm' | 'and' | 'or' | 'xor'
value = pseudo-variable | fix_value
fix_value = 'i:'integer | 's:'string | string
flags = 'g' | 'G' | 'i' | 'I'
Operator meaning:
eq - equal
ne - not equal
lt - less than
le - less or equal
gt - greater than
ge - greater or equal
re - regexp (regular exression match)
fm - fast match (see: man fnmatch)
and - bitwise 'and'
or - bitwise 'or'
xor - bitwise 'xor'
Integer values can be given in hexadecimal using notation: 'i:0xhex_number' (e.g.,: 'i:0xabcd');
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.18. avp_check
usage
... avp_check("$avp(678)", "lt/345/g"); avp_check("$fd", "eq/$td/I"); avp_check("$avp(foo)", "gt/$avp($bar)/g"); avp_check("$avp(foo)", "re/sip:.*@bar.net/g"); avp_check("$avp(foo)", "fm/$avp(fm_avp)/g"); ...
Copy / move an avp under a new name.
Meaning of the parameters is as follows:
from_avp (string, no expand) - which AVP(s) should be copied/moved. Parameter syntax is:
from_avp = ( avp_name | avp_alias )
to_avp (string, no expand) - the new name of the copied/moved AVP(s). Parameter syntax is:
to_avp = ( avp_name | avp_alias ) ['/'flags]
flags = 'g' | 'G' | 'd' | 'D' | 'n' | 'N' | 's' | 'S'
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.19. avp_copy
usage
... avp_copy("$avp(foo)", "$avp(bar)/g"); avp_copy("$avp(old)", "$avp(new)/gd"); # also deletes $avp(old) ...
Perl/sed-like subst applied to AVPs having string value.
Meaning of the parameters is as follows:
avps (string, no expand) - source AVP, destination AVP and flags. Parameter syntax is:
avps = src_avp [ '/' dst_avp [ '/' flags ] ]
src_avp = ( avp_name | avp_alias )
dst_avp = ( avp_name | avp_alias ) - if dst_avp is missing then the value of src_avp will be replaced
flags = ( d | D | g | G ) -- (d, D - delete source avp; g, G - apply to all avps matching src_avp name)
subst (string) - perl/sed-like reqular expression. Parameter syntax is:
subst = "/regexp/replacement/flags"
regexp - regular expression
replacement - replacement string, can include pseudo-variables and \1, ..., \9 for matching tokens, \0 for whole matching text
flags = 'g' | 'G' | 'i' | 'i' (g, G - replace all matching tokens; i, I - match ignore case)
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.20. avp_subst
usage
... # if avp 678 has a string value in e-mail format, replace the # domain part with the value of domain part from R-URI avp_subst("$avp(678)", "/(.*)@(.*)/\1@$rd/"); # if any avp 678 has a string value in e-mail format, replace the # domain part with the value of domain part from R-URI # and place the result in avp 679 avp_subst("$avp(678)/$avp(679)/g", "/(.*)@(.*)/\1@$rd/"); ...
IMPORTANT NOTE: if the replacement string includes src_avp or dst_avp you will get something that you may not expect. In case you have many src_avp and you make the substitution to be applied to all of them, after the first src_avp is processed, it will be added in avp list and next processing will use it.
Different integer operations with avps.
Meaning of the parameters is as follows:
name (string, no expand) - 'source_avp/destination_avp' - which AVP(s) should be processed and where to store the result. If 'destination_avp' is missing, same name as 'source_avp' is used to store the result.
Parameter syntax is:
name = ( source_avp[/destination_avp] )
source_avp = ( avp_name | avp_alias )
destination_avp = ( avp_name | avp_alias )
op_value (string, no expand) - define the operation, the value and flags. Parameter syntax is:
op_value = operator '/' value ['/'flags]
operator = 'add' | 'sub' | 'mul' | 'div' | 'mod' | 'and' | 'or' | 'xor' | 'not'
value = pseudo-variable | fix_value
fix_value = 'i:'integer
flags = 'g' | 'G' | 'd' | 'D'
Integer values can be given in hexadecimal using notation 'i:0xhex_number' (e.g.,: 'i:0xabcd');
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.21. avp_op
usage
... avp_op("$avp(678)", "add/345/g"); avp_op("$avp(number)", "sub/$avp(number2)/d"); ...
Check if any AVP with name is set.
Meaning of the parameters is as follows:
name (string, no expand) - name of AVP to look for. Parameter syntax is:
name = avp_name|avp_alias [ '/' flags ])
flags = ('e'|'s'|'n') - e = empty value; s = value string; n = value number (int)
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.22. is_avp_set
usage
... if(is_avp_set("$avp(foo)")) xlog("AVP with name 'foo' is set!\n"); ...
Randomly shuffles AVPs with name.
Meaning of the parameters is as follows:
name (string, no expand) - name of AVP to shuffle. Parameter syntax is:
name = avp_name
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.23. avp_shuffle
usage
... $avp(foo) := "str1"; $avp(foo) = "str2"; $avp(foo) = "str3"; xlog("Initial AVP list is: $(avp(foo)[*])\n"); # str3 str2 str1 if(avp_shuffle("$avp(foo)")) xlog("Shuffled AVP list is: $(avp(foo)[*])\n"); # str1, str3, str2 (for example) ...
This function takes the same parameters and behaves identically to avp_db_query(), but asynchronously (after launching the query, the current SIP worker pauses the execution of the current SIP message until the result is available and attempts to process more SIP traffic).
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
Example 1.25. async avp_db_query
usage
... { ... /* Example of a slow MySQL query - it should take around 5 seconds */ async( avp_db_query( "SELECT table_name, table_version, SLEEP(0.1) from version", "$avp(tb_name); $avp(tb_ver); $avp(retcode)"), my_resume_route); /* script execution is halted right after the async() call */ } /* We will be called when data is ready - meanwhile, the worker is free */ route [my_resume_route] { xlog("Results: \n$(avp(tb_name)[*])\n -------------------\n$(avp(tb_ver)[*])\n -------------------\n$(avp(retcode)[*])\n"); } ...
Table 2.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
Name | DevScore | Commits | Lines ++ | Lines -- | |
---|---|---|---|---|---|
1. | Daniel-Constantin Mierla (@miconda) | 104 | 44 | 2927 | 2158 |
2. | Bogdan-Andrei Iancu (@bogdan-iancu) | 67 | 49 | 690 | 716 |
3. | Liviu Chircu (@liviuchircu) | 54 | 28 | 1112 | 946 |
4. | Elena-Ramona Modroiu | 51 | 11 | 4040 | 390 |
5. | Razvan Crainea (@razvancrainea) | 21 | 14 | 149 | 246 |
6. | Elena-Ramona Modroiu | 18 | 5 | 1051 | 192 |
7. | Henning Westerholt (@henningw) | 12 | 8 | 112 | 133 |
8. | Vlad Paiu (@vladpaiu) | 8 | 6 | 25 | 2 |
9. | Ionut Ionita (@ionutrazvanionita) | 8 | 5 | 180 | 12 |
10. | Kobi Eshun (@ekobi) | 7 | 1 | 300 | 146 |
All remaining contributors: Andrei Pelinescu-Onciul, Anca Vamanu, Maksym Sobolyev (@sobomax), Norman Brandinger (@NormB), Vlad Patrascu (@rvlad-patrascu), Klaus Darilion, John Burke (@john08burke), Andrey Vorobiev, Olle E. Johansson, Kennard White, Julián Moreno Patiño, Konstantin Bokarius, Walter Doekes (@wdoekes), Andreas Granig, Peter Lemenkov (@lemenkov), Sergio Gutierrez, Edson Gellert Schubert, Ovidiu Sas (@ovidiusas).
(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
Table 2.2. Most recently active contributors(1) to this module
Name | Commit Activity | |
---|---|---|
1. | Liviu Chircu (@liviuchircu) | Mar 2013 - May 2024 |
2. | Razvan Crainea (@razvancrainea) | Jun 2011 - Mar 2023 |
3. | Maksym Sobolyev (@sobomax) | Oct 2022 - Feb 2023 |
4. | John Burke (@john08burke) | Jun 2022 - Jun 2022 |
5. | Bogdan-Andrei Iancu (@bogdan-iancu) | Jun 2005 - Mar 2020 |
6. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - Jul 2019 |
7. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jun 2018 |
8. | Andrey Vorobiev | Apr 2016 - Apr 2016 |
9. | Julián Moreno Patiño | Feb 2016 - Feb 2016 |
10. | Ionut Ionita (@ionutrazvanionita) | Nov 2015 - Feb 2016 |
All remaining contributors: Ovidiu Sas (@ovidiusas), Walter Doekes (@wdoekes), Vlad Paiu (@vladpaiu), Anca Vamanu, Kennard White, Norman Brandinger (@NormB), Sergio Gutierrez, Kobi Eshun (@ekobi), Henning Westerholt (@henningw), Olle E. Johansson, Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Elena-Ramona Modroiu, Klaus Darilion, Andreas Granig, Andrei Pelinescu-Onciul, Elena-Ramona Modroiu.
(1) including any documentation-related commits, excluding merge commits
Last edited by: Razvan Crainea (@razvancrainea), John Burke (@john08burke), Liviu Chircu (@liviuchircu), Peter Lemenkov (@lemenkov), Ionut Ionita (@ionutrazvanionita), Bogdan-Andrei Iancu (@bogdan-iancu), Vlad Paiu (@vladpaiu), Anca Vamanu, Norman Brandinger (@NormB), Kobi Eshun (@ekobi), Henning Westerholt (@henningw), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Elena-Ramona Modroiu, Klaus Darilion, Andrei Pelinescu-Onciul, Elena-Ramona Modroiu.
Documentation Copyrights:
Copyright © 2004-2008 Voice Sistem SRL