Interfaz de entrada común

Para otros usos de las siglas «CGI», véase CGI.

Interfaz de entrada común (en inglés Common Gateway Interface, abreviado CGI) es una importante tecnología de la World Wide Web que permite a un cliente (navegador web) solicitar datos de un programa ejecutado en un servidor web. CGI especifica un estándar para transferir datos entre el cliente y el programa. Es un mecanismo de comunicación entre el servidor web y una aplicación externa cuyo resultado final de la ejecución son objetos MIME. Las aplicaciones que se ejecutan en el servidor reciben el nombre de CGIs.

Las aplicaciones CGI fueron una de las primeras prácticas de crear contenido dinámico para las páginas web. En una aplicación CGI, el servidor web pasa las solicitudes del cliente a un programa externo. Este programa puede estar escrito en cualquier lenguaje que soporte el servidor, aunque por razones de portabilidad se suelen usar lenguajes de script. La salida de dicho programa es enviada al cliente en lugar del archivo estático tradicional.

CGI ha hecho posible la implementación de funciones nuevas y variadas en las páginas web, de tal manera que esta interfaz rápidamente se volvió un estándar, siendo implementada en todo tipo de servidores web.

Forma de actuación de CGI

A continuación se describe la forma de actuación de un CGI de forma esquemática:

1. En primera instancia, el servidor recibe una petición (el cliente ha activado un URL que contiene el CGI), y comprueba si se trata de una invocación de un CGI.
2. Posteriormente, el servidor prepara el entorno para ejecutar la aplicación. Esta información procede mayoritariamente del cliente.
3. Seguidamente, el servidor ejecuta la aplicación, capturando su salida estándar.
4. A continuación, la aplicación realiza su función: como consecuencia de su actividad se va generando un objeto MIME que la aplicación escribe en su salida estándar.
5. Finalmente, cuando la aplicación finaliza, el servidor envía la información producida, junto con información propia, al cliente, que se encontraba en estado de espera. Es responsabilidad de la aplicación anunciar el tipo de objeto MIME que se genera (campo CONTENT_TYPE).

Programación de un CGI

Un programa CGI puede ser escrito en cualquier lenguaje de programación que produzca un archivo ejecutable. Entre los lenguajes más habituales se encuentran: C, C++, Perl, Java, Visual Basic, Cobol... No obstante, debido a que el CGI recibe los parámetros en forma de texto será útil un lenguaje que permita realizar manipulaciones de las cadenas de caracteres de una forma sencilla, como por ejemplo Perl. Perl es un lenguaje interpretado que permite manipulaciones sencillas de ficheros y textos, así como la extracción y manipulación de cadenas de caracteres, unidas a unas búsquedas rápidas y fáciles.

Intercambio de información: Variables de entorno

Los siguientes datos son las variables de entorno que pasan por los programas CGI:

• Variables específicas del servidor:
  • SERVER_SOFTWARE — nombre y versión del servidor web.
  • SERVER_NAME — nombre de equipo del servidor, puede ser una dirección IP.
  • GATEWAY_INTERFACE — versión CGI.
• Variables específicas de la petición:
  • SERVER_PROTOCOL — versión HTTP.
  • SERVER_PORT — Puerto TCP.
  • REQUEST_METHOD — nombre del método HTTP.
  • PATH_INFO — sufijo de la ruta.
  • PATH_TRANSLATED — corresponde a la ruta completa del servidor, si PATH_INFO está presente.
  • SCRIPT_NAME — ruta relativa al programa. Ejemplo: /cgi-bin/script.cgi.
  • QUERY_STRING — la parte del URL después del carácter ?. la cadena de consulta puede estar compuesta de *nombre=valor separados por el carácter & (ejemplo: var1=val1&var2=val2…) que se utiliza para enviar datos de un formulario web usando el método GET.
  • REMOTE_HOST — nombre del host del cliente.
  • REMOTE_ADDR — dirección IP del cliente.
  • AUTH_TYPE — tipo de identificación.
  • REMOTE_USER variable usada para ciertos tipos de autentificación (AUTH_TYPE).
  • REMOTE_IDENT — variable para identificar algunas conexiones TCP.
  • CONTENT_TYPE — tipo de contenido de la aplicación.
  • CONTENT_LENGTH — tamaño de los datos de entrada.
  • Las variables que pasan por el agente de usuario del cliente (HTTP_ACCEPT, HTTP_ACCEPT_LANGUAGE, HTTP_USER_AGENT, HTTP_COOKIE etc.) contienen valores de sus correspondientes cabeceras HTTP por lo que sus datos no cambian.

Tipos habituales de CGI

1. Contador de accesos: Cuenta el número de veces que se ha solicitado una página determinada. Se guarda el valor en un fichero. Cada vez que se invoca se incrementa, para su posterior visualización.
2. Buscador: Localiza páginas que contengan los términos especificados. Utiliza una tabla que enumera las palabras y para cada una especifica las páginas donde se encuentra.
3. Correo: Obtiene información estructurada del usuario.
4. Contribuciones: Permite añadir enlaces o anotaciones a una página, indicando la procedencia de la adición.
5. Estadísticas de uso: Presenta información sobre los acontecimientos producidos en el servidor de WWW. El servidor mantiene un registro (log) de los acontecimientos que se han producido.
6. Administración remota del servidor: Permite interactuar con el servidor desde WWW. Invoca los programas que controlan o modifican el comportamiento del servidor.

Escenario de activación de un CGI

1. Situación inicial: El cliente solicita la invocación de un CGI, bien de manera involuntaria (se envía únicamente información de cabecera) o bien de forma explícita (formulario). En el formulario hay parejas del tipo variable=valor. El método de HTTP especificado en el formulario puede ser GET o POST.
   En el servidor en cambio, el archivo de configuración especifica un directorio cgi-bin con capacidad para ejecutar programas. Puede haber otros ficheros y otros programas a los que puede acceder tanto el servidor como sus CGIs.
2. El cliente pulsa el botón de tipo SUBMIT en el formulario: Dependiendo del método se construye un mensaje que contiene la información del formulario en la cabecera (para GET) o en el cuerpo del mensaje (para POST). El mensaje se envía al servidor, añadiendo información propia del cliente que el propio navegador conoce. El cliente queda a la espera de recibir un objeto MIME como respuesta del servidor.
3. El servidor recibe el mensaje de petición o pone en marcha el programa CGI: El servidor compara la información del mensaje con la que conoce de su fichero de configuración, determinando así la validez de la petición. En realidad el servidor se pregunta: ¿Existe esta URL? ¿Se tienen todos los permisos?.
   Prepara el entorno añadiendo información propia a la comunicada por el navegador del cliente. Si es GET, la información procedente del formulario (parejas variable=valor) se definen en QUERY_STRING. El servidor posteriormente pone en funcionamiento el CGI. Si se trata de POST, la información se coloca en la entrada estándar del CGI. Finalmente se inicia la ejecución del CGI y el servidor espera a que ésta acabe.
4. Ejecución del CGI: El CGI accede a las variables de entorno. Comprueba o adapta el funcionamiento según el método GET o POST establecido en REQUEST_METHOD: si se tratara de GET, la información estará en QUERY_STRING, mientras que si se trata de POST, se tomará la entrada estándar.

Se construye un objeto MIME que se enviará al cliente. La primera escritura deberá anunciar el tipo de objeto: CONTENT_TYPE: tipo/subtipo.

1. El servidor vuelve al trabajo: El servidor añade a su respuesta del CGI una cabecera indicando su tamaño (CONTENT_LENGTH).
2. El cliente recibe la respuesta: Interpretación de la respuesta. Visualización con el navegador.

Véase también

• FastCGI
• SCGI
• WinCGI

Bibliografía

• Sergio Luján Mora (2001). Programación de servidores web con CGI, SSI e IDC (libro completo gratuito en pdf) (1ª edición). Editorial Club Universitario. 
• Shishir Gundavaram (marzo de 1996). CGI Programming on the World Wide Web (libro completo en html) (en inglés) (1ª edición). O'Reilly & Associates, Inc. 

Enlaces externos

• Estándar CGI en w3.org.
• El protocolo SCGI es un reemplazo del protocolo Common Gateway Interface (CGI).

•   Datos: Q264364
•   Multimedia: CGI / Q264364