Programmation CGI en Perl


Qu'est-ce que CGI

CGI est actuellement maintenu par NCSA. NCSA définit CGI comme suit :

CGI (Common Gateway Interface), l'interface de passerelle générale, est un programme qui s'exécute sur un serveur tel qu'un serveur HTTP et fournit une interface aux pages HTML client.


Navigation Web

Pour mieux comprendre comment fonctionne CGI, nous pouvons commencer par le processus de clic sur un lien ou une URL dans une page web :

  • 1. Utilisez votre navigateur pour accéder à l'URL et vous connecter au serveur web HTTP.
  • 2. Après avoir reçu la requête, le serveur web analyse l'URL et vérifie si le fichier demandé existe sur le serveur. S'il existe, il renvoie le contenu du fichier ; sinon, il renvoie un message d'erreur.
  • 3. Le navigateur reçoit les informations du serveur et affiche le fichier reçu ou le message d'erreur.

Les programmes CGI peuvent être des scripts Python, des scripts Perl, des scripts Shell, des programmes C ou C++, etc.


Schéma de l'architecture CGI

cgiarch


Prise en charge et configuration du serveur web

Avant de commencer la programmation CGI, assurez-vous que votre serveur web prend en charge CGI et que le gestionnaire CGI est configuré.

Configuration CGI d'Apache:

Configurer le répertoire CGI:

ScriptAlias /cgi-bin/ /var/www/cgi-bin/

Tous les programmes CGI exécutés par les serveurs HTTP sont stockés dans un répertoire préconfiguré. Ce répertoire est appelé répertoire CGI et, par convention, il est nommé /var/www/cgi-bin.

Les fichiers CGI ont l'extension .cgi. Perl peut également utiliser l'extension .pl.

Par défaut, les serveurs Linux sont configurés avec /var/www comme répertoire cgi-bin pour exécuter des scripts CGI.

Si vous souhaitez spécifier un autre répertoire pour exécuter des scripts CGI, vous pouvez modifier le fichier de configuration httpd.conf comme suit :

<Directory "/var/www/cgi-bin">
   AllowOverride None
   Options +ExecCGI
   Order allow,deny
   Allow from all
</Directory>

Ajoutez le suffixe .pl à AddHandler afin que nous puissions accéder aux fichiers de script Perl se terminant par .pl :

AddHandler cgi-script .cgi .pl .py

Premier programme CGI

Ci-dessous, nous créons un fichier test.cgi avec le code suivant :

Code de test.cgi

#!/usr/bin/perl print "Content-type:text/html\r\n\r\n"; print '<html>'; print '<head>'; print '<meta charset="utf-8">'; print '<title>Tutoriel d'exemple (example.com)</title>'; print '</head>'; print '<body>'; print '<h2>Bonjour Word ! </h2>'; print '<p>Ceci est le premier programme CGI du tutoriel d'exemple.</p>'; print '</body>'; print '</html>'; 1;

Ensuite, ouvrez http://localhost/cgi-bin/test.cgi dans un navigateur, et la sortie est la suivante :

La sortie 'Content-type:text/html\r\n\r\n' sur la première ligne du script est envoyée au navigateur pour informer le navigateur que le type de contenu à afficher est 'text/html'.


En-tête HTTP

Le 'Content-type:text/html' dans le contenu du fichier test.cgi fait partie de l'en-tête HTTP. Il est envoyé au navigateur pour lui indiquer le type de contenu du fichier.

Le format de l'en-tête HTTP est le suivant :

HTTP 字段名: 字段内容

Par exemple :

Content-type:text/html\r\n\r\n

Le tableau suivant décrit les informations fréquemment utilisées dans les en-têtes HTTP dans les programmes CGI :

headDescription
Content-type: Informations MIME correspondant à l'entité demandée. Par exemple : Content-type:text/html
Expires: Date La date et l'heure auxquelles la réponse expire
Location: URL Utilisé pour rediriger le destinataire vers un emplacement autre que l'URL demandée afin de terminer la requête ou d'identifier une nouvelle ressource
Last-modified: DateL'heure de dernière modification de la ressource demandée
Content-length: NLa longueur du contenu de la requête
Set-Cookie: Chaîne Définir un cookie HTTP

Variables d'environnement CGI

Tous les programmes CGI reçoivent les variables d'environnement suivantes, qui jouent un rôle important dans les programmes CGI :

Nom de la variableDescription
CONTENT_TYPELa valeur de cette variable d'environnement indique le type MIME des informations transmises. Actuellement, la variable d'environnement CONTENT_TYPE est généralement : application/x-www-form-urlencoded, ce qui indique que les données proviennent d'un formulaire HTML.
CONTENT_LENGTHSi la méthode de transfert entre le serveur et le programme CGI est POST, cette variable d'environnement est le nombre d'octets de données valides pouvant être lus depuis l'entrée standard STDIN. Cette variable d'environnement doit être utilisée lors de la lecture des données d'entrée.
HTTP_COOKIELe contenu COOKIE dans le client.
HTTP_USER_AGENTFournit des informations sur le navigateur client contenant des numéros de version ou d'autres données propriétaires.
PATH_INFOLa valeur de cette variable d'environnement représente d'autres informations de chemin suivant immédiatement le nom du programme CGI. Elle apparaît souvent comme paramètre du programme CGI.
QUERY_STRINGSi la méthode de transfert entre le serveur et le programme CGI est GET, la valeur de cette variable d'environnement est l'information transférée. Cette information suit le nom du programme CGI, séparée par un point d'interrogation '?'.
REMOTE_ADDRLa valeur de cette variable d'environnement est l'adresse IP du client effectuant la requête, par exemple 192.168.1.67 ci-dessus. Cette valeur est toujours présente. C'est également l'identifiant unique qu'un client web doit fournir au serveur web, et il peut être utilisé dans les programmes CGI pour distinguer différents clients web.
REMOTE_HOSTLa valeur de cette variable d'environnement contient le nom d'hôte du client qui a envoyé la requête CGI. Si le serveur ne prend pas en charge la résolution souhaitée, cette variable d'environnement n'a pas besoin d'être définie.
REQUEST_METHODFournit la méthode par laquelle le script a été appelé. Pour les scripts utilisant le protocole HTTP/1.0, seuls GET et POST sont pertinents.
SCRIPT_FILENAMELe chemin complet vers le script CGI
SCRIPT_NAMELe nom du script CGI
SERVER_NAMEIl s'agit du nom d'hôte, de l'alias ou de l'adresse IP de votre serveur web.
SERVER_SOFTWARELa valeur de cette variable d'environnement contient le nom et le numéro de version du serveur HTTP qui a invoqué le programme CGI. Par exemple, la valeur ci-dessus est Apache/2.2.14(Unix).

Voici un script CGI simple qui affiche les variables d'environnement CGI :

Exemple

#!/usr/bin/perl print "Content-type: text/html\n\n"; print '<meta charset="utf-8">'; print "<font size=+1>Variables d'environnement :</font>\n"; foreach (sort keys %ENV) { print "<b>$_</b>: $ENV{$_}<br>\n"; } 1;

Téléchargement de fichier

Si nous voulons implémenter le téléchargement de fichier via Perl CGI, nous devons définir des informations d'en-tête différentes, comme suit :

Exemple

#!/usr/bin/perl # En-tête HTTP print "Content-Type:application/octet-stream; name=\"FileName\"\r\n"; print "Content-Disposition: attachment; filename=\"FileName\"\r\n\n"; # Le contenu réel du fichier ira ici. open( FILE, "<FileName" ); while(read(FILE, $buffer, 100) ) { print("$buffer"); }

Utilisation de la méthode GET pour transférer des données

La méthode GET envoie des informations utilisateur encodées au serveur. Les données sont incluses dans l'URL de la page demandée, séparées par un signe '?', comme montré ci-dessous :

http://www.test.com/cgi-bin/test.cgi?key1=value1&key2=value2
Quelques autres remarques sur les requêtes GET :
  • Les requêtes GET peuvent être mises en cache
  • Les requêtes GET restent dans l'historique du navigateur
  • Les requêtes GET peuvent être ajoutées aux favoris
  • Les requêtes GET ne doivent pas être utilisées lors du traitement de données sensibles
  • Les requêtes GET ont une limite de longueur
  • Les requêtes GET doivent être utilisées uniquement pour récupérer des données

Exemple d'URL simple : méthode GET

Voici une URL simple qui envoie deux paramètres au programme test.cgi en utilisant la méthode GET :

/cgi-bin/test.cgi?name=Example&url=http://www.example.com

Voici le code du fichier test.cgi :

Exemple

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Lire les informations textuelles $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "GET") { $buffer = $ENV{'QUERY_STRING'}; } # Lire les informations sur les paires nom/valeur @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $name = $FORM{name}; $url = $FORM{url}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>Tutoriel d'exemple (example.com)</title>'; print "</head>"; print "<body>"; print "<h2>$nameURL:$url</h2>"; print "</body>"; print "</html>"; 1;

Visualisez dans le navigateur, la sortie est la suivante :

Exemple de formulaire simple : méthode GET

Voici un formulaire HTML qui utilise la méthode GET pour envoyer deux éléments de données au serveur. Le script serveur soumis est également le fichier test.cgi. Le code test.html est le suivant :

Code du fichier test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Tutoriel d'exemple (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="get">Nom du site :<input type="text" name="name"> <br />URL du site :<input type="text" name="url" /> <input type="submit" value="Envoyer" /> </form> </body> </html>

Dans le navigateur, l'effet d'exécution est le suivant :


Utilisation de la méthode POST pour transmettre des données

Utiliser la méthode POST pour transmettre des données au serveur est plus sûr et plus fiable. Les informations sensibles telles que les mots de passe des utilisateurs doivent être transmises à l'aide de POST.

Ce qui suit est également test.cgi ; il peut également traiter les données de formulaire POST soumises par le navigateur :

Code de test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Lire les informations textuelles $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # Lire les informations de paire nom/valeur @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $name = $FORM{name}; $url = $FORM{url}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>Tutoriel d'exemple (example.com)</title>'; print "</head>"; print "<body>"; print "<h2>$nameURL:$url</h2>"; print "</body>"; print "</html>"; 1;

Voici un formulaire HTML qui utilise la méthode GET pour envoyer deux éléments de données au serveur. Le script serveur soumis est également le fichier test.cgi. Le code test.html est le suivant :

Code de test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Tutoriel d'exemple (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post">Nom du site :<input type="text" name="name"> <br />URL du site :<input type="text" name="url" /> <input type="submit" value="Envoyer" /> </form> </body> </html>

Dans le navigateur, l'effet d'exécution est le suivant :

Transmission des données de case à cocher via un programme CGI

La case à cocher est utilisée pour soumettre les données d'une ou plusieurs options. Le code de test.html est le suivant :

Code de test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Tutoriel d'exemple (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="POST" target="_blank"> <input type="checkbox" name="example" value="on" />Tutoriel d'exemple<input type="checkbox" name="google" value="on" /> Google <input type="submit" value="Sélectionner un site" /> </form> </body> </html>

Voici le code du fichier test.cgi :

Code de test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Lire les informations $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # Lire les informations de paire nom/valeur @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } if( $FORM{example} ){ $example_flag ="ON"; }else{ $example_flag ="OFF"; } if( $FORM{google} ){ $google_flag ="ON"; }else{ $google_flag ="OFF"; } print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>Tutoriel d'exemple (example.com)</title>'; print "</head>"; print "<body>"; print "<h2> Statut de sélection du tutoriel Example :$example_flag</h2>"; print "<h2> Statut de sélection de Google :$google_flag</h2>"; print "</body>"; print "</html>"; 1;

Dans le navigateur, l'effet d'exécution est le suivant :


Transmission de données de boutons radio via un programme CGI

Un bouton radio n'envoie qu'une seule donnée au serveur. Le code test.html est le suivant :

Code de test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Tutoriel d'exemple (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post" target="_blank"> <input type="radio" name="site" valeur="exemple" />Tutoriel d'exemple<input type="radio" name="site" valeur="google" /> Google <input type="submit" value="Soumettre" /> </form> </body> </html>

Le code du script test.cgi est le suivant :

Code de test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Lire les informations $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # Lire les informations de paire nom/valeur @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $site = $FORM{site}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>Tutoriel d'exemple (example.com)</title>'; print "</head>"; print "<body>"; print "<h2> Site sélectionné$site</h2>"; print "</body>"; print "</html>"; 1;

Dans le navigateur, l'effet d'exécution est le suivant :


Transmission de données Textarea via un programme CGI

Textarea envoie plusieurs lignes de données au serveur. Le code test.html est le suivant :

Code de test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Tutoriel d'exemple (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post" target="_blank"> <textarea name="textcontent" cols="40" rows="4">Saisissez le contenu ici...</textarea> <input type="submit" value="Soumettre" /> </form> </body> </html>

Le code du script test.cgi est le suivant :

Code de test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Lire les informations $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # Lire les informations de paire nom/valeur @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $text_content = $FORM{textcontent}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>Tutoriel d'exemple (example.com)</title>'; print "</head>"; print "<body>"; print "<h2> Le contenu du texte saisi est :$text_content</h2>"; print "</body>"; print "</html>"; 1;

Dans le navigateur, l'effet d'exécution est le suivant :


Transmission de données de liste déroulante via un programme CGI

Le code de la liste déroulante HTML est le suivant :

Code de test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Tutoriel d'exemple (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post" target="_blank"> <select name="dropdown"> <option value="example" selected>Tutoriel d'exemple</option> <option value="google">Google</option> </select> <input type="submit" value="Envoyer"/> </form> </body> </html>

Le code du script test.cgi est le suivant :

Code de test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Lire les informations $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # Lire les informations de paire nom/valeur @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $site = $FORM{dropdown}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>Tutoriel d'exemple (example.com)</title>'; print "</head>"; print "<body>"; print "<h2> Le site Web sélectionné est :$site</h2>"; print "</body>"; print "</html>"; 1;

Dans le navigateur, l'effet d'exécution est le suivant :


Utilisation des cookies en CGI

Un inconvénient majeur du protocole HTTP est qu'il ne détermine pas l'identité de l'utilisateur, ce qui entraîne de gros désagréments pour les programmeurs. L'apparition de la fonctionnalité cookie comble cette lacune.

Un cookie est créé lorsqu'un client visite un script et que, via le navigateur du client, des données d'enregistrement sont écrites sur le disque dur du client. Lorsque le client accède au script la prochaine fois, les informations de données sont récupérées, ce qui permet d'identifier l'identité. Les cookies sont couramment utilisés pour la vérification d'identité.

 

Syntaxe des cookies

Les cookies HTTP sont envoyés via l'en-tête HTTP, ce qui se produit avant le transfert de fichier. La syntaxe de l'en-tête Set-Cookie est la suivante :

Set-cookie:name=name;expires=date;path=path;domain=domain;secure 
  • name=name:Il faut définir la valeur du cookie (name ne peut pas utiliser ";",symbole), lorsqu'il y a plusieurs valeurs name, utilisez ";" pour les séparer, par exemple :name1=name1;name2=name2;name3=name3。
  • expires=date:Période de validité du cookie, format : expires="Wdy,DD-Mon-YYYY HH:MM:SS"
  • path=path: Définit le chemin pris en charge par le cookie. Si path est un chemin, le cookie prend effet pour tous les fichiers et sous-répertoires de ce répertoire, par exemple : path="/cgi-bin/". Si path est un fichier, le cookie ne prend effet que pour ce fichier, par exemple : path="/cgi-bin/cookie.cgi".
  • domain=domain:Le nom de domaine pour lequel le cookie est valide, par exemple : domain="www.example.com"
  • secure:Si cet indicateur est donné, cela signifie que le cookie ne peut être transmis que via un serveur HTTPS utilisant le protocole SSL.
  • La réception des cookies est mise en œuvre en définissant la variable d'environnement HTTP_COOKIE. Les programmes CGI peuvent récupérer les informations de cookie en interrogeant cette variable.

Définition des cookies

La définition des cookies est très simple ; les cookies sont envoyés séparément dans l'en-tête HTTP. L'exemple suivant définit UserID, Password et expires dans le cookie :

Exemple

#!/usr/bin/perl print "Set-Cookie:UserID=XYZ;\n"; print "Set-Cookie:Password=XYZ123;\n"; print "Set-Cookie:Expires=Tuesday, 31-Dec-2017 23:12:40 GMT";\n"; print "Set-Cookie:Domain=www.example.com;\n"; print "Set-Cookie:Path=/perl;\n"; print "Content-type:text/html\r\n\r\n"; ...........autre contenu HTML

Récupération des cookies

La page de récupération des informations de cookie est très simple. Les informations de cookie sont stockées dans la variable d'environnement CGI HTTP_COOKIE, au format suivant :

Exemple

#!/usr/bin/perl $rcvd_cookies = $ENV{'HTTP_COOKIE'}; @cookies = split /;/, $rcvd_cookies; foreach $cookie ( @cookies ){ ($key, $val) = split(/=/, $cookie); # se divise sur le premier =. $key =~ s/^\s+//; $val =~ s/^\s+//; $key =~ s/\s+$//; $val =~ s/\s+$//; if( $key eq "UserID" ){ $user_id = $val; }elsif($key eq "Mot de passe"){ $password = $val; } } print "Identifiant utilisateur = $user_id\n"; print "Mot de passe = $password\n";

Le résultat de sortie de l'exemple ci-dessus est :

User ID = XYZ
Password = XYZ123

Module CGI

Perl fournit de nombreux modules CGI intégrés, les deux suivants sont couramment utilisés:

Autres extensions