Programación CGI en Perl


¿Qué es CGI?

CGI es mantenido actualmente por NCSA, que define CGI de la siguiente manera:

CGI (Common Gateway Interface), interfaz de puerta de enlace común, es un programa que se ejecuta en el servidor, como un servidor HTTP, y proporciona una interfaz con las páginas HTML del cliente.


Navegación web

Para entender mejor cómo funciona CGI, podemos partir del proceso de hacer clic en un enlace o URL en una página web:

  • 1. Usa tu navegador para acceder a la URL y conectarte al servidor web HTTP.
  • 2. El servidor web, tras recibir la información de la solicitud, analiza la URL y comprueba si el archivo solicitado existe en el servidor. Si existe, devuelve el contenido del archivo; de lo contrario, devuelve un mensaje de error.
  • 3. El navegador recibe la información del servidor y muestra el archivo recibido o el mensaje de error.

Los programas CGI pueden ser scripts de Python, scripts de Perl, scripts de shell, programas en C o C++, etc.


Diagrama de arquitectura CGI

cgiarch


Soporte y configuración del servidor web

Antes de programar CGI, asegúrate de que tu servidor web sea compatible con CGI y de que ya haya configurado el manejador de CGI.

Configuración de soporte CGI en Apache:

Configurar el directorio CGI:

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

Todos los programas CGI que ejecuta el servidor HTTP se guardan en un directorio preconfigurado. Este directorio se llama directorio CGI y, por convención, se denomina /var/www/cgi-bin.

La extensión de los archivos CGI es .cgi; Perl también puede usar la extensión .pl.

Por defecto, el servidor Linux está configurado para ejecutar el directorio cgi-bin en /var/www.

Si deseas especificar otro directorio para ejecutar scripts CGI, puedes modificar el archivo de configuración httpd.conf, como se muestra a continuación:

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

Agrega el sufijo .pl en AddHandler, de esta manera podemos acceder a archivos de scripts Perl que terminan en .pl:

AddHandler cgi-script .cgi .pl .py

El primer programa CGI

A continuación, creamos un archivo test.cgi, con el siguiente código:

Código 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>Tutorial de novatos (example.com)</title>'; print '</head>'; print '<body>'; print '<h2>Hello Word! </h2>'; print '<p>El primer programa CGI de Ejemplo.</p>'; print '</body>'; print '</html>'; 1;

Luego abre http://localhost/cgi-bin/test.cgi en el navegador, y el resultado se muestra a continuación:

El contenido de salida de la primera línea del script, "Content-type:text/html\r\n\r\n", se envía al navegador e indica el tipo de contenido que se mostrará: "text/html".


Cabecera HTTP

"Content-type:text/html" en el contenido del archivo test.cgi es parte de la cabecera HTTP, que se envía al navegador para indicarle el tipo de contenido del archivo.

El formato de la cabecera HTTP es el siguiente:

HTTP 字段名: 字段内容

Por ejemplo:

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

La siguiente tabla describe la información que se usa con frecuencia en la cabecera HTTP de los programas CGI:

CabezaDescripción
Content-type: Información MIME correspondiente a la entidad solicitada. Por ejemplo: Content-type:text/html
Expires: Date Fecha y hora de expiración de la respuesta
Location: URL Se utiliza para redirigir al receptor a una ubicación que no es la URL solicitada para completar la solicitud o identificar un nuevo recurso
Last-modified: DateÚltima hora de modificación del recurso solicitado
Content-length: NLongitud del contenido de la solicitud
Set-Cookie: String Configurar cookies HTTP

Variables de entorno CGI

Todos los programas CGI reciben las siguientes variables de entorno, que desempeñan un papel importante en los programas CGI:

Nombre de la variableDescripción
CONTENT_TYPEEl valor de esta variable de entorno indica el tipo MIME de la información transferida. Actualmente, la variable de entorno CONTENT_TYPE suele ser: application/x-www-form-urlencoded, lo que indica que los datos provienen de un formulario HTML.
CONTENT_LENGTHSi el método de transferencia de información entre el servidor y el programa CGI es POST, esta variable de entorno indica el número de bytes de datos válidos que se pueden leer desde la entrada estándar STDIN. Esta variable de entorno es necesaria al leer los datos de entrada.
HTTP_COOKIEContenido de las cookies del cliente.
HTTP_USER_AGENTProporciona información del navegador del cliente, incluido el número de versión u otros datos propietarios.
PATH_INFOEl valor de esta variable de entorno representa otra información de ruta que aparece inmediatamente después del nombre del programa CGI. Suele aparecer como parámetro del programa CGI.
QUERY_STRINGSi el método de transferencia de información entre el servidor y el programa CGI es GET, el valor de esta variable de entorno es la información transferida. Esta información sigue al nombre del programa CGI, separada por un signo de interrogación '?'.
REMOTE_ADDREl valor de esta variable de entorno es la dirección IP del cliente que envía la solicitud, por ejemplo, 192.168.1.67 de arriba. Este valor siempre está presente. Además, es el único identificador que el cliente web debe proporcionar al servidor web, y se puede usar en programas CGI para distinguir diferentes clientes web.
REMOTE_HOSTEl valor de esta variable de entorno contiene el nombre de host del cliente que envía la solicitud CGI. Si no se admite la consulta del nombre de host, no es necesario definir esta variable de entorno.
REQUEST_METHODProporciona el método con el que se invoca el script. Para scripts que usan el protocolo HTTP/1.0, solo GET y POST tienen significado.
SCRIPT_FILENAMERuta completa del script CGI
SCRIPT_NAMENombre del script CGI
SERVER_NAMEEste es el nombre de host, alias o dirección IP de tu servidor web.
SERVER_SOFTWAREEl valor de esta variable de entorno contiene el nombre y el número de versión del servidor HTTP que invoca el programa CGI. Por ejemplo, el valor anterior es Apache/2.2.14(Unix)

A continuación, un script CGI simple que muestra las variables de entorno CGI:

Ejemplo

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

Descarga de archivos

Si queremos implementar la descarga de archivos mediante Perl CGI, necesitamos configurar diferentes cabeceras, como se muestra a continuación:

Ejemplo

#!/usr/bin/perl # HTTP Header print "Content-Type:application/octet-stream; name=\"FileName\"\r\n"; print "Content-Disposition: attachment; filename=\"FileName\"\r\n\n"; # Actual File Content will go hear. open( FILE, "<FileName" ); while(read(FILE, $buffer, 100) ) { print("$buffer"); }

Transferencia de datos usando el método GET

El método GET envía información de usuario codificada al servidor. Los datos se incluyen en la URL de la página solicitada, separados por el signo "?", como se muestra a continuación:

http://www.test.com/cgi-bin/test.cgi?key1=value1&key2=value2
Otras notas sobre las solicitudes GET:
  • Las solicitudes GET se pueden almacenar en caché
  • Las solicitudes GET se conservan en el historial del navegador
  • Las solicitudes GET se pueden guardar como marcadores
  • Las solicitudes GET no deben usarse al manejar datos sensibles
  • Las solicitudes GET tienen límite de longitud
  • Las solicitudes GET solo deben usarse para recuperar datos

Ejemplo simple de URL: método GET

La siguiente es una URL simple que usa el método GET para enviar dos parámetros al programa test.cgi:

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

El siguiente es el código del archivo test.cgi:

Ejemplo

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Leer información de texto $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "GET") { $buffer = $ENV{'QUERY_STRING'}; } # Leer la información del par name/value @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>Tutorial de novatos (example.com)</title>'; print "</head>"; print "<body>"; print "<h2>$nameURL:$url</h2>"; print "</body>"; print "</html>"; 1;

Revisa el navegador, el resultado se muestra a continuación:

Ejemplo simple de formulario: método GET

Lo siguiente es un formulario HTML que utiliza el método GET para enviar dos datos al servidor. El script de servidor enviado también es el archivo test.cgi. El código de test.html es el siguiente:

Código del archivo test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Ejemplo (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="get">Nombre del sitio:<input type="text" name="name"> <br />URL del sitio:<input type="text" name="url" /> <input type="submit" value="Enviar" /> </form> </body> </html>

En el navegador, el efecto de ejecución es el siguiente:


Transferencia de datos usando el método POST

Usar el método POST para enviar datos al servidor es más seguro y confiable. La información sensible, como las contraseñas de usuario, debe enviarse mediante POST.

Lo siguiente también es test.cgi, que también puede procesar los datos de formularios POST enviados por el navegador:

Código de test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Leer información de texto $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'}; } # Leer la información de pares name/value @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>Ejemplo (example.com)</title>'; print "</head>"; print "<body>"; print "<h2>$nameURL:$url</h2>"; print "</body>"; print "</html>"; 1;

Lo siguiente es un formulario HTML que utiliza el método GET para enviar dos datos al servidor. El script de servidor enviado también es el archivo test.cgi. El código de test.html es el siguiente:

Código de test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Ejemplo (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post">Nombre del sitio:<input type="text" name="name"> <br />URL del sitio:<input type="text" name="url" /> <input type="submit" value="Enviar" /> </form> </body> </html>

En el navegador, el efecto de ejecución es el siguiente:

Transferencia de datos de checkbox mediante programas CGI

El checkbox se usa para enviar datos de una o más opciones. El código de test.html es el siguiente:

Código de test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Ejemplo (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="POST" target="_blank"> <input type="checkbox" name="ejemplo" value="on" />Ejemplo<input type="checkbox" name="google" value="on" /> Google <input type="submit" value="Seleccionar sitio" /> </form> </body> </html>

El siguiente es el código del archivo test.cgi:

Código de test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Leer información $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'}; } # Leer la información de pares name/value @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } if( $FORM{ejemplo} ){ $ejemplo_flag ="ON"; }else{ $ejemplo_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>Ejemplo (example.com)</title>'; print "</head>"; print "<body>"; print "<h2> Estado seleccionado de Ejemplo:$ejemplo_flag</h2>"; print "<h2> Estado seleccionado de Google:$google_flag</h2>"; print "</body>"; print "</html>"; 1;

En el navegador, el efecto de ejecución es el siguiente:


Transferencia de datos de botones de radio mediante programas CGI

Radio solo envía un dato al servidor. El código de test.html es el siguiente:

Código de test.html

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

El código del script test.cgi es el siguiente:

Código de test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Leer información $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'}; } # Leer la información de pares name/value @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>Ejemplo (example.com)</title>'; print "</head>"; print "<body>"; print "<h2> Sitio web seleccionado$site</h2>"; print "</body>"; print "</html>"; 1;

En el navegador, el efecto de ejecución es el siguiente:


Transferencia de datos de textarea mediante programas CGI

Textarea envía datos de varias líneas al servidor. El código de test.html es el siguiente:

Código de test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Ejemplo (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post" target="_blank"> <textarea name="textcontent" cols="40" rows="4">Escriba contenido aquí...</textarea> <input type="submit" value="Enviar" /> </form> </body> </html>

El código del script test.cgi es el siguiente:

Código de test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Leer información $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'}; } # Leer la información de pares name/value @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>Ejemplo (example.com)</title>'; print "</head>"; print "<body>"; print "<h2> El contenido de texto ingresado es:$text_content</h2>"; print "</body>"; print "</html>"; 1;

En el navegador, el efecto de ejecución es el siguiente:


Transferencia de datos de lista desplegable mediante programas CGI

El código del cuadro desplegable HTML es el siguiente:

Código de test.html

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

El código del script test.cgi se muestra a continuación:

Código de test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Leer información $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'}; } # Leer la información de pares name/value @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>Ejemplo (example.com)</title>'; print "</head>"; print "<body>"; print "<h2> El sitio web seleccionado es:$site</h2>"; print "</body>"; print "</html>"; 1;

En el navegador, el efecto de ejecución es el siguiente:


Uso de cookies en CGI

Una gran desventaja del protocolo http es que no verifica la identidad del usuario, lo que causa grandes inconvenientes a los programadores. La aparición de la función de cookie ha suplido esta deficiencia.

Una cookie escribe datos de registro en el disco duro del cliente a través del navegador del cliente mientras este accede al script. Cuando el cliente accede al script la próxima vez, se recupera la información de datos, logrando así la función de identificación. Las cookies se utilizan a menudo en la verificación de identidad.

 

Sintaxis de las cookies

El envío de cookies http se realiza a través de la cabecera http, y es anterior a la transferencia del archivo. La sintaxis de la cabecera set-cookie es la siguiente:

Set-cookie:name=name;expires=date;path=path;domain=domain;secure 
  • name=name:El valor de cookie a establecer (name no puede usar ";"y",signo), cuando hay múltiples valores de name, use ";para separar, por ejemplo:name1=name1;name2=name2;name3=name3。
  • expires=date:Período de validez de la cookie, formato: expires="Wdy,DD-Mon-YYYY HH:MM:SS"
  • path=path: Ruta compatible para configurar cookie. Si path es una ruta, la cookie se aplica a todos los archivos y subdirectorios de ese directorio, por ejemplo: path="/cgi-bin/". Si path es un archivo, la cookie solo se aplica a ese archivo, por ejemplo: path="/cgi-bin/cookie.cgi".
  • domain=domain:Dominio para el que la cookie es válida, por ejemplo: domain="www.example.com"
  • secure:Si se proporciona esta marca, indica que la cookie solo puede transmitirse a través de un servidor https con protocolo SSL.
  • La recepción de cookies se logra mediante la variable de entorno HTTP_COOKIE. El programa CGI puede obtener la información de la cookie consultando esta variable.

Configuración de cookies

Configurar la cookie es muy sencillo. La cookie se envía por separado en la cabecera http. El siguiente ejemplo establece UserID, Password y expires en la cookie:

Ejemplo

#!/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.ejemplo.com;\n"; print "Set-Cookie:Path=/perl;\n"; print "Content-type:text/html\r\n\r\n"; ...........otros contenidos HTML

Búsqueda de cookies

La página de recuperación de información de Cookie es muy simple. La información de Cookie se almacena en la variable de entorno HTTP_COOKIE de CGI. El formato de almacenamiento es el siguiente:

Ejemplo

#!/usr/bin/perl $rcvd_cookies = $ENV{'HTTP_COOKIE'}; @cookies = split /;/, $rcvd_cookies; foreach $cookie ( @cookies ){ ($key, $val) = split(/=/, $cookie); # splits on the first =. $key =~ s/^\s+//; $val =~ s/^\s+//; $key =~ s/\s+$//; $val =~ s/\s+$//; if( $key eq "UserID" ){ $user_id = $val; }elsif($key eq "Password"){ $password = $val; } } print "User ID = $user_id\n"; print "Password = $password\n";

El resultado de salida del ejemplo anterior es:

User ID = XYZ
Password = XYZ123

Módulo CGI

Perl proporciona muchos módulos CGI integrados. Los más utilizados son los dos siguientes:

Otras extensiones