Konkret handelt es sich bei der Environment-Klasse um die Python-Klasse WavecdnEnvironmentV1. Sie ist bei der [[Erweiterung schreiben|Programmierung von Erweiterungen]] relevant. Im folgenden findet sich die Dokumentation der Klassenmethoden. Die Spalte 'Verfügbarkeit' gibt die [[Anfragenmodell|Schritte der Anfragenabarbeitung]] an, in denen die jeweilige Methode verfügbar ist.

{| class="table-wavecdn" cellspacing="0"
!Methode
!style="width:600px"|Beschreibung
!Verfügbarkeit
|-
|get_client_ip()
|Gibt die IP vom Webuser zurück.

Zum Beispiel: '185.22.221.5'
|
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
* wavecdn_fetch
* wavecdn_deliver
|-
|get_request_ssl()
|Gibt in Form eines Boolean zurück, ob der Webuser bei der Anfrage SSL genutzt hat oder nicht.
|
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
* wavecdn_fetch
* wavecdn_deliver
|-
|get_request_method()
|Gibt die Methode der Anfrage vom Webuser zurück.

Zum Beispiel: 'HEAD', 'GET' oder 'POST'
|
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
* wavecdn_fetch
* wavecdn_deliver
|-
|get_request_uri()
|Gibt die vom Webuser angefragte URI zurück.

Zum Beispiel: '/main/index.php?site=home'
|
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
* wavecdn_fetch
* wavecdn_deliver
|-
|get_request_path()
|Gibt die vom Webuser angefragte URL ohne Query-String zurück.

Zum Beispiel: '/main/index.php'
|
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
* wavecdn_fetch
* wavecdn_deliver
|-
|get_request_query_string()
|Gibt den Query-String aus der vom Webuser angefragten URL zurück. Wenn kein Query-String vorhanden ist, wird None zurückgegeben.

Zum Beispiel: 'site=home' oder None
|
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
* wavecdn_fetch
* wavecdn_deliver
|-
|get_request_query_string_parameters()
|Gibt ein Dictionary mit den Parametern des Query-Strings zurück. Wenn zwei Parameter den gleichen Namen haben, wird nur der erste in das Dictionary aufgenommen. Wenn kein Query-String vorhanden ist, wird ein leeres Dictionary zurückgegeben.

Zum Beispiel: {'site': 'home'}
|
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
* wavecdn_fetch
* wavecdn_deliver
|-
|get_request_query_string_parameter(name)
|Gibt den Wert vom Parameter mit dem angegebenen Namen aus dem Query-String zurück. Wenn es zwei Parameter mit dem angebenen Namen im Query-String gibt, wird der Wert vom ersten Parameter zurückgegeben. Wenn der angegebene Parameter nicht existiert, wird None zurückgegeben.
|
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
* wavecdn_fetch
* wavecdn_deliver
|-
|get_request_headers()
|Gibt eine Liste mit den Headern der Anfrage vom Webuser zurück.
Zum Beispiel:
[['Accept-Encoding', 'gzip'], ['Host', 'example.wavecdn.net']]
|
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
* wavecdn_fetch
* wavecdn_deliver
|-
|set_request_headers(headers)
|Ersetzt nachträglich in der Webuser-Anfrage alle Header. Der einzige Original-Header, der immer bestehen bleibt und seinen Originalwert beibehält, ist der Host-Header. Als Parameter wird eine Liste von Headern erwartet. Siehe get_request_headers() für das erwartete Format.
|
* wavecdn_receive
|-
|get_request_header(name)
|Gibt den ersten Header aus der Webuser-Anfrage zurück, der bei Ignorierung von Groß- und Kleinschreibung den gleichen Namen hat. Wenn der Header nicht existiert, wird None zurückgegeben.
|
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
* wavecdn_fetch
* wavecdn_deliver
|-
|set_request_header(name)
|Setzt nachträglich in der Webuser-Anfrage den Header mit dem angegebenen Namen. Alle Header, die bei Ignorierung von Groß- und Kleinschreibung den gleichen Namen haben, werden überschrieben. Am Ende gibt es genau einen Header mit dem angegebenen Namen.
|
* wavecdn_receive
|-
|unset_request_header(name)
|Entfernt nachträglich aus der Webuser-Anfrage bei Ignorierung von Groß- und Kleinschreibung alle Header mit dem angegebenen Namen.
|
* wavecdn_receive
|-
|get_backend_request_headers()
|Gibt eine Liste mit den Headern aus der Anfrage zurück, die WaveCDN an das Backend (Origin/Storage) schicken wird. Standardmäßig handelt es sich hierbei fast ausschließlich um die Header der Webuser-Anfrage, die auch für die Anfrage an das Backend verwendet werden.

Zum Beispiel: [['Accept-Encoding', 'gzip'], ['Host', 'example.wavecdn.net']]
|
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
|-
|set_backend_request_headers(headers)
|Ersetzt in der Anfrage, die WaveCDN an das Backend (Origin/Storagen) schicken wird, alle Header. Als Parameter wird eine Liste von Headern erwartet.
|
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
|-
|get_backend_request_header(name)
|Gibt den Header mit dem angegebenen Namen aus Anfrage zurück, die WaveCDN an das Backend (Origin/Storage) schicken wird. Wenn der Header nicht existiert, wird None zurückgegeben.
|
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
|-
|set_backend_request_header(name, value)
|Setzt den Header mit dem angegebenen Namen und Wert in der Anfrage, die WaveCDn an das Backend (Origin/Storage) schicken wird.
|
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
|-
|unset_backend_request_header(name)
|Entfernt aus der Anfrage, die WaveCDN an das Backend schicken wird, bei Ignorierung von Groß- und Kleinschreibung alle Header mit dem angegebenen Namen.
|
* wavecdn_hit
* wavecdn_miss
* wavecdn_pass
|-
|get_backend_response_headers()
|Gibt eine Liste mit den Headern aus der Origin/Storage-Antwort zurück.

Zum Beispiel: [['Set-Cookie', 'sessionid=f938a47a9ef3259860a8b7c4; path=/']]
|
* wavecdn_fetch
|-
|set_backend_response_headers(headers)
|Ersetzt nachträglich in der Antwort vom Origin/Storage alle Header. Als Parameter wird eine Liste von Headern erwartet.
|
* wavecdn_fetch
|-
|get_backend_response_header(name)
|Gibt den Header mit dem angegebenen Namen aus der Origin/Storage-Antwort zurück. Wenn der Header nicht existiert, wird None zurückgegeben.
|
* wavecdn_fetch
|-
|set_backend_response_header(name, value)
|Setzt den Header mit dem angegebenen Namen und Wert in der Origin/Storage-Antwort. Sinnvoll, wenn Header noch vor dem Caching hinzugefügt werden sollen.
|
* wavecdn_fetch
|-
|unset_backend_response_header(name)
|Entfernt nachträglich aus der Origin/Storage-Antwort bei Ignorierung von Groß- und Kleinschreibung alle Header mit dem angegebenen Namen.
|
* wavecdn_fetch
|-
|get_response_headers()
|Gibt ein Dictionary mit den Headern der Antwort zurück, die WaveCDN an den Webuser schicken wird.
|
* wavecdn_deliver
|-
|set_response_headers(headers)
|Ersetzt nachträglich in der Antwort, die WaveCDN zurück an den Webuser schicken wird, alle Header. Als Parameter wird eine Liste von Headern erwartet.
|
* wavecdn_deliver
|-
|get_response_header(name)
|Gibt den Header mit dem angegebenen Namen aus der Antwort zurück, die WaveCDN an den Webuser schicken wird. Wenn der Header nicht existiert, wird None zurückgegeben.
|
* wavecdn_deliver
|-
|set_response_header(name, value)
|Setzt den Header mit dem angegebenen Namen und Wert in der Anwort, die WaveCDN an den Webuser schicken wird.
|
* wavecdn_deliver
|-
|unset_response_header(name)
|Entfernt aus der Antwort, die WaveCDN an den Webuser schicken wird, bei Ignorierung von Groß- und Kleinschreibung alle Header mit dem angegebenen Namen.
|
* wavecdn_deliver
|-
|get_response_status_code()
|Gibt den HTTP-Code der Antwort zurück, die WaveCDN an den Webuser schicken wird. Es handelt sich dabei um einen Integer.
|
* wavecdn_deliver
|-
|set_response_status_code(code)
|Setzt den HTTP-Code der Antwort, die WaveCDN an den Webuser schicken wird. Beim Parameter muss es sich um einen Integer handeln.
|
* wavecdn_deliver
|-
|}

Erweiterung schreiben

2014-01-09T08:29:09Z

Nfr: /* Cookie aus Webuser-Anfrage entfernen */

= Einleitung =

Bei Erweiterungen handelt es sich um Python-Skripts, die auf den weltweiten Edges von WaveCDN ausgeführt werden. Damit ist es möglich, die Abarbeitung der Webuser-Anfragen stark zu beeinflussen. Die Erweiterungen können Daten auslesen und verändern. Erweiterungen erlauben es WaveCDN auf flexibelste Art und Weise an die eigenen Anforderungen anzupassen.

Die Erweiterungen laufen auf den Edges in abgeschlossenen Einheiten. Ein Python-Programm lädt die Erweiterung und führt die Erweiterungsfunktionen in mehrerenen Python-Threads parallel aus. Die Funktionen müssen also thread-safe sein. Der Speicher ist auf insgesamt 8 MB limitiert und die CPU-Nutzung ist ebenfalls stark eingeschränkt. Aufgrund der begrenzten Ressourcen sollten ausschließlich Python-Skripts mit hoher Performance eingesetzt werden. Für Fehler oder Beschränkungen bei der Ausführung von Erweiterungen übernehmen wir keinerlei Verantwortung. Man sollte Erweiterungen insbesondere ausgiebig Testen.

Wir empfehlen vorweg die [http://www.wavecdn.com/extensions FAQ] durchlesen.

= Funktionen =

Wenn ein Webuser eine Anfrage an WaveCDN stellt, so müssen bis zur Antwort einige Schritte abgearbeitet werden. Diese sind im [[Anfragenmodell]] beschrieben. Konkret handelt es sich um folgende fünf Schritte:
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_fetch
* wavecdn_deliver

Eine Erweiterung kann sich in die einzelnen Schritte einklinken, in dem sie eine Python-Funktion mit dem jeweiligen Schrittnamen deklariert. Damit zum Beispiel eine Erweiterung im Schritt wavecdn_receive ausgeführt wird, muss die entsprechende Funktion im Python-Skript deklariert sein. Das kann wie folgt aussehen:

#!/usr/bin/python

def wavecdn_receive():
pass

= Parameter =

Bei Aufruf einer Funktion der Erweiterung wird genau ein Parameter übergeben. Es handelt sich dabei um eine Instanz der Environment-Klasse. Aus dem Environment können Daten ausgelesen oder auch gespeichert werden. Über das Environment ist es also möglich die Abarbeitung der Anfrage zu beeinflussen.

Um ein Gefühl dafür zu bekommen, was alles möglich ist, sollte man sich die [[Environment-Klasse|Dokumentation der Environment-Klasse]] anschauen.

= Rückgabewerte =

Die Erweiterungsfunktionen können bestimmte Werte zurückgeben. Je nach Schritt gibt es bestimmte Rückgabewerte, mehr dazu später.

= Deployment =

Um die Erweiterungen auf den weltweiten Edges von WaveCDN zu deployen, muss man zunächst im Webpanel das CDN-Setup öffnen, in welchem die Erweiterung laufen soll. Im Tab "Erweiterungen" gibt es einen Button zum Hinzufügen einer Erweiterung. Nach Einfügen des Python-Codes und Abschicken des Formulars wird die Erweiterung weltweit installiert. Dies kann einige Minuten dauern.

= Snippets =

Wir wollen nun häufig verwendete Snippets auflisten.

== Cookie aus Webuser-Anfrage entfernen ==

Die Folgende Erweiterung entfernt bei Eintreffen der Webuser-Anfrage den Cookie-Header. Der Code wird häufig benötigt, wenn man bestimmte Pfade cachbar machen will und deshalb den Cookie entfernen muss. Siehe auch die <Caching-Voraussetzungen>.

#!/usr/bin/python

def wavecdn_receive(env):
env.unset_request_header('Cookie')

== Webuser-Anfrage mit Cookie cachbar machen ==

Wenn Anfragen gecached werden sollen, müssen die Caching-Voraussetzungen erfüllt sein. Dazu gehört, dass in der Webuser-Anfrage kein Cookie vorhanden ist oder dass "Cache with Cookies" aktiviert ist. Im folgenden sollen Anfragen mit Cookies explizit gecached werden. Dafür aktivieren "Cache with Cookies".

#!/usr/bin/python

def wavecdn_receive():
env.set_cache_with_cookies(True)

= Freie Erweiterung =

Sowohl das WaveCDN Team als auch die Community haben im Laufe der Zeit zahlreiche Erweiterungen geschrieben, die frei zur Verfügung stehen. Sie sind <hier> zu finden.

= Troubleshooting =

Zunächst sollte ein Blick in die Logs geworfen werden. Dafür klickt man auf das betroffene CDN-Setup, auf den Tab "Erweiterungen" und auf den Button "Anzeigen" bei der entsprechenden Erweiterung. Unten auf der Seite sind dann die letzten Log Messages vorzufinden.

Erweiterung schreiben

2014-01-09T08:28:55Z

Nfr: /* Cookie aus Webuser-Anfrage entfernen */

= Einleitung =

Bei Erweiterungen handelt es sich um Python-Skripts, die auf den weltweiten Edges von WaveCDN ausgeführt werden. Damit ist es möglich, die Abarbeitung der Webuser-Anfragen stark zu beeinflussen. Die Erweiterungen können Daten auslesen und verändern. Erweiterungen erlauben es WaveCDN auf flexibelste Art und Weise an die eigenen Anforderungen anzupassen.

Die Erweiterungen laufen auf den Edges in abgeschlossenen Einheiten. Ein Python-Programm lädt die Erweiterung und führt die Erweiterungsfunktionen in mehrerenen Python-Threads parallel aus. Die Funktionen müssen also thread-safe sein. Der Speicher ist auf insgesamt 8 MB limitiert und die CPU-Nutzung ist ebenfalls stark eingeschränkt. Aufgrund der begrenzten Ressourcen sollten ausschließlich Python-Skripts mit hoher Performance eingesetzt werden. Für Fehler oder Beschränkungen bei der Ausführung von Erweiterungen übernehmen wir keinerlei Verantwortung. Man sollte Erweiterungen insbesondere ausgiebig Testen.

Wir empfehlen vorweg die [http://www.wavecdn.com/extensions FAQ] durchlesen.

= Funktionen =

Wenn ein Webuser eine Anfrage an WaveCDN stellt, so müssen bis zur Antwort einige Schritte abgearbeitet werden. Diese sind im [[Anfragenmodell]] beschrieben. Konkret handelt es sich um folgende fünf Schritte:
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_fetch
* wavecdn_deliver

Eine Erweiterung kann sich in die einzelnen Schritte einklinken, in dem sie eine Python-Funktion mit dem jeweiligen Schrittnamen deklariert. Damit zum Beispiel eine Erweiterung im Schritt wavecdn_receive ausgeführt wird, muss die entsprechende Funktion im Python-Skript deklariert sein. Das kann wie folgt aussehen:

#!/usr/bin/python

def wavecdn_receive():
pass

= Parameter =

Bei Aufruf einer Funktion der Erweiterung wird genau ein Parameter übergeben. Es handelt sich dabei um eine Instanz der Environment-Klasse. Aus dem Environment können Daten ausgelesen oder auch gespeichert werden. Über das Environment ist es also möglich die Abarbeitung der Anfrage zu beeinflussen.

Um ein Gefühl dafür zu bekommen, was alles möglich ist, sollte man sich die [[Environment-Klasse|Dokumentation der Environment-Klasse]] anschauen.

= Rückgabewerte =

Die Erweiterungsfunktionen können bestimmte Werte zurückgeben. Je nach Schritt gibt es bestimmte Rückgabewerte, mehr dazu später.

= Deployment =

Um die Erweiterungen auf den weltweiten Edges von WaveCDN zu deployen, muss man zunächst im Webpanel das CDN-Setup öffnen, in welchem die Erweiterung laufen soll. Im Tab "Erweiterungen" gibt es einen Button zum Hinzufügen einer Erweiterung. Nach Einfügen des Python-Codes und Abschicken des Formulars wird die Erweiterung weltweit installiert. Dies kann einige Minuten dauern.

= Snippets =

Wir wollen nun häufig verwendete Snippets auflisten.

== Cookie aus Webuser-Anfrage entfernen ==

Die Folgende Erweiterung entfernt bei Eintreffen der Webuser-Anfrage den Cookie-Header. Der Code wird häufig benötigt, wenn man bestimmte Pfade cachbar machen will und deshalb den Cookie entfernen muss. Siehe auch die <Caching-Voraussetzungen>.

#!/usr/bin/python

def wavecdn_receive():
env.unset_request_header('Cookie')

== Webuser-Anfrage mit Cookie cachbar machen ==

Wenn Anfragen gecached werden sollen, müssen die Caching-Voraussetzungen erfüllt sein. Dazu gehört, dass in der Webuser-Anfrage kein Cookie vorhanden ist oder dass "Cache with Cookies" aktiviert ist. Im folgenden sollen Anfragen mit Cookies explizit gecached werden. Dafür aktivieren "Cache with Cookies".

#!/usr/bin/python

def wavecdn_receive():
env.set_cache_with_cookies(True)

= Freie Erweiterung =

Sowohl das WaveCDN Team als auch die Community haben im Laufe der Zeit zahlreiche Erweiterungen geschrieben, die frei zur Verfügung stehen. Sie sind <hier> zu finden.

= Troubleshooting =

Zunächst sollte ein Blick in die Logs geworfen werden. Dafür klickt man auf das betroffene CDN-Setup, auf den Tab "Erweiterungen" und auf den Button "Anzeigen" bei der entsprechenden Erweiterung. Unten auf der Seite sind dann die letzten Log Messages vorzufinden.

Erweiterung schreiben

2014-01-09T08:26:47Z

Nfr: /* Entfernen des Cookies aus der Webuser-Anfragen */

= Einleitung =

Bei Erweiterungen handelt es sich um Python-Skripts, die auf den weltweiten Edges von WaveCDN ausgeführt werden. Damit ist es möglich, die Abarbeitung der Webuser-Anfragen stark zu beeinflussen. Die Erweiterungen können Daten auslesen und verändern. Erweiterungen erlauben es WaveCDN auf flexibelste Art und Weise an die eigenen Anforderungen anzupassen.

Die Erweiterungen laufen auf den Edges in abgeschlossenen Einheiten. Ein Python-Programm lädt die Erweiterung und führt die Erweiterungsfunktionen in mehrerenen Python-Threads parallel aus. Die Funktionen müssen also thread-safe sein. Der Speicher ist auf insgesamt 8 MB limitiert und die CPU-Nutzung ist ebenfalls stark eingeschränkt. Aufgrund der begrenzten Ressourcen sollten ausschließlich Python-Skripts mit hoher Performance eingesetzt werden. Für Fehler oder Beschränkungen bei der Ausführung von Erweiterungen übernehmen wir keinerlei Verantwortung. Man sollte Erweiterungen insbesondere ausgiebig Testen.

Wir empfehlen vorweg die [http://www.wavecdn.com/extensions FAQ] durchlesen.

= Funktionen =

Wenn ein Webuser eine Anfrage an WaveCDN stellt, so müssen bis zur Antwort einige Schritte abgearbeitet werden. Diese sind im [[Anfragenmodell]] beschrieben. Konkret handelt es sich um folgende fünf Schritte:
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_fetch
* wavecdn_deliver

Eine Erweiterung kann sich in die einzelnen Schritte einklinken, in dem sie eine Python-Funktion mit dem jeweiligen Schrittnamen deklariert. Damit zum Beispiel eine Erweiterung im Schritt wavecdn_receive ausgeführt wird, muss die entsprechende Funktion im Python-Skript deklariert sein. Das kann wie folgt aussehen:

#!/usr/bin/python

def wavecdn_receive():
pass

= Parameter =

Bei Aufruf einer Funktion der Erweiterung wird genau ein Parameter übergeben. Es handelt sich dabei um eine Instanz der Environment-Klasse. Aus dem Environment können Daten ausgelesen oder auch gespeichert werden. Über das Environment ist es also möglich die Abarbeitung der Anfrage zu beeinflussen.

Um ein Gefühl dafür zu bekommen, was alles möglich ist, sollte man sich die [[Environment-Klasse|Dokumentation der Environment-Klasse]] anschauen.

= Rückgabewerte =

Die Erweiterungsfunktionen können bestimmte Werte zurückgeben. Je nach Schritt gibt es bestimmte Rückgabewerte, mehr dazu später.

= Deployment =

Um die Erweiterungen auf den weltweiten Edges von WaveCDN zu deployen, muss man zunächst im Webpanel das CDN-Setup öffnen, in welchem die Erweiterung laufen soll. Im Tab "Erweiterungen" gibt es einen Button zum Hinzufügen einer Erweiterung. Nach Einfügen des Python-Codes und Abschicken des Formulars wird die Erweiterung weltweit installiert. Dies kann einige Minuten dauern.

= Snippets =

Wir wollen nun häufig verwendete Snippets auflisten.

== Cookie aus Webuser-Anfrage entfernen ==

Die Folgende Erweiterung entfernt bei Eintreffen der Webuser-Anfrage den Cookie-Header. Der Code wird häufig benötigt, wenn man bestimmte Pfade cachbar machen will und deshalb den Cookie entfernen muss.

#!/usr/bin/python

def wavecdn_receive():
env.unset_request_header('Cookie')

= Freie Erweiterung =

Sowohl das WaveCDN Team als auch die Community haben im Laufe der Zeit zahlreiche Erweiterungen geschrieben, die frei zur Verfügung stehen. Sie sind <hier> zu finden.

= Troubleshooting =

Zunächst sollte ein Blick in die Logs geworfen werden. Dafür klickt man auf das betroffene CDN-Setup, auf den Tab "Erweiterungen" und auf den Button "Anzeigen" bei der entsprechenden Erweiterung. Unten auf der Seite sind dann die letzten Log Messages vorzufinden.

Erweiterung schreiben

2014-01-09T08:26:22Z

Nfr:

= Einleitung =

Bei Erweiterungen handelt es sich um Python-Skripts, die auf den weltweiten Edges von WaveCDN ausgeführt werden. Damit ist es möglich, die Abarbeitung der Webuser-Anfragen stark zu beeinflussen. Die Erweiterungen können Daten auslesen und verändern. Erweiterungen erlauben es WaveCDN auf flexibelste Art und Weise an die eigenen Anforderungen anzupassen.

Die Erweiterungen laufen auf den Edges in abgeschlossenen Einheiten. Ein Python-Programm lädt die Erweiterung und führt die Erweiterungsfunktionen in mehrerenen Python-Threads parallel aus. Die Funktionen müssen also thread-safe sein. Der Speicher ist auf insgesamt 8 MB limitiert und die CPU-Nutzung ist ebenfalls stark eingeschränkt. Aufgrund der begrenzten Ressourcen sollten ausschließlich Python-Skripts mit hoher Performance eingesetzt werden. Für Fehler oder Beschränkungen bei der Ausführung von Erweiterungen übernehmen wir keinerlei Verantwortung. Man sollte Erweiterungen insbesondere ausgiebig Testen.

Wir empfehlen vorweg die [http://www.wavecdn.com/extensions FAQ] durchlesen.

= Funktionen =

Wenn ein Webuser eine Anfrage an WaveCDN stellt, so müssen bis zur Antwort einige Schritte abgearbeitet werden. Diese sind im [[Anfragenmodell]] beschrieben. Konkret handelt es sich um folgende fünf Schritte:
* wavecdn_receive
* wavecdn_hit
* wavecdn_miss
* wavecdn_fetch
* wavecdn_deliver

Eine Erweiterung kann sich in die einzelnen Schritte einklinken, in dem sie eine Python-Funktion mit dem jeweiligen Schrittnamen deklariert. Damit zum Beispiel eine Erweiterung im Schritt wavecdn_receive ausgeführt wird, muss die entsprechende Funktion im Python-Skript deklariert sein. Das kann wie folgt aussehen:

#!/usr/bin/python

def wavecdn_receive():
pass

= Parameter =

Bei Aufruf einer Funktion der Erweiterung wird genau ein Parameter übergeben. Es handelt sich dabei um eine Instanz der Environment-Klasse. Aus dem Environment können Daten ausgelesen oder auch gespeichert werden. Über das Environment ist es also möglich die Abarbeitung der Anfrage zu beeinflussen.

Um ein Gefühl dafür zu bekommen, was alles möglich ist, sollte man sich die [[Environment-Klasse|Dokumentation der Environment-Klasse]] anschauen.

= Rückgabewerte =

Die Erweiterungsfunktionen können bestimmte Werte zurückgeben. Je nach Schritt gibt es bestimmte Rückgabewerte, mehr dazu später.

= Deployment =

Um die Erweiterungen auf den weltweiten Edges von WaveCDN zu deployen, muss man zunächst im Webpanel das CDN-Setup öffnen, in welchem die Erweiterung laufen soll. Im Tab "Erweiterungen" gibt es einen Button zum Hinzufügen einer Erweiterung. Nach Einfügen des Python-Codes und Abschicken des Formulars wird die Erweiterung weltweit installiert. Dies kann einige Minuten dauern.

= Snippets =

Wir wollen nun häufig verwendete Snippets auflisten.

== Entfernen des Cookies aus der Webuser-Anfragen ==

Die Folgende Erweiterung entfernt bei Eintreffen der Webuser-Anfrage den Cookie-Header. Der Code wird häufig benötigt, wenn man bestimmte Pfade cachbar machen will und deshalb den Cookie entfernen muss.

#!/usr/bin/python

def wavecdn_receive():
env.unset_request_header('Cookie')

= Freie Erweiterung =

Sowohl das WaveCDN Team als auch die Community haben im Laufe der Zeit zahlreiche Erweiterungen geschrieben, die frei zur Verfügung stehen. Sie sind <hier> zu finden.

= Troubleshooting =

Zunächst sollte ein Blick in die Logs geworfen werden. Dafür klickt man auf das betroffene CDN-Setup, auf den Tab "Erweiterungen" und auf den Button "Anzeigen" bei der entsprechenden Erweiterung. Unten auf der Seite sind dann die letzten Log Messages vorzufinden.

Environment-Klasse

2014-01-09T08:22:37Z

Nfr: