CGIC库的移植及使用

CGIC库的移植
    

   CGIC是一个支持CGI开发的开放源码的标准C库，可以免费使用，只需要在开发的站点和程序文档中有个公开声明即可，表明程序使用了CGIC库，用户也可以购买商业授权而无需公开声明。
     CGIC能够提供以下功能：

   1   分析数据，并自动校正一些有缺陷的浏览器发来的数据；

   2   透明接收用GET或 POST方法发来的From数据；

   3   能接受上传文件；
    4   能够设置和接收cookies；
    5   用一致的方式处理From元素里的回车；
    6   提供字符串，整数，浮点数，单选或多选功能来接收数据；
    7   提供数字字段的边界检查；
    8   能够将CGI环境变量转化成C中的非空字符串；
    9   提供CGI程序的调试手段，能够回放CGI程序执行时的CGI状态；

总之，CGIC是一个功能比较强大的支持CGI开发的标准C库，并支持Linux, Unix 和Windows等多操作系统。

以下描述CGIC的移植过程。

   从CGIC的主站点下载源码，当前最新版本是2.05版。将其解压并进入源码目录

     # tar xzf cgic205.tar.gz

     # cd cgic205

     修改Makefile文件，找到CC=gcc，将其改成CC=arm-linux-gcc，找到AR=ar，将其改成AR=arm-linux-ar，找到RANLIB=ranlib，将其改成RANLIB=arm-linux-ranlib。找到gcc cgictest.o -o cgictest.cgi ${LIBS}，将其改成$(CC) $(CFLAGS) cgictest.o -o cgictest.cgi ${LIBS}，找到gcc capture.o -o capture ${LIBS}，将其改成$(CC) $(CFLAGS) capture.o -o capture ${LIBS}，并保存退出。

    然后运行make进行编译，得到的CGIC库libcgic.a，我们通过调试辅助程序capture和测试程序cgictest.cgi，来验证生成CGIC库的正确性。

    将capture和cgictest.cgi拷贝到主机的/nfs/www/cgi-bin目录下。

     在工作站的浏览器地址栏输入，可以看到页面，表示CGIC库和测试脚本都移植成功。cgictest.cgi比较完整的展现了CGIC库的功能，在开发基于CGIC库的CGI程序前最好先掌握cgictest.cgi程序，也是用户开发特定应用程序时的参考范例。

   HTML模板的制作
Web方式的应用开发一般都会将界面和程序逻辑脱离开来，允许在一定程度下更改界面，如改变界面文本的属性，建立多语言版本等，而无需改动程序逻辑。界面一般由美工来进行制作，而程序员负责具体功能的实现。在 HTML中，表单 (FORM)是最主要的传递信息的手段，它适用于任何浏览器。表单中有很多元素，包括输入文本框，单选框，多选框，按钮，等等，可以提供信息的交互。具体对象说明和语法请参见其他HTML书籍，在这里不作介绍。根据应用需求，美工或其他设计人员将最后的Web页面设计出来，作为程序员进行开发的模板。

     CGI程序的工作一般就是接收表单数据，进行数据处理，最后根据处理结果生成新的页面返回给浏览器。表单数据一般是以POST方法提交给服务器，由CGI程序获得，程序必须要将界面数据和内部数据对应起来才能够进行下一步的处理。CGI程序从页面获取数据就根据元素名字/值中的元素名字来进行区分。但CGI返回页面就比较麻烦。由于界面在程序开发完成后还有可能会改变，而且有些需要程序处理的地方可能没有表单元素，因此对程序来说，不能以表单元素名作为区分的基础，一般方法是采用HTML中的注释来标记。

     程序员需要在模板中为每一个表单元素以及其他任何需要程序处理的地方，按照一定规则，如注释的下一行就是表单元素行，建立其注释标记。CGI程序就可以根据注释标记来判断表单元素信息并进行处理。程序逐行读取模板文件，检查有无注释标记，如有的话，则下一行需要进行处理，给表单元素赋上数据，最后就可以返回带数据的页面给浏览器。

     HTML模板还需要关注的是输入的检查。根据输入检查越早越好的原则，需要在用户界面上就对用户提交的数据进行检查。目前一般是采用javascript脚本的方式。当用户提交数据时，表单对象的onSubmit方法就会被调用，在该方法里就可以对用户的输入进行检查。常用的检查有是否必需、最大/小长度、是否字符、是否数字、email地址、IP地址是否正确、是否匹配一个正则表达式等。

CGI程序的开发
     CGI程序的工作一般就是接收表单数据，根据应用需求进行数据处理，最后根据处理结果生成新的页面返回给浏览器。表单数据一般是以POST方法提交给服务器，由CGI程序获得，程序根据元素名字/值中的元素名字来区分数据，完成数据处理后，再读取相应的模板文件，根据注释标记将对应的数据填充到HTML文本中去，生成最后的页面返回给浏览器。

     程序一般逻辑为：

     1．   安全性检查，是否允许运行脚本；

     2．   处理用户提交的数据，根据元素名字/值中的元素名字来区分数据，然后根据应用需求进行数据处理；

     3．   将处理结果填充表单，根据注释标记将对应的数据填充到HTML文本中去，生成最后的页面返回给浏览器。

     关于具体的代码实现细节，用户可以参考《嵌入式Linux系统开发详解－基于EP93XX系列ARM》一书的相关章节。（全文完）

1) CGIC的下载安装

从上面提供的官方网址下载了CGIC库之后，解开压缩包，里面有大约10个文件，有用的是：
cgic.h：头文件；
cgic.c：CGIC的源代码文件；
cgictest.c：CGIC库的作者提供的一个CGI程序例子；
capture.c：用于调试CGI程序的工具；
Makefile：安装CGIC的脚本文件；
可以看到，整个库实际上就是cgic.c一个文件，可以说是非常的精炼。
我们可以把CGIC安装为操作系统的一个动态链接库，这样我们每次编译的时候，就不需要有cgic.c这个源文件了。

但是由于需要（以后将会看到），我们将修改cgic.c代码，所以我们不把它安装进系统。每次编译的时候，只要把cgic.c和cgic.h放到当前文件夹就好了。

2) 测试安装

在开始编写你自己的CGI程序之前，一定要先走通他的例子程序，免得后来程序出错的时候还不知道是配置有问题，还是你的程序代码有问题。
我们用他自带cgictest.c来实现自己的第一个C语言CGI程序。
你可以新建一个工作目录，用于存放你的CGI程序源代码，把cgic.h, cgic.c, cgictest.c三个文件拷贝到这个目录，然后建立一个Makefile文件，其内容为：

1. test.cgi:cgictest.c cgic.h cgic.c
2.    gcc -wall cgictest.c cgic.c -o test.cgi

需要提醒的是，第二行开头一定是一个tab键（且仅有一个），不能使用空格。
保存好Makefile的内容之后，执行make命令：

make

我们看到，当前目录下应该多了一个test.cgi文件。

在你的网站根目录下建立一个cgi-bin目录（当然名字可以任意取，但作为习惯，一般叫做cgi-bin），然后在Apache的配置文件里赋予其执行CGI代码的权限，权限修改完之后要重启Apache。完成之后，把刚才生成的test.cgi放到cgi-bin目录中。此时我们可以在浏览器中输入以下地址进行访问：

如果正常的话，应该看到一个网页被展示出来。这样，第一个C语言的CGI程序就运行起来了。
如果浏览器报错，那么多半是配置Apache的时候有些操作没有正确完成。

3) 使用CGIC的基本思路

从cgic.c的代码可以看出，它定义了main函数，而在cgictest.c中定义了一个cgiMain函数。也就是说，对于使用CGIC编写的CGI程序，都是从cgic.c中的代码进入，在库函数完成了一系列必要的操作（比如解析参数、获取系统环境变量）之后，它才会调用你的代码（从你定义的cgiMain进入）。

另外一点就是，cgi程序输出HTML页面的方式都是使用printf把页面一行一行地打印出来，比如cgictest.c中的这一段代码：

fprintf(cgiOut, "<SPAN style="COLOR: navy">\</SPAN><SPAN style="COLOR: #8b0000">"</SPAN><SPAN style="COLOR: blue">address</SPAN><SPAN style="COLOR: gray">\</SPAN><SPAN style="COLOR: #8b0000">"</SPAN> <SPAN style="COLOR: red">ROWS=4 COLS=40></SPAN><SPAN style="COLOR: navy">\</SPAN><SPAN style="COLOR: red">n</SPAN><SPAN style="COLOR: #8b0000">"</SPAN><SPAN style="COLOR: olive">)</SPAN><SPAN style="COLOR: gray">;<BR></SPAN><SPAN style="COLOR: blue">fprintf</SPAN><SPAN style="COLOR: olive">(</SPAN><SPAN style="COLOR: blue">cgiOut</SPAN><SPAN style="COLOR: gray">,</SPAN> <SPAN style="COLOR: #8b0000">"</SPAN><SPAN style="COLOR: red">Default contents go here.</SPAN> <SPAN style="COLOR: navy">\</SPAN><SPAN style="COLOR: red">n</SPAN><SPAN style="COLOR: #8b0000">"</SPAN><SPAN style="COLOR: olive">)</SPAN><SPAN style="COLOR: gray">;<BR></SPAN><SPAN style="COLOR: blue">fprintf</SPAN><SPAN style="COLOR: olive">(</SPAN><SPAN style="COLOR: blue">cgiOut</SPAN><SPAN style="COLOR: gray">,</SPAN> <SPAN style="COLOR: #8b0000">"</SPAN><SPAN style="COLOR: red">\n");

上面这段代码的运行结果就是在页面上输出一个textarea。第一个参数cgiOut实际上就是stdin，所以我们可以直接使用printf，而不必使用fprintf。不过在调试的时候会用到fprintf来重定向输出。
这种方式与Java Servlet非常类似，Servlet也是通过调用打印语句System.out.println(…)来输出一个页面。（不过后来Java推出了JSP来克服这种不便。）
但是与Servlet不同的地方在于，使用C语言的我们还要自己输出HTML头部（声明文档类型）：

cgiHeaderContentType("text/html");

这个语句的调用一定要在所有printf语句之前。而这个语句执行的任务实际上就是：

void cgiHeaderContentType(char *mimeType) {
   fprintf(cgiOut, "Content-type: %s\r\n\r\n", mimeType);
}

这个语句告诉浏览器，这次传来的数据是什么类型，是一个HTML文档，还是一个bin文件… 如果是个HTML文档，就通过浏览器窗口显示，如果是一个bin（二进制）文件，则打开下载窗口，让用户选择是否保存文件以及保存文件的路径。

理解了这几点之后，你就可以编写自己的CGIC程序了。新建一个文件test.c试试：

下载:

1. #include <stdio.h>
2. #include "cgic.h"
3. #include <string.h>
4. #include <stdlib.h>
5. int cgiMain() {
6. cgiHeaderContentType("text/html");
7. fprintf(cgiOut, "\n");
8. fprintf(cgiOut, "\n");
9. fprintf(cgiOut, "

   Hello CGIC

   \n");
10. fprintf(cgiOut, "\n");
11. return 0;
12. }

把Makefile文件中的cgitest.c全部换称test.c，保存，再执行make命令即可。
此时通过浏览器访问，会在页面上看到一个大大的“Hello CGIC”。