floppy-isdn4linux Version 3.6.2 - Fli4l

Das Hilfsskript cgi-helper
8. Entwickler-Dokumentation
Gleich nach den Kopfzeilen sollte dann schon das Hilfsskript cgi-helper mit folgendem Aufruf
eingebunden werden:
. /srv/www/include/cgi-helper
Wichtig ist ein Leerzeichen zwischen Punkt und Slash!
Dieses Skript stellt diverse Hilfsfunktionen bereit, die das Erstellen von CGIs für fli4l wesentlich
vereinfachen sollen. Außerdem werden mit dem Einbinden des cgi-helper auch noch
Standardaufgaben ausgeführt, wie beispielsweise das parsen von Variablen, die mit Formularen
oder über die URL übergebenen wurden, oder das laden von Sprach- und CSS-Dateien.
Hier eine kleine Funktionsübersicht:
Name Funktion
check_rights Überprüfung der Benutzerrechte
http_header Ausgabe eines Standard HTTP-Headers oder eines speziellen Headers, beispielsweise zum Download von Dateien
show_html_header Ausgabe des kompletten Seitenheaders (inkl. HTTP-Header, Kopfzeile und Menü)
show_html_footer Ausgabe des Abschlusses der HTML-Seite
show_tab_header Ausgabe eines Inhalts-Fensters mit Tabs
show_tab_footer Ausgabe des Abschlusses des Inhaltsfensters
show_error Ausgabe eines Fensters für Fehlermeldungen (Farbe: rot)
show_info Ausgabe eines Fensters für Informationen/ Erfolgsmeldungen (Farbe: grün)
Der Inhalt
Tabelle 8.3.: Funktionen des cgi-helper Skriptes.
Um ein einheitliches Design und vor allem die Kompatibilität mit zukünftigen fli4l-Versionen
zu gewährleisten, ist es sehr zu empfehlen, die oben genannten Funktionen zu benutzen, auch
wenn man in einem CGI theoretisch alle Ausgaben selbst generieren könnte.
Eine einfaches CGI-Skript könnte wie folgt aussehen:
#!/bin/sh
# --------------------
# Header (c) Autor Datum
# --------------------
# get main helper functions
. /srv/www/include/cgi-helper
show_html_header "Mein erstes CGI"
echo ’ Willkommen’
echo ’ Dies ist ein Beispiel-CGI-Skript’
show_html_footer
Der Parameter, welcher der Funktion show_html_header übergeben wird, wird dabei als Titel
verwendet. Sie generiert automatisch das Menü und bindet ebenso automatisch zum Skript
gehörende CSS und Sprachdateien ein. Voraussetzung dafür ist, dass diese sich in den Verzeichnissen
/srv/www/css bzw. /srv/www/lang befinden und den selben Namen (aber natürlich eine
andere Endung) wie das Skript haben. Ein Beispiel:
333