CGI接口介绍

1.CGI定义：
CGI(CommonGateway Interface)是HTTP服务器与你的或其它机器上的程序进行“交谈”的一种工具，其程序须运行在网络服务器上。CGI程序在服务器端执行，并可以和Web服务器在同一主机上。常用的CGI语言有Perl、shell、Python，在windows上也可以用C、C++或Java等进行编写。

2.CGI功能：
绝大多数的CGI程序被用来解释处理来自表单的输入信息，并在服务器产生相应的处理，或将相应的信息反馈给浏览器。CGI程序使网页具有交互功能。

3.CGI运行环境：
CGI程序在UNIX操作系统上CERN或NCSA格式的服务器上运行。 在其它操作系统（如：windows NT及windows95等）的服务器上 也广泛地使用CGI程序，同时它也适用于各种类型机器。

4.CGI处理步骤：
⑴通过Internet把用户请求送到服务器。
⑵服务器接收用户请求并交给CGI程序处理。
⑶CGI程序把处理结果传送给服务器。
⑷服务器把结果送回到用户。

5.CGI服务器配置：
在许多服务器cgi-bin是仅能够放置CGI脚本的目录。

在Windows平台上将C或C++写好的程序的Debug或Release版本的.exe程序拷贝到cgi-bin的目录下（如上图所示），将.exe改为.cgi也可同样运行，如下2个图。

cgi-bin目录是存放CGI脚本的地方。这些脚本使WWW服务器和浏览器能运行外部程序，而无需启动另一个程序。它是运行在Web服务器上的一个程序，并由来自于浏览者的输入触发。

CGI程序不是放在服务器上就能顺利运行，如果要想使其在服务器上顺利的运行并准确的处理用户的请求，则须对所使用的服务器进行必要的设置。

配置：根据所使用的服务器类型以及它的设置把CGI程序放在某一特定的目录中或使其带有特定的扩展名。

CGI脚本是怎样工作的?
CGI脚本由服务器调用, 基于浏览器的数据输入. 其工作原理如下：
1. 一个URL指向一个CGI脚本. 一个CGI脚本的URL能如普通的URL一样出现，区别于.htm/.html静态URL,CGI的URL是动态URL。如http://xxxx.com/cgiurl
2. 服务器CGI接收浏览器的请求, 按照那个URL指向对应的脚本文件(注意文件的位置和扩展名),执行CGI脚本.
3. CGI脚本执行基于输入数据的操作，包括查询数据库、计算数值或调用系统中其他程序.
4. CGI脚本产生某种Web服务器能理解的输出结果.
5. 服务器接收来自脚本的输出并且把它传回浏览器，让用户了解处理结果。

CGI的输入/输出方法：CGI程序通过标准输入（STDIN）和标准输出（STDOUT）来进行输入输出，STDIN和STDOUT是两个预先定义好的文件指针。你可以利用文件读写函数来对其进行操纵。

此外CGI程序还通过环境变量来得到输入，只不过环境变量中提供的是一些常用的信息，并且通常不包括用户在WEB页面中输入的信息（除使用下面讲的GET方法时，通过检查环境变量QUERY_STRING来得到输入数据），而STDIN通常用来传递用户输入的信息。

在输入时所使用的POST/GET方法：在WEB页面向CGI发送数据时通常采用两种方法：GET/POST，GET方法将数据附加在URL后发送，如：/cgi/a_cgi_test.exe?your_data，CGI程序通过检查环境变量QUERY_STRING来得到输入数据。

GET和POST方法的区别

GET方法，它将数据打包放置在环境变量QUERY_STRING中作为URL整体的一部分传递给服务器。而他的限制是：1） 参数的内容作为URL信息，用户可以看到；2） 有大小的限制。

POST方法，通过环境变量和标准输入传递数据给CGI程序,因此POST方法可较方便地传递较多的数据给CGI程序。

CGI接口标准包括标准输入、环境变量、标准输出三部分。

1. 标准输入
   CGI程序像其他可执行程序一样,可通过标准输入(stdin)从Web服务器得到输入信息,如Form中的数据,这就是所谓的向CGI程序传递数据的POST方法。这意味着在操作系统命令行状态可执行CGI程序,对CGI程序进行调试。POST方法是常用的方法。

2. 环境变量
   操作系统提供了许多环境变量,它们定义了程序的执行环境,应用程序可以存取它们。Web服务器和CGI接口又另外设置了自己的一些环境变量,用来向CGI程序传递一些重要的参数。CGI的GET方法还通过环境变量QUERY-STRING向CGI程序传递Form中的数据。

3. 标准输出
   CGI程序通过标准输出(stdout)将输出信息传送给Web服务器。传送给Web服务器的信息可以用各种格式,通常是以纯文本或者HTML文本的形式,这样我们就可以在命令行状态调试CGI程序,并且得到它们的输出。

环境变量

环境变量是文本串(名字/值对),可以被OSShell或其他程序设置 ,也可以被其他程序访问。它们是Web服务器传递数据给CGI程序的简单手段,之所以称为环境变量是因为它们是全局变量,任何程序都可以存取它们。下面是CGI程序设计中常常要用到的一些环境变量。

对于CGI程序来说，它继承了系统的环境变量。CGI环境变量在CGI程序启动时初始化，在结束时销毁。
当一个CGI程序不是被HTTP服务器调用时，它的环境变量几乎是系统环境变量的复制。
当这个CGI程序被HTTP服务器调用时，它的环境变量就会多了以下关于HTTP服务器、客户端、CGI传输过程等项目。

环境变量是一个保存用户信息的内存区。当客户端的用户通过浏览器发出CGI请求时，服务器就寻找本地的相应CGI程序并执行它。在执行CGI程序的同时，服务器把该用户的信息保存到环境变量里。接下来，CGI程序的执行流程是这样的：查询与该CGI程序进程相应的环境变量：第一步是request_method，如果是POST，就从环境变量的len，然后到该进程相应的标准输入取出len长的数据。如果是GET，则用户数据就在环境变量的QUERY_STRING里。

环境变量 意义
SERVER_NAME
CGI脚本运行时的主机名和IP地址
SERVER_SOFTWARE
你的服务器的类型如： CERN/3.0 或 NCSA/1.3.
GATEWAY_INTERFACE
运行的CGI版本. 对于UNIX服务器, 这是CGI/1.1.
SERVER_PROTOCOL
服务器运行的HTTP协议. 这里当是HTTP/1.0.
SERVER_PORT
服务器运行的TCP口，通常Web服务器是80.
REQUEST_METHOD
POST 或 GET, 取决于你的表单是怎样递交的.
HTTP_ACCEPT
浏览器能直接接收的Content-types, 可以有HTTP Accept header定义.
HTTP_USER_AGENT
递交表单的浏览器的名称、版本 和其他平台性的附加信息。
HTTP_REFERER
递交表单的文本的 URL，不是所有的浏览器都发出这个信息，不要依赖它
PATH_INFO
附加的路径信息, 由浏览器通过GET方法发出.
PATH_TRANSLATED
在PATH_INFO中系统规定的路径信息.
SCRIPT_NAME
指向这个CGI脚本的路径, 是在URL中显示的(如, /cgi-bin/thescript).
QUERY_STRING
脚本参数或者表单输入项(如果是用GET递交). QUERY_STRING包含URL中问号后面的参数.
REMOTE_HOST
递交脚本的主机名，这个值不能被设置.
REMOTE_ADDR
递交脚本的主机IP地址.
REMOTE_USER
递交脚本的用户名. 如果服务器的authentication被激活，这个值可以设置。
REMOTE_IDENT
如果Web服务器是在ident (一种确认用户连接你的协议)运行, 递交表单的系统也在运行ident, 这个变量就含有ident返回值.
CONTENT_TYPE
如果表单是用POST递交, 这个值将是 application/x-www-form-urlencoded. 在上载文件的表单中, content-type 是个 multipart/form-data.
CONTENT_LENGTH
对于用POST递交的表单,标准输入口的字节数.

说明： 1. CONTENT_TYPE:如application/x-www-form-urlencoded，表示数据来自HTML表单，并且经过了URL编码
2. REQUEST_METHOD：它的值一般包括两种:POST和GET，但我们写CGI程序时，最后还要考虑其他的情况。

如果采用POST方法，那么客户端来的用户数据将存放在CGI进程的标准输入中，同时将用户数据的长度赋予环境变量中的CONTENT_LENGTH。客户端用POST方式发送数据有一个相应的MIME类型（通用Internet邮件扩充服务：Multi-purpose Internet Mail Extensions）。目前，MIME类型一般是：application/x-wwww-form-urlencoded，该类型表示数据来自HTML表单。该类型记录在环境变量CONTENT_TYPE中，CGI程序应该检查该变量的值。

如果采用GET方法，CGI程序无法直接从服务器的标准输入中获取数据，因为服务器把它从标准输入接收到得数据编码到环境变量QUERY_STRING（或PATH_INFO）。

GET与POST的区别：采用GET方法提交HTML表单数据的时候，客户机将把这些数据附加到由ACTION标记命名的URL的末尾，用一个包括把经过URL编码后的信息与CGI程序的名字分开：http://www.mycorp.com/hello.html？name=hgq$id=1，QUERY_STRING的值为name=hgq&id=1

从服务器获取数据的例子（C语言实现代码）：

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

int get_inputs()
{
int length;
char *method;
char *inputstring;

method = getenv(“REQUEST_METHOD”); //将返回结果赋予指针
if(method == NULL)
    return 1;       //找不到环境变量REQUEST_METHOD
if(!strcmp(method, ”POST”))  // POST方法
{
    length = atoi(getenv(“CONTENT_LENGTH”)); //结果是字符，需要转换
    if(length != 0)
    {
        inputstring = malloc(sizeof(char)*length + 1) //必须申请缓存，因为stdin是不带缓存的。
        fread(inputstring, sizeof(char), length, stdin); //从标准输入读取一定数据
}
}
else if(!strcmp(method, “GET”))
{
    Inputstring = getenv(“QUERY_STRING”);   
    length = strlen(inputstring);
}
if(length == 0)
return 0;
}

获取环境变量的时候，如果先判断“REQUEST_METHOD”是否存在，程序会更健壮，否则在某些情况下可能会造成程序崩溃。因为假若CGI程序不是由服务器调用的，那么环境变量集里就没有与CGI相关的环境变量（如REQUEST_METHOD，REMOTE_ADDR等）添加进来，也就是说“getenv(“REQUEST_METHOD”)”将返回NULL！

CGI数据输出

CGI程序如何将信息处理结果返回给客户端？这实际上是CGI格式化输出。

这个 “脚本输出” 意思是指你的脚本发回服务器的数据. 在UNIX系统中, 输出是发向标准输出, 服务器从那儿检测它. 在其他系统和服务器, 你的脚本输出也许不一样了.

在CGI程序中的标准输出stdout是经过重定义了的，它并没有在服务器上产生任何的输出内容，而是被重定向到客户浏览器，这与它是由C，还是Perl或Python实现无关。

所以，我们可以用打印来实现客户端新的HTML页面的生成。比如，C的printf是向该进程的标准输出发送数据，Perl和Python用print向该进程的标准输出发送数据。

输出头部信息，头部是实际不是文本的一部分，是服务器与浏览器之间的信息协议，你实际看不到。 在CGI程序输出时必须先输出一个CGI标题，标题共有以下三类: Content-type, Location, 和Status. Content-type 是最普遍的。

Location: 标题，指明输出另一个文档的URL，例如 fprintf(stdout,”Location:http://www.vchelp.net/\n\n”);

Content-Type: 标题，指明发送的数据的MIME类型，例如 fprintf(stdout,”Content-Type:text/html\n\n”);

Status: 标题，指明HTTP状态码，例如 fprintf(stdout,”Status:200\n\n”);

有关content-type解释可以见有关HTML的说明, 发出text/html特定编码如下：

Content-type, Location, 和Status.后面都要跟一个空行

例如：#!/bin/sh

echo “Content-type: text/html”
echo #空行
echo “”

URL编码

不管是POST还是GET方式，客户端浏览器发送给服务器的数据都不是原始的用户数据，而是经过URL编码的。此时，CGI的环境变量Content_type将被设置，如Content_type = application/x-www-form-urlencode就表示服务器收到的是经过URL编码的包含有HTML表单变量数据。

编码的基本规则是：
变量之间用“&”分开；
变量与其对应值用“=”连接；
空格用“+”代替；
保留的控制字符则用“%”连接对应的16进制ASCII码代替；
某些具有特殊意义的字符也用“%”接对应的16进制ASCII码代替；
空格是非法字符；
任意不可打印的ASCII控制字符均为非法字符。

所以，CGI程序从标准输入或环境变量中获取客户端数据后，还需要进行解码。解码的过程就是URL编码的逆变：根据“&”和“=”分离HTML表单变量，以及特殊字符的替换。