Linux CGI編程基礎【整理】

時間 2019-11-10

標籤 linux cgi 編程基礎整理欄目 Linux 简体版

原文原文鏈接

 
 
 
 Linux CGI編程基礎

1.爲何使用CGI？

    如前面所見，任何的HTML均是靜態網頁，它沒法實現一些複雜的功能，而CGI能夠爲咱們實現。如：a.列出服務器上某個目錄中的文件，對目錄中的文件進行操做；b.經過CGI實現串口通信；c.實現數據庫接口；d.實現從攝像頭讀取一張圖片顯示在網頁上… 等等

2. CGI是什麼？

    CGI全稱是 Common Gate Intergace ，在物理上，CGI是一段程序，它運行在Server上，提供同客戶端 Html頁面的接口。

3. CGI編程語言

    你能夠用任何一種你熟悉的高級語言， C,C++,C shell，Perl和VB均可以。

4. CGI的安全性

    實際上CGI是比較安全的，至少比 那些沒有數字簽名的ActiveX控件要安全的多。除非你有意在程序里加入了破壞Server的命令， 不然通常不會有什麼嚴重的後果。

簡單的說來，CGI是用來溝通HTML表單和服務器端程序的接口（interface）。說它是接口，也就是說CGI並非一種語言，而是能夠被其餘語言所應用的一個規範集。理論上講，你能夠用任何的程序語言來編寫CGI程序，只要在編程的時候符合CGI規範所定義的一些東西就能夠了。因爲C語言在平臺無關性上表現不錯（幾乎在任何的系統平臺下都有其相應編譯器），並且對大多數程序員而言都算得上很熟悉（不像Perl），所以，C是CGI編程的首選語言之一。這兒咱們介紹的，就是如何使用C來編寫CGI程序。

做爲CGI編程的最爲簡單的例子，就是進行表單的處理。於是在這篇文章中，咱們主要介紹的就是如何用C來編寫CGI程序來進行表但處理。

5.傳送方法：

    所謂方法是指調用CGI程序的途徑。事實上，要執行程序時，你用一種方法向服務器提出請求，此請求定義了程序如何接受數據。 下面介紹經常使用的兩種方法：GET和POST 1.GET 當使用這種方法時，CGI程序從環境變量QUERY_STRING獲取數據。

QUERY_STRING 被稱爲環境變量，就是這種環境變量把客戶端的數據傳給服務器。爲了解釋和執行 程序，CGI必需要分析（處理）此字符串。

    POST 使用POST方法時，WEB服務器經過stdin(標準輸入)，向CGI程序傳送數據。服務器 在數據的最後沒有使用EOF字符標記，所以程序爲了正確的讀取stdin,必須使用CONTENT_LENGTH 。當你發送的數據將改變

Web服務器端的數據或者你想給CGI程序傳送的數據超過了1024 字節，這是url的極限長度，你應該使用POST方法。 實現方法：

    GET實現方法

    <form name=「guyi‘s form」 action=「http://www.yourname.com/cgi/your.cgi」 method=GET>

    POST實現方法：

    <form method=post>

6. 表單編碼方式:

    form的enctype屬性爲編碼方式，經常使用有兩種：application/x-www-form-urlencoded和multipart/form-data，默認爲application/x-www-form-urlencoded。

當action爲get時候，瀏覽器用x-www-form-urlencoded的編碼方式把form數據轉換成一個字串（name1=value1&name2=value2...），而後把這個字串append到url後面，用?分割，加載這個新的url。

當action爲post時候，瀏覽器把form數據封裝到http body中，而後發送到server。

若是沒有type=file的控件，用默認的application/x-www-form-urlencoded就能夠了。

可是若是有type=file的話，就要用到multipart/form-data了。瀏覽器會把整個表單以控件爲單位分割，併爲每一個部分加上Content-Disposition(form-data或者file),Content-Type(默認爲text/plain),name(控件name)等信息，並加上分割符(boundary)。

    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("Content-type: text/html\n\n");
    printf("<TITLE>Mult Result</TITLE>");
    printf("<H3>Mult Result</H3>");

    data = getenv("QUERY_STRING");
    if(data == NULL)
        printf("<P>Don't transfer data or transfer error");
    else if(sscanf(data,"m=%ld&n=%ld",&m,&n)!=2)
        printf("<P>Error, invalid format, data have to number");
    else
        printf("<P>%ld and %ld result: %ld", m, n, m * n);
    printf("<br><h>Thank you to use the boa webserver</h1>");

    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 >form submit failed");
   } else {
       FILE *f;
       fgets(input, len+1, stdin);
       unencode(input+EXTRA, input+len, data);
       f = fopen(DATAFILE, "a");
       if(f == NULL)
           printf("< P >sorry, happened error, can't save your data");
       else
           fputs(data, f);
       fclose(f);
       printf("< P >Thanks very much, had saved your data< BR >%s",data);
   }
   return 0;
}

 
 
 
 從本質上來看，程序先從CONTENT_LENGTH環境變量中獲得數據的字長，而後讀取相應長度的字符串。由於數據內容在傳輸的過程當中是通過了編碼的，因此必須進行相應的解碼。編碼的規則很簡單，主要的有這幾條:

    1. 表單中每一個每一個字段用字段名後跟等號，再接上上這個字段的值來表示，每一個字段之間的內容用&連結；

    2. 全部的空格符號用加號代替，因此在編碼碼段中出現空格是非法的；

    3. 特殊的字符好比標點符號，和一些有特定意義的字符如「+」，用百分號後跟其對應的ACSII碼值來表示。

    例如：若是用戶輸入的是：

        Hello there!

    那麼數據傳送到服務器的時候通過編碼，就變成了data=Hello+there%21 上面的unencode（）函數就是用來把編碼後的數據進行解碼的。在解碼完成後，數據被添加到data.txt文件的尾部，並在瀏覽其中回顯出來。

    把文件編譯完成後，把它更名爲collect.cgi後放在CGI目錄中就能夠被表單調用了。下面給出了其相應的表單：

    <FORMACTION="/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>Error</TITLE> ");
        printf("<P><EM>have error, can't open file</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。

最後提供一個提交表單，並收到反饋的CGI實例：

<!--pass.html-->
<html> 
<head><title>user login verify</title></head> 
<body>
<!--下面的action是表單提交後在服務器端執行的gic程序（即c的可執行程序）-->
<!--cgi可執行程序放在 /var/www/cgi-bin/目錄下-->
<form name="form1" action="/cgi-bin/pass.cgi" method="GET"> 
<table align="center"> 
    <tr><td align="center" colspan="2"></td></tr>
    <tr>
       <td align="right">User</td>
       <td><input type="text" name="Username"></td>
    </tr>
    <tr>
       <td align="right">Passwd</td>
       <td><input type="password" name="Password"></td>
    </tr>
    <tr>
       <td><input type="submit" value="LogIn"></td>
       <td><input type="reset" value="Cancel"></td>
    </tr>
</table>
</form>
</body>
</html>

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

char* getcgidata(FILE* fp, char* requestmethod);

int main()
{
    char *input;
    char *req_method;
    char name[64];
    char pass[64];
    int i = 0;
    int j = 0;
       
//  printf("Content-type: text/plain; charset=iso-8859-1\n\n");
    printf("Content-type: text/html\n\n");
    printf("The following is query reuslt:<br><br>");

    req_method = getenv("REQUEST_METHOD");
    input = getcgidata(stdin, req_method);

    // 咱們獲取的input字符串可能像以下的形式
    // Username="admin"&Password="aaaaa"
    // 其中"Username="和"&Password="都是固定的
    // 而"admin"和"aaaaa"都是變化的，也是咱們要獲取的
    
   // 前面9個字符是UserName=
   // 在"UserName="和"&"之間的是咱們要取出來的用戶名
       for ( i = 9; i < (int)strlen(input); i++ ) {
           if ( input[i] == '&' ) {
            name[j] = '\0';
               break;
        }                   
        name[j++] = input[i];
      }

    // 前面9個字符 + "&Password="10個字符 + Username的字符數
    // 是咱們不要的，故省略掉，不拷貝
       for ( i = 19 + strlen(name), j = 0; i < (int)strlen(input); i++ ) {
        pass[j++] = input[i];
      }
    pass[j] = '\0';

    printf("Your Username is %s<br>Your Password is %s<br> \n", name, pass);
       
    return 0;
}

char* getcgidata(FILE* fp, char* requestmethod)
{
    char* input;
    int len;
    int size = 1024;
    int i = 0;
       
    if (!strcmp(requestmethod, "GET")) { //從這裏能夠看出來，GET在cgi中傳遞的Username="admin"&Password="aaaaa"被放置在環境變量QUERY_STRING中了。
        input = getenv("QUERY_STRING");
        return input;
      } else if (!strcmp(requestmethod, "POST")) {
        len = atoi(getenv("CONTENT_LENGTH"));
        input = (char*)malloc(sizeof(char)*(size + 1));
        
           if (len == 0) {
            input[0] = '\0';
            return input;
           }
              
        while(1) { //從這裏能夠看出來，POST在cgi中傳遞的Username="admin"&Password="aaaaa"被寫入stdin標準輸入流中了。
            input[i] = (char)fgetc(fp);
               if (i == size) {
                input[i+1] = '\0';
                return input;
             }
                     
               --len;
               if (feof(fp) || (!(len))) {
                i++;
                input[i] = '\0';
                return input;
            }
               i++;
           
         }
    }
    return NULL;
}