文章摘要:
CGI规定了Web服务器调用其他可执行程序(CGI程 序)的接口协议标准。Web服务器通过调用CGI程序实现和Web浏览器的交互。CGI程序可以用任何程序设计语言编写,如Shell脚本语言、Perl、Fortran、Pascal、C语言等。但是用C语言编写的CGI程序具有执行速度快、安全性高等特点。本文详细分析了用C语言进行CGI程序设计的方法、过程和技巧。
正文:
用C语言进行CGI程序设计
一、CGI概述
CGI(Common Gateway Interface: 公用网关接口)规定了Web服务器调用其他可执行程序(CGI程 序)的接口协议标准。Web服务器通过调用CGI程序实现和Web浏览器的交互,也就是CGI程序接受Web浏览器发送给Web服务器的信息,进行处理,将响应结果再回送给Web服务器及Web浏览器。CGI程序一般完成Web网页中表单(Form)数据的处理、数据库查询和实现与传统应用系统的集成等工作。CGI程序可以用任何程序设计语言编写,如Shell脚本语言、Perl、Fortran、Pascal、C语言等。但是用C语言编写的CGI程序具有执行速度快、安全性高(因为C语言程序是编译执行且不可被修改)等特点。
CGI接口标准包括标准输入、环境变量、标准输出三部分。
1.标准输入
CGI程序像其他可执行程序一样,可通过标准输入(stdin)从Web服务器得到输入信息,如Form中的数据,这就是所谓的向CGI程序传递数据的POST方法。这意味着在操作系统命令行状态可执行CGI程序,对CGI程序进行调试。POST方法是常用的方法,本文将以此方法为例,分析CGI程序设计的方法、过程和技巧。
2.环境变量
操作系统提供了许多环境变量,它们定义了程序的执行环境,应用程序可以存取它们。Web服务器和CGI接口又另外设置了自己的一些环境变量,用来向CGI程序传递一些重要的参数。CGI的GET方法还通过 环境变量QUERY-STRING向CGI程序传递Form中的数据。
3.标准输出
CGI程序通过标准输出(stdout)将输出信息传送给Web服务器。传送给Web服务器的信息可以用各种格式,通常是以纯文本或者HTML文本的形式,这样我们就可以在命令行状态调试CGI程序,并且得到它们的输出。
下面是一个简单的CGI程序,它将HTML中Form的信息直接输出到We b浏览器。
# include <stdio.h>
# include <stdib.h>
main()
{
int i , n ;
printf (″Content type: 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);
}
下面对此程序作一下简要的分析。
prinft (″Content type :text/plain/n/n″);
此行通过标准输出将字符串″Content type :text/plain/n/n″传送给Web服务器。它是一个MIME头信息,它告诉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服务器。
总之,CGI程序的主要任务就是从Web服务器得到输入信息,进行处理,然后将输出结果再送回给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类型,通常为″applica tion/x-www-form-url encodede″,它是从HTML Form中以POST方法传递数据给CGI程序的数据编码类型,称为URL编码类型。
CONTENT-LENGTH:传递给CGI程序的数据字符数(字节数)。
在C语言程序中,要访向环境变量,可使用getenv()库函数。例如:
if (getenv (″CONTENT-LENGTH″))
n=atoi(getenv (″CONTENT-LENGTH″));
请注意程序中最好调用两次getenv():第一次检查是否存在该环境变量,第二次再使用该环境变量。这是因为函数getenv()在给定的环境变量名不存在时,返回一个NULL(空)指针,如果你不首先检查而直接引用它,当该环境变量不存在时会引起CGI程序崩溃。
三、From输入的分析和解码
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(getenv(″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 * (strchr(digits, s[0]) -strchr (digits,′0′)
)
+(strchr(digits,s[1])-strchr(digits,′0′));
}
上面的程序首先输出一个MIME头信息给Web服务器,检查输入中的字符数,并循环检查每一个字符。当发现字符为&时,意味着一个名字/值对的结束,程序输出一个空行;当发现字符为+时,将它转换成空格; 当发现字符为%时,意味着一个两字符的十六进制值的开始,调用htoi()函数将随后的两个字符转换为相应的ASCII字符;当发现字符为=时,意味着一个名字/值对的名字部分的结束,并将它转换成字符:。最后将转换后的字符输出给Web服务器。
四、产生HTML输出
CGI程序产生的输出由两部分组成:MIME头信息和实际的信息。两部分之间以一个空行分开。我们已经看到怎样使用MIME头信息″Content type :text/plain/n/n″和printf()、put char()等函数调用来输 出纯ASCII文本给Web服务器。实际上,我们也可以使用MIME头信息″Content type :text/html/n/n″来输出HTML源代码给Web服务器。请注意任何MIME头信息后必须有一个空行。一旦发送这个MIME头信息给We b服务器后,Web浏览器将认为随后的文本输出为HTML源代码,在HTML源代码中可以使用任何HTML结构,如超链、图像、Form,及对其他CGI程 序的调用。也就是说,我们可以在CGI程序中动态产生HTML源代码输出 ,下面是一个简单的例子。
#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(″<body><br>/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);
}
上面的CGI程序简单地用printf()函数来产生HTML源代码。请注意在输出的字符串中如果有双引号,在其前面必须有一个后斜字符/, 这是因为整个HTML代码串已经在双引号内,所以HTML代码串中的双引号符必须用一个后斜字符/来转义。
五、结束语
本文详细分析了用C语言进行CGI程序设计的方法、过程和技巧。C语言的CGI程序虽然执行速度快、可靠性高,但是相对于Perl语言来说,C语言缺乏强有力的字符串处理能力,因此在实际应用中,应根据需 要和个人爱好来选择合适的CGI程序设计语言。
Turbo C++是一种使用灵活的高效编程语言,在C++ Builder不断更新的今天,Turbo C++仍是一种WINDOWS下的优秀开发环境,特别是在CGI程序开发方面与其它编程环境有着许多难以比拟的优点,它代码效率高、编译程序运行速度快且安全环保(不向WINDOWS注册表填加任何信息),是WEBMASTER的首选WEB开发语言之一。
本文的CGI程序编程实例是在下述环境下开发调试运行的:
1、WINDOWS9X操作系统
2、SAMBAR4.2一体化服务器软件(免费下载http://www.sambar.com)
3、Turbo C++ 3.0开发环境
上述软件的安装条件是:
WINDOWS9X软件安装好后需要安装TCP/IP协议,在安装SAMBAR服务器软件时,其安装路径选为C:/SAMBAR且标准方式CGI路径及WINDOWS方式CGI路径分别为C:/SAMBAR/CGI-BIN及C:/SAMBAR/CGI-WIN,WEB服务器的端口为8080,WEB的ROOT目录为C:/SAMBAR/DOCS
我们先看一下标准CGI程序显示一段文字的示例,它几乎是“hello world”的变体(大多数语言的入门性示例)。
示例一:在浏览器上显示一段文字。
# include <stdio.h>
# include <stdlib.h>
void main()
{
printf("HTTP/1.00 OK/n");
printf("Content-Type: text/html/n");
printf("<html>/n");
printf("<html><title>TC CGITEST1</title><body>/n");
printf("<H1><CENTER>HELLO WORLD!<br><br>/n");
printf("这是用TURBO C++ 3.0 编写的SERVER端CGI程序<br><br>/n");
printf("简直是酷呆了!</CENTER></H1>/n");
printf("</body></html>");
}
将上面的程序在Turbo C++下编译成CGITEST1.EXE并把它保存在C:/SAMBAR/CGI-BIN目录下。在本地计算机上打开IE浏览器并在URL处输入http://localhost:8080/cgi-bin/cgitest1.exe ,执行后浏览器上就会显示出 “HELLO WORLD 这是用TURBO C++ 3.0 编写的SERVER端CGI程序 简直是酷呆了!”的一段大字。从上面的这段程序可以看出,用Turbo C++编写CGI程序时向STDOUT输出,实际上就是在向浏览器页面输出。
示例二:编写CGI方式的访问计数器
计数器在WEB页面上被经常使用,它可以记录站点被访问的次数,一般以文字或图形两种方式显示,下面我讲一下文字方式的显示方式(把它处理一下,将计数值与对应的GIF图形进行组合就可变成图形方式的计数值显示)。
首先在C:/SAMBAR/DOCS下建立CGITEST2.DAT并在该文本文件内写入计数器的初始值,如:9871
# include <stdio.h>
# include <stdlib.h>
# include <ctype.h>
# include <conio.h>
# include <string.h>
void main()
{
long int counter;
char newvalue[10];
char invalue[10];
FILE *fileh;
fileh=fopen("c://sambar//docs//cgitest2.dat","r+t");
fgets(invalue,10,fileh);
fclose(fileh);
counter=atol(invalue);
ultoa(counter+1,newvalue,10);
fileh=fopen("c://sambar//docs//cgitest2.dat","r+w");
fputs(newvalue,fileh);
fclose(fileh);
printf("HTTP/1.00 OK/n");
printf("Content-Type: text/html/n");
printf("<html>/n");
printf("<html><title>TC CGITEST2</title><body>/n");
printf("<H1>%s</H1>/n",invalue);
printf("</body></html>/n");
}
将上面的程序编译后形成CGITEST2.EXE并考入C:/SAMBAR/CGI-BIN子目录,在本地计算机IE浏览器的URL处输入http://localhost:8080/cgi-bin/cgitest2.exe执行后便会显示9871,以后每按一下刷新钮,它的计数值就会自动加一。
下面看一下常用的留言薄CGI源程序。
首先创建 C:/SAMBAR/DOCS/MYPROGS/BOOKREC 文件夹,在该文件下写一个BOOK.HTM,它就是用来存放客户留言的原始HTM文件,其内容如下:
<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=gb_2312-80">
<meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
<title>客户留言薄</title>
</head>
<body background="../../../myprogs/bookrec/backg01.gif" bgcolor="#FFFFFF"
text="#000000" link="#000000" vlink="#000000" alink="#000000">
<p align="center"><font color="#0000A0" size="7"><b>来访者留言</b></font>
<font color="#0000A0" size="5"> </font></p>
<p align="left"><a href="../../../../myprogs/bookrec/addbook.htm"><font
color="#0000FF">添加新留言</font></a><font color="#0000FF"> </font><a
href="../../../../../"><font color="#0000FF">返回本站首页</font></a></p>
<hr>
<!--top-->
<b>IT IS VERY GOOD.</b><br>
SONGYQ <<A HREF="mailto:SONGYQ@371.NET">SONGYQ@371.NET
</A>><HR>
</body>
</html>
上面的BOOK.HTM有两个链接,一个是添加新留言,另一个是返回本站首页。添加新留言的功能是执行 addbook.htm ,它显然是一个用于输入留言的表单,而返回本站首页则只是简单地执行 ../../../../../ ,将浏览器的URL退回至站点的起始位置,即:http://localhost:8080/
可以直接显示上面的BOOK.HTM来显示用户的留言,但最好是通过CGI程序把它显示出来,这样在添加新留言后可以免去按刷新钮(如果是直接显示BOOK.HTM则必须刷新才能看见新加的留言)。下面的程序CGITEST3.EXE用于显示上面的BOOK.HTM
# include <stdio.h>
void main()
{
char invalue[512];
FILE *fileh;
printf("HTTP/1.00 OK/n");
printf("Content-Type: text/html/n");
printf("<html>/n");
fileh=fopen("c://sambar//docs//myprogs//bookrec//book.htm","r+t");
while (!feof(fileh))
{
fgets(invalue,500,fileh);
printf(invalue);
}
fclose(fileh);
}
程序CGITEST3.EXE的功能只是将BOOK.HTM文件打开,读一行,在游览器上显示一行,当BOOK.HTM的内容发生变化时,执行CGITEST3.EXE可以把其中所有的内容显示出来。除了显示用户的留言外,下面是添加留言addbook.htm的内容:
<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=gb_2312-80">
<meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
<title>添加新留言</title>
</head>
<body background="../../../myprogs/bookrec/backg01.gif" bgcolor="#FFFFFF"
text="#000000" link="#000000" vlink="#000000" alink="#000000">
<p align="center"><font color="#0000A0" size="7"><b>添加新留言</b></font>
<br>
<br>
</p>
<form action="/cgi-bin/bookrec.exe" method="GET">
<table border="0" cellpadding="5">
<tr>
<td>姓 名(<i>必须的</i>)</td>
<td><!--webbot bot="Validation"
s-display-name="acvd" s-data-type="String"
b-allow-letters="TRUE" --><input type="text"
size="40" name="name"></td>
</tr>
<tr>
<td>电子邮箱</td>
<td><input type="text" size="40" name="email"></td>
</tr>
<tr>
<td valign="top">您的留言 (<i>必须的</i>)</td>
<td><textarea name="msg" rows="12" cols="60"></textarea></td>
</tr>
<tr>
<td> </td>
<td><input type="submit" value=" 提 交 "></td>
</tr>
</table>
</form>
<p align="center">本程序仅使用 HTM标记语言及CGI编译语言,提交后可以看到新的留言。</p>
<p align="center">中海石油技术服务公司<br>技术发展中心<br>维修制造中心版权所有</p>
<p align="center">Email: <a href="mailto:wxzx@petrotech.com.cn">
wxzx@petrotech.com.cn</a><br>
电话:010-84522288-8164-1</p>
</body>
</html>
上面的addbook.htm是一个表单,它传送给/cgi-bin/bookrec.exe三个有用的参数name、email和msg,而/cgi-bin/bookrec.exe的作用是取得这三个参数,然后适当变换后把新的内容加到book.htm文件<!--top-->标记的下面,这样当执行CGITEST3.EXE时,新的留言与旧的留言一起就被显示出来,新的留言先出现,旧的留言后出现,下面是bookrec.exe的Turbo C++源程序CGITEST4.CPP:
# include <stdio.h>
# include <stdlib.h>
# include <ctype.h>
# include <conio.h>
# include <string.h>
void main()
{
char *cstring;
char estring1[512], estring2[512], estring3[512];
char invalue[512];
int check;
char *param, *temp;
char *cmpstr, *orgstr;
char *oldfile, *newfile, *ostring;
FILE *fileh, *filej;
cmpstr="<!--top-->";
cstring=getenv("QUERY_STRING");
strcpy(ostring,cstring);
strcpy(estring1,cstring);
param=strstr(estring1,"&");
strcpy(estring2,param);
strcpy(param,"/0");
temp=estring2+1;
strcpy(estring2,temp);
param=strstr(estring2,"&");
strcpy(estring3,param);
strcpy(param,"/0");
temp=estring3+1;
strcpy(estring3,temp);
param=strstr(estring1,"=");
temp=param+1;
strcpy(estring1,temp);
param=strstr(estring2,"=");
temp=param+1;
strcpy(estring2,temp);
param=strstr(estring3,"=");
temp=param+1;
strcpy(estring3,temp);
//name, email, msg are seperated
filej=fopen("c://sambar//docs//myprogs//bookrec//nbook.htm","w");
fileh=fopen("c://sambar//docs//myprogs//bookrec//book.htm","r");
while (!feof(fileh))
{
fgets(invalue,500,fileh);
strcpy(orgstr,invalue);
strcpy(orgstr+10,"/0");
check=stricmp(orgstr,cmpstr);
if (check==0){
//fputs new comments from guest
fputs(invalue,filej);
fputs("<b>",filej);
fputs(estring3,filej);
fputs("</b><br>/n",filej);
fputs(estring1,filej);
fputs(" <<A HREF=",filej);
strset(temp,34);
strcpy(temp+1,"/0");
fputs(temp,filej);
fputs("mailto:",filej);
fputs(estring2,filej);
fputs(temp,filej);
fputs(">",filej);
fputs(estring2,filej);
fputs("</A>><HR>/n",filej);
}
else
fputs(invalue,filej);
}
fclose(fileh);
fclose(filej);
oldfile="c://sambar//docs//myprogs//bookrec//book.htm";
newfile="c://sambar//docs//myprogs//bookrec//nbook.htm";
remove(oldfile);
rename(newfile,oldfile);
printf("Your message has been added<br>/n");
printf("<a href=");
printf(temp);
printf("/cgi-bin/cgitest3.exe");
printf(temp);
printf(">SEE GUEST BOOK</A><br>/n");
printf("<a href=");
printf(temp);
printf("../../../");
printf(temp);
printf(">RETURN TO HOME PAGE</A>/n");
}
把上面的程序编译后生成CGITEST4.EXE,放在C:/SAMBAR/CGI-BIN目录下。在浏览器的URL处输入http://localhost:8080/docs/myprogs/bookrec/addbook.htm后执行,在姓名处输入:Me,在邮箱处输入:Me@263.net,在留言处填写:This is realy a nice guest book.按提交后会显示出:
Your message has been added
SEE GUEST BOOK
RETURN TO HOME PAGE
其中最后的两行带有超级链接,点击SEE GUEST BOOK就可以看到自已的留言。
上面的程序介绍了用TC编写CGI程序的一般性方法,这些实例都是可运行的,但真的要把它们应用于站点建设,则需要进一步的完善,多考虑一些PITFALL,否则会有问题。CGITEST4的问题是输入的汉字都被编码为%xx十六进制数的方式(正是由于编码的结果,CGI程序才能准确地判断出&#等非法字符的输入并去除它们),因此,CGI程序必须把合理的%xx换回原有的汉字,否则你在留言薄上看到的是%xx而不是汉字。
更多