用C语言进行CGI程序设计

     进公司不就，刚完成了公司交给的第一个跟嵌入式有关系的产品开发工作。本人Java Web出身，具有传奇的求职经验（不为吹嘘，请大家不要为这句话纠缠不清），竟然稀里糊涂的就从一个做Java Web的，华丽的转身成为一个做跟我梦寐以求的嵌入式的人！废话太多不好，先总结一下这个产品开发中遇到的问题，供以后参考。
     公司是一个转型公司，最近几年才开始注重研发的。公司里面除了我是Java Web出身，其他技术研发的都是C的，刚进来鸭梨比较大，虽然自己有一定的C和C++基础。
     刚进来就是对公司产品的熟悉，读了一下源码（linux下，基本上都是C），感觉比较吃力，没过多久，老大就让我对公司一个产品的配置界面的进行改造，这个是需要直接放进flash中的，工程容量的最大允许量1M！由于刚开始没有进行深入的研究，一直秉承着做java web的思维，认为工程大小无所谓，反正是放在电脑上的，硬盘不够就扩容就行了。但是后来发现，嵌入式的产品对这个很敏感，在作设计的时候就应该考虑如何去给程序瘦身，如何去提高代码质量。
     花了差不多2个月的时间，将产品的改造初步完成，接下来就是一些很小的修修补补的事了，老大把剩下的事交给了一直跟我协作的那个人，让我开始投入到公司PBX相关的研究与开发中。
     公司PBX的东西，属于核心产品，我要做的第一件事就是将原有的配置界面的风格跟之前做的一个产品进行统一，（cgi(linux下c实现) + jquery）。又一次被打击：linux下开发，不停的vi，还有不得不去了解熟悉的lighttpd和cgi(c实现)的通信原理和深层次应用。之前大致对这个产品进行了分心，估计是要经历一次很痛苦的开发。。。
     不过，作IT的，注定了需要不断去学习。下面将我对cgi的一些了解写下来，欢迎同行们能拍砖。

      [color=olive]一，CGI概述
     CGI(公共网关接口)规定了Web服务器调用其他可执行程序(CGI)的接口协议标准。Web服务器通过调用CGI程序实现和Web浏览器的交互，也就是CGI程序接收Web浏览器发送给Web服务器的信息进行处理，将相应结果送给Web服务器及Web浏览器。CGI程序一般完成Web网页中表单数据的处理，数据库查询和实现与传统应用系统的集成等工作。CGI程序可以用任何程序设计语言编写，如shell、Perl、Fortran、Pascal、C等。但是用C语言编写的CGI程序具有执行快、安全性高（因为C语言程序是编译执行且不可被修改）等特点。
    
     CGI接口标准包括标准输入、环境变量、标准输出三部分。
     1. 标准输入
    
     CGI程序像其他可执行程序一样，可通过标准输入(stdin)从Web服务器得到输入信息，如Form中的数据，这就是萎缩的向CGI程序传递数据的POST方法。这意味着在操作系统命令行状态可执行CGI程序，并对CGI程序进行调试。（从开始接触嵌入式开始，你就该适应频繁跟操作系统，特别是unix和linux这样的东西打交道的环境）。POST方法是常用的方法，下面我将以此方法为例，分析CGI程序设计的方法、过程和技巧。
     
     2. 环境变量

     操作系统提供了许多环境变量，它们定义了程序的执行环境，应用程序可以存取它们。Web服务器和CGI接口又另外设置了一些环境变量，用来向CGI程序传递一些重要的参数。CGI的GET方法还通过环境变量QUERY-STRING向CGI程序传递Form中的数据。
    
     3. 标准输出
    
     CGI程序的标准输出(stdout)将输出信息传送给Web服务器。传送给Web服务器的信息可以用各种格式，通常以纯文本或者html文本的形式，这样我们就可以在命令行状态调试CGI程序，并且得到它们的输出。

     下面是一个简单的C实现的CGI程序，它将html中form的信息直接输出到Web浏览器。
     
    

     #include <stdin.h>
     #include <stdlib.h>
     main()
     {
         int i, n;
         printf("Contenttype:text/plain\n\n");
         n = 0;
         if(getenv("CONTENT-LENGTH"))
            n = atoi(getenv("CONTENT-LENGTH"));
         for(i = 0;i < n;i++)
            putchar(getchar());
         putchar("\n");
         fflush(stdout);
     }

    
     下面对程序作以下简要的分析。
     printf("Contenttype:text/plain\n\n");
     此行通过标准输出将字符串Contenttype:text/plain\n\n传送给Web服务器。它是一个MINE头信息，它告诉Web服务器随后的输出是以纯ASCII文本的形式。注意：这个头信息中有两个换行符，这是因为Web服务器需要在实际的文本信息开始之前先看见一个空行。
     if(getenv("CONTENT-LENGTH")) n = atoi(getenv("CONTENT-LENGTH"));
     此行首先检查CONTENT-LENGTH环境变量是否存在。Web服务器在调用使用POST方法的CGI程序时设置此环境变量，它的文本值表示Web服务器传送给CGI程序的输入中的字符数目，因此使用atoi()函数将此环境变量的值转换成整数，并赋值给n。请注意，Web服务器并不以文件结束符来终止它的输出，所以如果不检查环境变量CONTENT-LENGTH，CGI程序就无法知道什么时候输入结束了。
     for(i = 0;i < n;i++) putchar(getchar());
     此行从0循环到CONTENT-LENGTH - 1次将标准输入中读到的每一个字符直接拷贝到标准输出，也就是将所有的输入以ASCII的形式送回给Web服务器。

     通过此例，可将CGI程序的一般工作过程总结为如下几点：
     1. 通过检查环境变量CONTENT-LENGTH确定有多少输入
     2. 循环使用getchar()或者其他文件读函数得到所有的输入
     3. 以相应的方法处理输入
     4. 通过Contenttype头信息，将输出信息的格式告诉给Web服务器
     5. 通过使用printf()或者putchar()或者其他文件写函数，将输出传送给Web服务器。

     二，环境变量
   
     环境变量是文本串(名字/值对),可以别OS Shell或者其他程序设置，也可以被其他程序访问。它们是Web服务器传递数据给CGI程序的简单手段，之所以称为环境变量是因为它们是全局变量，任何程序都可以存取它们。
 
     下面是CGI程序设计中经常要用到的一些环境变量：
     HTTP-REFERER：调用该CGI程序的网页的URL
     REMOTE-HOST：调用该CGI程序的Web浏览器的机器名和域名
     REQUEST-METHOD：当Web服务器传递数据给CGI程序时所采用的方法，分为GET和POST两种。GET方法仅通过环境变量（如QUERY-STRING）传递数据给CGI程序，而POST方法通过环境变量和标准输入传递数据给CGI程序，因此POST方法可较方便的传递数据给CGI程序。
     SCRIPT—NAME：该CGI程序的名称
     QUERY-STRING：当使用POST方法时，Form中的数据最后放在QUERY-STRING中，传递给CGI程序
     CONTENT-TYPE：传递给CGI程序数据的MIME类型，通常为"application/x-www-form-url-encoded"，它是html form中以POST方法传递数据给CGI程序的数据编码类型，成为URL编码类型。
     CONTENT-LENGTH： 传递给CGI程序的数据字符数(字节数)

     三，Form中输入的分析和解码

     1. 分析名字/值对

     当用户提交一个html form时，Web浏览器首先对form中的数据以名字/值对的形式进行编码，并发送给Web服务器，然后由Web服务器传递给CGI程序。其格式如下：
     name1=value1&name2=value2&name3=value3&name4=value4...
     其中名字是form中定义的input、select或textarea等tag的名字，值是用户输入或者选择的值。这种格式即为URL编码，程序中需要对其进行分析和解码。要分析这种数据流，CGI程序必须首先将数据流分解成一组组的名字/值对，这可以通过在输入流中查找下面的两个字符来完成。
     每当找到字符=，标志着一个form变量名字的结束；每当找到字符&，标志着一个form变量值的结束。清注意输入数据的最后一个变量值不以&结束。
     一旦名字/值对分解后，还必须将输入中的一些特殊字符转换成相应的ASCII字符，这些特殊字符是：
     + ： 将+转换成空格符
     %xx ： 用其十六进制ASCII码值表示的特殊字符。根据值xx将其转换成相应的ASCII字符。
     对form变量名和变量值都要进行这种转换。下面是一个对form数据进行分析并将结果回送给Web服务器的CGI程序。

    

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

     int htoi(char *);

     main()
     {
         int i, n;
         char c;
         printf("Contenttype:text/plain\n\n");
         n = 0;
         if(getenv("CONTENT-LENGTH"))
             n = atoi("CONTENT-LENGTH");
         for(i = 0;i < n;i++)
         {
             int is-eq = 0;
             c = getchar();
             switch(c)
             {
                 case '&' : 
                   c = '\n';
                   break;
                 case '+' : 
                   c = '  ';
                   break;
                 case '%' : 
                   {
                       char s[3];
                       s[0] = getchar();
                       s[1] = getchar();
                       s[2] = 0;
                       c = htoi(s);
                       i += 2;  
                   }
                   break;
                 case '=' : 
                   c = ':';
                   is-eq = 1;
                   break;
             };
             putchar(c);
             if(is-eq)
                 putchar('  ');
         }
         putchar('\n');
         fflush(stdout);
     }
      
     /** Convert hex string to int  **/
     int htoi(char *s)
     {
         char *digits = "0123456789ABCDEF";
         if(islower(s[0])) s[0] = toupper(s[0]);
         if(islower(s[1])) s[1] = toupper(s[1]);
         return 16 * (strchar(digits,s[0]) - strchar(digits, '0')) + (strchar(digits,s[1] -  strchar(digits, '0')));
        
     }

     上面的程序首先输出一个MIME头信息给Web服务器，检查输入中的字符数，并循环检查每个字符。

     三，产生HTML输出

     CGI的输出由两部分组成：MIME头信息和实际的信息。两部分之间以一个空行分开。可以使用MIME头信息为"Contenttype:text/html\n\n"来输出html源代码给Web服务器，下面是一个简单的例子：

    

     #include <stdio.h>
     #include <string.h>
     main()
     {
         printf("Contenttype:text/html\n\n");
         printf("<html>\n");

         printf("<head><title>An HTML Page From a CGI</title></h ead>\n″");

         printf("<h2> This is an HTML page generated from with i n a CGI program.. 　　.</h2>\n");

         printf("<hr><p>\n");

         printf("<a href="../output.html#two"><b> Go back to out put.html page <
　　/b></a>\n");

         printf("</body>\n");

         printf("</html>\n");

         fflush(stdout);
     }

    
[/color]