9446175e19dc80f08c1aed200509c5c4d20802c4
[asterisk/asterisk.git] / doc / README.variables
1 EXTENSION LOGIC : 
2
3 There are two levels of parameter evaluation done in asterisk in 
4 extensions.conf.
5 The first, and most frequently used, is the substitution of variable
6 references with their values. 
7
8 Then there are the evaluations done in $[ .. ]. This will be
9 discussed below.
10
11 ___________________________
12 PARAMETER QUOTING: 
13 ---------------------------
14
15 exten => s,5,BackGround,blabla
16
17 The parameter (blabla) can be quoted ("blabla"). In this case, a 
18 comma does not terminate the field. However, the double quotes
19 will be passed down to the Background command, in this example.
20
21 Also, characters special to variable substitution, expression evaluation, etc
22 (see below), can be quoted. For example, to literally use a $ on the 
23 string "$1231", quote it with a preceding \. Special characters that must
24 be quoted to be used, are [ ] $ " \. (to write \ itself, use \\). 
25
26 These Double quotes and escapes are evaluated at the level of the
27 asterisk config file parser. 
28
29 Double quotes can also be used inside expressions, as discussed below.
30
31
32 ___________________________
33 VARIABLES: 
34 ---------------------------
35
36 Parameter strings can include variables. Variable names are arbitrary strings. 
37 They are stored in the respective channel structure. 
38
39 To set a variable to a particular value, do : 
40
41     exten => 1,2,SetVar,varname=value
42
43 You can substitute the value of a variable everywhere using ${variablename}.
44 For example, to stringwise append $lala to $blabla and store result in $koko, 
45 do: 
46
47    exten => 1,2,SetVar,koko=${blabla}${lala}
48
49 There are also the following special variables: 
50
51 ${ACCOUNTCODE}  Account code (if specified)
52 ${CALLERID}     Caller ID
53 ${CALLERIDNAME} Caller ID Name only
54 ${CALLERIDNUM}  Caller ID Number only
55 ${CALLINGPRES}  PRI Caller ID presentation for incoming calls
56 ${CHANNEL}      Current channel name
57 ${CONTEXT}      Current context
58 ${DATETIME}     Current date time in the format: YYYY-MM-DD_HH:MM:SS
59 ${DNID}         Dialed Number Identifier
60 ${ENUM}         Result of application EnumLookup
61 ${EPOCH}        Current unix style epoch
62 ${EXTEN}        Current extension
63 ${ENV(VAR)}     Environmental variable VAR
64 ${HANGUPCAUSE}  Asterisk hangup cause
65 ${INVALID_EXTEN}The invalid called extension (used in the "i" extension)
66 ${LANGUAGE}     Current language
67 ${LEN(VAR)}     String length of VAR (integer)
68 ${MEETMESECS}   Number of seconds a user participated in a MeetMe conference
69 ${PRIORITY}     Current priority
70 ${RDNIS}        Redirected Dial Number ID Service
71 ${SIPCALLID}    SIP Call-ID: header verbatim (for logging or CDR matching)
72 ${SIPDOMAIN}    SIP destination domain of an inbound call (if appropriate)
73 ${SIPUSERAGENT} SIP user agent 
74 ${TIMESTAMP}    Current date time in the format: YYYYMMDD-HHMMSS
75 ${TXTCIDNAME}   Result of application TXTCIDName
76 ${UNIQUEID}     Current call unique identifier
77 ${PRIREDIRECTREASON} Reason for redirect, if a call was directed
78
79 The dial() application sets the following variables:
80
81 ${DIALEDPEERNAME} Dialed peer name
82 ${DIALEDPEERNUMBER} Dialed peer number
83 ${DIALEDTIME}   Total time for the call in seconds (Network time).
84 ${ANSWEREDTIME} Time from answer to end of call in seconds (Billable time).
85 ${DIALSTATUS}   Status of the call, one of:
86                 CHANUNAVAIL | CONGESTION | BUSY | NOANSWER | ANSWER | CANCEL
87
88 The agent channel uses the following variables:
89 ${AGENTMAXLOGINTRIES}   Set the maximum number of failed logins
90 ${AGENTUPDATECDR}       Whether to update the CDR record with Agent channel data
91 ${AGENTGOODBYE}         Sound file to use for "Good Bye" when agent logs out
92 ${AGENTACKCALL}         Whether the agent should acknowledge the incoming call
93 ${AGENTAUTOLOGOFF}      Auto logging off for an agent
94 ${AGENTWRAPUPTIME}      Setting the time for wrapup between incoming calls
95 ${AGENTNUMBER}          Agent number (username) set at login
96 ${AGENTSTATUS}          Status of login ( fail | on | off )
97 ${AGENTEXTEN}           Extension for logged in agent
98
99 The queue() application uses the following variables:
100 ${MONITOR_FILENAME}     File for monitoring (recording) calls in queue
101 ${QUEUE_PRIO}           Queue priority
102
103 There are two reference modes - reference by value and reference by name. 
104 To refer to a variable with its name (as an argument to a function that 
105 requires a variable), just write the name. To refer to the variable's value, 
106 enclose it inside ${}. For example, SetVar takes as the first argument 
107 (before the =) a variable name, so: 
108
109 ;exten => 1,2,SetVar,koko=lala
110 ;exten => 1,3,SetVar,${koko}=blabla
111
112 stores to the variable "koko" the value "lala" and to variable "lala" the 
113 value "blabla". 
114
115 In fact, everything contained ${here} is just replaced with the value of 
116 the variable "here". 
117
118 ___________________________
119 EXPRESSIONS: 
120 ---------------------------
121
122 Everything contained inside a bracket pair prefixed by a $ (like $[this]) is 
123 considered as an expression and it is evaluated. Evaluation works similar to 
124 (but is done on a later stage than) variable substitution: the expression 
125 (including the square brackets) is replaced by the result of the expression 
126 evaluation. The arguments and operands of the expression MUST BE separated 
127 by at least one space. 
128
129
130 For example, after the sequence: 
131
132 exten => 1,1,SetVar,"lala=$[1 + 2]";
133 exten => 1,2,SetVar,"koko=$[2 * ${lala}]";
134
135 the value of variable koko is "6".
136
137 And, further:
138
139 exten => 1,1,SetVar,"lala=$[1+2]";
140
141 will not work as you might have expected. Since all the chars in the single 
142 token "1+2" are not numbers, it will be evaluated as the string "1+2". Again,
143 please do not forget, that this is a very simple parsing engine, and it
144 uses a space (at least one), to separate "tokens".
145
146 and, further:
147
148 exten => 1,1,SetVar,"lala=$[  1 +    2   ]";
149
150 will parse as intended. Extra spaces are ignored.
151
152 ___________________________
153 SPACES INSIDE VARIABLE
154 ---------------------------
155 If the variable being evaluated contains spaces, there can be problems.
156
157 For these cases, double quotes around text that may contain spaces
158 will force the surrounded text to be evaluated as a single token.
159 The double quotes will be counted as part of that lexical token.
160
161 As an example:
162
163 exten => s,6,GotoIf($[ "${CALLERIDNAME}" : "Privacy Manager" ]?callerid-liar|s|1:s|7)
164
165 The variable CALLERIDNAME could evaluate to "DELOREAN MOTORS" (with a space)
166 but the above will evaluate to:
167
168 "DELOREAN MOTORS" : "Privacy Manager"
169
170 and will evaluate to 0.
171
172 The above without double quotes would have evaluated to:
173
174 DELOREAN MOTORS : Privacy Manager
175
176 and will result in syntax errors, because token DELOREAN is immediately
177 followed by token MOTORS and the expression parser will not know how to 
178 evaluate this expression.
179
180 _____________________
181 OPERATORS
182 ---------------------
183 Operators are listed below in order of increasing precedence.  Operators
184 with equal precedence are grouped within { } symbols.
185
186      expr1 | expr2
187              Return the evaluation of expr1 if it is neither an empty string
188              nor zero; otherwise, returns the evaluation of expr2.
189
190      expr1 & expr2
191              Return the evaluation of expr1 if neither expression evaluates to
192              an empty string or zero; otherwise, returns zero.
193
194      expr1 {=, >, >=, <, <=, !=} expr2
195              Return the results of integer comparison if both arguments are
196              integers; otherwise, returns the results of string comparison
197              using the locale-specific collation sequence.  The result of each
198              comparison is 1 if the specified relation is true, or 0 if the
199              relation is false.
200
201      expr1 {+, -} expr2
202              Return the results of addition or subtraction of integer-valued
203              arguments.
204
205      expr1 {*, /, %} expr2
206              Return the results of multiplication, integer division, or
207              remainder of integer-valued arguments.
208
209      expr1 : expr2
210              The `:' operator matches expr1 against expr2, which must be a
211              regular expression.  The regular expression is anchored to the
212              beginning of  the string with an implicit `^'.
213
214              If the match succeeds and the pattern contains at least one regu-
215              lar expression subexpression `\(...\)', the string correspond-
216              ing to `\1' is returned; otherwise the matching operator
217              returns the number of characters matched.  If the match fails and
218              the pattern contains a regular expression subexpression the null
219              string is returned; otherwise 0.
220
221 Parentheses are used for grouping in the usual manner.
222
223 The parser must be parsed with bison (bison is REQUIRED - yacc cannot 
224 produce pure parsers, which are reentrant) 
225
226 ___________________________
227 CONDITIONALS
228 ---------------------------
229
230 There is one conditional operator - the conditional goto : 
231
232 ;exten => 1,2,gotoif,condition?label1:label2
233
234 If condition is true go to label1, else go to label2. Labels are interpreted
235 exactly as in the normal goto command.
236
237 "condition" is just a string. If the string is empty or "0", the condition
238 is considered to be false, if it's anything else, the condition is true. 
239 This is designed to be used together with the expression syntax described 
240 above, eg : 
241
242 exten => 1,2,gotoif,$[${CALLERID} = 123456]?2|1:3|1
243
244
245 Example of use : 
246
247 exten => s,2,SetVar,"vara=1"
248 exten => s,3,SetVar,"varb=$[${vara} + 2]"
249 exten => s,4,SetVar,"varc=$[${varb} * 2]"
250 exten => s,5,GotoIf,"$[${varc} = 6]?99|1:s|6";
251
252 ___________________________
253 PARSE ERRORS
254 ---------------------------
255
256 Syntax errors are now output with 3 lines.
257
258 If the extensions.conf file contains a line like:
259
260 exten => s,6,GotoIf($[ "${CALLERIDNUM}"  = "3071234567" & "${CALLERIDNAME}" : "Privacy Manager" ]?callerid-liar|s|1:s|7)
261
262 You may see an error in /var/log/asterisk/messages like this:
263
264 May  3 15:58:53 WARNING[1234455344]: ast_yyerror(): syntax error: parse error; Input:
265  "3072312154"  : "3071234567" & & "Steves Extension" : "Privacy Manager"
266  ^^^^^^^^^^^^^^^^^^^^^^^^^^^
267                                   ^
268
269 The first line shows the string passed to the expression parser. This
270 string is the result of the variable replacements, etc. This way, you
271 can see the actual string that went into the parser.
272
273 The second line usually shows a string of '^' chars, that show what's
274 been legally parsed so far.
275
276 And the third line shows where the parser was (lookahead token lexing,
277 etc), when the parse hit the rocks. A single '^' here. The error is
278 going to be somewhere between the last '^' on the second line, and the
279 '^' on the third line. That's right, in the example above, there are two
280 '&' chars, separated by a space, and this is a definite no-no!
281
282
283 ___________________________
284 NULL STRINGS
285 ---------------------------
286
287 Testing to see if a string is null can be done in one of two different ways:
288
289 exten => _XX.,1,GotoIf($["${calledid}" != ""]?3) 
290
291 exten => _XX.,1,GotoIf($[foo${calledid} != foo]?3) 
292
293
294 The second example above is the way suggested by the WIKI. It will 
295 work as long as there are no spaces in the evaluated value.
296
297 The first way should work in all cases, and indeed, might now
298 be the safest way to handle this situation.
299
300 ___________________________
301 WARNING
302 ---------------------------
303
304 If you need to do complicated things with strings, asterisk expressions
305 is most likely NOT the best way to go about it. AGI scripts are an
306 excellent option to this need, and make available the full power of
307 whatever language you desire, be it Perl, C, C++, Cobol, RPG, Java,
308 Snobol, PL/I, Scheme, Common Lisp, Shell scripts, Tcl, Forth, Modula,
309 Pascal, APL, assembler, etc.
310