In regards to changes for 9508, expr2 system choking on floating point numbers, I...
[asterisk/asterisk.git] / doc / tex / channelvariables.tex
1 \section{Introduction}
2
3 There are two levels of parameter evaluation done in the Asterisk
4 dial plan in extensions.conf.
5 \begin{enumerate}
6 \item The first, and most frequently used, is the substitution of variable
7   references with their values. 
8 \item Then there are the evaluations of expressions done in \$[ .. ]. 
9   This will be discussed below.
10 \end{enumerate}
11 Asterisk has user-defined variables and standard variables set
12 by various modules in Asterisk. These standard variables are
13 listed at the end of this document.
14
15 \section{Parameter Quoting}
16 \begin{verbatim}
17 exten => s,5,BackGround,blabla
18 \end{verbatim}
19 The parameter (blabla) can be quoted ("blabla"). In this case, a 
20 comma does not terminate the field. However, the double quotes
21 will be passed down to the Background command, in this example.
22
23 Also, characters special to variable substitution, expression evaluation, etc
24 (see below), can be quoted. For example, to literally use a \$ on the 
25 string "\$1231", quote it with a preceding \\. Special characters that must
26 be quoted to be used, are [ ] \$ " \\. (to write \\ itself, use \\). 
27
28 These Double quotes and escapes are evaluated at the level of the
29 asterisk config file parser. 
30
31 Double quotes can also be used inside expressions, as discussed below.
32
33 \section{Variables}
34
35 Parameter strings can include variables. Variable names are arbitrary strings. 
36 They are stored in the respective channel structure. 
37
38 To set a variable to a particular value, do : 
39 \begin{verbatim}
40     exten => 1,2,Set(varname=value)
41 \end{verbatim}
42 You can substitute the value of a variable everywhere using \${variablename}.
43 For example, to stringwise append \$lala to \$blabla and store result in \$koko, 
44 do: 
45 \begin{verbatim}
46    exten => 1,2,Set(koko=${blabla}${lala})
47 \end{verbatim}
48
49 There are two reference modes - reference by value and reference by name. 
50 To refer to a variable with its name (as an argument to a function that 
51 requires a variable), just write the name. To refer to the variable's value, 
52 enclose it inside \${}. For example, Set takes as the first argument 
53 (before the =) a variable name, so: 
54 \begin{verbatim}
55         exten => 1,2,Set(koko=lala)
56         exten => 1,3,Set(${koko}=blabla)
57 \end{verbatim}
58 stores to the variable "koko" the value "lala" and to variable "lala" the 
59 value "blabla". 
60
61 In fact, everything contained \${here} is just replaced with the value of 
62 the variable "here". 
63
64 \section{Variable Inheritance}
65
66 Variable names which are prefixed by "\_" will be inherited to channels 
67 that are created in the process of servicing the original channel in 
68 which the variable was set.  When the inheritance takes place, the 
69 prefix will be removed in the channel inheriting the variable.  If the 
70 name is prefixed by "\_\_" in the channel, then the variable is 
71 inherited and the "\_\_" will remain intact in the new channel.
72
73 In the dialplan, all references to these variables refer to the same 
74 variable, regardless of having a prefix or not.  Note that setting any 
75 version of the variable removes any other version of the variable, 
76 regardless of prefix.
77
78 \subsection{Example}
79 \begin{verbatim}
80 Set(__FOO=bar) ; Sets an inherited version of "FOO" variable 
81 Set(FOO=bar)   ; Removes the inherited version and sets a local 
82                ; variable.
83
84 However,
85
86 NoOp(${__FOO}) is identical to NoOp(${FOO})
87 \end{verbatim}
88
89
90 \section{Selecting Characters from Variables}
91
92 The format for selecting characters from a variable can be expressed as:
93 \begin{verbatim}
94         ${variable_name[:offset[:length]]}
95 \end{verbatim}
96 If you want to select the first N characters from the string assigned
97 to a variable, simply append a colon and the number of characters to
98 skip from the beginning of the string to the variable name.
99 \begin{verbatim}
100         ;Remove the first character of extension, save in "number" variable
101         exten => _9X.,1,Set(number=${EXTEN:1})
102 \end{verbatim}
103 Assuming we've dialed 918005551234, the value saved to the 'number' variable
104 would be 18005551234. This is useful in situations when we require users to 
105 dial a number to access an outside line, but do not wish to pass the first 
106 digit.
107
108 If you use a negative offset number, Asterisk starts counting from the end 
109 of the string and then selects everything after the new position. The following
110 example will save the numbers 1234 to the 'number' variable, still assuming
111 we've dialed 918005551234.
112 \begin{verbatim}
113         ;Remove everything before the last four digits of the dialed string
114         exten => _9X.,1,Set(number=${EXTEN:-4})
115 \end{verbatim}
116 We can also limit the number of characters from our offset position that we
117 wish to use. This is done by appending a second colon and length value to the
118 variable name. The following example will save the numbers 555 to the 'number'
119 variable.
120 \begin{verbatim}
121         ;Only save the middle numbers 555 from the string 918005551234
122         exten => _9X.,1,Set(number=${EXTEN:5:3})
123 \end{verbatim}
124 The length value can also be used in conjunction with a negative offset. This
125 may be useful if the length of the string is unknown, but the trailing digits
126 are. The following example will save the numbers 555 to the 'number' variable,
127 even if the string starts with more characters than expected (unlike the
128 previous example).
129 \begin{verbatim}
130         ;Save the numbers 555 to the 'number' variable
131         exten => _9X.,1,Set(number=${EXTEN:-7:3})
132 \end{verbatim}
133 If a negative length value is entered, Asterisk will remove that many characters
134 from the end of the string.
135 \begin{verbatim}
136         ;Set pin to everything but the trailing #.
137         exten => _XXXX#,1,Set(pin=${EXTEN:0:-1})
138 \end{verbatim}
139
140 \section{Expressions} 
141
142 Everything contained inside a bracket pair prefixed by a \$ (like \$[this]) is 
143 considered as an expression and it is evaluated. Evaluation works similar to 
144 (but is done on a later stage than) variable substitution: the expression 
145 (including the square brackets) is replaced by the result of the expression 
146 evaluation. 
147
148 For example, after the sequence:
149 \begin{verbatim}
150 exten => 1,1,Set(lala=$[1 + 2])
151 exten => 1,2,Set(koko=$[2 * ${lala}])
152 \end{verbatim}
153 the value of variable koko is "6".
154
155 and, further:
156 \begin{verbatim}
157 exten => 1,1,Set,(lala=$[  1 +    2   ]);
158 \end{verbatim}
159 will parse as intended. Extra spaces are ignored.
160
161
162 \subsection{Spaces Inside Variables Values}
163
164 If the variable being evaluated contains spaces, there can be problems.
165
166 For these cases, double quotes around text that may contain spaces
167 will force the surrounded text to be evaluated as a single token.
168 The double quotes will be counted as part of that lexical token.
169
170 As an example:
171
172 \begin{verbatim}
173 exten => s,6,GotoIf($[ "${CALLERIDNAME}" : "Privacy Manager" ]?callerid-liar|s|1:s|7)
174 \end{verbatim}
175
176 The variable CALLERIDNAME could evaluate to "DELOREAN MOTORS" (with a space)
177 but the above will evaluate to:
178
179 \begin{verbatim}
180 "DELOREAN MOTORS" : "Privacy Manager"
181 \end{verbatim}
182
183 and will evaluate to 0.
184
185 The above without double quotes would have evaluated to:
186
187 \begin{verbatim}
188 DELOREAN MOTORS : Privacy Manager
189 \end{verbatim}
190
191 and will result in syntax errors, because token DELOREAN is immediately
192 followed by token MOTORS and the expression parser will not know how to 
193 evaluate this expression, because it does not match its grammar.
194
195 \subsection{Operators}
196
197 Operators are listed below in order of increasing precedence.  Operators
198 with equal precedence are grouped within { } symbols.
199
200 \begin{verbatim}
201      expr1 | expr2
202              Return the evaluation of expr1 if it is neither an empty string
203              nor zero; otherwise, returns the evaluation of expr2.
204
205      expr1 & expr2
206              Return the evaluation of expr1 if neither expression evaluates to
207              an empty string or zero; otherwise, returns zero.
208
209      expr1 {=, >, >=, <, <=, !=} expr2
210              Return the results of floating point comparison if both arguments are
211              numbers; otherwise, returns the results of string comparison
212              using the locale-specific collation sequence.  The result of each
213              comparison is 1 if the specified relation is true, or 0 if the
214              relation is false.
215
216      expr1 {+, -} expr2
217              Return the results of addition or subtraction of floating point-valued
218              arguments.
219
220      expr1 {*, /, %} expr2
221              Return the results of multiplication, floating point division, or
222              remainder of arguments.
223
224      - expr1
225             Return the result of subtracting expr1 from 0.
226             This, the unary minus operator, is right associative, and
227             has the same precedence as the ! operator.
228
229      ! expr1
230             Return the result of a logical complement of expr1.
231             In other words, if expr1 is null, 0, an empty string,
232             or the string "0", return a 1. Otherwise, return a 0.
233             It has the same precedence as the unary minus operator, and
234             is also right associative.
235
236      expr1 : expr2
237              The `:' operator matches expr1 against expr2, which must be a
238              regular expression.  The regular expression is anchored to the
239              beginning of  the string with an implicit `^'.
240
241              If the match succeeds and the pattern contains at least one regu-
242              lar expression subexpression `\(...\)', the string correspond-
243              ing to `\1' is returned; otherwise the matching operator
244              returns the number of characters matched.  If the match fails and
245              the pattern contains a regular expression subexpression the null
246              string is returned; otherwise 0.
247
248              Normally, the double quotes wrapping a string are left as part
249              of the string. This is disastrous to the : operator. Therefore,
250              before the regex match is made, beginning and ending double quote
251              characters are stripped from both the pattern and the string.
252
253       expr1 =~ expr2
254              Exactly the same as the ':' operator, except that the match is
255              not anchored to the beginning of the string. Pardon any similarity
256              to seemingly similar operators in other programming languages!
257              The ":" and "=~" operators share the same precedence.
258
259       expr1 ? expr2 :: expr3
260              Traditional Conditional operator. If expr1 is a number
261              that evaluates to 0 (false), expr3 is result of the this
262              expression evaluation.  Otherwise, expr2 is the result.
263              If expr1 is a string, and evaluates to an empty string,
264              or the two characters (""), then expr3 is the
265              result. Otherwise, expr2 is the result.  In Asterisk, all
266              3 exprs will be "evaluated"; if expr1 is "true", expr2
267              will be the result of the "evaluation" of this
268              expression.  expr3 will be the result otherwise. This
269              operator has the lowest precedence.
270 \end{verbatim}
271
272 Parentheses are used for grouping in the usual manner.
273
274 Operator precedence is applied as one would expect in any of the C
275 or C derived languages.
276
277 subsection{Floating Point Numbers}
278
279 In 1.6 and above, we shifted the \$\[...\] expressions to be calculated
280 via floating point numbers instead of integers. We use 'long double' numbers
281 when possible, which provide around 16 digits of precision with 12 byte numbers. 
282
283 To specify a floating point constant, the number has to have this format: D.D, where D is 
284 a string of base 10 digits. So, you can say 0.10, but you can't say .10 or 20.-- we hope
285 this is not an excessive restriction!
286
287 Floating point numbers are turned into strings via the '%g'/'%Lg' format of the printf
288 function set. This allows numbers to still 'look' like integers to those counting
289 on integer behavior. If you were counting on 1/4 evaluating to 0, you need to now say
290 TRUNC(1/4). For a list of all the truncation/rounding capabilities, see the next section.
291
292
293 subsection{Functions}
294
295 In 1.6 and above, we upgraded the $[] expressions to handle floating point numbers.
296 Because of this, folks counting on integer behavior would be disrupted. To make
297 the same results possible, some rounding and integer truncation functions have been
298 added to the core of the Expr2 parser. Indeed, dialplan functions can be called from
299 $[..] expressions without the ${...} operators. The only trouble might be in the fact that
300 the arguments to these functions must be specified with a comma. If you try to call
301 the MATH function, for example, and try to say 3 + MATH(7*8), the expression parser will
302 evaluate 7*8 for you into 56, and the MATH function will most likely complain that its 
303 input doesn't make any sense.
304
305 We also provide access to most of the floating point functions in the C library. (but not all of them).
306
307 While we don't expect someone to want to do Fourier analysis in the dialplan, we
308 don't want to preclude it, either.
309
310 Here is a list of the 'builtin' functions in Expr2. All other dialplan functions
311 are available by simply calling them (read-only). In other words, you don't need to
312 surround function calls in \$\[...\] expressions with \$\{...\}. Don't jump to conclusions,
313 though! -- you still need to wrap variable names in curly braces!
314
315 \begin{Enumerate}
316 \item COS(x) x is in radians. Results vary from -1 to 1. 
317 \item SIN(x) x is in radians. Results vary from -1 to 1.
318 \item TAN(x) x is in radians.
319 \item ACOS(x) x should be a value between -1 and 1.
320 \item ASIN(x) x should be a value between -1 and 1.
321 \item ATAN(x) returns the arc tangent in radians; between -PI/2 and PI/2.
322 \item ATAN2(x,y) returns a result resembling y/x, except that the signs of both args are used to determine the quadrant of the result. Its result is in radians, between -PI and PI.
323 \item POW(x,y) returns the value of x raised to the power of y.
324 \item SQRT(x) returns the square root of x.
325 \item FLOOR(x) rounds x down to the nearest integer.
326 \item CEIL(x) rounds x up to the nearest integer.
327 \item ROUND(x) rounds x to the nearest integer, but round halfway cases away from zero.
328 \item RINT(x) rounds x to the nearest integer, rounding halfway cases to the nearest even integer.
329 \item TRUNC(x) rounds x to the nearest integer not larger in absolute value.
330 \item REMAINDER(x,y) computes the remainder of dividing x by y. The return value is x - n*y, where n is the value x/y, rounded to the nearest integer.
331 If this quotient is 1/2, it is rounded to the nearest even number.
332 \item EXP(x) returns e to the x power.
333 \item EXP2(x) returns 2 to the x power.
334 \item LOG(x) returns the natural logarithm of x.
335 \item LOG2(x) returns the base 2 log of x.
336 \item LOG10(x) returns the base 10 log of x.
337 \end{Enumerate}
338
339 subsection{Examples}
340
341 \begin{verbatim}
342  "One Thousand Five Hundred" =~ "(T[^ ]+)"
343         returns: Thousand
344
345  "One Thousand Five Hundred" =~ "T[^ ]+"
346         returns: 8
347
348  "One Thousand Five Hundred" : "T[^ ]+"
349         returns: 0
350
351  "8015551212" : "(...)"
352         returns: 801
353
354  "3075551212":"...(...)"
355         returns: 555
356
357  ! "One Thousand Five Hundred" =~ "T[^ ]+"
358         returns: 0 (because it applies to the string, which is non-null,
359                     which it turns to "0", and then looks for the pattern
360                     in the "0", and doesn't find it)
361
362  !( "One Thousand Five Hundred" : "T[^ ]+" )
363         returns: 1  (because the string doesn't start with a word starting
364                      with T, so the match evals to 0, and the ! operator
365                      inverts it to 1 ).
366
367  2 + 8 / 2
368         returns 6. (because of operator precedence; the division is done first, then the addition).
369
370  2+8/2
371         returns 6. Spaces aren't necessary.
372
373 (2+8)/2
374         returns 5, of course.
375
376 (3+8)/2
377         returns 5.5 now.
378
379 TRUNC((3+8)/2)
380         returns 5.
381
382 FLOOR(2.5)
383         returns 2
384
385 FLOOR(-2.5)
386         returns -3
387
388 CEIL(2.5)
389         returns 3.
390
391 CEIL(-2.5)
392         returns -2.
393
394 ROUND(2.5)
395         returns 3.
396
397 ROUND(3.5)
398         returns 4.
399
400 ROUND(-2.5)
401         returns -3
402
403 RINT(2.5)
404         returns 2.
405
406 RINT(3.5)
407         returns 4.
408
409 RINT(-2.5)
410         returns -2.
411
412 RINT(-3.5)
413         returns -4.
414
415 TRUNC(2.5)
416         returns 2.
417
418 TRUNC(3.5)
419         returns 3.
420
421 TRUNC(-3.5)
422         returns -3.
423
424 \begin{verbatim}
425
426 Of course, all of the above examples use constants, but would work the
427 same if any of the numeric or string constants were replaced with a
428 variable reference \${CALLERIDNUM}, for instance.
429
430
431 \subsection{Numbers Vs. Strings}
432
433 Tokens consisting only of numbers are converted to 'long double' if possible, which
434 are from 80 bits to 128 bits depending on the OS, compiler, and hardware.
435 This means that overflows can occur when the
436 numbers get above 18 digits (depending on the number of bits involved).  Warnings will appear in the logs in this
437 case.
438
439 \subsection{Conditionals}
440
441 There is one conditional application - the conditional goto : 
442
443 \begin{verbatim}
444         exten => 1,2,gotoif(condition?label1:label2)
445 \end{verbatim}
446
447 If condition is true go to label1, else go to label2. Labels are interpreted
448 exactly as in the normal goto command.
449
450 "condition" is just a string. If the string is empty or "0", the condition
451 is considered to be false, if it's anything else, the condition is true. 
452 This is designed to be used together with the expression syntax described 
453 above, eg : 
454
455 \begin{verbatim}
456         exten => 1,2,gotoif($[${CALLERID} = 123456]?2|1:3|1)
457 \end{verbatim}
458
459 Example of use : 
460
461 \begin{verbatim}
462 exten => s,2,Set(vara=1)
463 exten => s,3,Set(varb=$[${vara} + 2])
464 exten => s,4,Set(varc=$[${varb} * 2])
465 exten => s,5,GotoIf($[${varc} = 6]?99|1:s|6)
466 \end{verbatim}
467
468 \subsection{Parse Errors}
469
470 Syntax errors are now output with 3 lines.
471
472 If the extensions.conf file contains a line like:
473
474 \begin{verbatim}
475 exten => s,6,GotoIf($[ "${CALLERIDNUM}"  = "3071234567" & &  "${CALLERIDNAME}" : "Privacy Manager" ]?callerid-liar|s|1:s|7)
476 \end{verbatim}
477
478 You may see an error in /var/log/asterisk/messages like this:
479 \begin{verbatim}
480 Jul 15 21:27:49 WARNING[1251240752]: ast_yyerror(): syntax error: parse error, unexpected TOK_AND, expecting TOK_MINUS or TOK_LP or TOKEN; Input:
481 "3072312154"  = "3071234567" & & "Steves Extension" : "Privacy Manager" 
482                                ^
483 \end{verbatim}
484
485 The log line tells you that a syntax error was encountered. It now
486 also tells you (in grand standard bison format) that it hit an "AND"
487 (\&) token unexpectedly, and that was hoping for for a MINUS (-), LP
488 (left parenthesis), or a plain token (a string or number).
489
490 The next line shows the evaluated expression, and the line after
491 that, the position of the parser in the expression when it became confused,
492 marked with the "\^" character.
493
494 \subsection{NULL Strings}
495 Testing to see if a string is null can be done in one of two different ways:
496 \begin{verbatim}
497         exten => _XX.,1,GotoIf($["${calledid}" != ""]?3) 
498
499         exten => _XX.,1,GotoIf($[foo${calledid} != foo]?3) 
500 \end{verbatim}
501
502 The second example above is the way suggested by the WIKI. It will 
503 work as long as there are no spaces in the evaluated value.
504
505 The first way should work in all cases, and indeed, might now
506 be the safest way to handle this situation.
507
508 \subsection{Warning}
509
510 If you need to do complicated things with strings, asterisk expressions
511 is most likely NOT the best way to go about it. AGI scripts are an
512 excellent option to this need, and make available the full power of
513 whatever language you desire, be it Perl, C, C++, Cobol, RPG, Java,
514 Snobol, PL/I, Scheme, Common Lisp, Shell scripts, Tcl, Forth, Modula,
515 Pascal, APL, assembler, etc.
516
517 \subsection{Incompatabilities}
518
519 The asterisk expression parser has undergone some evolution. It is hoped
520 that the changes will be viewed as positive. 
521
522 The "original" expression parser had a simple, hand-written scanner,
523 and a simple bison grammar. This was upgraded to a more involved bison
524 grammar, and a hand-written scanner upgraded to allow extra spaces,
525 and to generate better error diagnostics. This upgrade required bison
526 1.85, and part of the user community felt the pain of having to
527 upgrade their bison version.
528
529 The next upgrade included new bison and flex input files, and the makefile
530 was upgraded to detect current version of both flex and bison, conditionally
531 compiling and linking the new files if the versions of flex and bison would
532 allow it.
533
534 If you have not touched your extensions.conf files in a year or so, the
535 above upgrades may cause you some heartburn in certain circumstances, as
536 several changes have been made, and these will affect asterisk's behavior on 
537 legacy extension.conf constructs.  The changes have been engineered
538 to minimize these conflicts, but there are bound to be problems.
539
540 The following list gives some (and most likely, not all) of areas
541 of possible concern with "legacy" extension.conf files:
542
543 \begin{enumerate}
544 \item Tokens separated by space(s).
545    Previously, tokens were separated by spaces. Thus, ' 1 + 1 ' would evaluate
546    to the value '2', but '1+1' would evaluate to the string '1+1'. If this
547    behavior was depended on, then the expression evaluation will break. '1+1'
548    will now evaluate to '2', and something is not going to work right.
549    To keep such strings from being evaluated, simply wrap them in double 
550    quotes: '  "1+1" '
551
552 \item The colon operator. In versions previous to double quoting, the
553    colon operator takes the right hand string, and using it as a 
554    regex pattern, looks for it in the left hand string. It is given
555    an implicit \^ operator at the beginning, meaning the pattern 
556    will match only at the beginning of the left hand string. 
557    If the pattern or the matching string had double quotes around
558    them, these could get in the way of the pattern match. Now,
559    the wrapping double quotes are stripped from both the pattern 
560    and the left hand string before applying the pattern. This
561    was done because it recognized that the new way of
562    scanning the expression doesn't use spaces to separate tokens,
563    and the average regex expression is full of operators that 
564    the scanner will recognize as expression operators. Thus, unless
565    the pattern is wrapped in double quotes, there will be trouble.
566    For instance,      \${VAR1} : (Who|What*)+
567    may have have worked before, but unless you wrap the pattern
568    in double quotes now, look out for trouble! This is better:
569          "\${VAR1}" : "(Who|What*)+"
570    and should work as previous.
571
572 \item Variables and Double Quotes
573    Before these changes, if a variable's value contained one or more double
574    quotes, it was no reason for concern. It is now!
575
576 \item LE, GE, NE operators removed. The code supported these operators,
577    but they were not documented. The symbolic operators, <=, >=, and !=
578    should be used instead.
579
580 \item  Added the unary '-' operator. So you can 3+ -4 and get -1.
581
582 \item  Added the unary '!' operator, which is a logical complement.
583     Basically, if the string or number is null, empty, or '0',
584     a '1' is returned. Otherwise a '0' is returned.
585
586 \item  Added the '=~' operator, just in case someone is just looking for
587     match anywhere in the string. The only diff with the ':' is that
588     match doesn't have to be anchored to the beginning of the string.
589
590 \item  Added the conditional operator  'expr1 ? true\_expr :: false\_expr'
591     First, all 3 exprs are evaluated, and if expr1 is false, the 'false\_expr'
592     is returned as the result. See above for details. 
593
594 \item  Unary operators '-' and '!' were made right associative.
595 \end{enumerate}
596
597 \subsection{Debugging Hints}
598
599 There are two utilities you can build to help debug the \$[ ] in
600 your extensions.conf file.
601
602 The first, and most simplistic, is to issue the command:
603
604 make testexpr2
605
606 in the top level asterisk source directory. This will build a small
607 executable, that is able to take the first command line argument, and
608 run it thru the expression parser. No variable substitutions will be
609 performed. It might be safest to wrap the expression in single
610 quotes...
611
612 testexpr2 '2*2+2/2'
613
614 is an example.
615
616 And, in the utils directory, you can say:
617
618 make check\_expr
619
620 and a small program will be built, that will check the file mentioned
621 in the first command line argument, for any expressions that might be
622 have problems when you move to flex-2.5.31.  It was originally
623 designed to help spot possible incompatibilities when moving from the
624 pre-2.5.31 world to the upgraded version of the lexer.
625
626 But one more capability has been added to check\_expr, that might make
627 it more generally useful. It now does a simple minded evaluation of
628 all variables, and then passes the \$[] exprs to the parser. If there
629 are any parse errors, they will be reported in the log file. You can
630 use check\_expr to do a quick sanity check of the expressions in your
631 extensions.conf file, to see if they pass a crude syntax check.
632
633 The "simple-minded" variable substitution replaces \${varname} variable
634 references with '555'. You can override the 555 for variable values,
635 by entering in var=val arguments after the filename on the command
636 line.  So...
637
638  check\_expr /etc/asterisk/extensions.conf CALLERIDNUM=3075551212 DIALSTATUS=TORTURE EXTEN=121
639
640 will substitute any \${CALLERIDNUM} variable references with
641 3075551212, any \${DIALSTATUS} variable references with 'TORTURE', and
642 any \${EXTEN} references with '121'.  If there is any fancy stuff
643 going on in the reference, like \${EXTEN:2}, then the override will
644 not work. Everything in the \${...} has to match. So, to substitute
645 \${EXTEN:2} references, you'd best say:
646
647  check\_expr /etc/asterisk/extensions.conf CALLERIDNUM=3075551212 DIALSTATUS=TORTURE EXTEN:2=121
648
649 on stdout, you will see something like:
650
651  OK -- \$[ "\${DIALSTATUS}"  = "TORTURE" | "\${DIALSTATUS}" = "DONTCALL" ] at line 416
652
653 In the expr2\_log file that is generated, you will see:
654
655  line 416, evaluation of \$[  "TORTURE"  = "TORTURE" | "TORTURE" = "DONTCALL"  ] result: 1
656
657 check\_expr is a very simplistic algorithm, and it is far from being
658 guaranteed to work in all cases, but it is hoped that it will be
659 useful.
660
661 \section{Asterisk standard channel variables}
662
663 There are a number of variables that are defined or read
664 by Asterisk. Here is a list of them. More information is
665 available in each application's help text. All these variables
666 are in UPPER CASE only.
667
668 Variables marked with a * are builtin functions and can't be set,
669 only read in the dialplan.  Writes to such variables are silently 
670 ignored.
671
672 \begin{verbatim}
673 ${ACCOUNTCODE}          * Account code (if specified) (Deprecated; use ${CDR(accountcode)})
674 ${BLINDTRANSFER}        The name of the channel on the other side of a blind transfer
675 ${BRIDGEPEER}           Bridged peer
676 ${CALLERANI}            * Caller ANI (PRI channels) (Deprecated; use ${CALLERID(ani)})
677 ${CALLERID}             * Caller ID (Deprecated; use ${CALLERID(all)})
678 ${CALLERIDNAME}         * Caller ID Name only (Deprecated; use ${CALLERID(name)})
679 ${CALLERIDNUM}          * Caller ID Number only (Deprecated; use ${CALLERID(num)})
680 ${CALLINGANI2}          * Caller ANI2 (PRI channels)
681 ${CALLINGPRES}          * Caller ID presentation for incoming calls (PRI channels)
682 ${CALLINGTNS}           * Transit Network Selector (PRI channels)
683 ${CALLINGTON}           * Caller Type of Number (PRI channels)
684 ${CHANNEL}              * Current channel name
685 ${CONTEXT}              * Current context
686 ${DATETIME}             * Current date time in the format: DDMMYYYY-HH:MM:SS (Deprecated; use ${STRFTIME(${EPOCH},,%d%m%Y-%H:%M:%S)})
687 ${DB_RESULT}            Result value of DB_EXISTS() dial plan function
688 ${DNID}                 * Dialed Number Identifier (Deprecated; use ${CALLERID(dnid)})
689 ${EPOCH}                * Current unix style epoch
690 ${EXTEN}                * Current extension
691 ${ENV(VAR)}             Environmental variable VAR
692 ${GOTO_ON_BLINDXFR}     Transfer to the specified context/extension/priority
693                         after a blind transfer (use ^ characters in place of
694                         | to separate context/extension/priority when setting
695                         this variable from the dialplan)
696 ${HANGUPCAUSE}          * Asterisk cause of hangup (inbound/outbound)
697 ${HINT}                 * Channel hints for this extension
698 ${HINTNAME}             * Suggested Caller*ID name for this extension
699 ${INVALID_EXTEN}        The invalid called extension (used in the "i" extension)
700 ${LANGUAGE}             * Current language (Deprecated; use ${LANGUAGE()})
701 ${LEN(VAR)}             * String length of VAR (integer)
702 ${PRIORITY}             * Current priority in the dialplan
703 ${PRIREDIRECTREASON}    Reason for redirect on PRI, if a call was directed
704 ${RDNIS}                * Redirected Dial Number ID Service (Deprecated; use ${CALLERID(rdnis)})
705 ${TIMESTAMP}            * Current date time in the format: YYYYMMDD-HHMMSS (Deprecated; use ${STRFTIME(${EPOCH},,%Y%m%d-%H%M%S)})
706 ${TRANSFER_CONTEXT}     Context for transferred calls
707 ${FORWARD_CONTEXT}     Context for forwarded calls
708 ${UNIQUEID}             * Current call unique identifier
709 ${SYSTEMNAME}           * value of the systemname option of asterisk.conf
710 \end{verbatim}
711
712 \subsection{Application return values}
713 -------------------------
714 In Asterisk 1.2, many applications return the result in a variable
715 instead of, as in Asterisk 1.0, changing the dial plan priority (+101).
716 For the various status values, see each application's help text.
717 \begin{verbatim}
718 ${AGISTATUS}                    * agi()
719 ${AQMSTATUS}                    * addqueuemember()
720 ${AVAILSTATUS}                  * chanisavail()
721 ${CHECKGROUPSTATUS}             * checkgroup()
722 ${CHECKMD5STATUS}               * checkmd5()
723 ${CPLAYBACKSTATUS}              * controlplayback()
724 ${DIALSTATUS}                   * dial()
725 ${DBGETSTATUS}                  * dbget()
726 ${ENUMSTATUS}                   * enumlookup()
727 ${HASVMSTATUS}                  * hasnewvoicemail()
728 ${LOOKUPBLSTATUS}               * lookupblacklist()
729 ${OSPAUTHSTATUS}                * ospauth()
730 ${OSPLOOKUPSTATUS}              * osplookup()
731 ${OSPNEXTSTATUS}                * ospnext()
732 ${OSPFINISHSTATUS}              * ospfinish()
733 ${PARKEDAT}                     * parkandannounce()
734 ${PLAYBACKSTATUS}               * playback()
735 ${PQMSTATUS}                    * pausequeuemember()
736 ${PRIVACYMGRSTATUS}             * privacymanager()
737 ${QUEUESTATUS}                  * queue()
738 ${RQMSTATUS}                    * removequeuemember()
739 ${SENDIMAGESTATUS}              * sendimage()
740 ${SENDTEXTSTATUS}               * sendtext()
741 ${SENDURLSTATUS}                * sendurl()
742 ${SYSTEMSTATUS}                 * system()
743 ${TRANSFERSTATUS}               * transfer()
744 ${TXTCIDNAMESTATUS}             * txtcidname()
745 ${UPQMSTATUS}                   * unpausequeuemember()
746 ${VMSTATUS}                     * voicmail()
747 ${VMBOXEXISTSSTATUS}            * vmboxexists()
748 ${WAITSTATUS}                   * waitforsilence()
749 \end{verbatim}
750
751 \subsection{Various application variables}
752 \begin{verbatim}
753 ${CURL}                 * Resulting page content for curl()
754 ${ENUM}                 * Result of application EnumLookup
755 ${EXITCONTEXT}          Context to exit to in IVR menu (app background())
756                         or in the RetryDial() application
757 ${MONITOR}              * Set to "TRUE" if the channel is/has been monitored (app monitor())
758 ${MONITOR_EXEC}         Application to execute after monitoring a call
759 ${MONITOR_EXEC_ARGS}    Arguments to application
760 ${MONITOR_FILENAME}     File for monitoring (recording) calls in queue
761 ${QUEUE_PRIO}           Queue priority
762 ${QUEUE_MAX_PENALTY}    Maximum member penalty allowed to answer caller
763 ${QUEUESTATUS}          Status of the call, one of:
764                         (TIMEOUT | FULL | JOINEMPTY | LEAVEEMPTY | JOINUNAVAIL | LEAVEUNAVAIL)
765 ${RECORDED_FILE}        * Recorded file in record()
766 ${TALK_DETECTED}        * Result from talkdetect()
767 ${TOUCH_MONITOR}        The filename base to use with Touch Monitor (auto record)
768 ${TOUCH_MONITOR_FORMAT} The audio format to use with Touch Monitor (auto record)
769 ${TOUCH_MONITOR_OUTPUT} * Recorded file from Touch Monitor (auto record)
770 ${TXTCIDNAME}           * Result of application TXTCIDName
771 ${VPB_GETDTMF}          chan_vpb
772 \end{verbatim}
773
774 \subsection{The MeetMe Conference Bridge}
775 \begin{verbatim}
776 ${MEETME_RECORDINGFILE}         Name of file for recording a conference with 
777                                 the "r" option
778 ${MEETME_RECORDINGFORMAT}       Format of file to be recorded
779 ${MEETME_EXIT_CONTEXT}          Context for exit out of meetme meeting
780 ${MEETME_AGI_BACKGROUND}        AGI script for Meetme (zap only)
781 ${MEETMESECS}                   * Number of seconds a user participated in a MeetMe conference
782 \end{verbatim}
783
784 \subsection{The VoiceMail() application}
785 \begin{verbatim}
786 ${VM_CATEGORY}          Sets voicemail category
787 ${VM_NAME}              * Full name in voicemail
788 ${VM_DUR}               * Voicemail duration
789 ${VM_MSGNUM}            * Number of voicemail message in mailbox
790 ${VM_CALLERID}          * Voicemail Caller ID (Person leaving vm)
791 ${VM_CIDNAME}           * Voicemail Caller ID Name
792 ${VM_CIDNUM}            * Voicemail Caller ID Number
793 ${VM_DATE}              * Voicemail Date
794 ${VM_MESSAGEFILE}       * Path to message left by caller
795 \end{verbatim}
796
797 \subsection{The VMAuthenticate() application}
798 \begin{verbatim}
799 ${AUTH_MAILBOX} * Authenticated mailbox
800 ${AUTH_CONTEXT} * Authenticated mailbox context
801 \end{verbatim}
802
803 \subsection{DUNDiLookup()}
804 \begin{verbatim}
805 ${DUNDTECH}     * The Technology of the result from a call to DUNDiLookup()
806 ${DUNDDEST}     * The Destination of the result from a call to DUNDiLookup()
807 \end{verbatim}
808
809 \subsection{chan\_zap}
810 \begin{verbatim}
811 ${ANI2}                 * The ANI2 Code provided by the network on the incoming call. 
812                         (ie, Code 29 identifies call as a Prison/Inmate Call)
813 ${CALLTYPE}             * Type of call (Speech, Digital, etc)
814 ${CALLEDTON}            * Type of number for incoming PRI extension
815                         i.e. 0=unknown, 1=international, 2=domestic, 3=net_specific, 
816                         4=subscriber, 6=abbreviated, 7=reserved 
817 ${CALLINGSUBADDR}       * Called PRI Subaddress
818 ${FAXEXTEN}             * The extension called before being redirected to "fax" 
819 ${PRIREDIRECTREASON}    * Reason for redirect, if a call was directed
820 ${SMDI_VM_TYPE}         * When an call is received with an SMDI message, the 'type'
821                         of message 'b' or 'u'
822 \end{verbatim}
823
824 \subsection{chan\_sip}
825 \begin{verbatim}
826 ${SIPCALLID}            * SIP Call-ID: header verbatim (for logging or CDR matching)
827 ${SIPDOMAIN}            * SIP destination domain of an inbound call (if appropriate)
828 ${SIPUSERAGENT}         * SIP user agent (deprecated)
829 ${SIPURI}               * SIP uri
830 ${SIP_CODEC}            Set the SIP codec for a call    
831 ${SIP_URI_OPTIONS}      * additional options to add to the URI for an outgoing call
832 ${RTPAUDIOQOS}          RTCP QoS report for the audio of this call
833 ${RTPVIDEOQOS}          RTCP QoS report for the video of this call
834 \end{verbatim}
835
836 \subsection{chan\_agent}
837 \begin{verbatim}
838 ${AGENTMAXLOGINTRIES}   Set the maximum number of failed logins
839 ${AGENTUPDATECDR}       Whether to update the CDR record with Agent channel data
840 ${AGENTGOODBYE}         Sound file to use for "Good Bye" when agent logs out
841 ${AGENTACKCALL}         Whether the agent should acknowledge the incoming call
842 ${AGENTAUTOLOGOFF}      Auto logging off for an agent
843 ${AGENTWRAPUPTIME}      Setting the time for wrapup between incoming calls
844 ${AGENTNUMBER}          * Agent number (username) set at login
845 ${AGENTSTATUS}          * Status of login       ( fail | on | off )
846 ${AGENTEXTEN}           * Extension for logged in agent
847 \end{verbatim}
848
849
850 \subsection{The Dial() application}
851 \begin{verbatim}
852 ${DIALEDPEERNAME}               * Dialed peer name
853 ${DIALEDPEERNUMBER}             * Dialed peer number
854 ${DIALEDTIME}                   * Time for the call (seconds)
855 ${ANSWEREDTIME}                 * Time from dial to answer (seconds)
856 ${DIALSTATUS}                   * Status of the call, one of:
857                                 (CHANUNAVAIL | CONGESTION | BUSY | NOANSWER 
858                                         | ANSWER | CANCEL | DONTCALL | TORTURE)
859 ${DYNAMIC_FEATURES}             * The list of features (from the [applicationmap] section of
860                                   features.conf) to activate during the call, with feature
861                                   names separated by '#' characters
862 ${LIMIT_PLAYAUDIO_CALLER}       Soundfile for call limits
863 ${LIMIT_PLAYAUDIO_CALLEE}       Soundfile for call limits
864 ${LIMIT_WARNING_FILE}           Soundfile for call limits
865 ${LIMIT_TIMEOUT_FILE}           Soundfile for call limits
866 ${LIMIT_CONNECT_FILE}           Soundfile for call limits
867 ${OUTBOUND_GROUP}               Default groups for peer channels (as in SetGroup)
868 * See "show application dial" for more information
869 \end{verbatim}
870
871 \subsection{The chanisavail() application}
872 \begin{verbatim}
873 ${AVAILCHAN}            * the name of the available channel if one was found    
874 ${AVAILORIGCHAN}        * the canonical channel name that was used to create the channel
875 ${AVAILSTATUS}          * Status of requested channel
876 \end{verbatim}
877
878 \subsection{Dialplan Macros}
879 \begin{verbatim}
880 ${MACRO_EXTEN}          * The calling extensions
881 ${MACRO_CONTEXT}        * The calling context
882 ${MACRO_PRIORITY}       * The calling priority
883 ${MACRO_OFFSET}         Offset to add to priority at return from macro
884 \end{verbatim}
885
886 \subsection{The ChanSpy() application}
887 \begin{verbatim}
888 ${SPYGROUP}             * A ':' (colon) separated list of group names.
889                           (To be set on spied on channel and matched against the g(grp) option)
890 \end{verbatim}
891
892 \subsection{OSP}
893 \begin{verbatim}
894 ${OSPINHANDLE}          OSP handle of in_bound call
895 ${OSPINTIMELIMIT}       Duration limit for in_bound call
896 ${OSPOUTHANDLE}         OSP handle of out_bound call
897 ${OSPTECH}              OSP technology 
898 ${OSPDEST}              OSP destination
899 ${OSPCALLING}           OSP calling number
900 ${OSPOUTTOKEN}          OSP token to use for out_bound call
901 ${OSPOUTTIMELIMIT}      Duration limit for out_bound call
902 ${OSPRESULTS}           Number of remained destinations
903 \end{verbatim}