Asterisk Expressions

Asterisk dialplan expressions are special expressions that can be used in the dialplan of Asterisk.

Syntax

$[expr1 operator expr2]

Page Contents

• The high-level view of variable evaluations in Asterisk:
  • Parameter Quoting:
  • Spaces Inside Variable
  • Null Strings
  • Logical operators
  • Using Logical operators
  • Comparison operators
  • Arithmetic operators
  • Asterisk 1.6 Arithmetic
  • Regular expressions
  • Ternary "if" (inline conditional) operator
• Operator Precedence
  • Conditionals
• Example
• See also

The high-level view of variable evaluations in Asterisk:

Since most user input will come via config files to Asterisk, some filtering and substitutions are done
as the config files are read.

Next, as the dialplan is executed, the ${ ... } variables and functions are evaluated and substituted.

And lastly, the contents of $[ .. ] expressions are evaluated and substituted.

Parameter Quoting:

exten => s,5,BackGround,blabla

The parameter (blabla) can be quoted ("blabla"). In this case, a comma does not terminate the field. However, the double quotes will be passed down to the Background command, in this example.

Also, characters special to variable substitution, expression evaluation, etc (see below), can be quoted. For example, to literally use a $ on the string "$1231", quote it with a preceding \. Special characters that must be quoted to be used, are [ ] $ " \. (to write \ itself, use \\).

These double quotes and escapes are evaluated at the level of the asterisk config file parser.

Double quotes can also be used inside expressions, as discussed below.

Spaces Inside Variable

UPDATE: with the latest Asterisk Beta (1.2.0_2) there is the following notice:

Dialplan Expressions:

• The dialplan expression parser (which handles $[ ... ] constructs) has gone through a major upgrade, but has one incompatible change: spaces are no longer required around expression operators, including string comparisons. However, you can now use quoting to keep strings together for comparison. For more details, please read the doc/README.variables file, and check over your dialplan for possible problems.

If the variable being evaluated contains spaces, there can be problems.

For these cases, double quotes around text that may contain spaces will force the surrounded text to be evaluated as a single token. The double quotes will be counted as part of that lexical token.

As an example:

exten => s,6,GotoIf($[ "${CALLERIDNAME}" : "Privacy Manager" ]?callerid-liar|s|1:s|7)

The variable CALLERIDNAME could evaluate to "DELOREAN MOTORS" (with a space) but the above will evaluate to:

"DELOREAN MOTORS" : "Privacy Manager"

and will evaluate to 0.

The above without double quotes would have evaluated to:

DELOREAN MOTORS : Privacy Manager

and will result in syntax errors, because token DELOREAN is immediately followed by token MOTORS and the expression parser will not know how to evaluate this expression.

Null Strings

Testing to see if a string is null can be done in one of three different ways:

exten => _XX.,1,GotoIf($["${calledid}" != ""]?3)

exten => _XX.,1,GotoIf($[foo${calledid} != foo]?3)

exten => _XX.,1,GotoIf($[${LEN(${calledid})} > 0]?3)

The second example above is the way suggested by the WIKI. It will work as long as there are no spaces in the evaluated value.

The first way should work in all cases, and indeed, might now be the safest way to handle this situation.

The third way seems the most logical. Anyone care to comment. Besides the LEN() function, there is now also ISNULL. Keep in mind such function calls need to kept inside ${...}.

Logical operators

• expr1 | expr2 (Logical OR)
  • If expr1 evaluates to a non-empty string or a non-zero value, returns this value ("true"). Otherwise returns the evaluation of expr2.
• expr1 & expr2 (Logical AND)
• !expr (Logical Unary Complement)
  • If both expressions evaluate to non-empty strings or non-zero values, then returns the value of expr1 ("true"). Otherwise returns zero ("false").
  • Not available in versions of Asterisk < 1.1
  • Note that if a space is inserted between the '!' and the expression, an error will occur.

Using Logical operators

To use logical operator on conditionals commands like GotoIf do it like this:

exten => s,n,GotoIf($[ $[ "${FOO}" = "1" ] & $[ "${BAR}" = "2" ] ]?labelTrue:labelFalse)

Comparison operators

• expr1 = expr2
• expr1 != expr2
• expr1 < expr2
• expr1 > expr2
• expr1 <= expr2
• expr1 >= expr2
  • If both arguments are integers, returns the result of an integer comparison. Otherwise returns the result of string comparison using the locale-specific collation sequence. In either case, the result of a comparison is 1 if the specified relation is true, or 0 if the relation is false.

Arithmetic operators

• expr1 + expr2
• expr1 - expr2
• - expr (unary negation operator)
  • Returns the results of addition or subtraction of integer-valued arguments.
  • Not available in versions of Asterisk < 1.1
• expr1 * expr2
• expr1 / expr2
• expr1 % expr2
  • Return the results of multiplication, integer division, or remainder of integer-valued arguments.

Asterisk 1.6 Arithmetic

In 1.6 and above, we upgraded the $[] expressions to handle floating point numbers. Because of this, folks counting on integer behavior would be disrupted. To make the same results possible, some rounding and integer truncation functions have been added to the core of the Expr2 parser. Indeed, dialplan functions can be called from $[..] expressions without the ${...} operators. The only trouble might be in the fact that the arguments to these functions must be specified with a comma. If you try to call the MATH function, for example, and try to say 3 + MATH(7*8), the expression parser will evaluate 7*8 for you into 56, and the MATH function will most likely complain that its input doesn't make any sense. We also provide access to most of the floating point functions in the C library. (but not all of them).

While we don't expect someone to want to do Fourier analysis in the dialplan, we don't want to preclude it, either.

Here is a list of the 'builtin' functions in Expr2. All other dialplan functions are available by simply calling them (read-only). In other words, you don't need to surround function calls in $[...] expressions with ${...}. Don't jump to conclusions, though! - you still need to wrap variable names in curly braces!

• COS(x) x is in radians. Results vary from -1 to 1.
• SIN(x) x is in radians. Results vary from -1 to 1.
• TAN(x) x is in radians.
• ACOS(x) x should be a value between -1 and 1.
• ASIN(x) x should be a value between -1 and 1.
• ATAN(x) returns the arc tangent in radians; between -PI/2 and PI/2.
• 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.
• POW(x,y) returns the value of x raised to the power of y.
• SQRT(x) returns the square root of x.
• FLOOR(x) rounds x down to the nearest integer.
• CEIL(x) rounds x up to the nearest integer.
• ROUND(x) rounds x to the nearest integer, but round halfway cases away from zero.
• RINT(x) rounds x to the nearest integer, rounding halfway cases to the nearest even integer.
• TRUNC(x) rounds x to the nearest integer not larger in absolute value.
• 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. If this quotient is 1/2, it is rounded to the nearest even number.
• EXP(x) returns e to the x power.
• EXP2(x) returns 2 to the x power.
• LOG(x) returns the natural logarithm of x.
• LOG2(x) returns the base 2 log of x.
• LOG10(x) returns the base 10 log of x.

Regular expressions

• expr1 : regexp
  • The ':' operator matches expr1 against regexp, which must be a regular expression. The regular expression is anchored to the beginning of the string with an implicit '^'.
  • If the match succeeds and regexp contains at least one regular expression subexpression '\(...\)', the string corresponding to '\1' is returned; otherwise the result returned is the number of characters matched. If the match fails and regexpcontains a regular expression subexpression, the null string is returned; otherwise 0.
• expr1 =~ expr2
  • Exactly the same as the ':' operator, except that the match is not anchored to the beginning of the string. Pardon any similarity to seemingly similar operators in other programming languages!
  • The ":" and "=~" operators share the same precedence.
  • Not available in versions of Asterisk < 1.1

THE DOCUMENTATION ABOVE FOR REGULAR EXPRESSIONS IS WOEFULLY INADEQUATE. The problem seems to be that the regular expression syntax conflicts with Asterisk expression syntax. As a result, one must backslash escape anything which looks like it might be an expression operator. Also, contrary to what is suggested above, it does not seem to be necessary to backslash escape the parentheses.

Here is one example that works:

exten => stripcidtext,n,Set(regx="([0-9]+)") ; Note the quotes -- and note that parentheses are REQUIRED if you want to return the matched string
exten => stripcidtext,n,Set(cid2=$["${cid}" : ${regx}]) ; Returns numeric beginning to string

So if ${cid} contains 123foo then ${cid2} will contain just 123.

However, if ${cid} contains foo123 then ${cid2} will be empty. Supposedly you could use =~ instead of : and the string matching would work anywhere, but I don't think that works correctly (at least, I could not get =~ to work).

Here is another example:

exten => s,n,Set(enum-protocol=$["${enum-record}" : "([a-zA-Z0-9]\+)\:"])

If enum-record contains "sip:18005558355@tf.voipmich.com", then this command will set enum-protocol to "sip".

Ternary "if" (inline conditional) operator

• expr1 ? expr2 :: expr3
  • Traditional ternary operator. If expr1 is a number that evaluates to 0 (false), expr3 is result of the this expression evaluation. Otherwise, expr2 is the result.
  • If expr1 is a string, and evaluates to an empty string, or the two characters (""), then expr3 is the result. Otherwise, expr2 is the result.
  • In Asterisk, all 3 exprs will be "evaluated"; if expr1 is "true", expr2 will be the result of the "evaluation" of this expression. expr3 will be the result otherwise.
  • This operator has the lowest precedence.
  • Not available in versions of Asterisk < 1.1
  • This operator is quite buggy. The IF function is recommended instead.

Parentheses are used for grouping in the usual manner.

Operator Precedence

1. Parentheses: (, )
2. Unary operators !, -
3. Regular expression comparison: :, =~
4. Multiplicative arithmetic operators: *, /, %
5. Additive arithmetic operators: +, -
6. Comparison operators: =, !=, <, >, <=, >=
7. Logical operators: |, &
8. Ternary "if" (inline conditional) operator: ? :

Conditionals

There are now several conditional applications-- an example is the conditional gotoIf :

exten => 1,2,GotoIf,condition?label1:label2

If condition is true go to label1, else go to label2. Labels are interpreted exactly as in the normal goto command.

"condition" is just a string. If the string is empty or "0", the condition is considered to be false, if it's anything else, the condition is true. This is designed to be used together with the expression syntax described above, eg :

exten => 1,2,GotoIf,$[${CALLERID} = 123456]2|1:3|1

Example

After the sequence:

exten => 1,1,SetVar(lala=$[1 + 2]);
exten => 1,2,SetVar(koko=$[2 * ${lala}]);

the value of ${koko} is "6".

See also

• Using Variables in Asterisk Dialplans
• The Dialplan - extensions.conf