轉自：http://blog.csdn.net/clearver/article/details/5209332
一、CGI概述
CGI(公用網關接口)規定了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 (〃Contenttype:text/plainnn〃);
n=0;
if(getenv(〃CONTENT-LENGTH〃))
n=atoi(getenv(CONTENT-LENGTH〃));
for (i=0;i putchar(getchar());
putchar (′n′);
fflush(stdout);
}
下面對此程序作一下簡要的分析。
prinft (〃Contenttype:text/plainnn〃);
此行通過標准輸出將字符串〃Contenttype:text/plainnn〃傳送給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 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/plainnn〃);
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頭信息〃Cont enttype:text/plainnn〃和printf()、put char()等函數調用來輸出純ASCII文本給Web服務器。實際上,我們也可以使用MIME頭信息〃C ontenttype:text/htmlnn〃來輸出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 >< /head >/n〃);
printf(〃< body >
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代碼串中的雙引號符必須用一個后斜字符來轉義。
在 HTML中，當客戶填寫了表單，並按下了發送（submit）按鈕后，表單的內容被發送到了服務器端，一般的，這時就需要有一個服務器端腳本來 對表單的內容進行一些處理，或者是把它們保存起來，或者是按內容進行一些查詢，或者是一些別的什么。沒有了CGI，WEB的世界就完全失去了它的交互性， 所有的信息都變成單向的了，而不能夠有任何的反饋。
有的人認為可以用java script來代替CGI程序，這其實是一個概念上的錯誤。java script只能夠在客戶瀏覽器中運行，而CGI卻是工作在服務器上的。他們所做的工作有一些交集，比如表單數據驗證一類的，但是java script是絕對無法取代CGI的。但可以這樣說，如果一項工作即能夠用java script來做，又可以用CGI來做，那么絕對要使用java script，在執行的速度上，java script比CGI有着先天的優勢。只有那些在客戶端解決不了的問題，比如和某個遠程數據庫交互，這時就應該使用CGI了。
簡單的說來，CGI是用來溝通HTML表單和服務器端程序的接口（interface）。說它是接口，也就是說CGI並不是一種語言，而是可以被其他語言 所應用的一個規范集。理論上講，你可以用任何的程序語言來編寫CGI程序，只要在編程的時候符合CGI規范所定義的一些東西就可以了。由於C語言在平台無 關性上表現不錯（幾乎在任何的系統平台下都有其相應編譯器），而且對大多數程序員而言都算得上很熟悉（不像Perl），因此，C是CGI編程的首選語言之 一。這兒我們介紹的，就是如何使用C來編寫CGI程序。
作為CGI編程的最為簡單的例子，就是進行表單的處理。因而在這篇文章中，我們主要介紹的就是如何用C來編寫CGI程序來進行表但處理。
GET表單的處理
對於那些使用了屬性“METHOD=GET”的表單（或者沒有METHOD屬性，這時候GET是其缺省值），CGI定義為：當表單被發送到服務器斷后，表 單中的數據被保存在服務器上一個叫做QUERY_STRING的環境變量中。這種表單的處理相對簡單，只要讀取環境變量就可以了。這一點對不同的語言有不 同的做法。在C語言中，你可以用庫函數getenv（定義在標准庫函數stdlib中）來把環境變量的值作為一個字符串來存取。你可以在取得了字符串中的 數據后，運用一些小技巧進行類型的轉換，這都是比較簡單的了。在CGI程序中的標准輸出（output）（比如在C中的stdout文件流）也是經過重定 義了的。它並沒有在服務器上產生任何的輸出內容，而是被重定向到客戶瀏覽器。這樣，如果編寫一個C的CGI程序的時候，把一個HTML文檔輸出到它的 stdout上，這個HTML文檔會被在客戶端的瀏覽器中顯示出來。這也是CGI程序的一個基本原理。
我們來看看具體的程序實現，下面是一段HTML表單：
< form ACTION="/cgi-bin/mult.cgi" >
< P >請在下面填入乘數和被乘數，按下確定后可以看到結果。
< INPUT NAME="m" SIZE="5" >
< INPUT NAME="n" SIZE="5" >< BR >
< INPUT TYPE="SUBMIT" values="確定" >
< /form >
我們要實現的功能很簡單，就是把表單中輸入的數值乘起來，然后輸出結果。其實這個功能完全可以用java script來實現，但為了讓程序盡量的簡單易懂，我還是選擇了這個小小的乘法來作為示例。
下面就是處理這個表單的CGI程序，對應於form標簽中的ACTION屬性值。
引用
#include < stdio.h >
#include < stdlib.h >
int main(void)
{
char *data;
long m,n;
printf("%s%c%c ","Content-Type:text/html;charset=gb2312",13,10);
printf("< TITLE >乘法結果< /TITLE > ");
printf("< H3 >乘法結果< /H3 > ");
data = getenv("QUERY_STRING");
if(data == NULL)
printf("< P >錯誤！數據沒有被輸入或者數據傳輸有問題");
else if(sscanf(data,"m=%ld&n=%ld",&m,&n)!=2)
printf("< P >錯誤！輸入數據非法。表單中輸入的必須是數字。");
else
printf("< P >%ld和%ld的成績是：%ld。",m,n,m*n);
return 0;
}
具體的C語法就不多講了，我們來看看它作為CGI程序所特殊的地方。
前面已經提到標准輸出的內容就是要被顯示在瀏覽器中的內容。第一行的輸出內容是必須的，也是一個CGI程序所特有的：printf("%s%c%c ","Content-Type:text/html",13,10)，這個輸出是作為HTML的文件頭。因為CGI不僅可以像瀏覽器輸出HTML文本， 而且可以輸出圖像，聲音之類的東西。這一行告訴瀏覽器如何處理接受到的內容。在Content-Type的定義后面跟有兩行的空行，這也是不可缺少的。因 為所有CGI程序的頭部輸出都是相近的，因而可以為其定義一個函數，來節省編程的時間。這是CGI編程常用的一個技巧。
程序在后面調用了用了庫函數getevn來得到QUERY_STRING的內容，然后使用sscanf函數把每個參數值取出來，要注意的是sscanf函數的用法。其他的就沒有什么了，和一般的C程序沒有區別。
把程序編譯后，改名為mult.cgi放在/cgi-bin/目錄下面，就可以被表單調用了。這樣，一個處理GET方式表單的CGI程序就大功告成了。
POST表單處理
下面我們來考慮另外一種表單傳送方法：POST。假設我們要實現的任務是這樣的：把表單中客戶輸入的一段文本內容添加到服務器上的一個文本文件的后面。這 可以看作是一個留言版程序的雛形。顯然，這個工作是無法用java script這種客戶端腳本來實現，也算得上真正意義上的CGI程序了。
看起來這個問題和上面講的內容很相近，僅僅是用不同的表單和不同的腳本（程序）而已。但實際上，這中間是有一些區別的。在上面的例子中，GET的處理方法 可以看作是“純查詢（pure query）”類型的，也就是說，它與狀態無關。同樣的數據可以被提交任意的次數，而不會引起任何的問題（除了服務器的一些小小的開銷）。但是現在的任務 就不同了，至少它要改變一個文件的內容。因而，可以說它是與狀態有關的。這也算是POST和GET的區別之一。而且，GET對於表單的長度是有限制的，而 POST則不然，這也是在這個任務中選用POST方法的主要原因。但相對的，對GET的處理速度就要比POST快一些。
在 CGI的定義中，對於POST類型的表單，其內容被送到CGI程序的標准輸入（在C語言中是stdin），而被傳送的長度被放在環境變量 CONTENT_LENGTH中。因而我們要做的就是，在標准輸入中讀入CONTENT_LENGTH長度的字符串。從標准輸出讀入數據聽起來似乎要比從 環境變量中讀數據來的要容易一些，其實則不然,有一些細節地方要注意，這在下面的程序中可以看到。特別要注意的一點就是：CGI程序和一般的程序有所不 同，一般的程序在讀完了一個文件流的內容之后，會得到一個EOF的標志。但在CGI程序的表單處理過程中，EOF是永遠不會出現的，所以千萬不要讀多於 CONTENT_LENGTH長度的字符，否這會有什么后果，誰也不知道（CGI規范中沒有定義，一般根據服務器不同而有不同得處理方法）。
我們來看看到底如何從POST表單收集數據到CGI程序，下面給出了一個比較簡單的C源代碼:
引用
#include < stdio.h >
#include < stdlib.h >
#define MAXLEN 80
#define EXTRA 5
/* 4個字節留給字段的名字"data", 1個字節留給"=" */
#define MAXINPUT MAXLEN+EXTRA+2
/* 1個字節留給換行符，還有一個留給后面的NULL */
#define DATAFILE "../data/data.txt"
/* 要被添加數據的文件 */
void unencode(char *src, char *last, char *dest)
{
for(; src != last; src++, dest++)
if(*src == "+")
*dest = " ";
else if(*src == "%") {
int code;
if(sscanf(src+1, "%2x", &code) != 1) code = "?";
*dest = code;
src +=2; }
else
*dest = *src;
*dest = " ";
*++dest = "";
}
int main(void)
{
char *lenstr;
char input[MAXINPUT], data[MAXINPUT];
long len;
printf("%s%c%c ","Content-Type:text/html;charset=gb2312",13,10);
printf("< TITLE >Response< /TITLE > ");
lenstr = getenv("CONTENT_LENGTH");
if(lenstr == NULL || sscanf(lenstr,"%ld",&len)!=1 || len > MAXLEN)
printf("< P >表單提交錯誤");
else {
FILE *f;
fgets(input, len+1, stdin);
unencode(input+EXTRA, input+len, data);
f = fopen(DATAFILE, "a");
if(f == NULL)
printf("< P >對不起，意外錯誤，不能夠保存你的數據 ");
else
fputs(data, f);
fclose(f);
printf("< P >非常感謝，您的數據已經被保存< BR >%s",data);
}
return 0;
}
從本質上來看，程序先從CONTENT_LENGTH環境變量中得到數據的字長，然后讀取相應長度的字符串。因為數據內容在傳輸的過程中是經過了編碼的，所以必須進行相應的解碼。編碼的規則很簡單，主要的有這幾條:
1. 表單中每個每個字段用字段名后跟等號，再接上上這個字段的值來表示，每個字段之間的內容用&連結；
2. 所有的空格符號用加號代替，所以在編碼碼段中出現空格是非法的；
3. 特殊的字符比如標點符號，和一些有特定意義的字符如“+”，用百分號后跟其對應的ACSII碼值來表示。
例如：如果用戶輸入的是：
Hello there!
那么數據傳送到服務器的時候經過編碼，就變成了data=Hello+there%21 上面的unencode（）函數就是用來把編碼后的數據進行解碼的。在解碼完成后，數據被添加到data.txt文件的尾部，並在瀏覽其中回顯出來。
把文件編譯完成后，把它改名為collect.cgi后放在CGI目錄中就可以被表單調用了。下面給出了其相應的表單：
< form ACTION="/cgi-bin/collect.cgi" METHOD="POST" >
< P >請輸入您的留言（最多80個字符）：< BR >< INPUT NAME="data" SIZE="60" MAXLENGTH="80" >< BR >
< INPUT TYPE="SUBMIT" values="確定" >
< /form >
事實上，這個程序只能作為例子，是不能夠正式的使用的。它漏掉了很關鍵的一個問題：當有多個用戶同時像文件寫入數據是，肯定會有錯誤發生。而對於一個這樣 的程序而言，文件被同時寫入的幾率是很大的。因此，在比較正式的留言版程序中，都需要做一些更多的考慮，比如加入一個信號量，或者是借助於一個鑰匙文件 等。因為那只是編程的技巧問題，在這兒就不多說了。
最后，我們來寫一個瀏覽data.txt文件的的CGI程序，這只需要把內容輸出到stdout就可以了：
引用
#include < stdio.h >
#include < stdlib.h >
#define DATAFILE "../data/data.txt"
int main(void)
{
FILE *f = fopen(DATAFILE,"r");
int ch;
if(f == NULL) {
printf("%s%c%c ", "Content-Type:text/html;charset=gb2312",13,10);
printf("< TITLE >錯誤 < /TITLE > ");
printf("< P >< EM >意外錯誤，無法打開文件< /EM >"); }
else {
printf("%s%c%c ",
"Content-Type:text/plain",13,10);
while((ch=getc(f)) != EOF)
putchar(ch);
fclose(f); }
return 0;
}
這個程序唯一要注意的是：它並沒有把data.txt 包裝成HTML格式后再輸出，而是直接作為簡單文本（plain text）輸出，這只要在輸出的頭部用text/plain類型代替text/html就可以了，瀏覽器會根據Content-Type的類型自動的選擇 相應的處理方法。
要觸發這個程序也很簡單，因為沒有數據要輸入，所以只需一個按鈕就可以搞定了：
< form ACTION="/cgi-bin/viewdata.cgi" >
< P >< INPUT TYPE="SUBMIT" values="察看" >
< /form >
到這兒，一些基本的用C編寫CGI程序的原理就將完了。當然，就憑講的這些內容，還很難編寫出一個好的CGI程序，這需要進一步的學習CGI的規范定義，以及一些其他的CGI編程特有的技巧。
這篇文章的目的，也就是要你了解一下CGI編程的概念。事實上，現在的一些主流的服務器端腳本編程語言如ASP，PHP，JSP等，都基本上具備了CGI 編程的大部分的功能，但他們在使用上的，確實是比無論用什么語言進行CGI編程都要容易的多。所以在進行服務器端編程的時候，一般都會首先考慮使用這些腳 本編程語言。只有當他們也解決不了，比如要進行一些更為底層的編程的時候，才會用到CGI