Luis Colorado Über den Autor: Luis Colorado ist als Administrator von UNIX Systemen und Internetzugängen bei der spanischen Telefónica Sistemas S.A. tätig. Er machte seinen Abschluß in Physik an der Universidad Complutense of Madrid und entwickelte eine Anzahl von frei verfügbaren UNIX Werzeugen. M@il an den Autor Inhalt: Einführung Motivation M4 Funktionsweise Übertragung der Informationen vom Benutzer an das CGI Download

PG2CGI: WWW basierter Datenbankzugriff

Zusammenfassung:
Vorgestellt wird ein Programm, das den Zugriff auf eine Datenbank von HTML Seiten aus erlaubt. Als Ziele bei der Entwicklung von PG2CGI standen Kontrolle über den Datenzugriff, eine flexible Konfigurierung und die Unabhängigkeit von Layoutformaten im Vordergrund. Das Programm resultierte aus Ideen, die mir während des Lesens diverser Artikel über M4 kamen (Artikel der letzten 12 Monate in Linux Journal und LinuxFocus).

Einführung

Motivation

• Einfache Konfiguration. Die Einstellungen des Systems werden durch eine einzige Konfigurationsdatei gehandhabt.
• Kontrolle über die Sicherheit der Site. Das Programm ermöglicht die flexible Auswahl einer Konfiguration und kann einfach für die Kontrolle des Zugriffs auf WWW Seiten konfiguriert werden.
• Wie allgemein bekannt, ist HTML eine Sprache für die Formatierung von Dokumenten, die mittels eines WWW Browsers angezeigt werden können.

Ein Kriterium für einen guten Textgenerator ist eine brauchbare Sprache für die Textformatierung, die ausreichend Kontrolle über die Anordnung von Paragraphen und Textelementen auf der auszugebenen Seite ermöglicht. Desweiteren beinhalten die meisten Sprachen zusätzlich Makros, welche Fließelemente im Dokument behandeln (z.B. Elemente wie Tabellen, Bilder, usw., die dynamisch während der Laufzeit an die Seite angepaßt werden).

Viele mir bekannte Programme, die als Schnittstelle zwischen HTML und Datenbanken dienen, erzeugen Informationen über den auszugebenden Text dadurch, daß sie den HTML Befehlssatz (die HTML Tags) erweitern. Diese neuen Befehle übernehmen dann die Rolle von Makros. Dieser Ansatz hat jedoch einen schwerwiegenden Nachteil: meistens müssen Elemente innerhalb der ursprünglichen HTML Tags verändert werden, was eine große Einschränkung ist. Oft werden Tags von diesen Programmen quasi nochmals erfunden, nur um einen bestimmten Effekt innerhalb eines existierenden HTML Tags zu ermöglichen. PG2CGI nutzt intensiv M4, um das Ersetzen von Makros zu ermöglichen, wo immer es notwendig ist. Das Programm selbst erzeugt keinen formatierten Text, weswegen es unabhängig von der letztendlich für die Ausgabe benutzten Formatierungssprache ist. PG2CGI erzeugt einen Satz Makros als Ergebnis einer Anfrage. Diese Makros werden später zusammen mit einer vorgegebenen HTML Vorlage von M4 benutzt, um ein HTML Dokument zu generieren.

M4

M4 wurde ursprünglich entwickelt, um CGI (Common Gateway Interface) mit PostgreSQL Datenbanken zu verbinden. Bald jedoch stellte sich heraus, daß M4 allgemein ausreichend war, sodaß es für andere Schnittstellen neben CGI eingesetzt werden konnte (z.B. als Gateway zwischen einem LDAP Server und anderen Datenbanken wie Informix und Oracle). Später wurde die Schnittstelle standarisiert, wobei die notwendige Funktionalität mit aufgenommen wurde, und das PostgreSQL Modul wurde für die neue Schnittstelle umgeschrieben. Nun ist es möglich, neue Treiber zu entwickeln, die es ermöglichen, das Programm in Verbindung mit anderen Datenbank zu benutzen.

• M4 ersetzt die Makros, welche Informationen von der linken zu der rechten Seite der Auswahlregeln in der Konfigurationsdatei weiterreichen (weitere Informationen dazu sind in der Dokumentation der Software zu finden).
• Es wird ebenfalls benutzt, um alle Definitionen, die durch die Vorlage für die Erzeugung der HTML Ausgabe gegeben sind, zu implementieren.
• Unsere Software benutzt (wiederholt) auch intern M4, um interne Variablen, die an die Treiber übergeben werden und verantwortlich für den Start von Anfragen an die Datenbank sind, zu ersetzen.

Reguläre Ausdrücke:

• die Fähigkeit, mehrere Möglichkeiten mittels einer einzelnen Konfigurationsregel abzudecken.
• es gibt keine signifikanten Leistungseinbußen, da die aktuellen Bibliotheken (GNU) für reguläre Ausdrücke ausreichend "schlank" und effizient sind, was ihren Einsatz rechtfertigt.
• Die beigefügten Bibliotheken erlauben das Gruppieren von regulären Teilausdrücken (unter Einsatz von Klammern) und das Identifizieren von Teilstrings des ursprünglichen Ausdruckes. Dies ist ideal für die Analyse der Informationen, die für die Anfragetreiber notwendig sind.

 FIELD=value

 QUERY_STRING: "^FIELD=[^&]*$";

 QUERY_STRING: "^FIELD=([^&]*)$";

Funktionsweise

• Umgebungsvariablen werden von einem regulären Ausdruck aus der Konfigurationsdatei abgedeckt, zum Beispiel:

 QUERY_STRING:   "^FIELD=([^&]*)$";

• Umgebungsvariablen entsprechen nicht den regulären Ausdrücken in der Konfigurationsdatei. Durch diese Art von Termen ist es möglich, Regeln aufgrund von bestimmten Bedingungen in den Umgebungsvariablen auszusetzen, wie:

  ! HTTP_ADDRESS: "^194\.142\.12\.";

(Hier würde die Regel ungültig, falls die Anfrage von 194.142.12.xxx käme)

• Umgebungsvariablen mit optionalem Wert (wird nicht für die Auswahl der Regel bestimmt). Falls ein Wert existiert, wird er analysiert und weitergereicht:

 [ QUERY_STRING: "USER=([^&]*)" ];

Dieser Term ermöglicht es, einen Wert für den User zu übergeben, falls der Client dies unterstützt. Jedoch wird die Regel nicht ungültig, falls der Client diesen nicht spezifiziert.

• Als nächstes wird M4 aufgerufen, wobei die Begrenzer ersetzt worden sind (" ` " wird durch "<<<" und " ' " durch ">>>"ersetzt) und Kommentare ignoriert werden, sodaß Zeichen wie "#" nicht zu Konflikten im zu ersetzenden String führen. Der Ergebnisstring wird als Wert der entsprechenden Umgebunsvariable zugewiesen.
• PG2CGI benutzt drei reservierte Umgebungsvariablen:

M4FILE.

Diese Variable enthält den Dateinamen der Vorlage für die Ausgabe, die M4 erzeugen soll.

DRIVER.

verweist auf den Treiber, der benutzt werden soll.

TESTMODE.

Falls diese Variable TRUE ist, so wird die Augabe im Debug Modus erzeugt, PG2CGI ruft im letzten Schritt nicht M4 auf, das Ergebnis wird im Format TEXT/PLAIN erzeugt. Die erzeugte Datei enthält dabei die Eingabe, welche M4 im normalen Modus übergeben werden würde.

Wie erreichen die Informationen des Benutzers das CGI?

     QUERY_STRING: "NAME=([^&]*)";
     QUERY_STRING: "FAMNAME1=([^&]*)";
     QUERY_STRING: "FAMNAME2=([^&]*)";

     term_0_match_0  <- "NAME=JOSE";
     term_0_match_1  <- "JOSE";
     term_1_match_0  <- "FAMNAME1=DE LA FUENTE";  
           (man beachte, daß "+" Zeichen durch Leerzeichen " " ersetzen worden sind)
     term_1_match_1  <- "DE LA FUENTE";
     term_2_match_0  <- "FAMNAME2=LOPEZ";
     term_2_match_1  <- "LOPEZ";

Treiber:

Beispiel:

{
  PATH_INFO: "^/avisos/?$"; # Regel wird mittels PATH_INFO ausgewählt
  [SERVER_ADMIN: ".*"];     # Optionale Informationen in SERVER_ADMIN. 
} -> {
  DRIVER:   "POSTGRESQL";
  PGTTY:    "/dev/console";  # Logs werden an die Konsole geschickt
  PGDATABASE:     "postgres";
# Es wird eine Anfrage gestellt (dabei wird die oid immer mit übergeben.
# Sie wird intern benutzt, um den jeweiligen Datensatz 
# mittels der Vorlage darzustellen).
  PGQUERY:  "select oid,ct,titulo,texto,mt"
      " from avisos"
      " where (dt is NULL or dt > 'now')"
      " order by mt desc";
# Datei, die die Vorlage enthält 
  M4FILE:    "/usr/local/etc/httpd/plantillas_m4/avisos.m4";
  WEBMASTER: "term_1_match_0";
  #TESTMODE: "TRUE";
}

# Die folgende Regel ermöglicht die Wahl einer Ankündigung (aviso)
# mit einer bekannten OID (Primärschlüssel). Die Information ist in der
# Variable  PATH_INFO des CGI enthalten.

{
  PATH_INFO: "^/avisos/([0-9]+)/?$";
  SERVER_ADMIN: ".*";
} -> {
  DRIVER:   "POSTGRESQL";
  PGTTY:    "/dev/console";  # as before, write logs to the console
  PGDATABASE:     "postgres";
  OID:      "term_0_match_1"; # assign an OID

# Auch hier ist die Auswahl wichtig. Die OID des Feldes wird am Anfang  
# mit übergeben, für den Fall, daß ein Verweis fuer das Löschen dieses
# Eintrages gesetzt werden sollte.

  PGQUERY:  "select oid,ct,titulo,texto,mt,dt,autor"
            " from avisos"
            " where (dt is NULL or dt > 'now') and oid=OID";
# Hier wird nun eine andere Vorlage benutzt.
  M4FILE:    "/usr/local/etc/httpd/plantillas_m4/avisos_oid.m4";
  WEBMASTER: "term_1_match_0";
  #TESTMODE: "TRUE";
}

Download

mirror server hosted at Truenetwork, Russian Federation.