嵌入式CGI开发之旅

鉴于现在CGI开发的教程很少，C语言的CGI教程更是少，但是C语言的CGI开发在嵌入式WEB开发上又占了很重要的地位，本Blog将记录毕业设计过程中嵌入式WEB开发的全过程，给来着提供一点参考。本人也是新手，对于其中的错误和不妥以及不详之处欢迎大家指正！

 

开篇：环境搭建

 

CGI简介

CGI是组成WWW的技术之一，它为WWW服务器提供一种扩展手段，以允许用户编写扩展应用程序来扩展服务器的功能。CGI（Common Gateway Interface）全称是通用网关接口。是为不扩展应用程序与WW服务器交互的一个标准接口。遵循CGI标准编写的服务器侧的可执行程序（简称CGI程序）让HTML文件在哭户籍和服务器之间有了更多的交互，使信息网关、反馈机制、访问数据库、订货和查询等一系列灵活复杂的操作得以实现。

       早期很多著名的服务器都以自己独特的方式支持服务器侧的可执行程序，用来帮组完成客户机的请求。为某个服务器写的程序要在其他服务器上使用时必须做较大的修改，因为每个服务器与可执行程序之间传递信息的内容和方式都不尽相同，为此就形成了一个公共标准CGI，使得为一个服务器写的程序能够在任何服务器上运行。

       CGI只是一种规范,事实上你可以使用任何一种你熟悉的语言来编写CGI程序.比如Perl,C，C++，C Shell和VB,Perl是Unix上专用的高级语言具有强大的字符串处理能力,VB是微软公司推出的编程语言其开发的程序只能在windows平台上执行,C Shell只能在Unix平台下执行,而且功能有限,C，C++不但具有很强的可移植性,而且其灵活强大，因此也成为编写CGI程序的首选，但是正因为它的灵活使其对程序员的要求比较高,维护复杂。

       CGI处理步骤：1、通过Internet把用户请求送往服务器；2、服务器接收用户请求并交由CGI程序处理；3、CGI程序把处理结果传送给服务器；4、服务器将结果传回给用户。

       CGI不同于javascript，javascript是在客户端执行的，在客户端就能直接得到结果，CGI是在服务器端运行，结果要通过服务器反馈给用户才能显示出来。

这里有一些关于CGI的介绍大家可以去看看。

CGI开发运行环境的搭建

       进行一项项目之前最为先行的就是开发环境和运行环境的搭建了。为了配合我的毕业设计我将选用C语言就行CGI的开发，为了开发方便我将在Fedora10和Windows XP上同时搭建开发和运行环境，并最终将其移植到S3C2440的开发板上。

       CGIC

       呵呵不好意思这里又要引进一个概念——CGIC，cgic是专门为CGI开发的一个ANSI C库，封装了一些C语言CGI编程常用的操作，以及一些字符串和环境变量的处理，给C开发CGI带来了极大的方便，当然为了熟悉WEB编程你也可以不使用这个库，呵呵。

       Windows XP环境搭建

      环境：Windows XP SP3；Apache2.2；CGIC2.05；Visual C++2008 Express Edition

       1、Windows下我采用开源服务器apache2.2的WIN32版本，关于apache2.2_win的安装大家可以参考一下网上的文章，这类文章很多，而且比较详细。

       2、CGIC的安装：从获得CGIC的源码，现在最新版本是2.05，Windows下请下载ZIP文件，不然的话还要去下个7zip软件来解压了，然后解压，一般会有如下几个文件

 

capture.c是CGIC工作组提供的一个调试CGI的工具，cgic.c是CGIC库的源代码，cgic.h是CGIC库的头文件，cgictest.c是CGIC测试程序的源码，当然还有一个Makefile是Linux下必须的。其他几个文件大家可以看看里面的内容还是有帮助的。

       3、打开Visual C++2008速成版新建一个空项目，我的项目命名为：CGIC_WIN

       4、添加刚才下载的CGIC库源文件到项目中：

       5、编译，呵呵就会看到在工程目录下生成了CGIC_WIN.EXE可执行文件，将这个文件拷贝到服务器的cgi_bin目录下，我在Apache的配置文件中设置了ScriptAlias /cgi-bin/ "D:/usr/local/Apache_Http2.2/cgi-bin/"，所以我将CGIC_WIN.EXE拷贝到D:/usr/local/Apache_Http2.2/cgi-bin/下，并重命名为CGIC_WIN.cgi。

       6、在浏览器中输入：127.0.0.1/cgi-bin/CGIC_WIN.cgi，如果看到如下的页面说明你的服务器能正常运行cgi程序，并且你也可以开始CGI编程之旅了！

Fedora10环境搭建

我的fedora10安装在虚拟机里面，虚拟机下设置网络为NAT方式，在Fedora10中将网络设置为DHCP方式，重启，就能连上外网了，而且和Windows XP也可以ping通。

1、  为了和开发板相匹配我在Fedora上用的httpd服务器是boa，boa已经没有更新了，但是现在的应用仍然很大，当然更先进的AppWeb当然是更好的选择，不过学习我们先从简单的入手。

2、  到下载源码，boa最终版是0.94.13

3、   #tar -jxvf boa-0.94.13.tar.gz

         #cd boa-0.94.13/src

         #vim compat.h

将120行和126行的foo##->tm_gmtoff改为foo->tm_gmtoff

         #./configure

         #make

         #cp boa /bin/

4、  配置boa服务器，编辑boa-0.94.13目录下的boa.conf文件，按如下配置：

User           0                          用户

Group        0                          用户组

ServerName                                  这里默认是注释掉的，一定要去掉注释

DocumentRoot          /var/www                  为HTML文件目录

ScriptAlias                  /cgi-bin/ /var/www/cgi-bin             CGI程序目录

         #cp boa.conf    /etc/                   将boa.conf拷贝到etc目录中

#boa

此时boa服务器就运行起来了。

5、编写一个测试用CGI脚本：

#vim cgi-test.c

#include

#include

 

void main()

{

        printf("Content-type: text/html\n\n");

//注意这里要两个换行符，这是HTML的规定

        printf("\n");

        printf("");

        printf("");

        printf("

BOA CGI TEST

");

        printf("

huyi

");

        printf("Hello\n");

        printf(" ");

}

6、用GCC编译成CGI程序：#gcc –o cgi-test.cgi cgi-test.c

7、拷贝编译好的cgi-test.cgi到/www/cgi-bin/目录中

8、用#ifconfig命令查看机器的IP地址：我的机器为：192.168.44.128；在Windows XP下打开IE输入：192.168.44.128/cgi-bin/看到如下页面的话那么恭喜你，Linux上的开发运行环境也已经搭建好了

第一个CGI程序：Hello World

Hello World！

任何程序语言的学习都是从打印Hello World！开始的，这样不但可以熟悉程序的流程和大体结构，而且最大限度的避免了一些细小的错误，给初学者信心。

hello.c

#include

int main(){

        printf("Content-Type:text/plain;charset=us-ascii\n\n");

        printf("Hello World\n\n");

        return 0;

}

#gcc –o hello.cgi hello.c

#cp hello.cgi /var/www/cgi-bin/

用GCC将源文件编译成CGI程序，并拷贝到服务器所制定的cgi程序运行目录中。在浏览器中输入：192.168.44.128/cgi-bin/hello.cgi可以看到页面打印出“Hello World”。

       让我们再来一个更简单的CGI脚本：（Linux下）

#vim /var/www/cgi-bin/hellow.cgi

echo Conten-Type: text/plain

echo

echo

/bin/date

在浏览器中输入：192.168.44.128/cgi-bin/hellow.cgi，我们看到在浏览器页面中输出了当前时间。呵呵，这时应该对CGI是什么有比较深的印象里吧？CGI就是在服务器端执行的一段程序，这段程序执行完毕得到结果后会反馈显示给客户。编写CGI程序的可以是任何形式的语言。

在所有CGI程序中，第一句必须输出HTML头来告诉浏览器这是一个什么样的内容，这个头是服务器与浏览器之间的信息协议并不属于文本的一部分其实Contet-Type指定的就是MIME信息。有三个类型的头部：Contet-Type，Location，Status。Contet-Type最为常用

Format	Content-Type
HTML	text/html
Text	text/plain
GIF	image/gif
JPEG	image/jpeg
MPEG	video/mpeg
AVI	Video/avi

Content-Type行后必须接两个空行，不然浏览器不能正确的认出内容类型来。

对于CGI来说，处理表单是它的重头戏，今天我们来看看CGI如何处理HTML的表单。

处理表单（GET）

现在大多数的CGI脚本用来处理表单输入，处理表单的过程和上面直接在URL中调用CGI脚本的情况有些不同。一个表单通常分为两个部分：HTML表单格式和处理数据的脚本，处理程序由标签的ACTION属性指定，每个输入区都有一个NAME属性用来称呼表单元素，当表单数据被递交给ACTION中定义的处理程序时，NAME和其输入内容被以数字或字符的形式保存在环境变量中，脚本程序再通过读取环境变量的方式获得用户输入，根据编程语言的不同获取环境变量的方式也不同，C语言中可以通过stdlib库函数getenv来获得环境变量。

表单从浏览器发给服务器有两种方法（METHOD属性）：GET和POST。GET方法将数据打包放在环境变量QUERY_STRING中作为URL整体的一部分传递给服务器。POST做很多类型GET的事情，但是它分离地传递数据给脚本的，程序要通过标准输入或得数据，POST方式不会改变数据，也就是说同样的数据可以多次提交而不必重新输入。当数据量超过1024时只能使用POST来传递，由于GET将数据直接放到URL中，数据的传输也就变得很不安全了。

表单输入的数据通过URL编码后传输到服务器端，我们有必要了解一下URL的编码规则：

1、  每个name/value以name=valu的形式配对出现，每对name/valu之间用&分隔

2、  若用户没有对某个name赋值，则以“name=”的形式出现

3、  任何特殊字符以百分号%用十六进制编码。

4、  输入区的空格将以“+”显示

要想得到用户输入的数据就必须对传递进来的URL编码进行解码，解码有很多工具可用，比如CGIC库中就已经对解码进行了包装，常用的工具还有uncgi

我们以简单的乘法为例说明表单的提交

         先建立一个乘法表单，有两个输入区，分别是乘数和被乘数，一个提交按钮，当点击提交按钮时，显示结果

         multiple.html

Multiplicand 1:

Multiplicand 2:

然后在/var/www/cgi-bin目录下建立mult.c文件并编译成mult.cgi

mult.c

#include

#include

int main(){

 char *data;

 long m,n;

 printf("%s%c%c\n","Content-Type:text/html;charset=iso-8859-1",13,10);

//打印HTML头

 printf("\n");

 printf("

Multiplication results

\n");

 data=getenv("QUERY_STRING");

//取得环境变量

 if(data==NULL)

   printf("

Error!Error in passing data to script

");

 else if(sscanf(data,"m=%ld&n=%ld",&m,&n)!=2)

   printf("

Error! Invalid data. Data must be numeric.");

 else

   printf("

The product of %ld and %ld is %ld.",m,n,m*n);

 return 0;

}

可见CGI反馈给用户的信息要显示出来是一行一行的将HTML的代码打印出来的！天啦这样的话如果返回页面一复杂那还得了啊？而且想返回一个漂亮的界面都几乎是不可能的呢！应该有解决办法的！慢慢深入！

表单提交有两种方式前面讲了GET方式，还有一种POST方式。POST方式不受提交数据大小的限制，而且不会在URL中显示出提交的内容

 

处理表单（POST）

         用METHOD=”POST”指定表单按POST方式提交，数据将通过标准输入流stdin的方式传入脚本，POST提交的数据是没有结束符EOF的，所以其长度由环境变量CONTENT_LENGTH指定，不要试图读取超过CONTENT_LENGTH的长度。在将这个例子之前有必要好好介绍一下C语言中的一个输入函数：int sscanf(string str,string fmt,mixed var1,mixed var2 …)

这个函数用来从一个字符串中读进与指定格式相符的数据。此函数与int scanf(const char *format[，argument])类似，只是scanf用来以键盘（stdin）为输入源，而sscanf以固定字符串为输入源，其返回值为按正确格式输入的变量的个数。

参考百度百科——SSCANF

其中的format可以是一个或多个 {%[*] [width] [{h | l | I64 | L}]type | ' ' | '\t' | '\n' | 非%符号}

　　注：

　　1、 * 亦可用于格式中, (即 %*d 和 %*s) 加了星号 (*) 表示跳过此数据不读入. (也就是不把此数据读入参数中)

　　2、{a|b|c}表示a,b,c中选一，[d],表示可以有d也可以没有d。

　　3、width表示读取宽度。

　　4、{h | l | I64 | L}:参数的size,通常h表示单字节size，I表示2字节 size,L表示4字节size(double例外),l64表示8字节size。

　　5、type :这就很多了，就是%s,%d之类。

　　6、特别的：%*[width] [{h | l | I64 | L}]type 表示满足该条件的被过滤掉，不会向目标参数中写入值

　　支持集合操作：

　　%[a-z] 表示匹配a到z中任意字符，贪婪性(尽可能多的匹配)

　　%[aB'] 匹配a、B、'中一员，贪婪性

%[^a] 匹配非a的任意字符，贪婪性

　　1. 常见用法。

　　char buf[512] = ;

　　sscanf("123456 ", "%s", buf);

　　printf("%s\n", buf);

　　结果为：123456

　　2. 取指定长度的字符串。如在下例中，取最大长度为4字节的字符串。

　　sscanf("123456 ", "%4s", buf);

　　printf("%s\n", buf);

　　结果为：1234

　　3. 取到指定字符为止的字符串。如在下例中，取遇到空格为止字符串。

　　sscanf("123456 abcdedf", "%[^ ]", buf);

　　printf("%s\n", buf);

　　结果为：123456

　　4. 取仅包含指定字符集的字符串。如在下例中，取仅包含1到9和小写字母的字符串。

　　sscanf("123456abcdedfBCDEF", "%[1-9a-z]", buf);

　　printf("%s\n", buf);

　　结果为：123456abcdedf

　　5. 取到指定字符集为止的字符串。如在下例中，取遇到大写字母为止的字符串。

　　sscanf("123456abcdedfBCDEF", "%[^A-Z]", buf);

　　printf("%s\n", buf);

　　结果为：123456abcdedf

　　6、给定一个字符串iios/12DDWDFF@122，获取 / 和 @ 之间的字符串，先将 "iios/"过滤掉，再将非'@'的一串内容送到buf中

　　sscanf("iios/12DDWDFF@122", "%*[^/]/%[^@]", buf);

　　printf("%s\n", buf);

　　结果为：12DDWDFF

　　7、给定一个字符串““hello, world”，仅保留world。（注意：“，”之后有一空格）

　　sscanf(“hello, world”, "%*s%s", buf);

　　printf("%s\n", buf);

　　结果为：world

　　%*s表示第一个匹配到的%s被过滤掉，即hello被过滤了

　　如果没有空格则结果为NULL。

　　sscanf的功能很类似于正则表达式, 但却没有正则表达式强大,所以如果对于比较复杂的字符串处理,建议使用正则表达式.

　　//-------------------------------------------------------

　　sscanf,表示从字符串中格式化输入

　　上面表示从str中，输入数字给x，就是32700

　　久以前，我以为c没有自己的split string函数，后来我发现了sscanf；一直以来，我以为sscanf只能以空格来界定字符串，现在我发现我错了。

　　sscanf是一个运行时函数，原形很简单：

　　int sscanf(

　　const char *buffer,

　　const char *format [,

　　argument ] ...

　　);

　　它强大的功能体现在对format的支持上。

　　我以前用它来分隔类似这样的字符串2006:03:18:

　　int a, b, c;

　　sscanf("2006:03:18", "%d:%d:%d", a, b, c);

　　以及2006:03:18 - 2006:04:18:

　　char sztime1[16] = "", sztime2[16] = "";

　　sscanf("2006:03:18 - 2006:04:18", "%s - %s", sztime1, sztime2);

　　但是后来，我需要处理2006:03:18-2006:04:18

　　仅仅是取消了‘-’两边的空格，却打破了%s对字符串的界定。

　　我需要重新设计一个函数来处理这样的情况？这并不复杂，但是，为了使所有的代码都有统一的风格，我需要改动很多地方，把已有的sscanf替换成我自己的分割函数。我以为我肯定需要这样做，并伴随着对sscanf的强烈不满而入睡；一觉醒来，发现其实不必。

　　format-type中有%[]这样的type field。如果读取的字符串，不是以空格来分隔的话，就可以使用%[]。

　　%[]类似于一个正则表达式。[a-z]表示读取a-z的所有字符，[^a-z]表示读取除a-z以外的所有字符。

　　所以那个问题也就迎刃而解了:

　　sscanf("2006:03:18 - 2006:04:18", "%[0-9,:] - %[0-9,:]", sztime1, sztime2);

关于格式字符：

%d  从键盘输入十进制整数

%o  从键盘输入八进制整数

%x  从键盘输入十六进制整数

%c  从键盘输入一个字符

%s  从键盘输入一个字符串

%f  从键盘输入一个实数

%e  与%f的作用相同

         1、修改multiple.html加入代码，添加一个POST提交的表单

Multiplicand 1:

Multiplicand 2:

 method="POST">

Your input (80 chars max.):

1、  新建文件collect.c

#vim collect.c

#include

#include

#define MAXLEN 80

#define EXTRA 5

/* 4 for field name "data", 1 for "=" */

#define MAXINPUT MAXLEN+EXTRA+2

/* 1 for added line break, 1 for trailing NUL */

#define DATAFILE "../data/data.txt"

 

void unencode(char *src, char *last, char *dest)

{

//对URL编码数据进行解码URL数据会以data=xxx的形式编码

//URL编码和ASCII值的对应关系可以看这里

// 

 for(; src != last; src++, dest++)

   if(*src == '+')

     *dest = ' ';

//遇到+转化为空格

   else if(*src == '%') {

     int code;

     if(sscanf(src+1, "%2x", &code) != 1) code = '?';

     *dest = code;

/*如果发现以%开头的，则为特殊字符的编码，检查%后的两位十六进制是否是特殊符号编码，如果是则将取符号的ASCII值，比如！被编码为%21，其ASCII值为21，dest中将保存值21*/

     src +=2; }    

   else

     *dest = *src;

//非特殊字符直接保存

 *dest = '\n';

 *++dest = '\0';

//最后加上换行和字符串结束符

}

 

int main(void)

{

char *lenstr;

char input[MAXINPUT], data[MAXINPUT];

long len;

printf("%s%c%c\n",

"Content-Type:text/html;charset=iso-8859-1",13,10);

printf("\n");

lenstr = getenv("CONTENT_LENGTH");

if(lenstr == NULL || sscanf(lenstr,"%ld",&len)!=1 || len > MAXLEN)

  printf("

Error in invocation - wrong FORM probably.");

else {

  FILE *f;

  fgets(input, len+1, stdin);

/*fetts从指定输入流读取字符串,原型为:char *fgets(char *s,int n,FILE *stream)从stream读入字符串到s中,当读入n-1个字符或换行符时,函数停止操作,改函数在s的末尾增加一个NULL字符表明串的结束.成功返回指向s的指针,遇到文件结束或出错返回EOF*/

  unencode(input+EXTRA, input+len, data);

  f = fopen(DATAFILE, "a");

/*以追加方式打开文件, r 打开只读文件，该文件必须存在。

r+ 打开可读写的文件，该文件必须存在。

w 打开只写文件，若文件存在则文件长度清为0，即该文件内容会消失。若文件不存在则建立该文件。

w+ 打开可读写文件，若文件存在则文件长度清为零，即该文件内容会消失。若文件不存在则建立该文件。

a 以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。

a+ 以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。

上述的形态字符串都可以再加一个b字符，如rb、w+b或ab＋等组合，加入b 字符用来告诉函数库打开的文件为二进制文件，而非纯文字文件。不过在POSIX系统，包含Linux都会忽略该字符。*/

  if(f == NULL)

    printf("

Sorry, cannot store your data.");

  else

fputs(data, f);

/*将字符串data写入文件f中,fputs函数的功能是向指定的输出流拷贝一个以NULL为结束符的字符串*/,

  fclose(f);

  printf("

Thank you! Your contribution has been stored.");

  }

return 0;

}

#gcc –o collect.cgi collect.c

#mv collect.cgi /var/www/cgi-bin/

2、  在浏览器中输入：192.168.44.128/html/multiple.html

页面上出现了我们刚才增加的一个输入框，在输入框中输入一段文字，点击提交按钮，文字就被保存到文件中了。

呵呵上面的C源文件其实是有一点点小问题的，就是规范上的问题，当然对于这点小问题来说Apache等高级的服务器是忽略的，但是对于即优秀又弱智的boa来说可就不会给你好好工作了呵呵！用boa的朋友们会发现运行以后会出现502错误！呵呵好好分析一下，网上给出了最普通的原因为权限和lib库问题，还有一个原因就是HTML写的不标准呵呵！

前面提到，那个C源程序有点问题，其实就是HTML标签没有安装XHTML的规范来写，现在贴出更改后的mian函数

int main(void)
{
char *lenstr;
char input[MAXINPUT], data[MAXINPUT];
long len;
//printf("%s%c%c\n\n","Content-Type:text/html;charset=iso-8859-1",13,10);
printf("Content-Type:text/html\n\n");
printf("\n");
printf("\n\n\n");
printf("\n");
lenstr = getenv("CONTENT_LENGTH");
if(lenstr == NULL || sscanf(lenstr,"%ld",&len)!=1 || len > MAXLEN)
  printf("

Error in invocation - wrong FORM probably.

\n");
else {
  FILE *f;
  fgets(input, len+1, stdin);
  unencode(input+EXTRA, input+len, data);
  f = fopen(DATAFILE, "a");
  if(f == NULL)
    printf("

Sorry, cannot store your data.

\n");
  else
    fputs(data, f);
  fclose(f);
  printf("

Thank you! Your contribution has been stored.

\n");
  }
printf("\n\n");
return 0;
}WEB服务器和CGI/FastCGI程序之间交流信息的主要途径是环境变量（以及标准输入输出流）。这里说的环境变量是指操作系统中的环境变量。（windows系统下，PATH是很常见的一个环境变量）CGI规范对CGI程序中使用的环境变量名称及其含义做了具体而明确的规定，通常把这些环境变量成为：CGI环境变量。

常用CGI环境变量

CGI环境变量名称	说明
REQUEST_METHOD	请求类型，如“GET”或“POST”
CONTENT_TYPE	被发送数据的类型
CONTENT_LENGTH	客户端向标准输入设备发送的数据长度，单位为字节
QUERY_STRING	查询参数，如“id=10010&sn=liigo”
SCRIPT_NAME	CGI脚本程序名称
PATH_INFO	CGI脚本程序附加路径
PATH_TRANSLATED	PATH_INFO对应的绝对路径
REMOTE_ADDR	发送此次请求的主机IP
REMOTE_HOST	发送此次请求的主机名
REMOTE_USER	已被验证合法的用户名
REMOTE_IDENT	WEB服务器的登录用户名
AUTH_TYPE	验证类型
GATEWAY_INTERFACE	服务器遵守的CGI版本，如：CGI/1.1
SERVER_NAME	服务器主机名、域名或IP
SERVER_PORT	服务器端口号
SERVER_PROTOCOL	服务器协议，如：HTTP/1.1
DOCUMENT_ROOT	文档根目录
SERVER_SOFTWARE	服务器软件的描述文本
HTTP_ACCEPT	客户端可以接收的MIME类型，以逗号分隔
HTTP_USER_AGENT	发送此次请求的web浏览器
HTTP_REFERER	调用此脚本程序的文档
HTTP_COOKIE	获取COOKIE键值对，多项之间以分号分隔，如：key1=value1;key2=value2

FastCGI扩展的环境变量

FastCGI环境变量名称	说明
FCGI_ROLE	当前FastCGI程序担当的角色，如：RESPONDER,AUTHORIZER,FILTER
FCGI_DATA_LENGTH	服务器发送的数据长度，仅当FCGI_ROLE为：FILTER时有效
FILE_LAST_MOD	输入文件的最后修改时间，其值为自1970年1月1日零时零分零秒至今的秒数，仅当FCGI_ROLE为：FILTER时有效