c70b11439783a669ddf5eb183ef7cd431c381e12
[asterisk/asterisk.git] / README.variables
1 GENERAL ENCHANCEMENTS TO EXTENSION LOGIC : 
2
3 QUOTING: 
4
5 exten => s,5,BackGround,blabla
6
7 The parameter (blabla) can be quoted ("blabla"). In this case, a 
8 comma does not terminate the field. 
9
10 Also, characters special to variable substitution, expression evaluation, etc
11 (see below), can be quoted. For example, to literally use a $ on the 
12 string "$1231", quote it with a preceeding \. Special characters that must
13 be quoted to be used, are [ ] $ " \. (to write \ itself, use \\). 
14
15 VARIABLES: 
16
17 Parameter strings can include variables. Variable names are arbitrary strings. 
18 They are stored in the respective channel structure. 
19
20 To set a variable to a particular value, do : 
21
22 ;exten => 1,2,SetVar,varname=value
23
24 You can substitute the value of a variable everywhere using ${variablename}.
25 For example, to stringwise append $lala to $blabla and store result in $koko, 
26 do: 
27
28 ;exten => 1,2,SetVar,koko=${blabla}${lala}
29
30 There are also the following special variables: 
31
32 ${CALLERID}     Caller ID
33 ${CALLERIDNAME} Caller ID Name only
34 ${CALLERIDNUM}  Caller ID Number only
35 ${EXTEN}        Current extension
36 ${CONTEXT}      Current context
37 ${PRIORITY}     Current priority
38 ${CHANNEL}      Current channel name
39 ${ENV(VAR)}     Environmental variable VAR
40 ${LEN(VAR)}     String length of VAR (integer)
41 ${EPOCH}        Current unix style epoch
42 ${DATETIME}     Current date time in the format: YYYY-MM-DD_HH:MM:SS
43 ${UNIQUEID}     Current call unique identifier
44 ${DNID}         Dialed Number Identifier
45 ${RDNIS}        Redirected Dial Number ID Service
46
47 There are two reference modes - reference by value and reference by name. 
48 To refer to a variable with its name (as an argument to a function that 
49 requires a variable), just write the name. To refer to the variable's value, 
50 enclose it inside ${}. For example, SetVar takes as the first argument 
51 (before the =) a variable name, so: 
52
53 ;exten => 1,2,SetVar,koko=lala
54 ;exten => 1,3,SetVar,${koko}=blabla
55
56 stores to the variable "koko" the value "lala" and to variable "lala" the 
57 value "blabla". 
58
59 In fact, everything contained ${here} is just replaced with the value of 
60 the variable "here". 
61
62 EXPRESSIONS: 
63
64 Everything contained inside a bracket pair prefixed by a $ (like $[this]) is 
65 considered as an expression and it is evaluated. Evaluation works similar to 
66 (but is done on a later stage than) variable substitution: the expression 
67 (including the square brackets) is replaced by the result of the expression 
68 evaluation. The arguments and operands of the expression MUST BE separated 
69 with spaces (take care NOT to leave ANY spaces between opening and closing 
70 square brackets and the first and last arguments). 
71
72 For example, after the sequence: 
73
74 exten => 1,1,SetVar,"lala=$[1 + 2]";
75 exten => 1,2,SetVar,"koko=$[2 * ${lala}]";
76
77 the value of variable koko is "6".
78
79 Operators are listed below in order of increasing precedence.  Operators
80 with equal precedence are grouped within { } symbols.
81
82      expr1 | expr2
83              Return the evaluation of expr1 if it is neither an empty string
84              nor zero; otherwise, returns the evaluation of expr2.
85
86      expr1 & expr2
87              Return the evaluation of expr1 if neither expression evaluates to
88              an empty string or zero; otherwise, returns zero.
89
90      expr1 {=, >, >=, <, <=, !=} expr2
91              Return the results of integer comparison if both arguments are
92              integers; otherwise, returns the results of string comparison
93              using the locale-specific collation sequence.  The result of each
94              comparison is 1 if the specified relation is true, or 0 if the
95              relation is false.
96
97      expr1 {+, -} expr2
98              Return the results of addition or subtraction of integer-valued
99              arguments.
100
101      expr1 {*, /, %} expr2
102              Return the results of multiplication, integer division, or
103              remainder of integer-valued arguments.
104
105      expr1 : expr2
106              The `:' operator matches expr1 against expr2, which must be a
107              regular expression.  The regular expression is anchored to the
108              beginning of  the string with an implicit `^'.
109
110              If the match succeeds and the pattern contains at least one regu-
111              lar expression subexpression `\(...\)', the string correspond-
112              ing to `\1' is returned; otherwise the matching operator
113              returns the number of characters matched.  If the match fails and
114              the pattern contains a regular expression subexpression the null
115              string is returned; otherwise 0.
116
117 Parentheses are used for grouping in the usual manner.
118
119 The parser must be parsed with bison (bison is REQUIRED - yacc cannot 
120 produce pure parsers, which are reentrant) 
121
122 CONDITIONALS
123
124 There is one conditional operator - the conditional goto : 
125
126 ;exten => 1,2,gotoif,condition?label1:label2
127
128 If condition is true go to label1, else go to label2. Labels are interpreted
129 exactly as in the normal goto command.
130
131 "condition" is just a string. If the string is empty or "0", the condition
132 is considered to be false, if it's anything else, the condition is true. 
133 This is designed to be used together with the expression syntax described 
134 above, eg : 
135
136 exten => 1,2,gotoif,$[${CALLERID} = 123456]?2|1:3|1
137
138
139 Example of use : 
140
141 exten => s,2,SetVar,"vara=1"
142 exten => s,3,SetVar,"varb=$[${vara} + 2]"
143 exten => s,4,SetVar,"varc=$[${varb} * 2]"
144 exten => s,5,GotoIf,"$[${varc} = 6]?99|1:s|6";
145