PG2CGI databank toegang vanaf het Web

ArticleCategory:

AuthorImage:

TranslationInfo:

original in en Luis Colorado 

en to nl Tom Uijldert

AboutTheAuthor:

Abstract:

ArticleIllustration:

ArticleBody:

Inleiding

Motivatie

Verder staat er een leger van webservers en databanken die, in schril contrast, uitblinken in de afwezigheid van hulpmiddelen om beide omgevingen te integreren (de meeste van dit soort hulpmiddelen zijn alleen commercieel te verkrijgen en hebben grote beperkingen voor wat betreft de formaten die het aankan).

Het hier besproken pakket verenigt databank- en web omgevingen. Het ontwerp diende aan de volgende voorwaarden te voldoen:

• Eenvoudig te configureren. Instellen van het systeem geschiedt in één configuratiebestand.
• Controle over de beveiliging. Het pakket heeft een flexibele manier voor het kiezen van een configuratie en is eenvoudig in te stellen voor wat betreft toegangsbeveiliging.
• Het is bekend dat HTML een opmaaktaal is voor het opmaken van documenten die via een browser kunnen worden getoond. Een goede eigenschap van een tekstgenerator is de mogelijkheid om tekst eenvoudig op te maken met voldoende controle over de opmaak van paragrafen en andere tekstuele zaken in de uiteindelijke uitvoering. In de meeste van dit soort talen is er echter ook een aantal macro's die de "zwevende" elementen binnen een document (dit zijn de tabellen, plaatjes enzovoorts die in de uiteindelijke opmaak dynamisch worden behandeld) afhandelen.

  De meeste mij bekende hulpmiddelen voor het samenvoegen van HTML en databanken, genereren informatie in de uitvoer door het uitbreiden van de set van HTML-tags (een tag is een opmaakopdracht in een gedefinieerd formaat. De definitie van deze tags vormen tezamen de taal HTML); Deze nieuwe tags fungeren vervolgens als macro's. Deze aanpak heeft één groot nadeel: doorgaans moeten we elementen veranderen die binnen de "echte" HTML tags vallen en dat is een grote beperking. Vaak zijn hulpmiddelen hierdoor gedwongen om tags opnieuw "uit te vinden", alleen maar om het standaardeffect te bereiken binnen een bestaande tag. Mijn programma gebruikt M4 intensief om macro-substituties te kunnen doen op een willekeurige plek in de tekst. Het programma zélf genereert geen opgemaakte tekst en is daardoor onafhankelijk van het uiteindelijke formaat van de uitvoer. Het programma genereert een aantal macro's, als resultaat van een query (opvraging) en in een later stadium wordt dit gebruikt door M4 om, in combinatie met een HTML template, een HTML document te genereren.

M4

PG2CGI is oorspronkelijk ontwikkeld om CGI (Common Gateway Interface) op een PostgreSQL databank aan te sluiten. Al snel besefte men dat het algemeen genoeg was voor gebruik met andere aansluitingen dan alleen CGI (zoals bijvoorbeeld een gateway tussen een LDAP server en andere databanken zoals Informix en Oracle). Nadien is de interface gestandaardiseerd, met daarin alle benodigde functionaliteit en de module PostgreSQL werd herschreven om aan te sluiten op de nieuwe standaard. Het is nu mogelijk om nieuwe drivers te ontwikkelen die een aansluiting mogelijk maken met andere databank software.

• Het wordt gebruikt om macro's te substitueren die informatie doorgeven van de linker- naar de rechterkant van een selectieregel uit het configuratiebestand (zie de software documentatie voor meer informatie).
• Het wordt ook gebruikt om de definities te implementeren die in het template staan dat de uiteindelijke HTML uitvoer genereert.
• Onze software gebruikt M4 ook intern (meerdere malen) om substituties van interne variabelen uit te voeren die worden doorgegeven aan de drivers (aansturing) die verantwoordelijk zijn voor het uitvoeren van de databank queries.

Reguliere expressies

• De mogelijkheid om meerdere keuzes binnen één configuratieregel te groeperen.
• Geen verlies aan snelheid omdat de huidige programmabibliotheken (GNU) voldoende goede en efficiënte code bevat voor het afhandelen van reguliere expressies.
• Deze bibliotheken geven de mogelijkheid om reguliere sub-expressies te groeperen (met behulp van haakjes) en om sub-zinnen te onderscheiden van de hoofdexpressie. Deze functionaliteit is ideaal voor het ontleden van informatie, wat nodig is voor de aansturing van query drivers.

Voorbeeld: Stel de cliënt moet informatie doorgeven in de opvraagregel (query_string) en de data moet voldoen aan het volgende formaat:

  FIELD=waarde

Het forceren van deze syntaxis kan eenvoudig worden gedaan met het opgeven van de volgende term in de selectieregel:

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

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

Hoe werkt het?

• Omgevingsvariabelen voldoen aan een reguliere expressie, als gegeven in het configuratiebestand. Bijvoorbeeld:

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

• Omgevingsvariabelen voldoen niet aan de reguliere expressie uit het bestand. Hierdoor kunnen we een regel afwijzen, maar alleen als er in de omgevingsvariabelen een voorwaarde zit. Bijvoorbeeld:

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

  (Dit voorbeeld zou de regel ongeldig maken als de aanvraag van 194.142.12.xxx afkomstig is).
• Omgevingsvariabelen met een optionele waarde (het is niet noodzakelijk de regel te selecteren). Als de waarde er is dan wordt hij ontleed en doorgegeven. Bijvoorbeeld:

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

  Deze term geeft de waarde van de gebruiker door als de cliënt die ook opgeeft. De regel wordt echter niet ongeldig als de cliënt de waarde niet opgeeft.

De linker- en rechterkant van een regel worden afgebakend door accolades "{}" en van elkaar gescheiden door het symbool "->".

De rechterkant heeft hetzelfde formaat: de naam van een variabele, het teken ":", een aantal tekens en ";" als afsluiter. De rechterkant bevat alleen maar toewijzingen aan variabelen die M4 uit moet voeren:

• M4 wordt nu uitgevoerd met veranderde scheidingstekens (zet <<< in de plaats van >>>) en geen behandeling van commentaar zodat tekens als # geen invloed hebben op de te vervangen regel. Het resultaat daarvan wordt als waarde toegekend aan de betreffende omgevingsvariabele.
• PG2CGI gebruikt drie bekende omgevingsvariabelen:

  M4FILE.

  De variabele geeft de naam van het bestand voor de uitvoer van M4.

  DRIVER.

  Selecteert de driver die we moeten gebruiken.

  TESTMODE.

  Als deze de waarde TRUE (waar) heeft dan betekent het dat er uitvoer in debug mode moet worden geproduceerd. Dan wordt M4 niet aangeroepen in de laatste fase en het resultaat is dan in tekstopmaak. Het resultaat is een bestand wat M4 normaal gesproken uit zou hebben gevoerd.

Hoe bereikt de informatie van de gebruiker CGI?

      `NAME=JAN&FAMILIENAAM1=VAN+HET+HEK&FAMILIENAAM2=GOOR'

     QUERY_STRING: "NAAM=([^&]*)";
     QUERY_STRING: "FAMILIENAAM1=([^&]*)";
     QUERY_STRING: "FAMILIENAAM2=([^&]*)";

     term_0_match_0  <- "NAAM=JAN";
     term_0_match_1  <- "JAN";
     term_1_match_0  <- "FAMILIENAAM1=VAN HET HEK";  
           (de plustekens zijn vervangen door spaties)
     term_1_match_1  <- "VAN HET HEK";
     term_2_match_0  <- "FAMILIENAAM2=GOOR";
     term_2_match_1  <- "GOOR";

{
  PATH_INFO: "^/avisos/?$"; # Selecteert door PATH_INFO
  [SERVER_ADMIN: ".*"];     # Haalt informatie op van SERVER_ADMIN. Optioneel
} -> {
  DRIVER:   "POSTGRESQL";
  PGTTY:    "/dev/console";  # Stuurt de logs naar de console
  PGDATABASE:     "postgres";
# We maken een query (schrijf altijd het oid dat het intern
# in het template bestand zal gebruiken om te linken naar de
# interne records).
  PGQUERY:  "select oid,ct,titulo,texto,mt"
      " from avisos"
      " where (dt is NULL or dt > 'now')"
      " order by mt desc";
# Het bestand dat het template bevat
  M4FILE:    "/usr/local/etc/httpd/plantillas_m4/avisos.m4";
  WEBMASTER: "term_1_match_0";
  #TESTMODE: "TRUE";
}

# De volgende regel laat ons toe om een aankondiging de selecteren (aviso)
# met een gekend OID (primaire sleutel). De informatie zit bij in de variabele
# PATH_INFO van de CGI.

{
  PATH_INFO: "^/avisos/([0-9]+)/?$";
  SERVER_ADMIN: ".*";
} -> {
  DRIVER:   "POSTGRESQL";
  PGTTY:    "/dev/console";  # zoals hierboven, write logt naar de console
  PGDATABASE:     "postgres";
  OID:      "term_0_match_1"; # wijs een OID toe

# Ook hier is de selectie belangrijk. We voegen de OID toe aan het
# begin van het veld voor het geval dat we een hyperlink willen schrijven
# om dit veld te wissen.

  PGQUERY:  "select oid,ct,titulo,texto,mt,dt,autor"
            " from avisos"
            " where (dt is NULL or dt > 'now') and oid=OID";
# Het template is nu anders
  M4FILE:    "/usr/local/etc/httpd/plantillas_m4/avisos_oid.m4";
  WEBMASTER: "term_1_match_0";
  #TESTMODE: "TRUE";
}