Common Gateway Interface

Norme utilisée par Up ! Content Service

La norme Common Gateway Interface (CGI) décrit comment un serveur HyperText Transfer Protocol (HTTP) délègue à un programme tiers l'exécution d'une requête.

La communication s'effectue par :

L'entrée standard
Elle correspond à Clavier.
Elle est utilisée pour lire les entités associées à la requête.
La sortie standard
Elle correspond à Ecran.
Elle est utilisée pour écrire la réponse.
Des variables environnement.
Elles sont lues via l'Application Program Interface (API) LireEnvironnement.
Elles sont utilisées pour communiquer les paramètres de la requête.

Voici la liste des variables environnement, en prenant pour exemple l'URL http://mon-domaine.com/niveau1/niveau2?Param1=MonParametre1&Param2=MonParametre2#MonFragment :

Variable	Sémantique	Exemple
AUTH_TYPE	Mode d'authentification.	`Basic`
CONTENT_LENGTH	Taille du contenu en entrée.	`1024`
CONTENT_TYPE	Type du contenu en entrée.	`text/plain`
GATEWAY_INTERFACE	Version de la norme utilisée.	`CGI/1.1`
PATH	Chemin de la requête.	`/niveau1/niveau2`
PATH_TRANSLATED	Chemin sur le serveur.	`/ups120/upsnet/upscns/niveau1/niveau2`
QUERY_STRING	Paramètres stricto sensus de la requête.	`Param1=MonParametre1&Param2=MonParametre2#MonFragment`
REMOTE_ADDR	Adresse Ip du client.	`127.0.0.1`
REMOTE_HOST	Domaine du client.	`www.up-comp.com`
REMOTE_USER	Utilisateur du client.	`Spoule`
REQUEST_METHOD	Méthode demandée.	`GET`
SERVER_NAME	Adresse Ip du serveur.	`127.0.0.1`
SERVER_PORT	Port Ip du serveur.	`80`
SERVER_PROTOCOL	Protocole utilisé.	`HTTP/1.1`
SERVER_SOFTWARE	Logiciel serveur utilisé.	`Up ! Application System/4.0.0`

La réponse doit être formatée de la sorte :

L'en-tête.
Elle comporte les commandes suivantes :
- Content-Type pour le type de contenu. Cette information est obligatoire. Exemple : Content-Type: text/plain .
- Location pour rediriger le contenu vers une autre. Exemple : URL Content-Type: http://mon-domaine.com/essai/index.html .
- Status pour communiquer le code retour URL. Exemple : Status: 200 Ok .
Une ligne vide.
Le contenu des entités.
Il y a généralement une seule entité.

Messages de Common Gateway Interface

Voici les messages déclarés dans la norme :

200 Ok. 302 Found. 400 Bad request. 405 Method not allowed. 413 Request entity too large. 414 Request-URI too large. 501 Not implemented. 503 Service unavailable.

Exemple de production au format Common Gateway Interface

Cette conversation ne concerne que le flux de contrôle :

Content-Type: text/html\r\n Status: 200 Ok.\r\n \r\n Bonjour.\r\n Ceci est un essai.\r\n