Resources.DocsCoreVar14 HistoryShow minor edits - Show changes to markup April 24, 2013, at 02:10 PM
by
- Changed lines 1-537 from:
Resources -> Documentation -> CookBooks -> Scripting variables v1.4.xThis documentation is valid for OpenSIPS v1.4.x. (:toc-float Table of Content:) OpenSIPS provides multiple type of variables to be used in the routing script. The difference between the types of variables comes from (1) the visibility of the variable (when it is visible), (2) what the variable is attached to (where the variable resides), (3) read-write status of the variable (some types of the variables are read-only and (4) how multipe values (for the same variable are handled). The OpenSIPS variables can be easily identified in the script as all their names (or notations) starts with the $ sign. Types of variables:
Script variablesNaming: **$var(name)** Hints:
Example of usage: $var(a) = 2; # sets the value of variable 'a' to integer '2' $var(a) = "2"; # sets the value of variable 'a' to string '2' $var(a) = 3 + (7&(~2)); # arithmetic and bitwise operation $var(a) = "sip:" + $au + "@" + $fd; # compose a value from authentication username and From URI domain # using a script variable for tests if( [ $var(a) & 4 ] ) { xlog("var a has third bit set\n"); } Setting a variable to NULL is actually initializing the value to integer '0'. Script variables don't have NULL value. AVP variablesNaming: **$avp(id)** or **$(avp(id)[N])** The 'id' can be:
When using the index "N" you can force the AVP to return a certain value (the N-th value). If no index is given, the first value will be returned. Hints:
Example of usage:
# enable avps in onreply route modparam("tm", "onreply_avp_mode", 1) # define "tmp" as alias for "i:17" avp_aliases="tmp=i:17" ... route{ ... $avp(tmp) = $Ts ; # store the current time (at request processing) ... t_onreply("1"); t_relay(); ... } onreply_route[1] { if (t_check_status("200")) { # calculate the setup time $var(setup_time) = $Ts - $avp(tmp); } }
$avp(i:17) = "one"; # we have a sigle value $avp(i:17) = "two"; # we have two values ("two","one") $avp(i:17) = "three"; # we have three values ("three","two","one") xlog("accessing values with no index: $avp(i:17)\n"); # this will print the first value, which is the last added value -> "three" xlog("accessing values with no index: $(avp(i:17)[2])\n"); # this will print the index 2 value (third one), -> "one" # remove the last value of the avp; if there is only one value, the AVP itself will be destroyed $avp(i:17) = NULL; # delete all values and destroy the AVP avp_delete("$avp(i:17)/g"); The AVPOPS module provides a lot of useful functions to operate AVPs (like checking values, pushing values into different other locations, deleting AVPs, etc). Pseudo VariablesNaming: $name Hints:
Predefined (provided by core) PVs are listed in alphabetical order. URI in SIP Request's P-Asserted-Identity header$ai - reference to URI in request's P-Asserted-Identity header (see RFC 3325) Authentication Digest URI$adu - URI from Authorization or Proxy-Authorization header. This URI is used when calculating the HTTP Digest Response. Authentication realm$ar - realm from Authorization or Proxy-Authorization header Auth username user$au - user part of username from Authorization or Proxy-Authorization header Auth username domain$ad - domain part of username from Authorization or Proxy-Authorization header Auth whole username$aU - whole username from Authorization or Proxy-Authorization header Acc username$Au - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username otherwise. Request's first branch$br - reference to request's first branch It is R/W variable (you can assign values to it from routing logic) Request's all branches$bR - reference to request's all branches Branch flags$bf - reference to branch flags of branch 0 (RURI) - decimal output It is R/W variable (you can assign values to it from routing logic) Branch flags$bF - reference to branch flags of branch 0 (RURI) - hexa output It is R/W variable (you can assign values to it from routing logic) Call-Id$ci - reference to body of call-id header Content-Length$cl - reference to body of content-length header CSeq$cs - reference to cseq number from cseq header Contact header$ct - reference to body of contact header Content-Type$cT - reference to body of content-type header Domain of destination URI$dd - reference to domain of destination uri Diversion header URI$di - reference to Diversion header URI Diversion "privacy" parameter$dip - reference to Diversion header "privacy" parameter value Diversion "reason" parameter$dir - reference to Diversion header "reason" parameter value Port of destination URI$dp - reference to port of destination uri Transport protocol of destination URI$dP - reference to transport protocol of destination uri Destination set$ds - reference to destination set Destination URI$du - reference to destination uri (outbound proxy to be used for sending the request) If loose_route() returns TRUE a destination uri is set according to the first Route header. It is R/W variable (you can assign values to it from routing logic) Error class$err.class - the class of error (now is '1' for parsing errors) Error level$err.level - severity level for the error Error info$err.info - text describing the error Error reply code$err.rcode - recommended reply code Error reply reason$err.rreason - recommended reply reason phrase From URI domain$fd - reference to domain in URI of 'From' header From display name$fn - reference to display name of 'From' header Forced socket$fs - reference to the forced socket for message sending (if any) in the form proto:ip:port It is R/W variable (you can assign values to it routing script) From tag$ft - reference to tag parameter of 'From' header From URI$fu - reference to URI of 'From' header From URI username$fU - reference to username in URI of 'From' header SIP message buffer$mb - reference to SIP message buffer Message Flags$mf - reference to message/transaction flags set for current SIP request It is R/W variable (you can assign values to it from routing logic) Message Flags in hexadecimal$mF -reference to message/transaction flags set for current SIP request in hexa It is R/W variable (you can assign values to it from routing logic) SIP message ID$mi - reference to SIP message id SIP message length$ml - reference to SIP message length Domain in SIP Request's original URI$od - reference to domain in request's original R-URI Port of SIP request's original URI$op - reference to port of original R-URI Transport protocol of SIP request original URI$oP - reference to transport protocol of original R-URI SIP Request's original URI$ou - reference to request's original URI Username in SIP Request's original URI$oU - reference to username in request's original URI Domain in SIP Request's P-Preferred-Identity header URI$pd - reference to domain in request's P-Preferred-Identity header URI (see RFC 3325) Display Name in SIP Request's P-Preferred-Identity header$pn - reference to Display Name in request's P-Preferred-Identity header (see RFC 3325) Process id$pp - reference to process id (pid) Protocol of received message$pr or $proto - protocol of received message (UDP, TCP, TLS, SCTP) User in SIP Request's P-Preferred-Identity header URI$pU - reference to user in request's P-Preferred-Identity header URI (see RFC 3325) URI in SIP Request's P-Preferred-Identity header$pu - reference to URI in request's P-Preferred-Identity header (see RFC 3325) Domain in SIP Request's URI$rd - reference to domain in request's URI It is R/W variable (you can assign values to it routing script) Body of request/reply$rb - reference to message body Returned code$rc - reference to returned code by last invoked function $retcode - same as **$rc** Remote-Party-ID header URI$re - reference to Remote-Party-ID header URI SIP request's method$rm - reference to request's method SIP request's port$rp - reference to port of R-URI It is R/W variable (you can assign values to it routing script) Transport protocol of SIP request URI$rP - reference to transport protocol of R-URI SIP reply's reason$rr - reference to reply's reason SIP reply's status$rs - reference to reply's status Refer-to URI$rt - reference to URI of refer-to header SIP Request's URI$ru - reference to request's URI It is R/W variable (you can assign values to it routing script) Username in SIP Request's URI$rU - reference to username in request's URI It is R/W variable (you can assign values to it routing script) Received IP address$Ri - reference to IP address of the interface where the request has been received Received port$Rp - reference to the port where the message was received Script flags$sf - reference to script flags - decimal output It is R/W variable (you can assign values to it from routing logic) Script flags$sF - reference to script flags - hexa output It is R/W variable (you can assign values to it from routing logic) IP source address$si - reference to IP source address of the message Source port$sp - reference to the source port of the message To URI Domain$td - reference to domain in URI of 'To' header To display name$tn - reference to display name of 'To' header To tag$tt - reference to tag parameter of 'To' header To URI$tu - reference to URI of 'To' header To URI Username$tU - reference to username in URI of 'To' header Branch index$T_branch_idx - the index (starting with 1 for the first branch) of the branch for which is executed the branch_route[]. If used outside of branch_route[] block, the value is '0'. This is exported by TM module. String formatted time$Tf - reference string formatted time Unix time stamp$Ts - reference to unix time stamp User agent header$ua - reference to user agent header field SIP Headers$(hdr(name)[N]) - represents the body of the N-th header identified by 'name'. If [N] is omitted then the body of the first header is printed. The first header is got when N=0, for the second N=1, a.s.o. To print the last header of that type, use -1, no other negative values are supported now. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N='*', all headers of that type are printed. The module should identify most of compact header names (the ones recognized by OpenSIPS which should be all at this moment), if not, the compact form has to be specified explicitly. It is recommended to use dedicated specifiers for headers (e.g., %ua for user agent header), if they are available -- they are faster. It is R/W variable (you can assign values to it routing script)
Escape SequencesThese sequences are exported, and mainly used, by xlog module to print messages in many colors (foreground and background) using escape sequences. Foreground and background colors$C(xy) - reference to an escape sequence. ¿x¿ represents the foreground color and ¿y¿ represents the background color. Colors could be:
ExamplesA few examples of usage. ... avp_aliases="uuid=I:50" ... route { ... $avp(uuid)="caller_id"; $avp(i:20)= $avp(uuid) + ": " + $fu; xdbg("$(C(bg))avp(i:20)$(C(xx)) [$avp(i:20)] $(C(br))cseq$(C(xx))=[$hdr(cseq)]\n"); ... } ... to:
(:redirect Documentation.Script-CoreVar-1-4 quiet=1 :) December 02, 2010, at 04:41 PM
by
- Changed lines 18-20 from:
AVPs are read write and an existing AVP can be even deleted (removed). An AVP may contain multiple values - a new assigment (or write operation) will add a new value to the AVP; the values are kept in "last added first to be used" order (stack).
to:
AVPs are read write and an existing AVP can be even deleted (removed). An AVP may contain multiple values - a new assignment (or write operation) will add a new value to the AVP; the values are kept in "last added first to be used" order (stack).
Changed lines 23-26 from:
to:
Changed line 33 from:
to:
Changed line 43 from:
$var(a) = 3 + (7&(~2)); # arithemetic and bitwise operation to:
$var(a) = 3 + (7&(~2)); # arithmetic and bitwise operation Changed lines 64-67 from:
When using the index "N" you can force the AVP to returne a certain value (the N-th value). If no index is given, the first value will be returned. to:
When using the index "N" you can force the AVP to return a certain value (the N-th value). If no index is given, the first value will be returned. Changed line 71 from:
to:
Changed line 77 from:
to:
Changed line 86 from:
$avp(tmp) = $ts ; # store the current time (at request processing) to:
$avp(tmp) = $Ts ; # store the current time (at request processing) Changed line 96 from:
$var(setup_time) = $ts - $avp(tmp); to:
$var(setup_time) = $Ts - $avp(tmp); Changed line 110 from:
xlog("aceesing values with no index: $avp(i:17)\n"); to:
xlog("accessing values with no index: $avp(i:17)\n"); Changed line 113 from:
xlog("aceesing values with no index: $(avp(i:17)[2])\n"); to:
xlog("accessing values with no index: $(avp(i:17)[2])\n"); Changed line 123 from:
The AVPOPS module provides a lot of usefull functions to operate AVPs (like checking values, pushing values into different other locations, deleting AVPs, etc). to:
The AVPOPS module provides a lot of useful functions to operate AVPs (like checking values, pushing values into different other locations, deleting AVPs, etc). November 30, 2010, at 10:29 PM
by
- Changed line 202 from:
$cs - reference to body of cseq header to:
$cs - reference to cseq number from cseq header April 23, 2009, at 11:29 AM
by
- Added lines 1-537:
Resources -> Documentation -> CookBooks -> Scripting variables v1.4.xThis documentation is valid for OpenSIPS v1.4.x. (:toc-float Table of Content:) OpenSIPS provides multiple type of variables to be used in the routing script. The difference between the types of variables comes from (1) the visibility of the variable (when it is visible), (2) what the variable is attached to (where the variable resides), (3) read-write status of the variable (some types of the variables are read-only and (4) how multipe values (for the same variable are handled). The OpenSIPS variables can be easily identified in the script as all their names (or notations) starts with the $ sign. Types of variables:
Script variablesNaming: **$var(name)** Hints:
Example of usage: $var(a) = 2; # sets the value of variable 'a' to integer '2' $var(a) = "2"; # sets the value of variable 'a' to string '2' $var(a) = 3 + (7&(~2)); # arithemetic and bitwise operation $var(a) = "sip:" + $au + "@" + $fd; # compose a value from authentication username and From URI domain # using a script variable for tests if( [ $var(a) & 4 ] ) { xlog("var a has third bit set\n"); } Setting a variable to NULL is actually initializing the value to integer '0'. Script variables don't have NULL value.
AVP variablesNaming: **$avp(id)** or **$(avp(id)[N])** The 'id' can be:
When using the index "N" you can force the AVP to returne a certain value (the N-th value). If no index is given, the first value will be returned. Hints:
Example of usage:
# enable avps in onreply route modparam("tm", "onreply_avp_mode", 1) # define "tmp" as alias for "i:17" avp_aliases="tmp=i:17" ... route{ ... $avp(tmp) = $ts ; # store the current time (at request processing) ... t_onreply("1"); t_relay(); ... } onreply_route[1] { if (t_check_status("200")) { # calculate the setup time $var(setup_time) = $ts - $avp(tmp); } }
$avp(i:17) = "one"; # we have a sigle value $avp(i:17) = "two"; # we have two values ("two","one") $avp(i:17) = "three"; # we have three values ("three","two","one") xlog("aceesing values with no index: $avp(i:17)\n"); # this will print the first value, which is the last added value -> "three" xlog("aceesing values with no index: $(avp(i:17)[2])\n"); # this will print the index 2 value (third one), -> "one" # remove the last value of the avp; if there is only one value, the AVP itself will be destroyed $avp(i:17) = NULL; # delete all values and destroy the AVP avp_delete("$avp(i:17)/g"); The AVPOPS module provides a lot of usefull functions to operate AVPs (like checking values, pushing values into different other locations, deleting AVPs, etc).
Pseudo VariablesNaming: $name Hints:
Predefined (provided by core) PVs are listed in alphabetical order. URI in SIP Request's P-Asserted-Identity header$ai - reference to URI in request's P-Asserted-Identity header (see RFC 3325) Authentication Digest URI$adu - URI from Authorization or Proxy-Authorization header. This URI is used when calculating the HTTP Digest Response. Authentication realm$ar - realm from Authorization or Proxy-Authorization header Auth username user$au - user part of username from Authorization or Proxy-Authorization header Auth username domain$ad - domain part of username from Authorization or Proxy-Authorization header Auth whole username$aU - whole username from Authorization or Proxy-Authorization header Acc username$Au - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username otherwise. Request's first branch$br - reference to request's first branch It is R/W variable (you can assign values to it from routing logic) Request's all branches$bR - reference to request's all branches Branch flags$bf - reference to branch flags of branch 0 (RURI) - decimal output It is R/W variable (you can assign values to it from routing logic) Branch flags$bF - reference to branch flags of branch 0 (RURI) - hexa output It is R/W variable (you can assign values to it from routing logic) Call-Id$ci - reference to body of call-id header Content-Length$cl - reference to body of content-length header CSeq$cs - reference to body of cseq header Contact header$ct - reference to body of contact header Content-Type$cT - reference to body of content-type header Domain of destination URI$dd - reference to domain of destination uri Diversion header URI$di - reference to Diversion header URI Diversion "privacy" parameter$dip - reference to Diversion header "privacy" parameter value Diversion "reason" parameter$dir - reference to Diversion header "reason" parameter value Port of destination URI$dp - reference to port of destination uri Transport protocol of destination URI$dP - reference to transport protocol of destination uri Destination set$ds - reference to destination set Destination URI$du - reference to destination uri (outbound proxy to be used for sending the request) If loose_route() returns TRUE a destination uri is set according to the first Route header. It is R/W variable (you can assign values to it from routing logic) Error class$err.class - the class of error (now is '1' for parsing errors) Error level$err.level - severity level for the error Error info$err.info - text describing the error Error reply code$err.rcode - recommended reply code Error reply reason$err.rreason - recommended reply reason phrase From URI domain$fd - reference to domain in URI of 'From' header From display name$fn - reference to display name of 'From' header Forced socket$fs - reference to the forced socket for message sending (if any) in the form proto:ip:port It is R/W variable (you can assign values to it routing script) From tag$ft - reference to tag parameter of 'From' header From URI$fu - reference to URI of 'From' header From URI username$fU - reference to username in URI of 'From' header SIP message buffer$mb - reference to SIP message buffer Message Flags$mf - reference to message/transaction flags set for current SIP request It is R/W variable (you can assign values to it from routing logic) Message Flags in hexadecimal$mF -reference to message/transaction flags set for current SIP request in hexa It is R/W variable (you can assign values to it from routing logic) SIP message ID$mi - reference to SIP message id SIP message length$ml - reference to SIP message length Domain in SIP Request's original URI$od - reference to domain in request's original R-URI Port of SIP request's original URI$op - reference to port of original R-URI Transport protocol of SIP request original URI$oP - reference to transport protocol of original R-URI SIP Request's original URI$ou - reference to request's original URI Username in SIP Request's original URI$oU - reference to username in request's original URI Domain in SIP Request's P-Preferred-Identity header URI$pd - reference to domain in request's P-Preferred-Identity header URI (see RFC 3325) Display Name in SIP Request's P-Preferred-Identity header$pn - reference to Display Name in request's P-Preferred-Identity header (see RFC 3325) Process id$pp - reference to process id (pid) Protocol of received message$pr or $proto - protocol of received message (UDP, TCP, TLS, SCTP) User in SIP Request's P-Preferred-Identity header URI$pU - reference to user in request's P-Preferred-Identity header URI (see RFC 3325) URI in SIP Request's P-Preferred-Identity header$pu - reference to URI in request's P-Preferred-Identity header (see RFC 3325) Domain in SIP Request's URI$rd - reference to domain in request's URI It is R/W variable (you can assign values to it routing script) Body of request/reply$rb - reference to message body Returned code$rc - reference to returned code by last invoked function $retcode - same as **$rc** Remote-Party-ID header URI$re - reference to Remote-Party-ID header URI SIP request's method$rm - reference to request's method SIP request's port$rp - reference to port of R-URI It is R/W variable (you can assign values to it routing script) Transport protocol of SIP request URI$rP - reference to transport protocol of R-URI SIP reply's reason$rr - reference to reply's reason SIP reply's status$rs - reference to reply's status Refer-to URI$rt - reference to URI of refer-to header SIP Request's URI$ru - reference to request's URI It is R/W variable (you can assign values to it routing script) Username in SIP Request's URI$rU - reference to username in request's URI It is R/W variable (you can assign values to it routing script) Received IP address$Ri - reference to IP address of the interface where the request has been received Received port$Rp - reference to the port where the message was received Script flags$sf - reference to script flags - decimal output It is R/W variable (you can assign values to it from routing logic) Script flags$sF - reference to script flags - hexa output It is R/W variable (you can assign values to it from routing logic) IP source address$si - reference to IP source address of the message Source port$sp - reference to the source port of the message To URI Domain$td - reference to domain in URI of 'To' header To display name$tn - reference to display name of 'To' header To tag$tt - reference to tag parameter of 'To' header To URI$tu - reference to URI of 'To' header To URI Username$tU - reference to username in URI of 'To' header Branch index$T_branch_idx - the index (starting with 1 for the first branch) of the branch for which is executed the branch_route[]. If used outside of branch_route[] block, the value is '0'. This is exported by TM module. String formatted time$Tf - reference string formatted time Unix time stamp$Ts - reference to unix time stamp User agent header$ua - reference to user agent header field SIP Headers$(hdr(name)[N]) - represents the body of the N-th header identified by 'name'. If [N] is omitted then the body of the first header is printed. The first header is got when N=0, for the second N=1, a.s.o. To print the last header of that type, use -1, no other negative values are supported now. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N='*', all headers of that type are printed. The module should identify most of compact header names (the ones recognized by OpenSIPS which should be all at this moment), if not, the compact form has to be specified explicitly. It is recommended to use dedicated specifiers for headers (e.g., %ua for user agent header), if they are available -- they are faster. It is R/W variable (you can assign values to it routing script)
Escape SequencesThese sequences are exported, and mainly used, by xlog module to print messages in many colors (foreground and background) using escape sequences. Foreground and background colors$C(xy) - reference to an escape sequence. ¿x¿ represents the foreground color and ¿y¿ represents the background color. Colors could be:
ExamplesA few examples of usage. ... avp_aliases="uuid=I:50" ... route { ... $avp(uuid)="caller_id"; $avp(i:20)= $avp(uuid) + ": " + $fu; xdbg("$(C(bg))avp(i:20)$(C(xx)) [$avp(i:20)] $(C(br))cseq$(C(xx))=[$hdr(cseq)]\n"); ... } ... |