(筆記)Linux下的簡單CGI編程

為什么要進行CGI編程? 
在HTML中，當客戶填寫了表單，並按下了發送（submit）按鈕后，表單的內容被發送到了服務器端，一般的，這時就需要有一個服務器端腳本來對表單的內容進行一些處理，或者是把它們保存起來，或者是按內容進行一些查詢，或者是一些別的什么。沒有了CGI，WEB的世界就完全失去了它的交互性，所有的信息都變成單向的了，而不能夠有任何的反饋。 
有的人認為可以用JavaScript來代替CGI程序，這其實是一個概念上的錯誤。JavaScript只能夠在客戶瀏覽器中運行，而CGI卻是工作在服務器上的。他們所做的工作有一些交集，比如表單數據驗證一類的，但是JavaScript是絕對無法取代CGI的。但可以這樣說，如果一項工作即能夠用 JavaScript來做，又可以用CGI來做，那么絕對要使用JavaScript，在執行的速度上，JavaScript比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" VALUE="確定" > 
< /FORM > 
  我們要實現的功能很簡單，就是把表單中輸入的數值乘起來，然后輸出結果。其實這個功能完全可以用JavaScript來實現，但為了讓程序盡量的簡單易懂，我還是選擇了這個小小的乘法來作為示例。 
  下面就是處理這個表單的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。假設我們要實現的任務是這樣的：把表單中客戶輸入的一段文本內容添加到服務器上的一個文本文件的后面。這可以看作是一個留言版程序的雛形。顯然，這個工作是無法用JavaScript這種客戶端腳本來實現，也算得上真正意義上的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" VALUE="確定" > 
< /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" VALUE="察看" > 
  < /FORM > 
  到這兒，一些基本的用C編寫CGI程序的原理就將完了。當然，就憑講的這些內容，還很難編寫出一個好的CGI程序，這需要進一步的學習CGI的規范定義，以及一些其他的CGI編程特有的技巧。 
這篇文章的目的，也就是要你了解一下CGI編程的概念。事實上，現在的一些主流的服務器端腳本編程語言如ASP，PHP，JSP等，都基本上具備了CGI 編程的大部分的功能，但他們在使用上的，確實是比無論用什么語言進行CGI編程都要容易的多。所以在進行服務器端編程的時候，一般都會首先考慮使用這些腳本編程語言。只有當他們也解決不了，比如要進行一些更為底層的編程的時候，才會用到CGI。