Documentation |
Documentation.Script-CoreVar-1-8 HistoryHide minor edits - Show changes to markup March 05, 2015, at 02:29 PM
by
- Changed line 682 from:
xdbg("$(C(bg))avp(tmp)$(C(xx)) [$avp(tmp)] $(C(br))cseq$(C(xx))=[$hdr(cseq)]\n"); to:
xlog("$C(bg)$avp(tmp)$C(xx) [$avp(tmp)] $C(br)$cseq$C(xx)=[$hdr(cseq)]\n"); March 02, 2014, at 07:07 PM
by
- Changed line 19 from:
The OpenSIPS variables can be easily identified in the script as all their names (or notations) starts with the $ sign. to:
The OpenSIPS variables can be easily identified in the script as all their names (or notations) start with the $ sign. August 05, 2013, at 02:01 PM
by
- Changed lines 4-5 from:
to:
(:allVersions Script-CoreVar 1.8:) Changed line 686 from:
@] to:
@] May 29, 2013, at 01:34 AM
by
- Changed lines 1-2 from:
Documentation? -> Script -> Variables 1.8.xto:
Documentation -> Manuals -> Manual 1.8 -> Core variables(:title Core Variables - ver 1.8 :) Changed lines 4-12 from:
to:
Changed line 32 from:
Ex: hdr(From), avp(i:25). to:
Ex: hdr(From), avp(name). May 09, 2013, at 01:06 PM
by
- Changed line 1 from:
Documentation? -> Script -> Transformations 1.8.xto:
Documentation? -> Script -> Variables 1.8.xMay 09, 2013, at 01:03 PM
by
- Changed line 1 from:
Resources -> Documentation -> CookBooks -> Scripting variablesto:
Documentation? -> Script -> Transformations 1.8.xChanged line 25 from:
to:
April 24, 2013, at 02:21 PM
by
- Added lines 1-677:
Resources -> Documentation -> CookBooks -> Scripting variablesThis documentation is valid for OpenSIPS v1.8.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 multiple 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. Syntax: $(<context>name(subname)[index]{transformation}) The fields written in green are optional. The fields meaning is:
Usage examples:
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(name)** or **$(avp(name)[N])** 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) ... 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(17) = "one"; # we have a single value $avp(17) = "two"; # we have two values ("two","one") $avp(17) = "three"; # we have three values ("three","two","one") xlog("accessing values with no index: $avp(17)\n"); # this will print the first value, which is the last added value -> "three" xlog("accessing values with no index: $(avp(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(17) = NULL; # delete all values and destroy the AVP avp_delete("$avp(17)/g"); # delete the value located at a certain index $(avp(17)[1]) = NULL; #overwrite the value at a certain index $(avp(17)[0]) = "zero"; 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 nonce$an - the nonce from Authorization or Proxy-Authorization header Auth response$auth.resp - the authentication response from Authorization or Proxy-Authorization header Auth nonce$auth.nonce - the nonce string from Authorization or Proxy-Authorization header Auth opaque$auth.opaque - the opaque string from Authorization or Proxy-Authorization header Auth algorithm$auth.alg - the algorithm string from Authorization or Proxy-Authorization header Auth QOP$auth.qop - the value of qop parameter from Authorization or Proxy-Authorization header Auth nonce count (nc)$auth.nc - the value of nonce count parameter 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. Argument options$argv - provides access to command line arguments specified with '-o' option. Examples: # for option '-o foo=0' xlog("foo is $argv(foo) \n"); Branch$branch - this variable is used for creating new branches by writing into it the value of a SIP URI. Examples: # creates a new branch $branch = "sip:new@doamin.org"; # print its URI xlog("last added branch has URI $(branch(uri)[-1]) \n"); Branch fields$branch() - this variable provides read/write access to all fields/attributes of an already existing branch (priorly created with append_branch() ). The fields of the branch are:
The variable accepts also index $(branch(uri)[1]) for accessing a specific branch (multiple branches can be defined at a moment). The index starts from 0 (first branch). If the index is negative, it is considered the n-th branch from the end ( index -1 means the last branch). # creates the first branch append_branch(); # creates the second branch force_send_socket(udp:192.168.1.10:5060); $du = "sip:192.168.2.10"; append_branch("sip:foo@bar.com","0.5"); # display branches xlog("----- branch 0: $(branch(uri)[0]) , $(branch(q)[0]), $(branch(duri)[0]), $(branch(path)[0]), $(branch(flags)[0]), $(branch(socket)[0]) \n"); xlog("----- branch 1: $(branch(uri)[1]) , $(branch(q)[1]), $(branch(duri)[1]), $(branch(path)[1]), $(branch(flags)[1]), $(branch(socket)[1]) \n"); # do some changes over the branches $branch(uri) = "sip:user@domain.ro"; # set URI for the first branch $(branch(q)[0]) = 1000; # set to 1.00 for the first branch $(branch(socket)[1]) = NULL; # reset the socket of the second branch $branch(duri) = NULL; # reset the destination URI or the first branch 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 number$cs - reference to cseq number from cseq header Contact instance$ct - reference to contact instance/body from the contact header. A contact instance is display_name + URI + contact_params. As a Contact header may contain multiple Contact instances and a message may contain multiple Contact headers, an index was added to the $ct variable:
Fields of a contact instance$ct.fields() - reference to the fields of a contact instance/body (see above). Supported fields are:
Examples:
Content-Type$cT - reference to body of content-type header Domain of destination URI$dd - reference to domain of destination uri It is R/W variable (you can assign values to it from routing logic) 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 It is R/W variable (you can assign values to it from routing logic) 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) Q value of the SIP Request's URI$ru_q - reference to q value of the R-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 Formatted date and time$time(format) - returns the string formatted time according to UNIX date (see: man date). 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 Current unix time stamp in seconds$Ts - reference to current unix time stamp in seconds Current microseconds of the current second$Tsm - reference to current microseconds of the current second Startup unix time stamp$TS - reference to startup 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. $(hdrcnt(name)) -- returns number of headers of type given by 'name'. Uses same rules for specifying header names as $hdr(name) above. Many headers (e.g., Via, Path, Record-Route) may appear more than once in the message. This variable returns the number of headers of a given type. Note that some headers (e.g., Path) may be joined together with commas and appear as a single header line. This variable counts the number of header lines, not header values. For message fragment below, $hdrcnt(Path) will have value 2 and $(hdr(Path)[0]) will have value <a.com>: Path: <a.com> Path: <b.com> For message fragment below, $hdrcnt(Path) will have value 1 and $(hdr(Path)[0]) will have value <a.com>,<b.com>: Path: <a.com>,<b.com> Note that both examples above are semantically equivalent but the variables take on different values.
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. ... route { ... $avp(uuid)="caller_id"; $avp(tmp)= $avp(uuid) + ": " + $fu; xdbg("$(C(bg))avp(tmp)$(C(xx)) [$avp(tmp)] $(C(br))cseq$(C(xx))=[$hdr(cseq)]\n"); ... } ... |