Variablen
Variablen sind Platzhalter für konkrete Werte. Diese konkreten Werte hängen von der Definition der Variablen ab, also dem Typ, und können bei Asterisk Zahlen, Buchstaben und Buchstabenfolgen sein. Variablen dienen dazu, das kompilierte Programm flexibler zu gestalten und für unterschiedliche oder wechselnde Einsatzzwecke anzupassen. Die Verwendung von Variablen ermöglicht erst den individuellen Einsatz eines Programms, ohne die erneute Übersetzung des Programmcodes in ein ausführbares Programm.
|
Wenn Sie noch nie programmiert haben oder mit Variablen in Berührung gekommen sind, lesen Sie sich auf https://de.wikipedia.org/wiki/Variable_(Programmierung) kurz ein. |
Variablen haben bei Asterisk unterschiedliche Geltungsbereiche. Es gibt Channel-Variablen, die Werte nur für den jeweiligen und aktiven Channel (also das aktuelle Gespräch) setzen, und globale Variablen, die Werte für alle Channels setzen. Die bereits von Asterisk vorgesehenen Variablen haben wir ja in Form der Parameter in den Konfigurationsdateien schon ausführlich kennengelernt. Neben diesen gibt es auch die Möglichkeit, eigene Variablen zu definieren und diese in den Konfigurationsdateien zu verwenden.
Variablen in einer Extension auslesen
Der Wert einer Variable kann immer in der Syntax
${VARIABLENNAME} ausgelesen werden. Es gibt Variablen, die
vom Asterisk-System automatisch gesetzt werden. So wird z. B. die
angerufene Nummer immer in der Variable EXTEN
abgespeichert. Durch Regular Expressions und den Einsatz von Variablen
kann man somit einen langen Dialplan häufig stark komprimieren.
Beispiel vorher:
exten => 100,1,Dial(PJSIP/100)
exten => 101,1,Dial(PJSIP/101)
exten => 102,1,Dial(PJSIP/102)
exten => 103,1,Dial(PJSIP/103)
exten => 104,1,Dial(PJSIP/104)
exten => 105,1,Dial(PJSIP/105)
exten => 106,1,Dial(PJSIP/106)
exten => 107,1,Dial(PJSIP/107)
exten => 108,1,Dial(PJSIP/108)
exten => 109,1,Dial(PJSIP/109)Beispiel nachher:
exten => _10X,1,Dial(PJSIP/${EXTEN})Allgemeines
Variablennamen müssen nicht wie in unseren Beispielen großgeschrieben werden und sind auch nicht an Groß- und Kleinschreibung gebunden. Die Großschreibung von Variablen führt aber meistens zu besser lesbarem Code, da Sie bereits an der Schreibweise erkennen können, dass es sich um eine Variable handelt. Umgekehrt bedeutet das aber auch, dass Groß- und Kleinschreibung nicht für die Unterscheidung von Variablen verwendet werden kann.
|
Die von Asterisk selbst generierten Variablen wie
|
Strings
Strings (als Variablen, die keine Zahlen, sondern Text enthalten) sollten immer in Anführungszeichen gesetzt werden. Asterisk akzeptiert sie aber auch ohne diese Markierung. So sind die folgenden zwei Zeilen im Ergebnis gleich:
exten => 1234,1,Set(OBST=Apfel)
exten => 1234,2,Set(OBST="Apfel")Sollte der String ein Komma oder ein Leerzeichen enthalten, dann müssen Sie Anführungszeichen verwenden, da diese sonst als Kommandos und nicht als Strings interpretiert werden:
exten => 1234,1,Set(OBSTSORTEN="Apfel, Birne, usw.")Quoting
Bei einer Variablen, die Zeichen oder Zeichenfolgen (Wörter, Text) als Werte enthält, kann es vorkommen, dass man bestimmte Zeichen verwenden möchte, die bereits für andere Funktionen reserviert sind. Wollen Sie zum Beispiel ein Underscore-Zeichen als Bestandteil des Variablenwertes verwenden, müssen Sie es besonders kennzeichnen bzw. maskieren. Diese Kennzeichnung nennt man beim Programmieren „escapen“. Folgende Zeichen müssen auf jeden Fall maskiert („escapt“) werden:
[ ] $ " \Das Quoting in der extensions.conf erfolgt
mit einem vorangestellten \ (Backslash).
Beispiel:
exten => 1234,1,Set(BETRAG="10,00 US \$")Globale Variablen in der extensions.conf definieren
Eine globale Variable kann am Anfang der
extensions.conf gesetzt werden. Dies muss im
besonderen Context [globals] erfolgen (er folgt dem Context
[general]).
Beispiel:
[general]
[globals]
KLINGELZEIT=90
[from-intern]
exten => _XXX,1,Dial(PJSIP/${EXTEN},${KLINGELZEIT})
same => n,VoiceMail(${EXTEN}@default)Variablen mit Set() definieren
Die Applikation Set() wird benutzt, um eine Variable
in einer Extension zu setzen.
Syntax
Set(Variablenname=Wert)Beispiel:
; Eine Channel-Variable setzen:
exten => 10,1,Set(LIEBLINGSOBSTSORTE="Apfel")
; Eine globale Variable setzen:
exten => 10,n,Set(GLOBAL(KLINGELZEIT)=90)
; Die Variablen auf dem CLI ausgeben
exten => 10,n,NoOp(KLINGELZEIT = ${KLINGELZEIT})
exten => 10,n,NoOp(LIEBLINGSOBSTSORTE = ${LIEBLINGSOBSTSORTE})
exten => 10,n,NoOp(VAR1 = ${VAR1})
exten => 10,n,NoOp(VAR2 = ${VAR2})Vererbung von Channel-Variablen
Wird im Laufe eines Gespräches ein weiterer Channel aufgebaut, so hat dieser natürlich wieder eigene Channel-Variablen.
Einstufige Vererbung
Will man eine Channel-Variable übergeben, aber keine globale
Variable dafür benutzen, so kann man der Channel-Variable ein
_ (Unterstrich) voransetzen. Diese Channel-Variable
wird dann an den nächsten Channel vererbt. Dabei wird der Unterstrich
entfernt. Die Vererbung kann also nur einmal erfolgen.
Beispiel:
exten => 1234,1,Set(_KUCHENSORTE="Marmorkuchen")Mehrstufige Vererbung
Will man eine Channel-Variable beliebig oft vererben, so muss
man zwei __ (Unterstrich)-Zeichen vor die Variable
setzen. Die zwei Unterstrich-Zeichen werden dann immer
mitvererbt.
|
Asterisk unterscheidet die Namen von Variablen, die mit einem
Underscore anfangen, nicht von Variablen, die keinen Underscore
haben. So wird im folgenden Beispiel aus der vererbbaren
Channel-Variable |
Beispiel:
exten => 1234,1,Set(__KUCHENSORTE="Nusskuchen")Die Unterstriche müssen aber nur beim Setzen der Variable vorangestellt werden, nicht beim Auslesen.
exten => 1234,1,Set(__KUCHENSORTE="Pflaumenkuchen")
exten => 1234,n,NoOp(Kuchen: ${KUCHENSORTE})Feste Channel-Variablen
Die folgende Liste enthält die wichtigsten fest einprogrammierten
Channel-Variablen, die nicht in der extensions.conf
überschrieben, aber ausgelesen werden können.
|
Die jeweils aktuelle, vollständige Liste aller vordefinierten
Channel-Variablen steht in der offiziellen Dokumentation unter
https://docs.asterisk.org. Die hier aufgeführten Variablen sind der
kleinste gemeinsame Nenner, mit dem Sie über viele Versionen hinweg
arbeiten können. Alte Legacy-Namen wie |
Die für das jeweilige Thema relevanten Variablen werden aber im Buch immer in jedem Kapitel extra aufgeführt.[1]
|
Bei einigen der hier aufgeführten Variablen handelt es sich gar nicht um Variablen, sondern um eingebaute Funktionen. Da dies in der Praxis aber oft verschwimmt, werden sie hier trotzdem aufgelistet. |
${ANSWEREDTIME}-
Die Gesamtzeit (in Sekunden), seitdem das Gespräch zustande gekommen ist.
${BLINDTRANSFER}-
Der Name des Channels auf der anderen Seite eines Blind-Transfers.
${CHANNEL}-
Der Name des aktuellen Channels
${CONTEXT}-
Der Name des aktuellen Contextes
${EPOCH}-
Der aktuelle Unix-Timestamp.
${EXTEN}-
Die aktuell angewählte Extension
$\{ENV(VARIABLENNAME)}-
Die Umgebungsvariable
VARIABLENNAME ${HANGUPCAUSE}-
Der Grund für das Beenden (hangup) eines Gesprächs
${INVALID_EXTEN}-
Wird in der
i-Extension benutzt und enthält die gewählte Extension. ${PRIORITY}-
Die aktuelle Priorität innerhalb der Extension
${TRANSFER_CONTEXT}-
Der Context eines weiterverbundenen Gesprächs
${UNIQUEID}-
Der im System einzigartige (unique) ID für das aktuelle Gespräch
${SYSTEMNAME}-
In der
/etc/asterisk/asterisk.conf-Datei eingetragene `systemname`-Parameter.
Variablenmanipulation
Variablen an sich sind erst dann nützlich, wenn man sie zur Laufzeit verändern kann. Mithilfe dieser Variabilität lassen sich komplexe Verhaltensweisen steuern und vorsehen.
Substring
In der Regel bezeichnen Strings eine Aneinanderreihung einzelner
Zeichen (character). Die Größe eines Strings
bestimmt sich durch die Anzahl der identifizierbaren einzelnen
Zeichen. Zum Beispiel besteht der String „Apfelbaum“ aus
9 Zeichen. Ein String kann grundsätzlich in sogenannte Teilstrings
zerlegt werden, also in Strings, die, wenn man sie wieder
aneinanderreiht, den ursprünglichen String ergeben. Im genannten
Beispiel könnten wir den String „Apfelbaum“ in die
Teilstrings „Apfel“ und „baum“ zerlegen,
aber auch „Apf“ und „elbaum“ sind echte
Teilstrings. Ein String hat theoretisch keine begrenzte Größe, er kann
beliebig viele Zeichen enthalten; der gesamte Text dieses Buches
könnte so als ein String aufgefasst werden. Natürlich wäre das dann
nicht mehr sehr handlich. Dennoch ist der Vorgang des Zerlegens eines
Strings in Teilstrings eine Standardprozedur beim Programmieren von
Anwendungen. In vielen Programmiersprachen heißt die hier beschriebene
Funktionalität Substring. Mit einer
Substring-Funktion kann man Teile eines Strings ausschneiden und das
Ergebnis in einer anderen Variablen abspeichern. In Asterisk gibt es
keine eigenständige Routine für diese Substring-Funktion, sondern
hierfür wird ein : (Doppelpunkt) nach dem Variablennamen
eingesetzt. Vom Inhalt der Variablen, also dem String, wird dann eine
vorgegebene Anzahl von Zeichen (Länge) als Teilstring
abgetrennt.
Beispiele
Bei einer Telefonanlage wird traditionell eine führende 0
(Null) gewählt, um eine Amtsleitung zu bekommen. Die zu wählende
Telefonnummer darf diese 0 aber nicht enthalten. Wird die Nummer
0030 227 32320 gewählt, so kann man mit folgender Zeile
die eigentliche Rufnummer in die Variable
${RUFNUMMER} abspeichern:[2]
exten => _0X.,1,Set(RUFNUMMER=${EXTEN:1})Wenn die Angabe der Länge fehlt, wird automatisch der Rest des Strings genommen.
Wenn wir die letzten 5 Ziffern der gewählten Nummer benötigen,
dann erreichen wir das mit einer negativen Zahl. Bei der oben
gewählten Nummer würde die folgende Zeile den Wert 32320 in der
Variablen ${DURCHWAHL}
abspeichern:
exten => _0X.,1,Set(DURCHWAHL=${EXTEN:-5})Möchten wir die Vorwahl in einer separaten Variable abspeichern, so erreichen wir dies durch:
exten => _0X.,1,Set(VORWAHL=${EXTEN:1:3})Diese
Zeile geht davon aus, dass die Vorwahl 3-stellig ist, und speichert
sie in der Variable ${VORWAHL}.[3]
Nehmen wir an, wir möchten bei Telefonaten zur Nummer
00012024562121 nach Amerika die einzelnen Bestandteile
herausfiltern:[4]
exten => _0001X.,1,Set(INTERNATIONALEVORWAHL=${EXTEN:3:1})
exten => _0001X.,n,Set(ORTSVORWAHL=${EXTEN:4:3})
exten => _0001X.,n,Set(RUFNUMMER=${EXTEN:7})
exten => _0001X.,n,Set(DURCHWAHL=${EXTEN:-4})